API List Room Cameras

This API provides camera details for a specified room.

Resource URL

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

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
cameras			Array of cameras assigned to the room.
	id		Camera ID
	name		Camera Name
	type		Device Type: Camera or Device (ipad, iphone, card reader)
	device_type		Device Type: Camera or Device (ipad, iphone, card reader)
	ip		IP Address or FQDN of the camera
	http_port		Port used for camera control.
	rtsp_port		Port used for pulling the video stream from the camera.
	username		Username to access the camera.
	password		Password to access the camera.
	brand		Camera Brand (Axis or Epiphan)
	model		Camera Model Type (Usually Axis-1)
	wowza		Media server camera is assigned to.
		id	Media Server ID Number
		name	Media Server Name
	color		Color for camera control interface in VALT
	colo_hex		Hex code for color value above.

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/admin/rooms/37/cameras?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":{
"cameras":[
{
"id": 63,
"name": "P5635-E Mk II",
"type": "camera",
"device_type": "camera",
"ip": "192.168.7.37",
"http_port": 80,
"rtsp_port": 554,
"username": "root",
"password": "admin51",
"brand": "Axis",
"model": "Axis-1",
"wowza":{"id": 1, "name": "localhost"},
"color": "white",
"colo_hex": "#ffffff"
}
]
}
}

Failure Response

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