User Tools

Site Tools


en-133-app-lsub


APP Request / LSUB

The LSUB command requests to the webservice, through POST, the list of channels subscribeds by the user.



POST variables

id Contains the identification of the Device, no encrypted (Device-ID)
key Contains the temporary AES key encrypted with the public key and encoded in Base64;
frame Contains the XML request, encrypted with the temporary AES key and encoded in Base64.



XML POST response

In response to the POST, the webservice returns the XML POST response, which should not mistaken with the XML request response, as described below. The POST response XML includes 3 tags:

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<retcode>return-code</retcode>
<retframe>xml-request-response</retframe>
<retmd5>md5-hash</retmd5>
</followzup>

where:

  • retcode: Return code of the requested command represented by 4 numeric digits or “0” (zero) for successfully execution;
  • retframe: Contains the XML request response, encrypted with the temporary key AES and encoded in Base64. The XML request response depends on the command that was requested and the AES key used in its encryption is the same were used when the request was sent;
  • retmd5: Contains the MD5 hash of the retframe tag, to be validated by the requester.



XML request

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<stp>stamp</stp>
<com>lsub</com>
<seq>sequence</seq>
</followzup>

Where:

  • stamp: Stamp code of the Interface.
  • lsub: Must contain the literal “lsub” (List Subscriptions);
  • sequence: Contains the request sequence number.



XML request response

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<tag>device-tag</tag>
<cnt>channels-count</cnt>
<chn>channel-tag;subscription-code;md5-icon;flag-response-url</chn>
<chn>...</chn>
</followzup>

Where:

  • device-tag: Device name;
  • channels-count: Total number of subscribed channels;
  • channel-tag: Tag of the subscribed channel;
  • subscription-code: Subscription code of the channel;
  • md5-icon: Hash MD5 of the channel icon;
  • flag-response-url: Flag to display the channel text box.


XML request response (invalid sequence):

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<seq>Last-sequence</seq>
</followzup>

Where:

  • Last-sequence: Sequence number used in the last request.



Return codes

0 Successfully execution
7101 Invalid sequence
7102 Invalid frame
7103 Invalid command
7104 Invalid Device-ID
7999 Webservice under maintenance


en-133-app-lsub.txt · Last modified: 2017/05/30 09:48 by admin

Page Tools