GET api/PBI_role/roles?active={active}

Request Information

URI Parameters

Name	Description	Type	Additional information
active		boolean	None.

Body Parameters

None.

Response Information

Resource Description

Collection of PBI_RoleViewModel

Name	Type	Additional 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.

Response Formats

application/json, text/json

Sample:

[
  {
    "active": true,
    "code": "sample string 2",
    "customer_ID": "297469a3-9c77-4c8c-a1fb-aa53adea91d7",
    "customerName": "sample string 4",
    "id": "b5ff3f87-4c2c-46e2-bcc5-c68eedb5e1ce",
    "names": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "permissions": [
      {
        "id": "f2169092-f0b5-4e59-9bbd-b3b93c9d5294",
        "active": true,
        "foreign_ID": "bca8c2bb-ccc0-4d68-82b0-006cb8817989",
        "foreign_Label": "sample string 3",
        "type": 1
      },
      {
        "id": "f2169092-f0b5-4e59-9bbd-b3b93c9d5294",
        "active": true,
        "foreign_ID": "bca8c2bb-ccc0-4d68-82b0-006cb8817989",
        "foreign_Label": "sample string 3",
        "type": 1
      }
    ],
    "site_ID": "f2d69dc1-4e41-4efd-832e-98897dc5c9cf",
    "siteName": "sample string 8"
  },
  {
    "active": true,
    "code": "sample string 2",
    "customer_ID": "297469a3-9c77-4c8c-a1fb-aa53adea91d7",
    "customerName": "sample string 4",
    "id": "b5ff3f87-4c2c-46e2-bcc5-c68eedb5e1ce",
    "names": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "permissions": [
      {
        "id": "f2169092-f0b5-4e59-9bbd-b3b93c9d5294",
        "active": true,
        "foreign_ID": "bca8c2bb-ccc0-4d68-82b0-006cb8817989",
        "foreign_Label": "sample string 3",
        "type": 1
      },
      {
        "id": "f2169092-f0b5-4e59-9bbd-b3b93c9d5294",
        "active": true,
        "foreign_ID": "bca8c2bb-ccc0-4d68-82b0-006cb8817989",
        "foreign_Label": "sample string 3",
        "type": 1
      }
    ],
    "site_ID": "f2d69dc1-4e41-4efd-832e-98897dc5c9cf",
    "siteName": "sample string 8"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPBI_RoleViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <PBI_RoleViewModel>
    <active>true</active>
    <code>sample string 2</code>
    <customerName>sample string 4</customerName>
    <customer_ID>297469a3-9c77-4c8c-a1fb-aa53adea91d7</customer_ID>
    <id>b5ff3f87-4c2c-46e2-bcc5-c68eedb5e1ce</id>
    <names xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </names>
    <permissions>
      <PBI_PermissionsViewModel>
        <Active>true</Active>
        <Foreign_ID>bca8c2bb-ccc0-4d68-82b0-006cb8817989</Foreign_ID>
        <Foreign_Label>sample string 3</Foreign_Label>
        <ID>f2169092-f0b5-4e59-9bbd-b3b93c9d5294</ID>
        <type>SiteCustomer</type>
      </PBI_PermissionsViewModel>
      <PBI_PermissionsViewModel>
        <Active>true</Active>
        <Foreign_ID>bca8c2bb-ccc0-4d68-82b0-006cb8817989</Foreign_ID>
        <Foreign_Label>sample string 3</Foreign_Label>
        <ID>f2169092-f0b5-4e59-9bbd-b3b93c9d5294</ID>
        <type>SiteCustomer</type>
      </PBI_PermissionsViewModel>
    </permissions>
    <siteName>sample string 8</siteName>
    <site_ID>f2d69dc1-4e41-4efd-832e-98897dc5c9cf</site_ID>
  </PBI_RoleViewModel>
  <PBI_RoleViewModel>
    <active>true</active>
    <code>sample string 2</code>
    <customerName>sample string 4</customerName>
    <customer_ID>297469a3-9c77-4c8c-a1fb-aa53adea91d7</customer_ID>
    <id>b5ff3f87-4c2c-46e2-bcc5-c68eedb5e1ce</id>
    <names xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </names>
    <permissions>
      <PBI_PermissionsViewModel>
        <Active>true</Active>
        <Foreign_ID>bca8c2bb-ccc0-4d68-82b0-006cb8817989</Foreign_ID>
        <Foreign_Label>sample string 3</Foreign_Label>
        <ID>f2169092-f0b5-4e59-9bbd-b3b93c9d5294</ID>
        <type>SiteCustomer</type>
      </PBI_PermissionsViewModel>
      <PBI_PermissionsViewModel>
        <Active>true</Active>
        <Foreign_ID>bca8c2bb-ccc0-4d68-82b0-006cb8817989</Foreign_ID>
        <Foreign_Label>sample string 3</Foreign_Label>
        <ID>f2169092-f0b5-4e59-9bbd-b3b93c9d5294</ID>
        <type>SiteCustomer</type>
      </PBI_PermissionsViewModel>
    </permissions>
    <siteName>sample string 8</siteName>
    <site_ID>f2d69dc1-4e41-4efd-832e-98897dc5c9cf</site_ID>
  </PBI_RoleViewModel>
</ArrayOfPBI_RoleViewModel>