WorkerRoles Test
ReferenceData/WorkerRoles/{id}?filter={filter}&maintenanceMode={maintenanceMode}
Get the details of a worker role by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/WorkerRoles/{id}?filter={filter}&maintenanceMode={maintenanceMode}

URI Parameters

Parameter Name Data Type Required Notes
id integer Y
filter string N Filter by user access (default: readwrite).
maintenanceMode boolean N Ignore control grouping (default: false).

Request Body

None.
No request body.

Response object type : WorkerRole

Response object type WorkerRole has the following properties.
Property Name Data Type Length Required Readonly Notes
ControlGroup ControlGroupSummary N
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N
CreatedDateTime date N
CreateLocation string N
Description string N
Id integer N
Inactive boolean N
ShowInPortfolioDefault boolean N
UpdatedBy string N
UpdatedDateTime date N 
{
  "Description": "sample string 1",
  "Id": 1,
  "Inactive": true,
  "ShowInPortfolioDefault": true,
  "CreatedDateTime": "2025-04-24T08:19:18.1010075-07:00",
  "CreateLocation": "sample string 3",
  "CreatedBy": "sample string 4",
  "UpdatedDateTime": "2025-04-24T08:19:18.1010075-07:00",
  "UpdatedBy": "sample string 5",
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  }
}
<WorkerRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ControlGroup>
    <Description>sample string 1</Description>
    <Id>2</Id>
    <Inactive>true</Inactive>
  </ControlGroup>
  <CreateLocation>sample string 3</CreateLocation>
  <CreatedBy>sample string 4</CreatedBy>
  <CreatedDateTime>2025-04-24T08:19:18.1010075-07:00</CreatedDateTime>
  <Description>sample string 1</Description>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <ShowInPortfolioDefault>true</ShowInPortfolioDefault>
  <UpdatedBy>sample string 5</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:19:18.1010075-07:00</UpdatedDateTime>
</WorkerRole>
Change Version Description Contract Old New
Parameter Changed 15.0.0 id has been marked as required. Required