AffiliationInfo Test
CRM/AffiliationInfo
Create affiliation between a group constituent and its related constituent. If the related constituent does not exist then create the related constituent as well before creating the affiliation.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/AffiliationInfo

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : AffiliationInfo

Request object type AffiliationInfo has the following properties.
Property Name Data Type Length Required Readonly Notes
AffiliationType AffiliationTypeSummary
ConstituentId integer
EditIndicator boolean
EndDate date
Id integer
Inactive boolean
IsAllowedToTransact boolean
IsIncludedInSearchResults boolean
NameIndicator integer
Note string
PrimaryIndicator boolean
ProtectionType ConstituentProtectionTypeSummary
Rank integer
RelatedConstituentFirstName string
RelatedConstituentGender GenderSummary
RelatedConstituentId integer
RelatedConstituentInactive boolean
RelatedConstituentLastName string
RelatedConstituentMiddleName string
RelatedConstituentNameStatusDescription string
RelatedConstituentNameStatusId integer
RelatedConstituentPrefix PrefixSummary
RelatedConstituentShortDisplayName string
RelatedConstituentSortName string
RelatedConstituentSuffix SuffixSummary
RelatedConstituentType ConstituentTypeSummary
Salary decimal number
StartDate date
Title string
{
  "Id": 1,
  "AffiliationType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "UseSalary": true,
    "UseTitle": true,
    "IsIncludedInSearchResultsDefault": true,
    "RelationshipCategory": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "Inactive": true,
  "IsAllowedToTransact": true,
  "IsIncludedInSearchResults": true,
  "StartDate": "2025-04-24T09:36:32.777359-07:00",
  "EndDate": "2025-04-24T09:36:32.777359-07:00",
  "NameIndicator": 1,
  "Note": "sample string 1",
  "Salary": 1.0,
  "Title": "sample string 2",
  "PrimaryIndicator": true,
  "EditIndicator": true,
  "ConstituentId": 5,
  "RelatedConstituentId": 1,
  "RelatedConstituentInactive": true,
  "RelatedConstituentLastName": "sample string 7",
  "RelatedConstituentShortDisplayName": "sample string 8",
  "RelatedConstituentMiddleName": "sample string 9",
  "RelatedConstituentFirstName": "sample string 10",
  "RelatedConstituentNameStatusId": 11,
  "RelatedConstituentNameStatusDescription": "sample string 12",
  "RelatedConstituentPrefix": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "RelatedConstituentSuffix": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "RelatedConstituentGender": {
    "Id": 1,
    "Description": "sample string 1",
    "ShortDescription": "sample string 2",
    "Inactive": true
  },
  "RelatedConstituentSortName": "sample string 13",
  "RelatedConstituentType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "ConstituentGroup": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "Rank": 1,
  "ProtectionType": {
    "Id": 1,
    "Description": "sample string 1"
  }
}
<AffiliationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AffiliationType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <IsIncludedInSearchResultsDefault>true</IsIncludedInSearchResultsDefault>
    <RelationshipCategory>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </RelationshipCategory>
    <UseSalary>true</UseSalary>
    <UseTitle>true</UseTitle>
  </AffiliationType>
  <ConstituentId>5</ConstituentId>
  <EditIndicator>true</EditIndicator>
  <EndDate>2025-04-24T09:36:32.777359-07:00</EndDate>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IsAllowedToTransact>true</IsAllowedToTransact>
  <IsIncludedInSearchResults>true</IsIncludedInSearchResults>
  <NameIndicator>1</NameIndicator>
  <Note>sample string 1</Note>
  <PrimaryIndicator>true</PrimaryIndicator>
  <ProtectionType>
    <Description>sample string 1</Description>
    <Id>1</Id>
  </ProtectionType>
  <Rank>1</Rank>
  <RelatedConstituentFirstName>sample string 10</RelatedConstituentFirstName>
  <RelatedConstituentGender>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ShortDescription>sample string 2</ShortDescription>
  </RelatedConstituentGender>
  <RelatedConstituentId>1</RelatedConstituentId>
  <RelatedConstituentInactive>true</RelatedConstituentInactive>
  <RelatedConstituentLastName>sample string 7</RelatedConstituentLastName>
  <RelatedConstituentMiddleName>sample string 9</RelatedConstituentMiddleName>
  <RelatedConstituentNameStatusDescription>sample string 12</RelatedConstituentNameStatusDescription>
  <RelatedConstituentNameStatusId>11</RelatedConstituentNameStatusId>
  <RelatedConstituentPrefix>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </RelatedConstituentPrefix>
  <RelatedConstituentShortDisplayName>sample string 8</RelatedConstituentShortDisplayName>
  <RelatedConstituentSortName>sample string 13</RelatedConstituentSortName>
  <RelatedConstituentSuffix>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </RelatedConstituentSuffix>
  <RelatedConstituentType>
    <ConstituentGroup>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </ConstituentGroup>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </RelatedConstituentType>
  <Salary>1</Salary>
  <StartDate>2025-04-24T09:36:32.777359-07:00</StartDate>
  <Title>sample string 2</Title>
</AffiliationInfo>

Response object type : AffiliationInfo

