API - User Group Membership

Support Center > API Integration

Published 06/21/2019 at 7:25pm UTC

Page viewed 17789 times

Details

How can I get all of the Users in a Group, or add and remove Users from Groups?

Answer

 

Get a list of Users in a Group

GET https://api.securevideo.com/groupuser/123

The above API call would get a list of users who are members of the Group with the ID 123.

The returned JSON is an object containing the Group object and zero to many User objects.

{
"Group": {
"GroupId": 123,
"GroupName": "Urgent Care Patients",
"GroupType": "Virtual Clinic Participants",
"GroupDescription": "Patients directed to First Response from the First Response website",
"PublicUserKey": "4f0f16857bbcf6c9c6a765a077fb9337"
},
"Users": [
{
"SystemUserId": "77759",
"FullName": "Xavier Xerox",
"EmailAddress": "[email protected]",
"SmsNumber": "",
"DefaultResolution": "high",
"TimeZoneWindowsId": "Eastern Standard Time",
"HelpNumber": "111-222-3333",
"VideoId": "securevideo+sx000007775969069864",
"ExternalId": "",
"SystemRoles": "I",
"NewPassword": null
},
{
"SystemUserId": "86009",
"FullName": "Zilda Zebra",
"EmailAddress": "[email protected]",
"SmsNumber": "",
"DefaultResolution": "high",
"TimeZoneWindowsId": "Pacific Standard Time",
"HelpNumber": "111-222-3333",
"VideoId": "securevideo+sx000008600919887139",
"ExternalId": "",
"SystemRoles": "I",
"NewPassword": null
},
{
"SystemUserId": "146539",
"FullName": "Fanta Flakes",
"EmailAddress": "[email protected]",
"SmsNumber": "",
"DefaultResolution": "high",
"TimeZoneWindowsId": "Pacific Standard Time",
"HelpNumber": "111-222-3333",
"VideoId": "securevideo+sx000014653947320233",
"ExternalId": "",
"SystemRoles": "I",
"NewPassword": null
},
{
"SystemUserId": "2924406",
"FullName": "Yabba Yonex",
"EmailAddress": "[email protected]",
"SmsNumber": "",
"DefaultResolution": "high",
"TimeZoneWindowsId": "Pacific Standard Time",
"HelpNumber": "111-222-3333",
"VideoId": "securevideo+sx000292440698425075",
"ExternalId": "",
"SystemRoles": "I",
"NewPassword": null
}
]
}

 

Get a list of Groups that a User is in

GET https://api.securevideo.com/usergroup/12345

GET https://api.securevideo.com/usergroup/0?externalId=XXXXX (where XXXXX is the ExternalId of a User in your EHR/PM system)

The above API call would get a list of groups of which the User specified by its SecureVideo ID or your external ID is a member.

The returned JSON is an object containing the User object and zero to many Group objects.

{
"User": {
"SystemUserId": "12345",
"FullName": "Dr. Josette Mondanaro",
"EmailAddress": "[email protected]",
"SmsNumber": "111-222-3333",
"DefaultResolution": "high",
"TimeZoneWindowsId": "Pacific Standard Time",
"HelpNumber": "11112223333",
"VideoId": "securevideo+sx000002440317447986",
"ExternalId": "1234512345",
"SystemRoles": "A",
"NewPassword": null
},
"Groups": [
{
"GroupId": 328,
"GroupName": "Urgent Care Doctors",
"GroupType": "Host Group",
"GroupDescription": "Doctors with whom you can schedule an Urgent Care appointment",
"PublicUserKey": ""
},
{
"GroupId": 2687,
"GroupName": "Triage / Consult - Trauma Unit",
"GroupType": "Host Group",
"GroupDescription": "Triage / Consult - Trauma Unit",
"PublicUserKey": ""
}
]
}
  

 

Add a User to a Group

PUT https://api.securevideo.com/groupuser/12345

{
    "GroupId": 123
}

The above API call would add the user with the ID 12345 into the Group with the ID 123. If the user is already in the group, the call succeeds (the call is idempotent).

This method return HTTP 204 (No Content) if successful. In the event of an error will return HTTP 4xx or 5xx.

 

Remove a User from a Group

DELETE https://api.securevideo.com/groupuser/12345

{
    "GroupId": 123
}

The above API call would remove the user with the ID 12345 from the Group with the ID 123. If the user is not currently a member of the group, the call succeeds (the call is idempotent).

This method return HTTP 204 (No Content) if successful. In the event of an error will return HTTP 4xx or 5xx.