PlanWorkers Test
Finance/PlanWorkers?planId={planId}
Get details of all the plan workers for the specified constituent.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/PlanWorkers?planId={planId}

URI Parameters

Parameter Name Data Type Required Notes
planId integer N

Request Body

None.
No request body.

Response object type : Collection of PlanWorker

Response object type Collection of PlanWorker has the following properties.
Property Name Data Type Length Required Readonly Notes
CreatedBy string N
CreatedDateTime date N
CreateLocation string N
EditIndicator boolean
Id integer N
Plan Entity N
FK: T_PLAN.plan_no   Resource: Plans
PrimaryIndicator boolean N
Role WorkerRoleSummary N
FK: TR_WORKER_ROLE.id   Resource: WorkerRoles
ShowInPortfolio boolean N
UpdatedBy string N
UpdatedDateTime date N
Worker ConstituentDisplaySummary N
FK: T_CUSTOMER.customer_no   Resource: Constituents 
[
  {
    "CreatedDateTime": "2025-04-24T05:08:04.5458962-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Worker": {
      "Id": 1,
      "SortName": "sample string 1",
      "DisplayName": "sample string 2"
    },
    "Id": 1,
    "UpdatedDateTime": "2025-04-24T05:08:04.5458962-07:00",
    "UpdatedBy": "sample string 3",
    "PrimaryIndicator": true,
    "ShowInPortfolio": true,
    "Role": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true,
      "ShowInPortfolioDefault": true
    },
    "Plan": {
      "Id": 1
    },
    "EditIndicator": true
  },
  {
    "CreatedDateTime": "2025-04-24T05:08:04.5458962-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Worker": {
      "Id": 1,
      "SortName": "sample string 1",
      "DisplayName": "sample string 2"
    },
    "Id": 1,
    "UpdatedDateTime": "2025-04-24T05:08:04.5458962-07:00",
    "UpdatedBy": "sample string 3",
    "PrimaryIndicator": true,
    "ShowInPortfolio": true,
    "Role": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true,
      "ShowInPortfolioDefault": true
    },
    "Plan": {
      "Id": 1
    },
    "EditIndicator": true
  }
]
<PlanWorkers xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PlanWorker>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T05:08:04.5458962-07:00</CreatedDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <Plan>
      <Id>1</Id>
    </Plan>
    <PrimaryIndicator>true</PrimaryIndicator>
    <Role>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <ShowInPortfolioDefault>true</ShowInPortfolioDefault>
    </Role>
    <ShowInPortfolio>true</ShowInPortfolio>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:08:04.5458962-07:00</UpdatedDateTime>
    <Worker>
      <DisplayName>sample string 2</DisplayName>
      <Id>1</Id>
      <SortName>sample string 1</SortName>
    </Worker>
  </PlanWorker>
  <PlanWorker>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T05:08:04.5458962-07:00</CreatedDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <Plan>
      <Id>1</Id>
    </Plan>
    <PrimaryIndicator>true</PrimaryIndicator>
    <Role>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <ShowInPortfolioDefault>true</ShowInPortfolioDefault>
    </Role>
    <ShowInPortfolio>true</ShowInPortfolio>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:08:04.5458962-07:00</UpdatedDateTime>
    <Worker>
      <DisplayName>sample string 2</DisplayName>
      <Id>1</Id>
      <SortName>sample string 1</SortName>
    </Worker>
  </PlanWorker>
</PlanWorkers>

No entries in change log for this operation.