protocol.SearchResponse
This response acts as an acknowledgment to its corresponding request as well as containing a collection of media types matching your request parameters. There is meta data included prior to the list to indicate the number of results returned as well as the total matching results in the database. This is useful if you have subset the 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 |
| q | no | 1 | text | POSIX regular expression. |
| tys | no | 1 | list | list of media types to apply search to: track/album/artist/playlist/radiostation/composer |
| tn | no | 1 | integer | total number matching request |
| n | no | 1 | integer | number of results returned |
| col | no | 1 | list | list of media types grouped in the order you specified in the media types list. |
Example xml:
<siresp>
<cid>Mum</cid>
<fn>
<search>
<ixs>
<i0>0</i0>
<i1>9</i1>
</ixs>
<q>Cold Play fdffd</q>
<tys>
<ty>track</ty>
<ty>album</ty>
<ty>playlist</ty>
<ty>artist</ty>
<ty>radiostation</ty>
<ty>composer</ty>
</tys>
<tn>30</tn>
<n>3</n>
<col>
<tr>
<trid>432546325432</trid>
<trnm>Dark days are over</trnm>
<arnm>Florence and the Machine</arnm>
<arid>432546325432</arid>
<alnm>Lungs</alnm>
<alid>432546325432</alid>
<dura>350909</dura>
<cv>http://10.5.0.39:8080/art.cgi?id=ere&fm=png</cv>
<grid>6546665454654654</grid>
<grnm>rock</grnm>
<cpid>3434353</cpid>
<cpnm>3434353</cpnm>
<bpm>123</bpm>
<brt>256 kbs</brt>
<frq>44100 hz</frq>
<yr>1998</yr>
<tarid>65565665</tarid>
<tarnm>Florence and the Machine</tarnm>
<cve>1</cve>
<alarid>432546325432</alarid>
<alarnm>The Best of Florence and the Machine</alarnm>
</tr>
<al>
<alid>432546325432</alid>
<alnm>Lungs</alnm>
<arnm>Florence and the Machine</arnm>
<arid>584374858</arid>
<trco>13</trco>
<cv>http://10.5.0.39:8080/art.cgi?id=ere&fm=png</cv>
<cpl>1</cpl>
</al>
<pl>
<plid>432546325432</plid>
<plnm>Podcasts</plnm>
<trco></trco>
<cv></cv>
<ro>1</ro>
<uid>mum</uid>
</pl>
<ar>
<arid>432546325432</arid>
<arnm>Florence and the Machine</arnm>
<alco>2</alco>
<trco>36</trco>
<cv></cv>
</ar>
<rstn>
<rdid>432546325432</rdid>
<rdnm>1.FM - ABSOLUTE 90's RADIO</rdnm>
<wbs>http://www.1.fm</wbs>
<rdcv>http://www.apple.com/art.jpg</rdcv>
<grnm>90s pop dance rock</grnm>
<brt>64kbit/s</brt>
<frq>44100 Hz</frq>
</rstn>
<cp>
<cpid>432546325432</cpid>
<cpnm>Florence and the Machine</cpnm>
<alco>2</alco>
<trco>36</trco>
<cv></cv>
</cp>
</col>
</search>
</fn>
</siresp>