API Delete Room
Revision as of 13:52, 14 April 2020 by IVSWikiBlue (talk | contribs) (Created page with "This API call will delete an existing room. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/rooms/{roomid}/delete</pre> ''Replace {roomid} with the actual id num...")
This API call will delete an existing room.
Contents
Resource URL
http://valt.example.com/api/v3/admin/rooms/{roomid}/delete
Replace {roomid} with the actual id number of the room. Rooms are numbered sequentially when added to VALT.
Resource Information
| Method | POST |
| Response Type | JSON |
| Authentication Required | Yes |
Parameters
No parameters are required for this API call.
Response
| Code | Reason |
|---|---|
| 200 | Request Successful |
| 401 | Unauthorized |
| 404 | Room Not Found |
| data | |
|---|---|
| message | Deleted |
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/admin/rooms/69/delete?access_token=e82632d19c523678fea3d1016c6df9e9
Successful Response
{
"data":{
"message": "Deleted"
}
}
Failure Response
{
"error":{
"code": 404
}
}
