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

http://valt.example.com/api/v3/admin/user_groups/{groupid}

''Replace {groupi..."

2020-04-14T19:22:47Z

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

New page

This API provides detailed information for a specified user group.

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

''Replace {groupid} with the actual id number of the user group. User groups 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 Group Not Found
|}

{|class="wikitable"
|+JSON Response
!colspan="5"|data
|-
|colspan="4"|'''id'''
|Group ID Number
|-
|colspan="4"|'''name'''
|Group Name
|-
|colspan="4"|'''marker'''
|Currently selected primary marker template.
|-
|colspan="4"|'''information'''
|Currently selected primary information template.
|-
|colspan="4"|'''rights'''
|List of all rights currently enabled for the specified user group.
|-
|
|colspan="3"|'''name'''
|Right Category Name (This should correspond to the right categories in the Users & Groups section of VALT)
|-
|
|colspan="3"|'''sub-rights'''
|Array of all rights in the above category currently enabled for the specified user group.
|-
|colspan="4"|'''max_record_duration'''
| Maximum record duration in minutes defined for the user group.
|-
|colspan="4"|'''rooms'''
|List of rooms the user group is allowed access to.
|-
|
|colspan="3"|'''id'''
|Room ID
|-
|
|colspan="3"|'''name'''
|Room Name
|-
|colspan="4"|'''video_access'''
|List of users and group who's videos the specified user group is allowed to view.
|-
|
|colspan="3"|'''user_groups'''
|
|-
|
|
|colspan="2"|'''id'''
| User Group ID
|-
|
|
|colspan="2"|'''name'''
| User Group Name
|-
|
|
|colspan="2"|'''users'''
| Users are categorized under their primary group.
|-
|
|
|
|'''id'''
| User ID
|-
|
|
|
|'''name'''
|User Name
|-
|colspan="4"|'''retention'''
|Default retention period for any videos belonging to users in the specified user group.
|-
|
|colspan="3"|'''until'''
|Date videos will be retained until. If another retention type is set, will return 0.
|-
|
|
|colspan="2"|'''date'''
|Date videos will be deleted on.
|-
|
|
|colspan="2"|'''timezone_type'''
|
|-
|
|
|colspan="2"|'''timezone'''
|Timezone used to calculate date for retention
|-
|
|colspan="3"|'''for'''
|
|-
|
|
|colspan="2"|'''days'''
|Number of days a video will be retained for. If another retention type is set, will return 0.
|-
|
|
|colspan="2"|'''hours'''
|Number of hours a video will be retained for. If another retention type is set, will return 0.
|-
|
|
|colspan="2"|'''minutes'''
|Number of minutes a video will be retained for. If another retention type is set, will return 0.
|-
|
|colspan="3"|'''type'''
|Retention Type (Possible values: until, infinitely, days, hours, minutes)
|}

==Examples==
===Request===
<pre>https://ivstest1.ad.ipivs.com/api/v3/admin/user_groups/6?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": 6,
"name": "Justin testing",
"marker": 2,
"information": 1,
"rights":[
{
"name": "general",
"sub_rights":[
"general--home",
"general--alert",
"general--edit-profile",
"general--change-password",
"general--notifications"
]
},
{
"name": "monitoring",
"sub_rights":[
"monitoring--talkback",
"monitoring--ptz",
"monitoring--ptz--ptz-control",
"monitoring--ptz--can-ptz-all-authors",
"monitoring--ptz--edit-presets",
"monitoring--ptz--use-presets",
"monitoring--lock-rooms",
"monitoring--unlock-all-users",
"monitoring--views",
"monitoring--recording",
"monitoring--recording--start-recording",
"monitoring--recording--stop-all-authors",
"monitoring--recording--stop-confirmation",
"monitoring--recording--sharing",
"monitoring--recording--retention",
"monitoring--recording--reassign-author",
"monitoring--recording--prepare-recording",
"monitoring--recording--pause-recording",
"monitoring--recording--pause-all-authors",
"monitoring--recording--resume-all-authors",
"monitoring--view--recording",
"monitoring--recording--evaluation",
"monitoring--recording--evaluation--view-option-values",
"monitoring--recording--evaluation--view-field-values",
"monitoring--recording--evaluation--view-total-value",
"monitoring--recording--options",
"monitoring--recording--options-all-authors"
]
}
],
"max_record_duration": 0,
"rooms":[
{
"id": 37,
"name": "Test"
},
{
"id": 39,
"name": "Fixed Dome"
},
{
"id": 40,
"name": "Wall PTZ"
},
{
"id": 41,
"name": "Ceiling PTZ"
},
{
"id": 42,
"name": "Covert F41"
},
{
"id": 43,
"name": "Fixed Box"
},
{
"id": 44,
"name": "Q Series"
}
],
"video_access":{
"user_groups":[
{
"id": 6,
"name": "Justin testing",
"users":[
]
}
]
},
"retention":{
"until": 0,
"for":{
"days": 300,
"hours": 0,
"minutes": 0
},
"type": "days"
}
}
}</nowiki>

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

API User Group Details - Revision history

IVSWikiBlue: Created page with "This API provides detailed information for a specified user group. ===Resource URL===
http://valt.example.com/api/v3/admin/user_groups/{groupid}
''Replace {groupi..."