API Lock Room

This API call will lock the specified room.

Resource URL

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

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

Resource Information

Method	POST
Headers	Content-Type:application/json
Response Type	JSON
Authentication Required	Yes

Parameters

No parameters can be passed to this call.

Response

Code	Reason
200	Room Locked Successfully
400	Invalid Request (see response for details)
401	Unauthorized
404	Room ID Not Found

JSON Response

data
id	ID number for the room that was locked.
locked_by	ID number of the user that locked the room.

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/rooms/59/lock?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": 59,
"locked_by": 1
}
}

Failure Response

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

{
"data":{
"message": "This room is already locked."
},
"code": 400
}