User Tools

Site Tools


en-134-app-lkup


APP Request / LKUP

The LKUP command requests to the webservice, through POST, to search for new channels.

Channel search returns a list of the first 10 channels that matche the search argument. If the complete list has more than 10 channels, the webservice also returns the tag more, which value is equal to the last of the 10 received tags.

When the more tag is returned in a search result, the APP displays the “More …” button at the bottom of the results list. When the user clicks this button, the APP submits a new search with the argument more, telling the webservice that it wants the next 10 results, and so on.

The search result with the tag more empty, indicates that there are no more results besides the tags listed.

The search also includes the MD5 hash of the channel icon, allowing the APP to get the image of the icon in the local base or request the image through the icon command.

Images of icons obtained should be stored in the local base for future use.



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>lkup</com>
<seq>sequence</seq>
<chn>channel-arg</chn>
<mor>more-tag</mor>
</followzup>

Where:

  • stamp: Stamp code of the Interface.
  • lkup: Must contain the literal “lkup” (Channel Lookup);
  • sequence: Contains the request sequence number.
  • channel-arg: Search tag argument;
  • more-tag: Last channel listed in partial search.



XML request response

<?xml version="1.0" encoding="utf-8"?>
<followzup>
<chn>channel-tag;flag-private;flag-private-code;md5-icon;presentation-text</chn>
<chn>...</chn>
<mor>more-tag</mor>
</followzup>

Where:

  • channel-tag: Tag of the channel;
  • flag-private: Private channel flag;
  • flag-private-code: Private code flag;
  • md5-icon: Hash MD5 of the channel icon;
  • presentation-text: Channel presentation text (BASE64 format).
  • more-tag: Last channel listed in partial search.


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
7242 Search argument less than 3 characters
7999 Webservice under maintenance


en-134-app-lkup.txt · Last modified: 2017/05/30 10:06 by admin

Page Tools