Playlist

CRUD

CRUD	Http Verb	Route	Description
READ	GET	/playlist/{id}	Retrieve a single Playlist from it's id
CREATE	POST	/playlist	Create a Playlist
UPDATE	POST	/playlist/{id}	Update a Playlist
DELETE	DELETE	/playlist/{id}	Delete a Playlist
SEARCH	GET	/playlist	Looking for Playlists
BATCH DELETE	DELETE	/playlist	Delete multiple Playlists

Model

WARNING: This Model is the one retrieve using X-API-MODE="get" (see READ & SEARCH operations). So if you use the legacy one (standard), the model may differs on some fields.

Field	Type	Readonly	Nullable	Translatable	Description
client_id	string
created_at	datetime(ISO 8601)				Create datetime
description	string
id	int				Identifier
medias	array
medias[]	Media#id
name	string				Name
parameters	array
parameters[]	string
tags	array
tags[]	Tag#id
signature	string				Unique optional identifier used to reference that Site to be used in data import
site	Site#id				Site identifier
updated_at	datetime(ISO 8601)				Last updated datetime
version	int				Revision version, it's incremented on each change

READ

Parameters

Name	In	Type	Required	Default	Constraint	Description
id	Route	int
X-API-LOCALE	Header	string		Site#locale	Must be one of Site#languages
X-API-MODE	Header	string		standard	"standard" or "get"	The "standard" mode is deprecated. Note that X-API-MODE will change serialization format.

Responses

Http Code	Description	Response type	Response Content	Note
200	Success	application/json	Playlist	The Playlist serialisation will differs depending on X-API-MODE
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

CREATE

Parameters

Name	In	Type	Nullable	Required	Default	Constraint
X-API-LOCALE	header	string			Site#locale	Must be one of Site#languages
client_id	Data	string			null
description	Data				null
medias	Data				[]
medias[]	Data
name	Data	string				Not empty string
parameters	Data				[]
parameters[]	Data
tags	Data				[]
tags[]	Data
signature	Data	string			null
site	Data	Site#id				Valid Site#id

Responses

Http Code	Description	Response type	Response Content
200	Success	application/json	{ id: Playlist#id }
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

UPDATE

Parameters

Name	In	Type	Nullable	Required	Default	Constraint
X-API-LOCALE	header	string			Site#locale	Must be one of Site#languages
client_id	Data	string			Preserves value
description	Data				Preserves value
medias	Data				Preserves value
medias[]	Data				n/a
name	Data	string			Preserves value	Not empty string
parameters	Data				Preserves value
parameters[]	Data				Preserves value
tags	Data				Preserves value
tags[]	Data				Preserves value
signature	Data	string			Preserves value

Responses

Http Code	Description	Response type	Response Content
204	Success	application/json
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

DELETE

Parameters

Name	In	Type	Required	Default	Constraint
id	Route	int

Responses

Http Code	Description	Response type	Response Content
204	Success	application/json
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

SEARCH

Parameters

Name	In	Type	Required	Default	Constraint	Description
X-API-LOCALE	Header	string		Site#locale	Must be one of Site#languages
X-API-MODE	Header	string		standard	"standard" or "get"	The "standard" mode is deprecated. Note that X-API-MODE will change serialization format.
name	Query	string
signature	Query	string
site	Query	int

Responses

Http Code	Description	Response type	Response Content	Note
200	Success	application/json	Playlist[]	The Playlist serialisation will differs depending on X-API-MODE
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable

BATCH DELETE

Parameters

Name	In	Type	Required	Default	Constraint
site	Query	int
id	Query	int[]

Responses

Http Code	Description	Response type	Response Content
204	Success	application/json
400	Invalid data	application/json	Error
403	Authentication Error	application/json	Error
404	Not Found
500	Internal Server Error	application/json	Error
503	Service Unavailable