GET Setup/Role

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludeError	boolean	None.
Match	MatchCriteriaStringType	None.
RoleIDs	Collection of integer	None.
BusinessUnits	Collection of integer	None.
CategoryID	integer	None.
RoleName	string	None.
Props	Collection of Object	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.
WorkerID	integer	None.
ClientOrderID	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of RoleDTO

Name	Type	Additional information
RoleID	integer	None.
BusinessUnits	Collection of RoleBusinessUnitDTO	None.
CategoryID	integer	None.
CategoryName	string	None.
RoleName	string	None.
Props	Collection of Object	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "roleID": 1,
    "businessUnits": [
      {
        "buid": 1,
        "roleID": 2,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:10:50.652377+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:10:50.652377+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
        }
      },
      {
        "buid": 1,
        "roleID": 2,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:10:50.652377+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:10:50.652377+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
        }
      }
    ],
    "categoryID": 2,
    "categoryName": "sample string 3",
    "roleName": "sample string 4",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:10:50.652377+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:10:50.652377+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
    }
  },
  {
    "roleID": 1,
    "businessUnits": [
      {
        "buid": 1,
        "roleID": 2,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:10:50.652377+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:10:50.652377+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
        }
      },
      {
        "buid": 1,
        "roleID": 2,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:10:50.652377+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:10:50.652377+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
        }
      }
    ],
    "categoryID": 2,
    "categoryName": "sample string 3",
    "roleName": "sample string 4",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:10:50.652377+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:10:50.652377+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:10:50 AM"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfRoleDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <RoleDTO>
    <BusinessUnits>
      <RoleBusinessUnitDTO>
        <BUID>1</BUID>
        <Created>
          <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <LastUpdated>
          <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <RecordState>Active</RecordState>
        <RoleID>2</RoleID>
      </RoleBusinessUnitDTO>
      <RoleBusinessUnitDTO>
        <BUID>1</BUID>
        <Created>
          <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <LastUpdated>
          <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <RecordState>Active</RecordState>
        <RoleID>2</RoleID>
      </RoleBusinessUnitDTO>
    </BusinessUnits>
    <CategoryID>2</CategoryID>
    <CategoryName>sample string 3</CategoryName>
    <Created>
      <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <LastUpdated>
      <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
    <RoleID>1</RoleID>
    <RoleName>sample string 4</RoleName>
  </RoleDTO>
  <RoleDTO>
    <BusinessUnits>
      <RoleBusinessUnitDTO>
        <BUID>1</BUID>
        <Created>
          <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <LastUpdated>
          <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <RecordState>Active</RecordState>
        <RoleID>2</RoleID>
      </RoleBusinessUnitDTO>
      <RoleBusinessUnitDTO>
        <BUID>1</BUID>
        <Created>
          <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <LastUpdated>
          <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <RecordState>Active</RecordState>
        <RoleID>2</RoleID>
      </RoleBusinessUnitDTO>
    </BusinessUnits>
    <CategoryID>2</CategoryID>
    <CategoryName>sample string 3</CategoryName>
    <Created>
      <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <LastUpdated>
      <DateUtc>2024-12-04T08:10:50.652377+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
    <RoleID>1</RoleID>
    <RoleName>sample string 4</RoleName>
  </RoleDTO>
</ArrayOfRoleDTO>

application/x-compressed-json

Sample:

��;�0��y���CِX`�N�!�QU��B���#q�k���l�>˶>E��xZ��օ�N@�l�+CW�#P7M��гKri�ڦ�����.�m)�K@�D�C��h�#��cgЗ�ᰅ�!����뒇�r[A��U&$Cj�R��+u%Bٍ��
�1Z�gp����m��o�{k6�d��=�=�o���.�-��k����<�y��|�F�K��$