protocol.GetUsersResponse
This response acts as an acknowledgment to its corresponding request as well as containing a collection of users 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.
| 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. Contains (ix) index of matching result thats pivoted around |
| tn | no | 1 | integer | total number matching request |
| n | no | 1 | integer | number of results returned |
| col | no | 1 | list | list of users. |
Example xml:
<siresp>
<cid>Mum</cid>
<fn>
<getUsers>
<ixs>
<i0>0</i0>
<i1>9</i1>
</ixs>
<sli>
<ss>a</ss>
<w0>50</w0>
<w1>50</w1>
<li>29</li>
<ui>55</ui>
<ix>35</ix>
</sli>
<tn>30</tn>
<n>3</n>
<col>
<us>
<uid>1</uid>
<usnm>Bob Dylan</usnm>
</us>
<us>
<uid>2</uid>
<usnm>Kurt Cobain</usnm>
</us>
</col>
</getUsers>
</fn>
</siresp>