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

AddUserRoleViewModel

Name	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": "cbdecc16-8790-4077-b5f3-8db5bc8258f5",
  "RoleId": 2,
  "RoleScopeTypeId": 3,
  "RoleScopeId": "97f026c3-8177-4dda-a4ee-312cc5ae111c"
}

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>97f026c3-8177-4dda-a4ee-312cc5ae111c</RoleScopeId>
  <RoleScopeTypeId>3</RoleScopeTypeId>
  <UserId>cbdecc16-8790-4077-b5f3-8db5bc8258f5</UserId>
</AddUserRoleViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultWithInt

Name	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>