BatchTypes Test
ReferenceData/BatchTypes/{id}
Update an existing batch type.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/BatchTypes/{id}

URI Parameters

Parameter Name Data Type Required Notes
id integer Y

Request Body

Request object type : BatchType

Request object type BatchType has the following properties.
Property Name Data Type Length Required Readonly Notes
BatchTypeGroup BatchTypeGroupSummary Y
FK: TR_BATCH_TYPE_GROUP.id   Resource: BatchTypeGroups
BusinessUnit BusinessUnitSummary N
FK: TR_BU.id   Resource: BusinessUnits
Category integer Y
CntlIndicator boolean Y
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string Y
Id integer Y Non-updatable
Inactive boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned 
{
  "Category": 1,
  "CntlIndicator": true,
  "CreatedDateTime": "2025-04-24T04:10:38.8428977-07:00",
  "CreateLocation": "sample string 2",
  "CreatedBy": "sample string 3",
  "Description": "sample string 4",
  "Id": 1,
  "Inactive": true,
  "UpdatedDateTime": "2025-04-24T04:10:38.8428977-07:00",
  "UpdatedBy": "sample string 5",
  "BatchTypeGroup": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "BusinessUnit": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  }
}
<BatchType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BatchTypeGroup>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </BatchTypeGroup>
  <BusinessUnit>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </BusinessUnit>
  <Category>1</Category>
  <CntlIndicator>true</CntlIndicator>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedDateTime>2025-04-24T04:10:38.8428977-07:00</CreatedDateTime>
  <Description>sample string 4</Description>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <UpdatedBy>sample string 5</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:10:38.8428977-07:00</UpdatedDateTime>
</BatchType>

Response object type : BatchType

Response object type BatchType has the following properties.
Property Name Data Type Length Required Readonly Notes
BatchTypeGroup BatchTypeGroupSummary Y
FK: TR_BATCH_TYPE_GROUP.id   Resource: BatchTypeGroups
BusinessUnit BusinessUnitSummary N
FK: TR_BU.id   Resource: BusinessUnits
Category integer Y
CntlIndicator boolean Y
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string Y
Id integer Y Non-updatable
Inactive boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned 
{
  "Category": 1,
  "CntlIndicator": true,
  "CreatedDateTime": "2025-04-24T04:10:38.8428977-07:00",
  "CreateLocation": "sample string 2",
  "CreatedBy": "sample string 3",
  "Description": "sample string 4",
  "Id": 1,
  "Inactive": true,
  "UpdatedDateTime": "2025-04-24T04:10:38.8428977-07:00",
  "UpdatedBy": "sample string 5",
  "BatchTypeGroup": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "BusinessUnit": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  }
}
<BatchType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BatchTypeGroup>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </BatchTypeGroup>
  <BusinessUnit>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </BusinessUnit>
  <Category>1</Category>
  <CntlIndicator>true</CntlIndicator>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedDateTime>2025-04-24T04:10:38.8428977-07:00</CreatedDateTime>
  <Description>sample string 4</Description>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <UpdatedBy>sample string 5</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:10:38.8428977-07:00</UpdatedDateTime>
</BatchType>
Change Version Description Contract Old New
Parameter Changed 15.0.0 id has been marked as required. Required