protocol.GetPlaylistsRequest3

GetPlaylistsRequest3

This request allows you to get all the playlists. 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. An optional user id filter can be added if you are only interested in playlists for certain users. There is also an optional type filter that allows you to explicitly include/exclude certain playlist types.

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
uids	yes	1	list of userids	an empty user id signifies any playlist without an id, i.e shared/global ones
flt2	yes	1	list of types tp filter	read only, playlist types

Example xml:

  <sireq>
      <cid>Mum</cid>
      <fn>
          <getPlaylists3>
              <ixs>
                  <i0>0</i0>
                  <i1>9</i1>
              </ixs>
              <sli>
                  <ss>a</ss>
                  <w0>50</w0>
                  <w1>50</w1>
              </sli>
              <uids>
                  <uid></uid>
                  <uid>1</uid>
                  <uid>2</uid>
              </uids>
              <flt2>
                  <ro>1</ro>
                  <tys>
                      <ty>0</ty>
                      <ty>1</ty>
                  <tys>
              </flt2>
          </getPlaylists3>
      </fn>
  </sireq>

 

back to index