regis

<back to all web services

UserRoleUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/UserRoles/{uuid}/Update

export class UserRoleResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public regent_login: string;
    public first_name: string;
    public last_name: string;
    public email: string;
    public is_staff: boolean;
    public roles: string[];

    public constructor(init?: Partial<UserRoleResponse>) { (Object as any).assign(this, init); }
}

export class UserRoleUpdateRequest
{
    public uuid: string;
    public authorizing_uuid: string;
    public admin_auth_secret: string;
    public is_staff: boolean;
    public role_ids: number[];

    public constructor(init?: Partial<UserRoleUpdateRequest>) { (Object as any).assign(this, init); }
}

TypeScript UserRoleUpdateRequest DTOs

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}/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
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/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
	]
}