The responses vary by request, as seen below.
AddTrialUser
<?xml version="1.0"?>
<response>
<action>addtrialuser</action>
<status>Success</status>
<result>
<plan>Trial 1 GB</plan>
<user_id>[UserID]</user_id>
<user_key>[UserKey]</user_key>
<message>The new trial user has been created</message>
</result>
</response>
{
"response": {
"action": "addtrialuser",
"status": "Success",
"result": {
"plan": "Trial 1 GB",
"user_id": "[UserID]",
"user_key": "[UserKey]",
"message": "The new trial user has been created"
}
}
}
AddSubUser
<?xml version="1.0"?>
<response>
<action>addsubuser</action>
<status>Success</status>
<result>
<plan>[Plan]</plan>
<user_id>[UserID]</user_id>
<user_key>[UserKey]</user_key>
<message>The new sub user has been created</message>
</result>
</response>
{
"response": {
"action": "addsubuser",
"status": "Success",
"result": {
"plan": "[Plan]",
"user_id": "[UserID]",
"user_key": "[UserKey]",
"message": "The new sub user has been created"
}
}
}
UpdateUser
<?xml version="1.0"?>
<response>
<action>updatesubuser</action>
<status>Success</status>
<result>
<user_id>[UserID]</user_id>
<message>The user data was updated</message>
<email>[New Email]</email>
<country>[New Country]</country>
</result>
</response>
{
"response": {
"action": "updatesubuser",
"status": "Success",
"result": {
"user_id": "[UserID]",
"message": "The user data was updated",
"email": "[New Email]",
"country": "[New Country]"
}
}
}
DeleteSubUser
<?xml version="1.0"?>
<response>
<action>deletesubuser</action>
<status>Success</status>
</response>
{
"response": {
"action": "deletesubuser",
"status": "Success"
}
}
GetUserInfo
<?xml version="1.0"?>
<response>
<action>getuserinfo</action>
<status>Success</status>
<result>
<user_id><<id>></user_id>
<ID>1800</ID>
<Login>[Login]</Login>
<FirstName>[FirstName]</FirstName>
<LastName>[LastName]</LastName>
<Email>[Email]</Email>
<UserKey><<key>></UserKey>
<Country>[Country]</Country>
<Phone>[Phone]</Phone>
<Status>[Status]</Status>
<PlanName>[PlanName]</PlanName>
<PlanType>[PlanType]</PlanType>
<PlanLimit>[PlanLimit]</PlanLimit>
<PlanUsage>[PlanUsage]</PlanUsage>
</result>
</response>
{
"response": {
"action": "getuserinfo",
"status": "Success",
"result": {
"user_id": "<<key>>",
"ID": "1800",
"Login": "[Login]",
"FirstName": "[FirstName]",
"LastName": "[LastName]",
"Email": "[Email]",
"UserKey": "<<key>>",
"Country": "[Country]",
"Phone": "[Phone]",
"Status": "[Status]",
"PlanName": "[PlanName]",
"PlanType": "[PlanType]",
"PlanLimit": "[PlanLimit]",
"PlanUsage": "[PlanUsage]"
}
}
}
GetSubUsers
<?xml version="1.0"?>
<response>
<action>getsubusers</action>
<status>Success</status>
<result>
<user_id><<key>></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>
{
"response": {
"action": "getsubusers",
"status": "Success",
"result": {
"user_id": "<<key>>",
"user_0": {
"ID": "[UserID]",
"Login": "[Login]",
"FirstName": "[FirstName]",
"LastName": "[LastName]",
"Email": "[Email]",
"UserKey": "[UserKey]",
"Country": "[Country]",
"Phone": "[Phone]",
"Status": "[Status]"
},
"user_1": {
"ID": "[UserID]",
"Login": "[Login]",
"FirstName": "[FirstName]",
"LastName": "[LastName]",
"Email": "[Email]",
"UserKey": "[UserKey]",
"Country": "[Country]",
"Phone": "[Phone]",
"Status": "[Status]"
}
}
}
}
GetASM
<?xml version="1.0"?>
<response>
<action>getasm</action>
<status>Success</status>
<result>
<user_id><<id>></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>
{
"response": {
"action": "getasm",
"status": "Success",
"result": {
"user_id": "<<id>>",
"encoding_success_rate": {
"percentage": "100"
},
"queue_time": {
"second": "[average queue time in this month]"
},
"processing_time": {
"second": "[average processing time in this month]"
},
"connection_speed": {
"kbs": "[average connection speed]"
},
"encoding_bandwidth": {
"gb": "[average amount of encoding bandwidth]"
}
}
}
}
GetStorageSpace
<?xml version="1.0"?>
<response>
<action>getstoragespace</action>
<status>Success</status>
<result>
<user_id>[UserID]</user_id>
<gb>[Storage Space]</gb>
</result>
</response>
{
"response": {
"action": "getstoragespace",
"status": "Success",
"result": {
"user_id": "[UserID]",
"gb": "[Storage Space]"
}
}
}
GetBandwidthStat
<?xml version="1.0"?>
<response>
<action>getbandwidthstat</action>
<status>Success</status>
<result>
<user_id><<id>></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>
<aspera_in>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</aspera_in>
<aspera_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</aspera_out>
<live_in>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</live_in>
<live_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</live_out>
<cloud_in>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_in>
<cloud_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_out>
<qc_in>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</qc_in>
<qc_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</qc_out>
<qc_baton>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</qc_baton>
<cloud_qc_in>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_qc_in>
<cloud_qc_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_qc_out>
<repackage_in>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</repackage_in>
<repackage_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</repackage_out>
<cloud_repackage_in>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_repackage_in>
<cloud_repackage_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_repackage_out>
<ludicrous_mode>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</ludicrous_mode>
<cloud_ludicrous_mode>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_ludicrous_mode>
<hevc_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</hevc_out>
<cloud_hevc_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_hevc_out>
<veryslow_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</veryslow_out>
<cloud_veryslow_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_veryslow_out>
<beamr_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</beamr_out>
<cloud_beamr_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_beamr_out>
<dolby_vision_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</dolby_vision_out>
<cloud_dolby_vision_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_dolby_vision_out>
<redcode_in>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</redcode_in>
<cloud_redcode_in>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_redcode_in>
<webm_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</webm_out>
<cloud_webm_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_webm_out>
<metrics_report_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</metrics_report_out>
<cloud_metrics_report_out>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</cloud_metrics_report_out>
<qc_qualify>
<bytes>[amount in bytes]</bytes>
<gb>[amount in gigabytes]</gb>
</qc_qualify>
</result>
</response>
{
"response": {
"action": "getbandwidthstat",
"status": "Success",
"result": {
"user_id": "<<id>>",
"date_from": "[Date from]",
"date_to": "[Date to]",
"in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"aspera_in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"aspera_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"live_in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"live_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"qc_in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"qc_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"qc_baton": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_qc_in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_qc_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"repackage_in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"repackage_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_repackage_in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_repackage_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"ludicrous_mode": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_ludicrous_mode": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"hevc_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_hevc_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"veryslow_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_veryslow_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"beamr_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_beamr_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"dolby_vision_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_dolby_vision_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"redcode_in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_redcode_in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"webm_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_webm_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"metrics_report_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"cloud_metrics_report_out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"qc_qualify": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
}
}
}
GetBandwidthStatGroupDate
<?xml version="1.0"?>
<response>
<action>getbandwidthstatgroupdate</action>
<status>Success</status>
<result>
<user_id><<id>></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>
{
"response": {
"action": "getbandwidthstatgroupdate",
"status": "Success",
"result": {
"user_id": "<<id>>",
"date_date1": {
"in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
}
},
"date_date2": {
"in": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
},
"out": {
"bytes": "[amount in bytes]",
"gb": "[amount in gigabytes]"
}
}
}
}
}