SiteCalibration

CRUD

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

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
device	Device#id				Device identifier
floor_calibrations	array				Floor calibrations
floor_calibrations[]	FloorCalibration#id				Floor calibration identifier
id	int				Identifier
site	Site#id				Site identifier
start_floor	int				Start floor id, identifying the floor to show by default
start_point_floor	int				Start point floor id, identifying the floor where the device is on
start_point_position	object				Start point position, identifying the device position into the floor identified by start_point_floor
start_point_position.x	int				X coordinate
start_point_position.y	int				Y coordinate
start_point_position.z	int				Z coordinate

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	SiteCalibration	The SiteCalibration 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
device	Data	Device#id				Valid Device#id which doesn't have a site_calibration
floor_calibrations	Data	array			[]
floor_calibrations[]	Data	FloorCalibration#id				Valid FloorCalibration#id
site	Data	Site#id				Valid Site#id
start_floor	Data	int
start_point_floor	Data	int			null
start_point_position	Data	object			null
start_point_position.x	Data	int
start_point_position.y	Data	int
start_point_position.z	Data	int

Responses

Http Code	Description	Response type	Response Content
200	Success	application/json	{ id: SiteCalibration#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
device	Data	Device#id			Preserves value	Valid Device#id which doesn't have a site_calibration
floor_calibrations	Data	array			Preserves value
floor_calibrations[]	Data	FloorCalibration#id				Valid FloorCalibration#id
site	Data	Site#id			Preserves value	Valid Site#id
start_floor	Data	int			Preserves value
start_point_floor	Data	int			Preserves value
start_point_position	Data	object			Preserves value
start_point_position.x	Data	int
start_point_position.y	Data	int
start_point_position.z	Data	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

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.
device	Query	int
site	Query	int

Responses

Http Code	Description	Response type	Response Content	Note
200	Success	application/json	SiteCalibration[]	The SiteCalibration 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