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

URI Parameters

Parameter Name Data Type Required Notes
id integer Y

Request Body

Request object type : DocumentCategory

Request object type DocumentCategory has the following properties.
Property Name Data Type Length Required Readonly Notes
ControlGroup ControlGroup Y
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string 30 Y
Id integer Y Non-updatable
Inactive boolean Y
ParentTableName string 128 Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
{
  "ControlGroup": {
    "CreatedBy": "sample string 1",
    "CreatedDateTime": "2025-04-24T08:29:06.1650134-07:00",
    "Description": "sample string 2",
    "Id": 1,
    "Inactive": true,
    "Permission": 0,
    "UpdatedBy": "sample string 3",
    "UpdatedDateTime": "2025-04-24T08:29:06.1650134-07:00"
  },
  "CreatedDateTime": "2025-04-24T08:29:06.1650134-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Description": "sample string 3",
  "Id": 1,
  "UpdatedDateTime": "2025-04-24T08:29:06.1650134-07:00",
  "UpdatedBy": "sample string 4",
  "ParentTableName": "sample string 5",
  "Inactive": true
}
<DocumentCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ControlGroup>
    <CreatedBy>sample string 1</CreatedBy>
    <CreatedDateTime>2025-04-24T08:29:06.1650134-07:00</CreatedDateTime>
    <Description>sample string 2</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <Permission>Read</Permission>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T08:29:06.1650134-07:00</UpdatedDateTime>
  </ControlGroup>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T08:29:06.1650134-07:00</CreatedDateTime>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <ParentTableName>sample string 5</ParentTableName>
  <UpdatedBy>sample string 4</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:29:06.1650134-07:00</UpdatedDateTime>
</DocumentCategory>

Response object type : DocumentCategory

Response object type DocumentCategory has the following properties.
Property Name Data Type Length Required Readonly Notes
ControlGroup ControlGroup Y
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string 30 Y
Id integer Y Non-updatable
Inactive boolean Y
ParentTableName string 128 Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
{
  "ControlGroup": {
    "CreatedBy": "sample string 1",
    "CreatedDateTime": "2025-04-24T08:29:06.1650134-07:00",
    "Description": "sample string 2",
    "Id": 1,
    "Inactive": true,
    "Permission": 0,
    "UpdatedBy": "sample string 3",
    "UpdatedDateTime": "2025-04-24T08:29:06.1650134-07:00"
  },
  "CreatedDateTime": "2025-04-24T08:29:06.1650134-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Description": "sample string 3",
  "Id": 1,
  "UpdatedDateTime": "2025-04-24T08:29:06.1650134-07:00",
  "UpdatedBy": "sample string 4",
  "ParentTableName": "sample string 5",
  "Inactive": true
}
<DocumentCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ControlGroup>
    <CreatedBy>sample string 1</CreatedBy>
    <CreatedDateTime>2025-04-24T08:29:06.1650134-07:00</CreatedDateTime>
    <Description>sample string 2</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <Permission>Read</Permission>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T08:29:06.1650134-07:00</UpdatedDateTime>
  </ControlGroup>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T08:29:06.1650134-07:00</CreatedDateTime>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <ParentTableName>sample string 5</ParentTableName>
  <UpdatedBy>sample string 4</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:29:06.1650134-07:00</UpdatedDateTime>
</DocumentCategory>
Change Version Description Contract Old New
Resource Added 15.1.3 New resource added. DocumentCategories