Billiecart API

<back to all web services

UnassignRolesRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
DELETE/users/{Id}/roles/unassign
UnassignRolesRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
RolesqueryList<string>No
AssignRolesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
UserAccountformUserAccountNo
UserAccount Parameters:
NameParameterData TypeRequiredDescription
NameformUserAccountNameNo
DisplayNameformstringNo
EmailformstringNo
RolesformList<string>No
StatusformAccountStatusNo
DefaultOrganisationIdformstringNo
IdformstringNo
UserAccountName Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
AccountStatus Enum:
Shadowed
Registered
AssignRolesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
UserAccountformUserAccountNo

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.

DELETE /users/{Id}/roles/unassign HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
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
		}
	},
	userAccount: 
	{
		name: 
		{
			firstName: String,
			lastName: String
		},
		displayName: String,
		email: String,
		roles: 
		[
			String
		],
		status: Shadowed,
		defaultOrganisationId: String,
		id: String
	}
}