IVSWikiBlue: Created page with "This API call will update an existing user group. ===Resource URL===

http://valt.example.com/api/v3/admin/users/{userid}/edit

''Replace {userid} with the actual i..."

2020-04-14T19:24:43Z

Created page with "This API call will update an existing user group. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/users/{userid}/edit</pre> ''Replace {userid} with the actual i..."

New page

This API call will update an existing user group.

===Resource URL===
<pre>http://valt.example.com/api/v3/admin/users/{userid}/edit</pre>

''Replace {userid} with the actual id number of the user. Users are numbered sequentially when added to VALT.''

===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"
!colspan="4"|Field Name
!Description
!Required
!Example
|-
|colspan="4"|'''name'''
|User Name
|no
|John
|-
|colspan="4"|'''password'''
|User Name
|no
|VALTisGR3@T
|-
|colspan="4"|'''display_name'''
|If populated will display instead of the user name.
|no
|John Doe
|-
|colspan="4"|'''user_group'''
|Primary group ID for the new user.
|no
|7
|-
|colspan="4"|'''card_number'''
|RFID Card Number or PIN Code for Keypad
|no
|362504
|-
|colspan="4"|'''rooms'''
|Array of rooms the new group will have access to.
|no
|[1,4,7]
|-
|colspan="4"|'''video_access'''
|
|no
|{"users":[15],"user_groups":[1]}
|-
|
|colspan="3"|'''users'''
|Array of user ids who's videos the new group will have access to.
|no
|[17,39,84]
|-
|
|colspan="3"|'''user_groups'''
|Array of user group ids who's videos the new group will have access to.
|no
|[1,3,17]
|}

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Update Successful
|-
|401
|Unauthorized
|-
|404
|User ID does not exist.
|}

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

==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/users/52/edit?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"name":"jdoe3",
"password":"apiuser",
"display_name":"John Doe",
"user_group":1,
"card_number":"32650",
"rooms":[37,39,43],
"video_access":
{
"users":[15],
"user_groups":[1]
}

}
</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": 48
}
}
</nowiki>

===Failure Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"error":{
"code": 404
}
}
</nowiki>

API Update User - Revision history

IVSWikiBlue: Created page with "This API call will update an existing user group. ===Resource URL===
http://valt.example.com/api/v3/admin/users/{userid}/edit
''Replace {userid} with the actual i..."