POST roles/create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RoleId	integer	None.
RoleName	string	Required
RoleDescription	string	Required
Active	integer	Required
TenantID	integer	Required
RoleRights	Collection of integer	None.
AddedRights	Collection of LinkedRight	None.
RemovedRights	Collection of integer	None.
RequiresRotation	boolean	None.
RightsSystemId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "RoleId": 1,
  "RoleName": "sample string 2",
  "RoleDescription": "sample string 3",
  "Active": 4,
  "TenantID": 5,
  "RoleRights": [
    1,
    2
  ],
  "AddedRights": [
    {
      "RightID": 1,
      "Create": true,
      "Read": true,
      "Update": true,
      "Delete": true
    },
    {
      "RightID": 1,
      "Create": true,
      "Read": true,
      "Update": true,
      "Delete": true
    }
  ],
  "RemovedRights": [
    1,
    2
  ],
  "RequiresRotation": true,
  "RightsSystemId": 7
}

text/html

Sample:

{"RoleId":1,"RoleName":"sample string 2","RoleDescription":"sample string 3","Active":4,"TenantID":5,"RoleRights":[1,2],"AddedRights":[{"RightID":1,"Create":true,"Read":true,"Update":true,"Delete":true},{"RightID":1,"Create":true,"Read":true,"Update":true,"Delete":true}],"RemovedRights":[1,2],"RequiresRotation":true,"RightsSystemId":7}

application/xml, text/xml

Sample:

<RoleCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Roles">
  <Active>4</Active>
  <AddedRights>
    <LinkedRight>
      <Create>true</Create>
      <Delete>true</Delete>
      <Read>true</Read>
      <RightID>1</RightID>
      <Update>true</Update>
    </LinkedRight>
    <LinkedRight>
      <Create>true</Create>
      <Delete>true</Delete>
      <Read>true</Read>
      <RightID>1</RightID>
      <Update>true</Update>
    </LinkedRight>
  </AddedRights>
  <RemovedRights xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </RemovedRights>
  <RequiresRotation>true</RequiresRotation>
  <RightsSystemId>7</RightsSystemId>
  <RoleDescription>sample string 3</RoleDescription>
  <RoleId>1</RoleId>
  <RoleName>sample string 2</RoleName>
  <RoleRights xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </RoleRights>
  <TenantID>5</TenantID>
</RoleCredentials>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RoleCredentials'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.