previous page |next page

show¶

Show detailed account information for a child account. Only available to resellers.

Parameters¶

account_key (optional) : string: Key of the account which information to show.

account_login (optional) : string: Login of the account which information to show.

Warning

One of the parameters account_key or account_login MUST be provided, not both.

account_password (optional) : string: Account password. Should be used in combination with account_login parameter. If specified, information for the account matching both account_login and account_password is returned. API NotFound error is returned, if no matching account is found.

Example response¶

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <account key="zUPp06Zi">
   <can_store>True</can_store>
   <can_stream>True</can_stream>
    <cdn>
      <name>Highwinds</name>
      <type>highwinds</type>
      <protocol>rtmp</protocol>
    </cdn>
    <conversions>
      <original>
        <delete>False</delete>
      </original>
      <templates total="5">
        <template key="BzV8dMpX" id="2389">
          <default>True</default>
          <name>Original</name>
          <required>True</required>
        </template>
        ...
      </templates>
    </conversions>
    <custom>
      <param1>value 1</param1>
      <param2>value 2</param2>
    </custom>
    <deleted />
    <dns_masks>
      <content>content.example.com</content>
    </dns_masks>
    <email>foo@bar.com</email>
    <jwplayer_edition>premium</jwplayer_edition>
    <login>foobar</login>
    <name>
      <alternative>Foo Bar</alternative>
      <first>Foo</first>
      <last>Bar</last>
    </name>
    <parent key="2cC36w2Z" />
    <registered>1246891649</registered>
    <restrictions>
      <downloads>
        <allow>True</allow>
      </downloads>
      <embeds>
        <allow>True</allow>
      </embeds>
    </restrictions>
    <role>administrator</role>
    <secret>dQ5vNpEijBDpkTAwvx18u3gv</secret>
    <state>
      <changed>1249917685</changed>
      <current>normal</current>
      <next>
        <change />
        <states total="3">
          <state default="True">pending</state>
          <state default="False">suspended</state>
          <state default="False">normal</state>
        </states>
      </next>
    </state>
    <content>
      <limit>3000000000</limit>
      <size>35646874</size>
      <used>29705728</used>
    </content>
    <subaccounts total="3" />
    <traffic>
      <limit>5000000000</limit>
      <used>4017146509</used>
    </traffic>
    <type>user</type>
    <usage_type>limited</usage_type>
    <videos total="0" />
  </account>
</response>

Response parameters¶

/response/status : string: Call execution status. Set to ok if call executed successfully.

//account/@key : string: Account key.

//account/can_store : string: True if account can upload content, False otherwise.

//account/can_stream : string: True if account can stream content, False otherwise.

//account/cdn/name : string: Account’s CDN name.

//account/cdn/type : string: Account’s CDN type.

//account/cdn/protocol : string: Account’s CDN protocol.

//account/conversions/original/delete : string: True if original video will be deleted when the default conversions are done, False otherwise. Available only for accounts with a type user or subuser.

//account/conversions/templates/@total : unsigned integer: Total number of video templates this account has. Available only for accounts with a type user or subuser.

//account/conversions/templates/@key : string: Key of the video template. Available only for accounts with a type user or subuser.

//account/conversions/templates/@id : unsigned integer: Identifier of the video template. Available only for accounts with a type user or subuser.

Warning

//account/conversions/templates/@id parameter is deprecated and it will be removed in the future. Please only use //account/conversions/templates/@key.

//account/conversions/templates/name : string: Name of the video template. Available only for accounts with a type user or subuser.

//account/conversions/templates/default : string: True if template is a default template, False otherwise. Available only for accounts with a type user or subuser.

//account/conversions/templates/required : string: True if template is a required template, False otherwise. Available only for accounts with a type user or subuser.

//account/custom/param1 : string: User defined parameter.

//account/dns_masks/content : string: Content server DNS mask.

//account/deleted : signed integer: UTC date and time when account was deleted in Unix timestamp format.

//account/email : string: Email address of the account owner.

//account/jwplayer_edition : string

