POST api/roleapi/add?siteId={siteId}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId		globally unique identifier	None.

Body Parameters

RoleViewModel

Name	Type	Additional information
descriptions	Dictionary of string [key] and string [value]	Required
active	boolean	Required
ID	globally unique identifier	None.
rights	Collection of ShortRightViewModel	None.
technical_description	string	Required

Request Formats

application/json, text/json

Sample:

{
  "descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "active": true,
  "id": "ff235cdf-c737-443b-90cb-ce52a63a0fa3",
  "rights": [
    {
      "code": "sample string 1",
      "id": "ec2bade1-38d2-41b1-b01c-ef69be6c7452"
    },
    {
      "code": "sample string 1",
      "id": "ec2bade1-38d2-41b1-b01c-ef69be6c7452"
    }
  ],
  "technical_description": "sample string 3"
}

application/xml, text/xml

Sample:

<role xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <ID>ff235cdf-c737-443b-90cb-ce52a63a0fa3</ID>
  <active>true</active>
  <rights>
    <right>
      <ID>ec2bade1-38d2-41b1-b01c-ef69be6c7452</ID>
      <code>sample string 1</code>
    </right>
    <right>
      <ID>ec2bade1-38d2-41b1-b01c-ef69be6c7452</ID>
      <code>sample string 1</code>
    </right>
  </rights>
  <technical_description>sample string 3</technical_description>
  <descriptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </descriptions>
</role>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"cce5c924-324e-46cb-8625-f5573a8dc145"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">cce5c924-324e-46cb-8625-f5573a8dc145</guid>