Playlist

From DriveCast Wiki

GET

   URL:        https://drivecast.eu/api/1.0/playlist
   Methods:    GET
   Returns:    200 OK + object containing the arrays of the playlists
               401 Unauthorized
   Formats:    json (default), xml, plist

Returns the list of the defined playlists:

curl --user username:password "https://drivecast.eu/api/1.0/playlist?apikey=ABCDEFGHILMNOPQ"

{"statuscode":"200",
 "statusdesc":"OK",
 "playlist":["Slager","Kossuth","CNN News Update"]
}

curl --user username:password "https://drivecast.eu/api/1.0/playlist?fmt=xml&apikey=ABCDEFGHILMNOPQ"

<?xml version="1.0" encoding="UTF-8"?>
<statuscode>200</statuscode>
<statusdesc>OK</statusdesc>
<playlist>Slager</playlist>
<playlist>Kossuth</playlist>
<playlist>CNN News Update</playlist>

curl --user username:password "https://drivecast.eu/api/1.0/playlist?fmt=plist&apikey=ABCDEFGHILMNOPQ"

 <?xml version="1.0" encoding="UTF-8"?>
 <plist>
 <dict>
   <key>statuscode</key>
   <string>200</string>
   <key>statusdesc</key>
   <string>OK</string>
   <key>playlist</key>
   <array>
     <string>Slager</string>
     <string>Kossuth</string>
     <string>CNN News Update</string>
   </array>
 </dict>
</plist>

---

GET detail

   URL:        https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>
   Methods:    GET
   Returns:    200 OK + object containing the UID array of the items belonging to the playlist
               401 Unauthorized
               404 Playlist does not exist
   Formats:    json (default), xml, plist

Returns the items belonging to the playlist as UID objects

curl --user username:password "https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>?apikey=ABCDEFGHILMNOPQ"

{"statuscode":"200",
 "statusdesc":"OK",
 "uid":["ERYTYPDLI","ERYTYPDLII","ERYTYPDLIII","ERYTYPDLIV"]
}

curl --user username:password "https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>?fmt=xml&apikey=ABCDEFGHILMNOPQ"

<?xml version="1.0" encoding="UTF-8"?>
<statuscode>200</statuscode>
<statusdesc>OK</statusdesc>
<uid>ERYTYPDLI</uid>
<uid>ERYTYPDLII</uid>
<uid>ERYTYPDLIII</uid>
<uid>ERYTYPDLIV</uid>

curl --user username:password "https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>?fmt=plist&apikey=ABCDEFGHILMNOPQ"

<?xml version="1.0" encoding="UTF-8"?>
<plist>
 <dict>
   <key>statuscode</key>
   <string>200</string>
   <key>statusdesc</key>
   <string>OK</string>
   <key>uid</key>
   <array>
     <string>ERYTYPDLI</string>
     <string>ERYTYPDLII</string>
     <string>ERYTYPDLIII</string>
     <string>ERYTYPDLIV</string>
   </array>
 </dict>
</plist>

---

POST

  URL:        https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>
  Methods:    POST
  Returns:    201 Created
              401 Unauthorized
              409 Playlist already present
  Formats:    No other data that the HTTP status code is returned

With POST a new empty playlist with the name is created

curl --user username:password -X POST "https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>?apikey=ABCDEFGHILMNOPQ"

{"statuscode":"200",
"statusdesc":"OK"
}

curl --user username:password -X POST "https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>?fmt=xml&apikey=ABCDEFGHILMNOPQ"

<?xml version="1.0" encoding="UTF-8"?>
<statuscode>200</statuscode>
<statusdesc>OK</statusdesc>

curl --user username:password -X POST "https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>?fmt=plist&apikey=ABCDEFGHILMNOPQ"

<?xml version="1.0" encoding="UTF-8"?>
<plist>
 <dict>
   <key>statuscode</key>
   <string>200</string>
   <key>statusdesc</key>
   <string>OK</string>
 </dict>
</plist>

---

DELETE

  URL:        https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>
  Methods:    DELETE
  Returns:    200 OK
              401 Unauthorized
              404 Playlist does not exist
  Formats:    No other data that the HTTP status code is returned

With DELETE the playlist is removed

curl --user username:password -X DELETE "https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>?apikey=ABCDEFGHILMNOPQ"

{"statuscode":"200",
 "statusdesc":"OK"
}

curl --user username:password -X DELETE "https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>?fmt=xml&apikey=ABCDEFGHILMNOPQ"

<?xml version="1.0" encoding="UTF-8"?>
<statuscode>200</statuscode>
<statusdesc>OK</statusdesc>

curl --user username:password -X DELETE "https://drivecast.eu/api/1.0/playlist/<PLAYLIST_NAME>?fmt=plist&apikey=ABCDEFGHILMNOPQ"

<?xml version="1.0" encoding="UTF-8"?>
<plist>
 <dict>
   <key>statuscode</key>
   <string>200</string>
   <key>statusdesc</key>
   <string>OK</string>
 </dict>
</plist>