regis

<back to all web services

UserRoleRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/UserRoles/{uuid}
UserRoleRequest Parameters:
NameParameterData TypeRequiredDescription
authorizing_uuidbodystringNo
uuidpathstringNo
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	authorizing_uuid: String,
	uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
	]
}