regis

<back to all web services

UserRoleUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/UserRoles/{uuid}/Update
UserRoleUpdateRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
authorizing_uuidbodystringNo
admin_auth_secretbodystringNo
is_staffbodyboolNo
role_idsbodyList<int>No
UserRoleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
regent_loginformstringNo
first_nameformstringNo
last_nameformstringNo
emailformstringNo
is_staffformboolNo
rolesformList<string>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /UserRoles/{uuid}/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","authorizing_uuid":"String","admin_auth_secret":"String","is_staff":false,"role_ids":[0]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","regent_login":"String","first_name":"String","last_name":"String","email":"String","is_staff":false,"roles":["String"]}