protocol.GetTracksRequest

GetTracksRequest

This request allows you to get all the tracks. An optional indices parameter can be passed if you wish to subset the returned list if you have a limit on the number of results you can display on your user interface. There is also an optional parameter that allows you to just get a slice of results around a matching string. This is useful if you are randomly jumping around in the results for example alphabetically. This class may be phased out some time in the future as a new class exists that will also return the index of the matched text in all the matching results which is useful for paging results where you may want to know where you matched results sit in the grand scheme of matched results

Parameter	Optional	Max Allowed	DataType	Notes
cid	no	1	text	client id. used to track origin of any particular message
ixs	yes	1	indices	start (i0) and end (i1) index inclusive
sli	yes	1	slice	pivot returned results around matching string (ss) with number of items before (w0) and after (w1) matching string

Example xml:

  <sireq>
      <cid>Mum</cid>
      <fn>
          <getTracks>
              <ixs>
                  <i0>0</i0>
                  <i1>9</i1>
              </ixs>
              <sli>
                  <ss>a</ss>
                  <w0>50</w0>
                  <w1>50</w1>
              </sli>
          </getTracks>
      </fn>
  </sireq>

 

back to index