Associations Test
CRM/Associations/{associationId}
Update a association.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Associations/{associationId}

URI Parameters

Parameter Name Data Type Required Notes
associationId integer Y

Request Body

Request object type : Association

Request object type Association has the following properties.
Property Name Data Type Length Required Readonly Notes
AssociatedConstituent Entity
AssociatedName string 55 N
AssociationType AssociationTypeSummary Y
BirthDate date N
Constituent Entity
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
EditIndicator boolean
EndDate date N
Gender GenderSummary N
Id integer Y Non-updatable
Inactive boolean Y
IsIncludedInSearchResults boolean Y
Note string 1024 N
ReciprocalAssociation Entity N
FK: T_ASSOCIATION.association_no   Resource: Associations
StartDate date N
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
{
  "AssociatedConstituent": {
    "Id": 1
  },
  "AssociatedName": "sample string 1",
  "Id": 1,
  "AssociationType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "ReciprocalType": {
      "Id": 1
    },
    "RelationshipCategory": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "CreatedDateTime": "2025-04-24T05:23:05.9445032-07:00",
  "CreateLocation": "sample string 2",
  "CreatedBy": "sample string 3",
  "Constituent": {
    "Id": 1
  },
  "EndDate": "2025-04-24T05:23:05.9445032-07:00",
  "Inactive": true,
  "IsIncludedInSearchResults": true,
  "UpdatedBy": "sample string 4",
  "UpdatedDateTime": "2025-04-24T05:23:05.9445032-07:00",
  "Note": "sample string 5",
  "BirthDate": "2025-04-24T05:23:05.9445032-07:00",
  "Gender": {
    "Id": 1,
    "Description": "sample string 1",
    "ShortDescription": "sample string 2",
    "Inactive": true
  },
  "ReciprocalAssociation": {
    "Id": 1
  },
  "StartDate": "2025-04-24T05:23:05.9445032-07:00",
  "EditIndicator": true
}
<Association xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AssociatedConstituent>
    <Id>1</Id>
  </AssociatedConstituent>
  <AssociatedName>sample string 1</AssociatedName>
  <AssociationType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ReciprocalType>
      <Id>1</Id>
    </ReciprocalType>
    <RelationshipCategory>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </RelationshipCategory>
  </AssociationType>
  <BirthDate>2025-04-24T05:23:05.9445032-07:00</BirthDate>
  <Constituent>
    <Id>1</Id>
  </Constituent>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedDateTime>2025-04-24T05:23:05.9445032-07:00</CreatedDateTime>
  <EditIndicator>true</EditIndicator>
  <EndDate>2025-04-24T05:23:05.9445032-07:00</EndDate>
  <Gender>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ShortDescription>sample string 2</ShortDescription>
  </Gender>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IsIncludedInSearchResults>true</IsIncludedInSearchResults>
  <Note>sample string 5</Note>
  <ReciprocalAssociation>
    <Id>1</Id>
  </ReciprocalAssociation>
  <StartDate>2025-04-24T05:23:05.9445032-07:00</StartDate>
  <UpdatedBy>sample string 4</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:23:05.9445032-07:00</UpdatedDateTime>
</Association>

Response object type : Association

Response object type Association has the following properties.
Property Name Data Type Length Required Readonly Notes
AssociatedConstituent Entity
AssociatedName string 55 N
AssociationType AssociationTypeSummary Y
BirthDate date N
Constituent Entity
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
EditIndicator boolean
EndDate date N
Gender GenderSummary N
Id integer Y Non-updatable
Inactive boolean Y
IsIncludedInSearchResults boolean Y
Note string 1024 N
ReciprocalAssociation Entity N
FK: T_ASSOCIATION.association_no   Resource: Associations
StartDate date N
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
{
  "AssociatedConstituent": {
    "Id": 1
  },
  "AssociatedName": "sample string 1",
  "Id": 1,
  "AssociationType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "ReciprocalType": {
      "Id": 1
    },
    "RelationshipCategory": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "CreatedDateTime": "2025-04-24T05:23:05.9445032-07:00",
  "CreateLocation": "sample string 2",
  "CreatedBy": "sample string 3",
  "Constituent": {
    "Id": 1
  },
  "EndDate": "2025-04-24T05:23:05.9445032-07:00",
  "Inactive": true,
  "IsIncludedInSearchResults": true,
  "UpdatedBy": "sample string 4",
  "UpdatedDateTime": "2025-04-24T05:23:05.9445032-07:00",
  "Note": "sample string 5",
  "BirthDate": "2025-04-24T05:23:05.9445032-07:00",
  "Gender": {
    "Id": 1,
    "Description": "sample string 1",
    "ShortDescription": "sample string 2",
    "Inactive": true
  },
  "ReciprocalAssociation": {
    "Id": 1
  },
  "StartDate": "2025-04-24T05:23:05.9445032-07:00",
  "EditIndicator": true
}
<Association xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AssociatedConstituent>
    <Id>1</Id>
  </AssociatedConstituent>
  <AssociatedName>sample string 1</AssociatedName>
  <AssociationType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ReciprocalType>
      <Id>1</Id>
    </ReciprocalType>
    <RelationshipCategory>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </RelationshipCategory>
  </AssociationType>
  <BirthDate>2025-04-24T05:23:05.9445032-07:00</BirthDate>
  <Constituent>
    <Id>1</Id>
  </Constituent>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedDateTime>2025-04-24T05:23:05.9445032-07:00</CreatedDateTime>
  <EditIndicator>true</EditIndicator>
  <EndDate>2025-04-24T05:23:05.9445032-07:00</EndDate>
  <Gender>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ShortDescription>sample string 2</ShortDescription>
  </Gender>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IsIncludedInSearchResults>true</IsIncludedInSearchResults>
  <Note>sample string 5</Note>
  <ReciprocalAssociation>
    <Id>1</Id>
  </ReciprocalAssociation>
  <StartDate>2025-04-24T05:23:05.9445032-07:00</StartDate>
  <UpdatedBy>sample string 4</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:23:05.9445032-07:00</UpdatedDateTime>
</Association>
Change Version Description Contract Old New
Property Changed 15.1.0 Gender has changed from String to GenderSummary Association String GenderSummary
Property Changed 15.1.0 Gender has changed from String to GenderSummary Association String GenderSummary
Parameter Changed 15.0.0 associationId has been marked as required. Required