FloorCalibration

CRUD

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

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
eye	object				Camera position
eye.x	int				X coordinate
eye.y	int				Y coordinate
eye.z	int				Z coordinate
floor_id	int				Floor identifier
id	int				Identifier
site	Site#id				Site identifier
site_calibration	SiteCalibration#id				SiteCalibration identifier
target	object				Camera target position
target.x	int				X coordinate
target.y	int				Y coordinate
target.z	int				Z coordinate
up	object				Camera orientation
up.x	int				X coordinate
up.y	int				Y coordinate
up.z	int				Z coordinate
zoom_max	int				Maximum zoom value
zoom_min	int				Minimum zoom value

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	FloorCalibration	The FloorCalibration 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
eye	Data	object
eye.x	Data	object			0
eye.y	Data	int			0
eye.z	Data	int			0
floor_id	Data	int
site	Data	Site#id				Valid Site#id
site_calibration	Data	SiteCalibration#id				Valid SiteCalibration#id on same site
target	Data	object
target.x	Data	object			0
target.y	Data	int			0
target.z	Data	int			0
up	Data	object
up.x	Data	int
up.y	Data	int
up.z	Data	int
zoom_max	Data	int			null
zoom_min	Data	int			null

Responses

Http Code	Description	Response type	Response Content
200	Success	application/json	{ id: FloorCalibration#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
eye	Data	object			Preserves value
eye.x	Data	object
eye.y	Data	int
eye.z	Data	int
floor_id	Data	int			Preserves value
site	Data	Site#id			Preserves value	Valid Site#id
site_calibration	Data	SiteCalibration#id			Preserves value	Valid SiteCalibration#id on same site
target	Data	object			Preserves value
target.x	Data	object
target.y	Data	int
target.z	Data	int
up	Data	object			Preserves value
up.x	Data	int
up.y	Data	int
up.z	Data	int
zoom_max	Data	int			Preserves value
zoom_min	Data	int			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.
site	Query	int

Responses

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