Specifies which JW Player edition should be used:

premium: JW Player Premium edition.

ads: JW Player Ads edition.

Available only for accounts with a type user or subuser.

//account/login : string: Login name of the account.

//account/name/alternative : string: Alternative name of the account owner (e.g. company name, user nickname or user name that does not fit into the first name – last name schema).

//account/name/first : string: First name of the account owner.

//account/name/last : string: Last name of the account owner.

//account/parent/@key : string: Key of the account that has created this account.

//account/registered : signed integer: UTC date and time when account was registered in Unix timestamp format.

//account/restrictions/downloads/allow : string

Specifies if unsigned direct video downloads are allowed:

True: Unsigned direct video downloads are allowed.

False: Only signed direct video downloads are allowed.

Available only for accounts with a type user or subuser.

//account/restrictions/embeds/allow : string

Specifies if unsigned video player embeds are allowed:

True: Unsigned video player embeds are allowed.

False: Only signed video player embeds are allowed.

Available only for accounts with a type user or subuser.

//account/role : string

Account role:

administrator: Account owner allowed to execute all calls for his own account and for child sub accounts as well.

editor: Account owner only allowed to execute list, show and update calls.

viewer: Account owner only allowed to execute list and show calls.

uploader: Account owner only allowed to upload videos (i.e. execute /videos/create call).

//account/secret : string: Account secret.

//account/state/changed : signed integer: UTC date and time when account state was changed in Unix timestamp format.

//account/state/current : string

Account current state:

undefined: Account state is not defined.

registered: Account is registered.

normal: Account is operational.

pending: Waiting for payment after content limit has been depleted. Account cannot upload any content. Streaming is allowed while //account/traffic/limit is greater than 0.

suspended: Account is (temporally) suspended. Account owner cannot login into the BotR system, cannot use System API and cannot stream any video content.

deleted: Account and all its media content has been permanently deleted.

//account/state/next/change : signed integer: UTC date and time in Unix timestamp format when account state will be automatically change to the next default state.

//account/state/next/states/@total : unsigned integer: Total number of states to which account state can be changed.

//account/state/next/states/state : string: State to which current account state can be changed.

//account/state/next/states/state/@default : string

Indicates whether the next state is default or not:

True: The next state is a default state. Account state will be automatically changed to this state after time specified in //account/state/next/change is reached.

False: The next state is not a default state.

//account/usage_type : string

Account usage type:

free: Account has free monthly usage quota.

limited: Account usage is limited.

unlimited: Account usage is unlimited.

//account/content/limit : unsigned integer: Total amount of available content space in bytes. Set to -1 if account has unlimited usage type.

//account/content/size : unsigned integer: Amount of disk space in bytes used by the account’s content.

//account/content/used : unsigned integer: Content used by the account. For accounts with a free or an unlimited usage type this amount is the same as the //account/content/size. For accounts with a limited usage type this amount shows current content usage in bytes-day.

//account/subaccounts/@total : unsigned integer: Total number of accounts for which this account is the parent. /accounts/list call with account_key set to the account key of the current account should be used to get detailed list of sub accounts.

//account/traffic/limit : unsigned integer: Total amount of available traffic in bytes. Set to -1 if account has unlimited usage type.

//account/traffic/used : unsigned integer: Amount of traffic in bytes used by the account since the last traffic counter reset.

//account/type : string

Type of account:

reseller: Reseller account. Can execute API calls for himself and accounts with type subreseller, user and subuser where he is the parent or the grandparent. This account type has no content.

subreseller: Sub reseller account. Can execute API calls for himself, his parent and accounts with type user and subuser where his parent reseller account is the parent or the grandparent. Which API calls can be executed depends on the role account has been assigned to. This account type has no content.

user: User account. Can execute API calls for himself and accounts with type subuser where he is the parent.

subuser: Sub user account. Can execute API calls for himself, his parent and his parent sub users.

//account/videos/@total : unsigned integer: Total number of videos account has. Available only for accounts with a type user or subuser.

previous page | Reference Overview |next page