IVSWikiBlue at 14:24, 14 June 2024

2024-06-14T14:24:51Z

IVSWikiBlue: Created page with "This API call will add a new room. ===Resource URL===

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

===Resource Information=== {|class="wikitable" |'''Method''' |POS..."

2020-04-14T19:51:33Z

Created page with "This API call will add a new room. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/rooms</pre> ===Resource Information=== {|class="wikitable" |'''Method''' |POS..."

New page

This API call will add a new room.

===Resource URL===
<pre>http://valt.example.com/api/v3/admin/rooms</pre>

===Resource Information===
{|class="wikitable"
|'''Method'''
|POST
|-
|'''Headers'''
|Content-Type:application/json
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===
The JSON body must be properly formatted. All fields and values should be enclosed in double quotes and separated by a colon.
{|class="wikitable"
!Field Name
!Description
!Required
!Example
|-
|'''name'''
|Room Name
|yes
|Room 174
|-
|'''is_io'''
|Enable IO control of room (true = enabled, false = disabled)
|no
|false
|-
|'''io_camera_id'''
|Camera ID number for IO control.
|no
|63
|-
|'''io_user_id'''
|User ID number that IO recordings should be assigned to.
|no
|47
|}

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Room Created Successfully
|-
|400
|Invalid Request (See Response for Specific Error)
|-
|401
|Unauthorized
|-
|500
|JSON Body Formatted Incorrectly
|}

{|class="wikitable"
|+JSON Response
!colspan="2"|data
|-
|'''id'''
|ID number for the new room.
|}

==Examples==
===Request===
The sample JSON body below is formatted with line breaks and indentation to make it easier to read. This is '''not''' required.
<pre>https://ivstest1.ad.ipivs.com/api/v3/admin/templates/52/fields?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"name":"API Test 4",
"is_io":true,
"io_camera_id":63,
"io_user_id":47
}
</nowiki>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"data":{
"id": 68
}
}
</nowiki>

===Failure Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"data":{
"message": "Validation Error",
"fields":[
{
"name": "name",
"message": "This value should not be blank."
}
]
},
"code": 400
}

</nowiki>

API Create Room - Revision history

IVSWikiBlue at 14:24, 14 June 2024

IVSWikiBlue: Created page with "This API call will add a new room. ===Resource URL===
http://valt.example.com/api/v3/admin/rooms
===Resource Information=== {|class="wikitable" |'''Method''' |POS..."

@@ Line 31: / Line 31: @@
 |yes
 |Room 174
 |-
 |'''is_io'''