IVSWikiBlue: Created page with "This API provides detailed information for a specified user. ===Resource URL===

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

''Replace {userid} with the ac..."

2020-04-14T19:24:10Z

Created page with "This API provides detailed information for a specified user. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/users/{userid}</pre> ''Replace {userid} with the ac..."

New page

This API provides detailed information for a specified user.

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

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

===Resource Information===
{|class="wikitable"
|'''Method'''
|GET
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===

No parameters can be passed to this call.

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Request Successful
|-
|401
|Unauthorized
|-
|404
|Specified User Not Found
|}

{|class="wikitable"
|+JSON Response
!colspan="5"|data
|-
|'''id'''
|colspan="4"|User ID Number
|-
|'''name'''
|colspan="4"|User Name
|-
|'''Display Name'''
|colspan="4"|User Display Name
|-
|'''user_group'''
|colspan="4"|User's Current Primary Group
|-
|
|'''id'''
|colspan="3"|Group ID
|-
|
|'''name'''
|colspan="3"|Group Name
|-
|'''card number'''
|colspan="4"|RFID Card number or PIN Code for Keypad
|-
|'''video_access'''
|colspan="4"|Array of users and group who's videos the specified user group is allowed to view.
|-
|
|'''user_groups'''
|colspan="3"|
|-
|
|
|'''id'''
|colspan="2"| User Group ID
|-
|
|
|'''name'''
|colspan="2"| User Group Name
|-
|
|
|'''users'''
|colspan="2"| Users are categorized under their primary group.
|-
|
|
|
|'''id'''
| User ID
|-
|
|
|
|'''name'''
|User Name
|}

==Examples==
===Request===
<pre>https://ivstest1.ad.ipivs.com/api/v3/admin/users/1?access_token=e82632d19c523678fea3d1016c6df9e9</pre>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"data":{
"id": 1,
"name": "admin",
"display_name": null,
"user_group":{
"id": 1,
"name": "Administrators"
},
"card_number": "326577",
"video_access":{
"user_groups":[
{
"id": 1,
"name": "Administrators",
"users":[
{
"id": 1,
"name": "admin"
},
{
"id": 7,
"name": "comma, test,"
},
{
"id": 5,
"name": "Denis Test"
},
{
"id": 6,
"name": "JoeDon Calhoun"
}
]
},
{
"id": 2,
"name": "test",
"users":[
{
"id": 25,
"name": "test1"
}
]
},
{
"id": 3,
"name": "Test sharing",
"users":[
]
},
{
"id": 4,
"name": "IoGroup",
"users":[
]
}
]
}
}
}
</nowiki>

===Failure Response===
<pre>{"error":{"code":401,"message":"No API key provided"}}</pre>

API User Details - Revision history

IVSWikiBlue: Created page with "This API provides detailed information for a specified user. ===Resource URL===
http://valt.example.com/api/v3/admin/users/{userid}
''Replace {userid} with the ac..."