Affiliations Test
CRM/Affiliations/{affiliationId}
Update an affiliation.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Affiliations/{affiliationId}

URI Parameters

Parameter Name Data Type Required Notes
affiliationId integer Y

Request Body

Request object type : Affiliation

Request object type Affiliation has the following properties.
Property Name Data Type Length Required Readonly Notes
AddressId integer N
FK: T_ADDRESS.address_no   Resource: Addresses
AffiliatedName string 55 N
AffiliationType AffiliationTypeSummary Y
FK: TR_AFFILIATION_TYPE.id   Resource: AffiliationTypes
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
EditIndicator boolean
ElectronicAddressId integer N
FK: T_EADDRESS.eaddress_no   Resource: ElectronicAddresses
EndDate date N
FK: T_CUSTOMER.customer_no   Resource: Constituents
GroupConstituent Entity
GroupConstituentName string Y
GroupConstituentSortName string Y
Id integer Y Non-updatable
Inactive boolean N
FK: T_CUSTOMER.customer_no   Resource: Constituents
IndividualConstituent Entity
IndividualConstituentName string Y
IndividualConstituentSortName string Y
IsAllowedToTransact (DEPRECATED) boolean N Obsolete: This property is unused and can be ignored.
IsIncludedInSearchResults boolean Y
NameIndicator integer N
Note string 1024 N
PrimaryIndicator boolean Y
Salary decimal number N
SalutationId integer N
FK: TX_CUST_SAL.salutation_no   Resource: Salutations
StartDate date N
Title string 50 N
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned 
{
  "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
    }
  },
  "AffiliatedName": "sample string 1",
  "CreatedDateTime": "2025-04-24T05:25:30.3739322-07:00",
  "CreatedBy": "sample string 2",
  "EndDate": "2025-04-24T05:25:30.3739322-07:00",
  "GroupConstituent": {
    "Id": 1
  },
  "Inactive": true,
  "IndividualConstituent": {
    "Id": 1
  },
  "IsAllowedToTransact": true,
  "IsIncludedInSearchResults": true,
  "UpdatedBy": "sample string 3",
  "UpdatedDateTime": "2025-04-24T05:25:30.3739322-07:00",
  "CreateLocation": "sample string 4",
  "Note": "sample string 5",
  "IndividualConstituentName": "sample string 6",
  "GroupConstituentName": "sample string 7",
  "IndividualConstituentSortName": "sample string 8",
  "GroupConstituentSortName": "sample string 9",
  "Salary": 1.0,
  "StartDate": "2025-04-24T05:25:30.3739322-07:00",
  "Title": "sample string 10",
  "PrimaryIndicator": true,
  "EditIndicator": true,
  "NameIndicator": 1,
  "AddressId": 1,
  "ElectronicAddressId": 1,
  "SalutationId": 1
}
<Affiliation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddressId>1</AddressId>
  <AffiliatedName>sample string 1</AffiliatedName>
  <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>
  <CreateLocation>sample string 4</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T05:25:30.3739322-07:00</CreatedDateTime>
  <EditIndicator>true</EditIndicator>
  <ElectronicAddressId>1</ElectronicAddressId>
  <EndDate>2025-04-24T05:25:30.3739322-07:00</EndDate>
  <GroupConstituent>
    <Id>1</Id>
  </GroupConstituent>
  <GroupConstituentName>sample string 7</GroupConstituentName>
  <GroupConstituentSortName>sample string 9</GroupConstituentSortName>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IndividualConstituent>
    <Id>1</Id>
  </IndividualConstituent>
  <IndividualConstituentName>sample string 6</IndividualConstituentName>
  <IndividualConstituentSortName>sample string 8</IndividualConstituentSortName>
  <IsAllowedToTransact>true</IsAllowedToTransact>
  <IsIncludedInSearchResults>true</IsIncludedInSearchResults>
  <NameIndicator>1</NameIndicator>
  <Note>sample string 5</Note>
  <PrimaryIndicator>true</PrimaryIndicator>
  <Salary>1</Salary>
  <SalutationId>1</SalutationId>
  <StartDate>2025-04-24T05:25:30.3739322-07:00</StartDate>
  <Title>sample string 10</Title>
  <UpdatedBy>sample string 3</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:25:30.3739322-07:00</UpdatedDateTime>
</Affiliation>

Response object type : Affiliation

