API Room Details

This API provides details for a specified room.

Resource URL

http://valt.example.com/api/v3/admin/rooms/{roomid}

Replace {roomid} with the actual id number of the room. Rooms are numbered sequentially when added to VALT.

Resource Information

Method	GET
Response Type	JSON
Authentication Required	Yes

Parameters

No parameters can be passed to this call.

Response

Code	Reason
200	Request Successful
401	Unauthorized
404	Room ID Not Found

JSON Response

data
id		Room ID Number
name		Room Name
is_io		True = IO Recording is enabled, False = IO Recording is not enabled
io_camera_id		ID of Camera designated for IO control (only returned if is_io is equal to true).
io_user_id		ID of user IO recordings will be assigned to (only returned if is_io is equal to true).
cameras		Array of cameras assigned to the room.
	id	Camera ID
	name	Camera Name
	type	Device Type: Camera or Device (ipad, iphone, card reader)

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/admin/rooms/37?access_token=exampletoken

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":{
"id": 37,
"name": "Test",
"is_io": false,
"cameras":[
{
"id": 63,
"name": "P5635-E Mk II",
"type": "camera"
}
]
}
}

Failure Response

{"error":{"code":401,"message":"No API key provided"}}