GET Workers/Role

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncludeActive

boolean

None.

IncludeInactive

boolean

None.

IncludeDeleted

boolean

None.

Match

MatchCriteriaStringType

None.

EntityBusinessUnitRoleIDs

Collection of integer

None.

RoleID

integer

None.

EntityID

integer

None.

BusinessUnits

Collection of integer

None.

StartDateUtcMin

date

None.

StartDateUtcMax

date

None.

StopDateUtcMin

date

None.

StopDateUtcMax

date

None.

StopDateUtcEventID

integer

None.

ReferenceNumber

string

None.

Props

Collection of Object

None.

CreatedDateUtcMin

date

None.

CreatedDateUtcMax

date

None.

LastUpdatedDateUtcMin

date

None.

LastUpdatedDateUtcMax

date

None.

Body Parameters

None.

Response Information

Resource Description

Collection of WorkerBusinessUnitRoleDTO
NameDescriptionTypeAdditional information
WorkerID

integer

None.

EntityBusinessUnitRoleID

integer

None.

RoleID

integer

None.

RoleName

string

None.

BUID

integer

None.

BusinessUnitName

string

None.

StartDateUtc

date

None.

StopDateUtc

date

None.

StopDateUtcEventID

integer

None.

ReferenceNumber

string

None.

Props

Collection of Object

None.

RecordState

RecordState

None.

Created

AuditDataDTO

None.

LastUpdated

AuditDataDTO

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "entityBusinessUnitRoleID": 3,
    "roleID": 4,
    "roleName": "sample string 5",
    "buid": 6,
    "businessUnitName": "sample string 7",
    "startDateUtc": "2024-12-04T08:06:37.7827708+00:00",
    "stopDateUtc": "2024-12-04T08:06:37.7827708+00:00",
    "stopDateUtcEventID": 1,
    "referenceNumber": "sample string 9",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:06:37.7827708+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:06:37 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:06:37.7827708+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:06:37 AM"
    },
    "workerID": 2
  },
  {
    "entityBusinessUnitRoleID": 3,
    "roleID": 4,
    "roleName": "sample string 5",
    "buid": 6,
    "businessUnitName": "sample string 7",
    "startDateUtc": "2024-12-04T08:06:37.7827708+00:00",
    "stopDateUtc": "2024-12-04T08:06:37.7827708+00:00",
    "stopDateUtcEventID": 1,
    "referenceNumber": "sample string 9",
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:06:37.7827708+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:06:37 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:06:37.7827708+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:06:37 AM"
    },
    "workerID": 2
  }
]

application/xml, text/xml

Sample:
<ArrayOfWorkerBusinessUnitRoleDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <WorkerBusinessUnitRoleDTO>
    <BUID>6</BUID>
    <BusinessUnitName>sample string 7</BusinessUnitName>
    <Created>
      <DateUtc>2024-12-04T08:06:37.7827708+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EntityBusinessUnitRoleID>3</EntityBusinessUnitRoleID>
    <EntityID>2</EntityID>
    <LastUpdated>
      <DateUtc>2024-12-04T08:06:37.7827708+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>
    <ReferenceNumber>sample string 9</ReferenceNumber>
    <RoleID>4</RoleID>
    <RoleName>sample string 5</RoleName>
    <StartDateUtc>2024-12-04T08:06:37.7827708+00:00</StartDateUtc>
    <StopDateUtc>2024-12-04T08:06:37.7827708+00:00</StopDateUtc>
    <StopDateUtcEventID>1</StopDateUtcEventID>
    <WorkerID>2</WorkerID>
  </WorkerBusinessUnitRoleDTO>
  <WorkerBusinessUnitRoleDTO>
    <BUID>6</BUID>
    <BusinessUnitName>sample string 7</BusinessUnitName>
    <Created>
      <DateUtc>2024-12-04T08:06:37.7827708+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EntityBusinessUnitRoleID>3</EntityBusinessUnitRoleID>
    <EntityID>2</EntityID>
    <LastUpdated>
      <DateUtc>2024-12-04T08:06:37.7827708+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>
    <ReferenceNumber>sample string 9</ReferenceNumber>
    <RoleID>4</RoleID>
    <RoleName>sample string 5</RoleName>
    <StartDateUtc>2024-12-04T08:06:37.7827708+00:00</StartDateUtc>
    <StopDateUtc>2024-12-04T08:06:37.7827708+00:00</StopDateUtc>
    <StopDateUtcEventID>1</StopDateUtcEventID>
    <WorkerID>2</WorkerID>
  </WorkerBusinessUnitRoleDTO>
</ArrayOfWorkerBusinessUnitRoleDTO>

application/x-compressed-json

Sample:
��R�N�0��VR긡	�@e`��	1�Ɂ,b;:;���1�I�v�ԡ]@ݞt�ݽwz��+@tX^^[��:ܺ�g '��p���L�!�}fg��b�-�i�=�ed��(�T�:4� �(F���W�O�<-+Q��:�\r����׊��2��c|BB��|0�=�8���.D�F�F������#��Hc-�g�Y��q1N'�v7���u�����b���Rz�Xg�.��G]z�}��