Response object type AffiliationInfo has the following properties.
Property Name Data Type Length Required Readonly Notes
AffiliationType AffiliationTypeSummary
ConstituentId integer
EditIndicator boolean
EndDate date
Id integer
Inactive boolean
IsAllowedToTransact boolean
IsIncludedInSearchResults boolean
NameIndicator integer
Note string
PrimaryIndicator boolean
ProtectionType ConstituentProtectionTypeSummary
Rank integer
RelatedConstituentFirstName string
RelatedConstituentGender GenderSummary
RelatedConstituentId integer
RelatedConstituentInactive boolean
RelatedConstituentLastName string
RelatedConstituentMiddleName string
RelatedConstituentNameStatusDescription string
RelatedConstituentNameStatusId integer
RelatedConstituentPrefix PrefixSummary
RelatedConstituentShortDisplayName string
RelatedConstituentSortName string
RelatedConstituentSuffix SuffixSummary
RelatedConstituentType ConstituentTypeSummary
Salary decimal number
StartDate date
Title string
{
  "Id": 1,
  "AffiliationType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "UseSalary": true,
    "UseTitle": true,
    "IsIncludedInSearchResultsDefault": true,
    "RelationshipCategory": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "Inactive": true,
  "IsAllowedToTransact": true,
  "IsIncludedInSearchResults": true,
  "StartDate": "2025-04-24T09:36:32.777359-07:00",
  "EndDate": "2025-04-24T09:36:32.777359-07:00",
  "NameIndicator": 1,
  "Note": "sample string 1",
  "Salary": 1.0,
  "Title": "sample string 2",
  "PrimaryIndicator": true,
  "EditIndicator": true,
  "ConstituentId": 5,
  "RelatedConstituentId": 1,
  "RelatedConstituentInactive": true,
  "RelatedConstituentLastName": "sample string 7",
  "RelatedConstituentShortDisplayName": "sample string 8",
  "RelatedConstituentMiddleName": "sample string 9",
  "RelatedConstituentFirstName": "sample string 10",
  "RelatedConstituentNameStatusId": 11,
  "RelatedConstituentNameStatusDescription": "sample string 12",
  "RelatedConstituentPrefix": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "RelatedConstituentSuffix": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "RelatedConstituentGender": {
    "Id": 1,
    "Description": "sample string 1",
    "ShortDescription": "sample string 2",
    "Inactive": true
  },
  "RelatedConstituentSortName": "sample string 13",
  "RelatedConstituentType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "ConstituentGroup": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "Rank": 1,
  "ProtectionType": {
    "Id": 1,
    "Description": "sample string 1"
  }
}
<AffiliationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AffiliationType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <IsIncludedInSearchResultsDefault>true</IsIncludedInSearchResultsDefault>
    <RelationshipCategory>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </RelationshipCategory>
    <UseSalary>true</UseSalary>
    <UseTitle>true</UseTitle>
  </AffiliationType>
  <ConstituentId>5</ConstituentId>
  <EditIndicator>true</EditIndicator>
  <EndDate>2025-04-24T09:36:32.777359-07:00</EndDate>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IsAllowedToTransact>true</IsAllowedToTransact>
  <IsIncludedInSearchResults>true</IsIncludedInSearchResults>
  <NameIndicator>1</NameIndicator>
  <Note>sample string 1</Note>
  <PrimaryIndicator>true</PrimaryIndicator>
  <ProtectionType>
    <Description>sample string 1</Description>
    <Id>1</Id>
  </ProtectionType>
  <Rank>1</Rank>
  <RelatedConstituentFirstName>sample string 10</RelatedConstituentFirstName>
  <RelatedConstituentGender>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <ShortDescription>sample string 2</ShortDescription>
  </RelatedConstituentGender>
  <RelatedConstituentId>1</RelatedConstituentId>
  <RelatedConstituentInactive>true</RelatedConstituentInactive>
  <RelatedConstituentLastName>sample string 7</RelatedConstituentLastName>
  <RelatedConstituentMiddleName>sample string 9</RelatedConstituentMiddleName>
  <RelatedConstituentNameStatusDescription>sample string 12</RelatedConstituentNameStatusDescription>
  <RelatedConstituentNameStatusId>11</RelatedConstituentNameStatusId>
  <RelatedConstituentPrefix>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </RelatedConstituentPrefix>
  <RelatedConstituentShortDisplayName>sample string 8</RelatedConstituentShortDisplayName>
  <RelatedConstituentSortName>sample string 13</RelatedConstituentSortName>
  <RelatedConstituentSuffix>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </RelatedConstituentSuffix>
  <RelatedConstituentType>
    <ConstituentGroup>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </ConstituentGroup>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </RelatedConstituentType>
  <Salary>1</Salary>
  <StartDate>2025-04-24T09:36:32.777359-07:00</StartDate>
  <Title>sample string 2</Title>
</AffiliationInfo>
Change Version Description Contract Old New
Property Changed 15.1.0 RelatedConstituentGender has changed from String to GenderSummary AffiliationInfo String GenderSummary
Property Added 15.1.0 RelatedConstituentShortDisplayName has been added to AffiliationInfo AffiliationInfo AffiliationInfo.RelatedConstituentShortDisplayName
Property Changed 15.1.0 RelatedConstituentGender has changed from String to GenderSummary AffiliationInfo String GenderSummary
Property Added 15.1.0 RelatedConstituentShortDisplayName has been added to AffiliationInfo AffiliationInfo AffiliationInfo.RelatedConstituentShortDisplayName