POST api/PBI_role/role

Request Information

URI Parameters

None.

Body Parameters

PBI_RoleViewModel
NameDescriptionTypeAdditional information
active

boolean

None.

code

string

Required

customer_ID

globally unique identifier

None.

customerName

string

None.

id

globally unique identifier

None.

names

Dictionary of string [key] and string [value]

Required

permissions

Collection of PBI_PermissionsViewModel

Required

site_ID

globally unique identifier

Required

siteName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "active": true,
  "code": "sample string 2",
  "customer_ID": "944560d0-a501-4117-94a4-9d534f50bad4",
  "customerName": "sample string 4",
  "id": "f3325069-a6ac-4873-9bba-323f183bf245",
  "names": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "permissions": [
    {
      "id": "7f8a1a48-d904-40e0-b01d-e0d9128074d7",
      "active": true,
      "foreign_ID": "79d3e427-ca79-4b6b-abb2-0d77607ec110",
      "foreign_Label": "sample string 3",
      "type": 1
    },
    {
      "id": "7f8a1a48-d904-40e0-b01d-e0d9128074d7",
      "active": true,
      "foreign_ID": "79d3e427-ca79-4b6b-abb2-0d77607ec110",
      "foreign_Label": "sample string 3",
      "type": 1
    }
  ],
  "site_ID": "79aac769-8f63-47c9-9bee-03db62d3471d",
  "siteName": "sample string 8"
}

application/xml, text/xml

Sample:
<PBI_RoleViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <active>true</active>
  <code>sample string 2</code>
  <customerName>sample string 4</customerName>
  <customer_ID>944560d0-a501-4117-94a4-9d534f50bad4</customer_ID>
  <id>f3325069-a6ac-4873-9bba-323f183bf245</id>
  <names 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>
  </names>
  <permissions>
    <PBI_PermissionsViewModel>
      <Active>true</Active>
      <Foreign_ID>79d3e427-ca79-4b6b-abb2-0d77607ec110</Foreign_ID>
      <Foreign_Label>sample string 3</Foreign_Label>
      <ID>7f8a1a48-d904-40e0-b01d-e0d9128074d7</ID>
      <type>SiteCustomer</type>
    </PBI_PermissionsViewModel>
    <PBI_PermissionsViewModel>
      <Active>true</Active>
      <Foreign_ID>79d3e427-ca79-4b6b-abb2-0d77607ec110</Foreign_ID>
      <Foreign_Label>sample string 3</Foreign_Label>
      <ID>7f8a1a48-d904-40e0-b01d-e0d9128074d7</ID>
      <type>SiteCustomer</type>
    </PBI_PermissionsViewModel>
  </permissions>
  <siteName>sample string 8</siteName>
  <site_ID>79aac769-8f63-47c9-9bee-03db62d3471d</site_ID>
</PBI_RoleViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:
"64206790-3fd2-4086-a45c-25a250db9f09"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">64206790-3fd2-4086-a45c-25a250db9f09</guid>