Response object type Affiliation has the following properties.
Property Name Data Type Length Required Readonly Notes
AddressId integer N
FK: T_ADDRESS.address_no   Resource: Addresses
AffiliatedName string 55 N
AffiliationType AffiliationTypeSummary Y
FK: TR_AFFILIATION_TYPE.id   Resource: AffiliationTypes
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
EditIndicator boolean
ElectronicAddressId integer N
FK: T_EADDRESS.eaddress_no   Resource: ElectronicAddresses
EndDate date N
FK: T_CUSTOMER.customer_no   Resource: Constituents
GroupConstituent Entity
GroupConstituentName string Y
GroupConstituentSortName string Y
Id integer Y Non-updatable
Inactive boolean N
FK: T_CUSTOMER.customer_no   Resource: Constituents
IndividualConstituent Entity
IndividualConstituentName string Y
IndividualConstituentSortName string Y
IsAllowedToTransact (DEPRECATED) boolean N Obsolete: This property is unused and can be ignored.
IsIncludedInSearchResults boolean Y
NameIndicator integer N
Note string 1024 N
PrimaryIndicator boolean Y
Salary decimal number N
SalutationId integer N
FK: TX_CUST_SAL.salutation_no   Resource: Salutations
StartDate date N
Title string 50 N
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned 
{
  "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
    }
  },
  "AffiliatedName": "sample string 1",
  "CreatedDateTime": "2025-04-24T05:25:30.3739322-07:00",
  "CreatedBy": "sample string 2",
  "EndDate": "2025-04-24T05:25:30.3739322-07:00",
  "GroupConstituent": {
    "Id": 1
  },
  "Inactive": true,
  "IndividualConstituent": {
    "Id": 1
  },
  "IsAllowedToTransact": true,
  "IsIncludedInSearchResults": true,
  "UpdatedBy": "sample string 3",
  "UpdatedDateTime": "2025-04-24T05:25:30.3739322-07:00",
  "CreateLocation": "sample string 4",
  "Note": "sample string 5",
  "IndividualConstituentName": "sample string 6",
  "GroupConstituentName": "sample string 7",
  "IndividualConstituentSortName": "sample string 8",
  "GroupConstituentSortName": "sample string 9",
  "Salary": 1.0,
  "StartDate": "2025-04-24T05:25:30.3739322-07:00",
  "Title": "sample string 10",
  "PrimaryIndicator": true,
  "EditIndicator": true,
  "NameIndicator": 1,
  "AddressId": 1,
  "ElectronicAddressId": 1,
  "SalutationId": 1
}
<Affiliation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddressId>1</AddressId>
  <AffiliatedName>sample string 1</AffiliatedName>
  <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>
  <CreateLocation>sample string 4</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T05:25:30.3739322-07:00</CreatedDateTime>
  <EditIndicator>true</EditIndicator>
  <ElectronicAddressId>1</ElectronicAddressId>
  <EndDate>2025-04-24T05:25:30.3739322-07:00</EndDate>
  <GroupConstituent>
    <Id>1</Id>
  </GroupConstituent>
  <GroupConstituentName>sample string 7</GroupConstituentName>
  <GroupConstituentSortName>sample string 9</GroupConstituentSortName>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IndividualConstituent>
    <Id>1</Id>
  </IndividualConstituent>
  <IndividualConstituentName>sample string 6</IndividualConstituentName>
  <IndividualConstituentSortName>sample string 8</IndividualConstituentSortName>
  <IsAllowedToTransact>true</IsAllowedToTransact>
  <IsIncludedInSearchResults>true</IsIncludedInSearchResults>
  <NameIndicator>1</NameIndicator>
  <Note>sample string 5</Note>
  <PrimaryIndicator>true</PrimaryIndicator>
  <Salary>1</Salary>
  <SalutationId>1</SalutationId>
  <StartDate>2025-04-24T05:25:30.3739322-07:00</StartDate>
  <Title>sample string 10</Title>
  <UpdatedBy>sample string 3</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:25:30.3739322-07:00</UpdatedDateTime>
</Affiliation>
Change Version Description Contract Old New
Property Added 15.1.0 GroupConstituentSortName has been added to Affiliation Affiliation Affiliation.GroupConstituentSortName
Property Added 15.1.0 IndividualConstituentSortName has been added to Affiliation Affiliation Affiliation.IndividualConstituentSortName
Property Added 15.1.0 GroupConstituentSortName has been added to Affiliation Affiliation Affiliation.GroupConstituentSortName
Property Added 15.1.0 IndividualConstituentSortName has been added to Affiliation Affiliation Affiliation.IndividualConstituentSortName
Property Deprecated 15.0.0 IsAllowedToTransact has been marked as deprecated. Affiliation Deprecated
Parameter Changed 15.0.0 affiliationId has been marked as required. Required
Property Deprecated 15.0.0 IsAllowedToTransact has been marked as deprecated. Affiliation Deprecated