PlanWorkers Test
Finance/PlanWorkers/{planWorkerId}
Update an existing plan worker.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/PlanWorkers/{planWorkerId}

URI Parameters

Parameter Name Data Type Required Notes
planWorkerId integer Y

Request Body

Request object type : PlanWorker

Request object type PlanWorker has the following properties.
Property Name Data Type Length Required Readonly Notes
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
EditIndicator boolean
Id integer Y Non-updatable
Plan Entity Y
FK: T_PLAN.plan_no   Resource: Plans
PrimaryIndicator boolean Y
Role WorkerRoleSummary Y
FK: TR_WORKER_ROLE.id   Resource: WorkerRoles
ShowInPortfolio boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
Worker ConstituentDisplaySummary Y
FK: T_CUSTOMER.customer_no   Resource: Constituents 
{
  "CreatedDateTime": "2025-10-28T10:07:42.6020688-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-10-28T10:07:42.6020688-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
}
<PlanWorker xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-10-28T10:07:42.6020688-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-10-28T10:07:42.6020688-07:00</UpdatedDateTime>
  <Worker>
    <DisplayName>sample string 2</DisplayName>
    <Id>1</Id>
    <SortName>sample string 1</SortName>
  </Worker>
</PlanWorker>

Response object type : PlanWorker

Response object type PlanWorker has the following properties.
Property Name Data Type Length Required Readonly Notes
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
EditIndicator boolean
Id integer Y Non-updatable
Plan Entity Y
FK: T_PLAN.plan_no   Resource: Plans
PrimaryIndicator boolean Y
Role WorkerRoleSummary Y
FK: TR_WORKER_ROLE.id   Resource: WorkerRoles
ShowInPortfolio boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
Worker ConstituentDisplaySummary Y
FK: T_CUSTOMER.customer_no   Resource: Constituents 
{
  "CreatedDateTime": "2025-10-28T10:07:42.6020688-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-10-28T10:07:42.6020688-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
}
<PlanWorker xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-10-28T10:07:42.6020688-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-10-28T10:07:42.6020688-07:00</UpdatedDateTime>
  <Worker>
    <DisplayName>sample string 2</DisplayName>
    <Id>1</Id>
    <SortName>sample string 1</SortName>
  </Worker>
</PlanWorker>
Change Version Description Contract Old New
Parameter Changed 15.0.0 planWorkerId has been marked as required. Required