POST api/v1/Users/{id}/UserRoles
Adds an existing Role to an existing User. Returns Success/Error code plus primary key of UserRole entry made.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | string |
None. |
Body Parameters
AddUserRoleViewModelName | Description | Type | Additional information |
---|---|---|---|
UserId |
Required: Represents the PK of an existing User |
globally unique identifier |
None. |
RoleId |
Required: Represents the PK of an existing Role. Retrieve possible values from /Role/GetAllRoles |
integer |
None. |
RoleScopeTypeId |
Required: Represents the type of scope that limits the Role. Retrieve possible values from /Role/GetAllRoleScopeTypes |
integer |
None. |
RoleScopeId |
Required: Represents the PK of the entity used to limit the Role based on RoleScopeTypeId |
globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserId": "b418c3e9-2e51-4bf0-90e0-ca8339039048", "RoleId": 2, "RoleScopeTypeId": 3, "RoleScopeId": "793e43d1-0c1c-41b1-a841-03ae0de46343" }
application/xml, text/xml
Sample:
<AddUserRoleViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <RoleId>2</RoleId> <RoleScopeId>793e43d1-0c1c-41b1-a841-03ae0de46343</RoleScopeId> <RoleScopeTypeId>3</RoleScopeTypeId> <UserId>b418c3e9-2e51-4bf0-90e0-ca8339039048</UserId> </AddUserRoleViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultWithIntName | Description | Type | Additional information |
---|---|---|---|
Value |
Represents the PK value that was created as a result of an add |
integer |
None. |
ResultCode |
Represents the result code |
integer |
None. |
Description |
Represents a description of the result code |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Value": 1, "ResultCode": 2, "Description": "sample string 3" }
application/xml, text/xml
Sample:
<ResultWithInt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Description>sample string 3</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>2</ResultCode> <Value>1</Value> </ResultWithInt>