API/Library Management Protocol
From ickStream Wiki
Principles
This page describes the protocol which is used to mark tracks as loved/banned or add a tag or rating to a track, basically functions to manage the ickStream Cloud Library.
Also note that the browsing functionality for the library management service will be provided as a normal implementation of a Content Access Protocol and due to this it's not described on this page.
To find the access point for the Library Management Protocol, see:
- For cloud version: The findServices method in the Cloud Core Protocol
- For local network versions: The getServiceInformation method in the Service Protocol
The recommendation is to use the cloud version if it exists in the user account and else use a local server if it exists and if none of them exists don't offer any library management functionality to the user
Generic methods
- getServiceInformation - Get information about service
- getProtocolVersions - Get information about supported protocol versions
Service methods
- saveTrack - Set rating, loved, ban information on a track or just add it to library
- removeTrack - Remove track from library including rating, loved, ban information
- getTrack - Get information about a specific track in the library