API List Rooms

This API provides a list of all currently configured rooms.

Resource URL

http://valt.example.com/api/v3/admin/rooms

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

JSON Response

data
			API returns an array of JSON objects
	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?access_token=e82632d19c523678fea3d1016c6df9e9

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"
}
]
},
{
"id": 39,
"name": "Fixed Dome",
"is_io": true,
"io_camera_id": 88,
"io_user_id": 1,
"cameras":[
{
"id": 53,
"name": "P3365",
"type": "camera"
},
{
"id": 54,
"name": "P3374-V",
"type": "camera"
},
{
"id": 55,
"name": "P3364",
"type": "camera"
},
{
"id": 67,
"name": "P3375-V",
"type": "camera"
},
{
"id": 80,
"name": "P3304",
"type": "camera"
},
{
"id": 81,
"name": "P3301",
"type": "camera"
},
{
"id": 88,
"name": "P3245",
"type": "camera"
}
]
}
]
}

Failure Response

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