Workers Test
Finance/Workers/Summary?constituentId={constituentId}&includeAffiliations={includeAffiliations}
Get summary of all the workers for the specified constituent.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/Workers/Summary?constituentId={constituentId}&includeAffiliations={includeAffiliations}

URI Parameters

Parameter Name Data Type Required Notes
constituentId integer N Limit results by constituent.
includeAffiliations boolean N Include all of the constituent's affiliates in the results (default: true).

Request Body

None.
No request body.

Response object type : Collection of WorkerSummary

Response object type Collection of WorkerSummary has the following properties.
Property Name Data Type Length Required Readonly Notes
ConstituentId integer
Inactive boolean
ShortDisplayName string
SortName string
WorkerTypes Collection of WorkerTypeSummary 
[
  {
    "Inactive": true,
    "WorkerTypes": [
      {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      },
      {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      }
    ],
    "ConstituentId": 1,
    "SortName": "sample string 2",
    "ShortDisplayName": "sample string 3"
  },
  {
    "Inactive": true,
    "WorkerTypes": [
      {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      },
      {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      }
    ],
    "ConstituentId": 1,
    "SortName": "sample string 2",
    "ShortDisplayName": "sample string 3"
  }
]
<WorkerSummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Worker>
    <ConstituentId>1</ConstituentId>
    <Inactive>true</Inactive>
    <ShortDisplayName>sample string 3</ShortDisplayName>
    <SortName>sample string 2</SortName>
    <WorkerTypes>
      <WorkerType>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </WorkerType>
      <WorkerType>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </WorkerType>
    </WorkerTypes>
  </Worker>
  <Worker>
    <ConstituentId>1</ConstituentId>
    <Inactive>true</Inactive>
    <ShortDisplayName>sample string 3</ShortDisplayName>
    <SortName>sample string 2</SortName>
    <WorkerTypes>
      <WorkerType>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </WorkerType>
      <WorkerType>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </WorkerType>
    </WorkerTypes>
  </Worker>
</WorkerSummaries>

No entries in change log for this operation.