Sub Users / Sub Accounts

Use GetBandwidthStatGroupDate to return encoding traffic of selected user. You can specify a certain date to return information on a particular user. The traffic will be grouped by existing's dates. Please note "date_to" and "date_from" the optional fields. You should use it if you intend to recieve bandwidth statistic into specified date interval. Post the following XML to the API

<?xml version="1.0"?>
<query>
<userid>[UserID]</userid>
<userkey>[UserKey]</userkey>
<action>GetBandwidthStatGroupDate</action>
<action_user_id>[ActionUserID]</action_user_id>
<date_from>[YYYY-MM-DD]</date_from>
</date_to>[YYYY-MM-DD]</date_to>
</query>

Response:

<?xml version="1.0"?>
<response>
  <action>getbandwidthstatgroupdate</action>
  <status>Success</status>
  <result>
     <user_id>[userID]</user_id>
     <date_[date1]>
       <in>
         <bytes>[amount in bytes]</bytes>
         <gb>[amount in gigabytes]</gb>
      </in>
       <out>
         <bytes>[amount in bytes]</bytes>
         <gb>[amount in gigabytes]</gb>
      </out>
     </date_[date1]>
     <date_[date2]>
        <in>
          <bytes>[amount in bytes]</bytes>
          <gb>[amount in gigabytes]</gb>
       </in>
       <out>
         <bytes>[amount in bytes]</bytes>
         <gb>[amount in gigabytes]</gb>
      </out>
    </date_[date2]>
...
  </result>
</response>

Use GetBandwidthStat to return encoding traffic of selected user. You can specify a certain date to return information on a particular user. Please note "date_to" and "date_from" the optional fields. You should use it if you intend to recieve bandwidth statistic into specified date interval. Post the following XML to the API:

<?xml version="1.0"?>
<query>
<userid>[UserID]</userid>
<userkey>[UserKey]</userkey>
<action>GetBandwidthStat</action>
<action_user_id>[ActionUserID]</action_user_id>
<date_from>[YYYY-MM-DD]</date_from>
</date_to>[YYYY-MM-DD]</date_to>
</query>

and your return will be:

<?xml version="1.0"?>
<response>
   <action>getbandwidthstat</action>
   <status>Success</status>
   <result>
    <user_id>[UserID]</user_id>
    <date_from>[Date from]</date_from>
    <date_to>[Date to]</date_to>
    <in>
       <bytes>[amount in bytes]</bytes>
       <gb>[amount in gigabytes]</gb>
   </in>
   <out>
       <bytes>[amount in bytes]</bytes>
       <gb>[amount in gigabytes]</gb>
   </out>
   <turbo>
       <bytes>[amount in bytes]</bytes>
       <gb>[amount in gigabytes]</gb>
   </turbo>
  </result>
</response>

Interested in a particular user's storage space. Send this XML to our API:

<?xml version="1.0"?>
<query>
<userid>[UserID]</userid>
<userkey>[UserKey]</userkey>
<action>GetStorageSpace</action>
<action_user_id>[ActionUserID]</action_user_id>
</query>

The response that you'll receive in is GB as follows:

<?xml version="1.0"?>
<response>
   <action>getstoragespace</action>
   <status>Success</status>
   <result>
     <user_id>[UserID]</user_id>
     <gb>[Storage Space]</gb>
   </result>
</response>

Say you're interested in how a user's been using the platform. In particular, their success rate, queue times, bandwidth specs, etc. Use GetASM to return this info. Here's an example of the XML to send to the API

<?xml version="1.0"?>
<query>
<userid>[UserID]</userid>
<userkey>[UserKey]</userkey>
<action>GetASM</action>
<action_user_id>[ActionUserID]</action_user_id>
</query>

and the response:

<?xml version="1.0"?>
<response>
  <action>getasm</action>
  <status>Success</status>
  <result>
    <user_id>[UserID]</user_id>
    <encoding_success_rate>
        <percentage>100</percentage>
    </encoding_success_rate>
    <queue_time>
        <second>[average queue time in this month]</second>
    </queue_time>
    <processing_time>
        <second>[average processing time in this month]</second>
    </processing_time>
    <connection_speed>
        <kbs>[average connection speed]</kbs>
    </connection_speed>
    <encoding_bandwidth>
         <gb>[average amount of encoding bandwidth]</gb>
    </encoding_bandwidth>
  </result>
</response>

Let's say you've made a ton of subusers, but want information back as a whole on all the users you've created. Send the following to the API...

<?xml version="1.0"?>
<query>
<!-- Main fields -->
    <userid>[UserID]</userid>
    <userkey>[UserKey]</userkey>
    <action>getsubusers</action>
