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

URI Parameters

Parameter Name Data Type Required Notes
id integer Y

Request Body

Request object type : InterestType

Request object type InterestType has the following properties.
Property Name Data Type Length Required Readonly Notes
Category InterestCategorySummary Y
FK: TR_TKW_CATEGORY.id   Resource: InterestCategories
ControlGroup ControlGroupSummary Y
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string Y
Id integer Y Non-updatable
SearchIndicator boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UsedIn string Y 
{
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "CreatedDateTime": "2025-04-24T04:10:54.8585351-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Description": "sample string 3",
  "Id": 1,
  "UpdatedDateTime": "2025-04-24T04:10:54.8585351-07:00",
  "UpdatedBy": "sample string 4",
  "Category": {
    "Description": "sample string 1",
    "Id": 1
  },
  "UsedIn": "sample string 5",
  "SearchIndicator": true
}
<InterestType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Category>
    <Description>sample string 1</Description>
    <Id>1</Id>
  </Category>
  <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-24T04:10:54.8585351-07:00</CreatedDateTime>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <SearchIndicator>true</SearchIndicator>
  <UpdatedBy>sample string 4</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:10:54.8585351-07:00</UpdatedDateTime>
  <UsedIn>sample string 5</UsedIn>
</InterestType>

Response object type : InterestType

Response object type InterestType has the following properties.
Property Name Data Type Length Required Readonly Notes
Category InterestCategorySummary Y
FK: TR_TKW_CATEGORY.id   Resource: InterestCategories
ControlGroup ControlGroupSummary Y
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
Description string Y
Id integer Y Non-updatable
SearchIndicator boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UsedIn string Y 
{
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "CreatedDateTime": "2025-04-24T04:10:54.8585351-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Description": "sample string 3",
  "Id": 1,
  "UpdatedDateTime": "2025-04-24T04:10:54.8585351-07:00",
  "UpdatedBy": "sample string 4",
  "Category": {
    "Description": "sample string 1",
    "Id": 1
  },
  "UsedIn": "sample string 5",
  "SearchIndicator": true
}
<InterestType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Category>
    <Description>sample string 1</Description>
    <Id>1</Id>
  </Category>
  <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-24T04:10:54.8585351-07:00</CreatedDateTime>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <SearchIndicator>true</SearchIndicator>
  <UpdatedBy>sample string 4</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:10:54.8585351-07:00</UpdatedDateTime>
  <UsedIn>sample string 5</UsedIn>
</InterestType>
Change Version Description Contract Old New
Parameter Changed 15.0.0 id has been marked as required. Required