Device

CRUD

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

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.

CAUTION: Device is an abstract class, so you can't create a Device, you will always have to create an inherited entity of Device.

Device

Field	Type	Readonly	Nullable	Translatable	Description
id	int				Identifier
core_version	string				Core Version
height	int				Device height
name	string				Name
site	Site#id				Site identifier
site_calibration	SiteCalibration#id				SiteCalibration identifier
type	string				Device discriminator field
validate_at	datetime(ISO 8601)				Device error last acknowledgment date
width	int				Device width

Discriminator Map

Discriminator Value	Class
kiosk	Kiosk
mobile	Mobile
web	Web

Kiosk

Field	Type	Readonly	Nullable	Translatable	Description
location	string				Kiosk text location, used to give textual information
position	object				[Deprecated] Kiosk position, use SiteCalibration#start_point and SiteCalibration#start_point_floor
os	string				Operating System
position.x	int				Kiosk position x coordinate
position.y	int				Kiosk position y coordinate
position.z	int				Kiosk position z coordinate

Mobile

No additional fields

Web

No additional fields

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	Device	The Device 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

You cannot create a Poi as it's abstract, you must choose an inherited entity.

Parameters

Shared Parameters

Name	In	Type	Nullable	Required	Default	Constraint
X-API-LOCALE	Header	string			Site#locale	Must be one of Site#languages
core_version	Data	string			null	Not empty string
name	Data	string				Not empty string
site	Data	int				Valid Site#id
site_calibration	Data	int			null	Valid SiteCalibration#id
type	Data	string				One of discriminator value
validate_at	Data	datetime(ISO 8601)			null	Valid date

Kiosk specific parameters (type="kiosk")

Name	In	Type	Nullable	Required	Default	Constraint
height	Data	int			1080	Positive integer
location	Data	string			null
os	Data	string			null
position	Data	object
position.x	Data	int			0
position.y	Data	int			0
position.z	Data	int			0
width	Data	int			1920	Positive integer

Mobile specific parameters (type="mobile")

Name	In	Type	Nullable	Required	Default	Constraint
height	Data	int			640	Positive integer
width	Data	int			340	Positive integer

Web specific parameters (type="web")

Name	In	Type	Nullable	Required	Default	Constraint
height	Data	int			479	Positive integer
width	Data	int			1187	Positive integer