</query>

and you'll get in return a complete list of who's who for sub users:

<?xml version="1.0"?>
<response>
  <action>getsubusers</action>
  <status>Success</status>
  <result>
    <user_id></user_id>
    <user_0>
      <ID>[UserID]</ID>
      <Login>[Login]</Login>
      <FirstName>[FirstName]</FirstName>
      <LastName>[LastName]</LastName>
      <Email>[Email]</Email>
      <UserKey>[UserKey]</UserKey>
      <Country>[Country]</Country>
      <Phone>[Phone]</Phone>
      <Status>[Status]</Status>
    </user_0>
    <user_1>
      <ID>[UserID]</ID>
      <Login>[Login]</Login>
      <FirstName>[FirstName]</FirstName>
      <LastName>[LastName]</LastName>
      <Email>[Email]</Email>
      <UserKey>[UserKey]</UserKey>
      <Country>[Country]</Country>
      <Phone>[Phone]</Phone>
      <Status>[Status]</Status>
   </user_1>
  </result>
</response>

For sub accounts, the whole point of creating them is to track usage, right? Well, since we have no UI, you'll want a way to see the information we have stored on a particular user under your main account. Use GetUserInfo to return information on a particular user:

<?xml version="1.0"?>
<query>
<userid>[UserID]</userid>
<userkey>[UserKey]</userkey>
<action>GetUserInfo</action>
<action_user_id>[ActionUserID]</action_user_id>
</query>

We'll return back this handy information:

<?xml version="1.0"?>
<response>
  <action>getuserinfo</action>
  <status>Success</status>
  <result>
    <user_id>[ActionUserID]</user_id>
    <ID>[ActionUserID]</ID>
    <Login>[Login]</Login>
    <FirstName>[FirstName]</FirstName>
    <LastName>[LastName]</LastName>
    <Email>[Email]</Email>
    <UserKey>[UserKey]</UserKey>
    <Country>[Country]</Country>
    <Phone>[Phone]</Phone>
    <Status>[Status]</Status>
  </result>
</response>

If you wish to update the email address and phone number of a sub user, send the following format of XML to our API.

<?xml version="1.0"?>
<query>
<!-- Main fields -->
<userid>[UserID]</userid>
<userkey>[UserKey]</userkey>
<action>UpdateSubUser</action>
<action_user_id>[ActionUserID]</action_user_id>
<user_data>
<email>[New email]</email>
<phone>[New phone]</phone>
</user_data>
</query>

You'll receive the following back to confirm success of the update:

<?xml version="1.0"?>
<response>
  <action>updatesubuser</action>
  <status>Success</status>
  <result>
    <user_id></user_id>
    <message>The user data was updated</message>
    <email>[New Email]</email>
    <country>[New Country]</country>
  </result>
</response>

You can easily delete sub accounts from your master account by sending the following XML to the API:

<?xml version="1.0"?>
<query>
<userid>[UserID]</userid>
<userkey>[UserKey]</userkey>
<action>DeleteSubUser</action>
<action_user_id>[ActionUserID]</action_user_id>
</query>

You'll receive the following response:

<?xml version="1.0"?>
<response>
<action>deletesubuser</action>
<status>Success</status>
</response>

To sign up a sub user on your account, you'll need to provide Encoding.com with a few pieces of information on the sub user. 

<?xml version="1.0"?>
<query>
<!-- Main fields -->
<userid>[UserID]</userid>
<userkey>[UserKey]</userkey>
<action>AddSubUser</action>
<user_data>
<email>[Email]</email>
<login>[Login]</login>
<password>[Password]</password>
<first_name>[FirstName]</first_name>
<last_name>[LastName]</last_name>
<phone>[Phone]</phone>
</user_data>
</query>

You'll receive the following response back from the system once the user has been created:

<?xml version="1.0"?>
<response>
<action>addsubuser</action>
<status>Success</status>
<result>
<plan>Max</plan>
<user_id>New_UserID</user_id>
<user_key>Unique_subaccount_API_key</user_key>
<message>The new sub user has been created</message>
</result>
</response>

Sub accounts are only granted to users on MAX or higher accounts. They are a useful way of tracking bandwidth on the master account if you have many users / agencies on your account. Please note that there is no UI for sub users, as its entirely supported by the API. Contact the administrator of the plan that signed up with Encoding.com for more information. This feature is not automatically turned on by Encoding.com; you must request this by contacting the Help Desk. For full information on sub accounts, please check out the complete API documentation.

http://www.encoding.com/api/category/category/sub_account_api_documentation