Sonos uses addToContainer
to add content to a playlist. See Add playlists for details.
Request parameters
The maximum string length is listed in parentheses. This will be URL-encoded in firmware so pay attention to length when approaching this limit.
Name | Type | Description |
---|---|---|
id |
string(255) | Unique ID of the item to add. |
parentId |
string(255) | Unique ID of the playlist. |
index |
int | Position in the playlist where the new content should appear. If you receive an index set to 0 , add the content to the beginning of the playlist. If you receive an index set to -1 , add the content to the end of the playlist. |
updateId |
string(255) | Future implementation. Can be used to handle editing collisions. |
Response
Include the response in an addToContainerResult
inside an addToContainerResponse
element.
Name | Type | Description |
---|---|---|
uniqueId |
string(255) | Future implementation. Can be used to handle editing collisions and data concurrency validation. |
Sample request
1 2 3 4 5 6 7 8 9 10 |
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <addToContainer xmlns="http://www.sonos.com/Services/1.1"> <id>track-001</id> <parentId>playlist-001</parentId> <index>0</index> <updateId /> </addToContainer> </soap:Body> </soap:Envelope> |
Sample response
1 2 3 4 5 6 7 8 9 |
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <addToContainerResponse xmlns="http://www.sonos.com/Services/1.1"> <addToContainerResult> <updateId /> </addToContainerResult> </addToContainerResponse> </soap:Body> </soap:Envelope> |