Formats Test
ReferenceData/Formats?maintenanceMode={maintenanceMode}
Get all formats. 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/Formats?maintenanceMode={maintenanceMode}

URI Parameters

Parameter Name Data Type Required Notes
maintenanceMode boolean N Ignore control grouping (default: false).

Request Body

None.
No request body.

Response object type : Collection of Format

Response object type Collection of Format 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
DataObject string N
Description string N
EmailIndicator string N
FormName EntitySummary N
FK: TR_FORM_NAME.id
GooesoftReportId string N
Id integer N
Inactive boolean
ReceiptCounter integer N
TemplateId integer N
FK: T_TEMPLATE.id   Resource: Templates
UpdatedBy string N
UpdatedDateTime date N 
[
  {
    "CreatedDateTime": "2025-04-24T03:59:09.890061-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Description": "sample string 3",
    "Id": 1,
    "Inactive": true,
    "GooesoftReportId": "sample string 5",
    "FormName": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "ReceiptCounter": 1,
    "DataObject": "sample string 6",
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "TemplateId": 1,
    "EmailIndicator": "sample string 7",
    "UpdatedDateTime": "2025-04-24T03:59:09.890061-07:00",
    "UpdatedBy": "sample string 8"
  },
  {
    "CreatedDateTime": "2025-04-24T03:59:09.890061-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Description": "sample string 3",
    "Id": 1,
    "Inactive": true,
    "GooesoftReportId": "sample string 5",
    "FormName": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "ReceiptCounter": 1,
    "DataObject": "sample string 6",
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "TemplateId": 1,
    "EmailIndicator": "sample string 7",
    "UpdatedDateTime": "2025-04-24T03:59:09.890061-07:00",
    "UpdatedBy": "sample string 8"
  }
]
<Formats xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Format>
    <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:09.890061-07:00</CreatedDateTime>
    <DataObject>sample string 6</DataObject>
    <Description>sample string 3</Description>
    <EmailIndicator>sample string 7</EmailIndicator>
    <FormName>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </FormName>
    <GooesoftReportId>sample string 5</GooesoftReportId>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ReceiptCounter>1</ReceiptCounter>
    <TemplateId>1</TemplateId>
    <UpdatedBy>sample string 8</UpdatedBy>
    <UpdatedDateTime>2025-04-24T03:59:09.890061-07:00</UpdatedDateTime>
  </Format>
  <Format>
    <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:09.890061-07:00</CreatedDateTime>
    <DataObject>sample string 6</DataObject>
    <Description>sample string 3</Description>
    <EmailIndicator>sample string 7</EmailIndicator>
    <FormName>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </FormName>
    <GooesoftReportId>sample string 5</GooesoftReportId>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ReceiptCounter>1</ReceiptCounter>
    <TemplateId>1</TemplateId>
    <UpdatedBy>sample string 8</UpdatedBy>
    <UpdatedDateTime>2025-04-24T03:59:09.890061-07:00</UpdatedDateTime>
  </Format>
</Formats>

No entries in change log for this operation.