Skip to main content

RemoveUserRole

Overview​

Removes an existing Role from an existing User. Returns Success/Error code.

Request Information​


Method​

POST - api/Person/RemoveUserRole

URI Parameters​

None.

Body Parameters

UserRoleViewModel

NameDescriptionTypeAdditional information
UserIdRepresents the PK of an existing Userglobally unique identifierNone.
RoleIdRepresents the PK of an existing Role assigned to an existing User represented by UserIdglobally unique identifierNone.

JSON​

{
"UserId": "2acd6775-8517-4092-a1e9-e9a585eed1c4",
"RoleId": "58c8d5c9-9877-443d-8ef5-c511aa9f9e0f"
}

XML​

<UserRoleViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<RoleId>58c8d5c9-9877-443d-8ef5-c511aa9f9e0f</RoleId>
<UserId>2acd6775-8517-4092-a1e9-e9a585eed1c4</UserId>
</UserRoleViewModel>

Response Information​


Resource Description​

Result

NameDescriptionTypeAdditional information
ResultCodeRepresents the result codeintegerNone.
DescriptionRepresents a description of the result codestringNone.

Response Formats​

JSON​

{
"ResultCode": 1,
"Description": "sample string 2"
}

XML​

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
`````<Description>``````sample string 2</Description>
`<ResultCode>`1</ResultCode>
</Result>