PlanStatuses Test
ReferenceData/PlanStatuses?filter={filter}&maintenanceMode={maintenanceMode}
Get all plan statuses. To get only the resoures for which 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). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/PlanStatuses?filter={filter}&maintenanceMode={maintenanceMode}

URI Parameters

Parameter Name Data Type Required Notes
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 : Collection of PlanStatus

Response object type Collection of PlanStatus 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
Rank integer N
UpdatedBy string N
UpdatedDateTime date N 
[
  {
    "Id": 1,
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "CreatedDateTime": "2025-04-24T03:59:04.0615817-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Description": "sample string 3",
    "Inactive": true,
    "Rank": 4,
    "UpdatedDateTime": "2025-04-24T03:59:04.0615817-07:00",
    "UpdatedBy": "sample string 5"
  },
  {
    "Id": 1,
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "CreatedDateTime": "2025-04-24T03:59:04.0615817-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Description": "sample string 3",
    "Inactive": true,
    "Rank": 4,
    "UpdatedDateTime": "2025-04-24T03:59:04.0615817-07:00",
    "UpdatedBy": "sample string 5"
  }
]
<PlanStatuses xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PlanStatus>
    <ControlGroup>
      <Description>sample string 1</Description>
      <Id>2</Id>
      <Inactive>true</Inactive>
    </ControlGroup>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T03:59:04.0615817-07:00</CreatedDateTime>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <Rank>4</Rank>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedDateTime>2025-04-24T03:59:04.0615817-07:00</UpdatedDateTime>
  </PlanStatus>
  <PlanStatus>
    <ControlGroup>
      <Description>sample string 1</Description>
      <Id>2</Id>
      <Inactive>true</Inactive>
    </ControlGroup>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T03:59:04.0615817-07:00</CreatedDateTime>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <Rank>4</Rank>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedDateTime>2025-04-24T03:59:04.0615817-07:00</UpdatedDateTime>
  </PlanStatus>
</PlanStatuses>

No entries in change log for this operation.