protocol.GetArtistsResponse
This response acts as an acknowledgement to its corresponding request as well as containing a collection of artists 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. There is also meta data relating to slice if slice is used which indicates upper and lower index of the slice in relation to all the data in this context. This class may be phased out some time in the future as the 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. Contains (li) lower index and (ui) upper index position of slice in relation to all data |
| tn | no | 1 | integer | total number matching request |
| n | no | 1 | integer | number of results returned |
| col | no | 1 | list | list of artists. |
Example xml:
<siresp>
<cid>Mum</cid>
<fn>
<getArtists>
<ixs>
<i0>0</i0>
<i1>9</i1>
</ixs>
<sli>
<ss>a</ss>
<w0>50</w0>
<w1>50</w1>
<li>29</li>
<ui>55</ui>
</sli>
<tn>30</tn>
<n>3</n>
<col>
<ar>
<arid>432546325432</arid>
<arnm>Florence and the Machine</arnm>
<alco>2</alco>
<trco>36</trco>
<cv></cv>
</ar>
<ar>
<arid>434334343</arid>
<arnm>Avril Lavigne</arnm>
<alco>2</alco>
<trco>36</trco>
<cv></cv>
</ar>
<ar>
<arid>343434</arid>
<arnm>Sting</arnm>
<alco>2</alco>
<trco>36</trco>
<cv></cv>
</ar>
</col>
</getArtists>
</fn>
</siresp>