Tag

CRUD

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

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
categories	array				List of associated Categories
categories[]	Category#id				Associated Category identifier
created_at	datetime(ISO 8601)				Create datetime
id	int				Identifier
medias	array				List of associated Medias
medias[]	Media#id				Associated Media identifier
name	string				Name
playlists	array				List of associated Playlists
playlists[]	Playlist#id				Associated Playlist identifier
pois	array				List of associated POIs
pois[]	Poi#id				Associated POI identifier
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	Tag	The Tag 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
categories	Data	array			[]
categories[]	Data	Category#id				Valid Category#id on same site
medias	Data	array			[]
medias[]	Data	Media#id				Valid Media#id on same site
name	Data	string				Not empty string
playlists	Data	array			[]
playlists[]	Data	Playlist#id				Valid Playlist#id on same site
pois	Data	array			[]
pois[]	Data	Poi#id				Valid Poi#id on same site
signature	Data	string			null
site	Data	Site#id				Valid Site#id

Responses

Http Code	Description	Response type	Response Content
200	Success	application/json	{ id: Tag#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
categories	Data	array			Preserves value
categories[]	Data	Category#id				Valid Category#id on same site
medias	Data	array			Preserves value
medias[]	Data	Media#id				Valid Media#id on same site
name	Data	string			Preserves value	Not empty string
playlists	Data	array			Preserves value
playlists[]	Data	Playlist#id				Valid Playlist#id on same site
pois	Data	array			Preserves value
pois[]	Data	Poi#id				Valid Poi#id on same site
signature	Data	string			Preserves value	null
site	Data	Site#id			Preserves value	Valid Site#id

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	Tag[]	The Tag 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