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

URI Parameters

Parameter Name Data Type Required Notes
id integer Y

Request Body

Request object type : AssociationType

Request object type AssociationType has the following properties.
Property Name Data Type Length Required Readonly Notes
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
Inactive boolean Y
IsIncludedInSearchResultsDefault boolean Y
ReciprocalType Entity Y
FK: TR_ASSOCIATION_TYPE.id   Resource: AssociationTypes
RelationshipCategory RelationshipCategorySummary Y
FK: TR_RELATIONSHIP_CATEGORY.id   Resource: RelationshipCategories
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UseBirthDate boolean Y
UseGender boolean Y 
{
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "CreatedDateTime": "2025-04-24T08:26:41.0476063-07:00",
  "CreatedBy": "sample string 1",
  "CreateLocation": "sample string 2",
  "Description": "sample string 3",
  "Id": 1,
  "Inactive": true,
  "UseBirthDate": true,
  "UseGender": true,
  "IsIncludedInSearchResultsDefault": true,
  "UpdatedBy": "sample string 7",
  "UpdatedDateTime": "2025-04-24T08:26:41.0476063-07:00",
  "RelationshipCategory": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "ReciprocalType": {
    "Id": 1
  }
}
<AssociationType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ControlGroup>
    <Description>sample string 1</Description>
    <Id>2</Id>
    <Inactive>true</Inactive>
  </ControlGroup>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 1</CreatedBy>
  <CreatedDateTime>2025-04-24T08:26:41.0476063-07:00</CreatedDateTime>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IsIncludedInSearchResultsDefault>true</IsIncludedInSearchResultsDefault>
  <ReciprocalType>
    <Id>1</Id>
  </ReciprocalType>
  <RelationshipCategory>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </RelationshipCategory>
  <UpdatedBy>sample string 7</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:26:41.0476063-07:00</UpdatedDateTime>
  <UseBirthDate>true</UseBirthDate>
  <UseGender>true</UseGender>
</AssociationType>

Response object type : AssociationType

Response object type AssociationType has the following properties.
Property Name Data Type Length Required Readonly Notes
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
Inactive boolean Y
IsIncludedInSearchResultsDefault boolean Y
ReciprocalType Entity Y
FK: TR_ASSOCIATION_TYPE.id   Resource: AssociationTypes
RelationshipCategory RelationshipCategorySummary Y
FK: TR_RELATIONSHIP_CATEGORY.id   Resource: RelationshipCategories
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UseBirthDate boolean Y
UseGender boolean Y 
{
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "CreatedDateTime": "2025-04-24T08:26:41.0476063-07:00",
  "CreatedBy": "sample string 1",
  "CreateLocation": "sample string 2",
  "Description": "sample string 3",
  "Id": 1,
  "Inactive": true,
  "UseBirthDate": true,
  "UseGender": true,
  "IsIncludedInSearchResultsDefault": true,
  "UpdatedBy": "sample string 7",
  "UpdatedDateTime": "2025-04-24T08:26:41.0476063-07:00",
  "RelationshipCategory": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "ReciprocalType": {
    "Id": 1
  }
}
<AssociationType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ControlGroup>
    <Description>sample string 1</Description>
    <Id>2</Id>
    <Inactive>true</Inactive>
  </ControlGroup>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 1</CreatedBy>
  <CreatedDateTime>2025-04-24T08:26:41.0476063-07:00</CreatedDateTime>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IsIncludedInSearchResultsDefault>true</IsIncludedInSearchResultsDefault>
  <ReciprocalType>
    <Id>1</Id>
  </ReciprocalType>
  <RelationshipCategory>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </RelationshipCategory>
  <UpdatedBy>sample string 7</UpdatedBy>
  <UpdatedDateTime>2025-04-24T08:26:41.0476063-07:00</UpdatedDateTime>
  <UseBirthDate>true</UseBirthDate>
  <UseGender>true</UseGender>
</AssociationType>
Change Version Description Contract Old New
Parameter Changed 15.0.0 id has been marked as required. Required