Relationships Test
CRM/Relationships?constituentId={constituentId}&associatedConstituentId={associatedConstituentId}&includeAffiliations={includeAffiliations}&startActiveDate={startActiveDate}&endActiveDate={endActiveDate}&activeOnly={activeOnly}
Get all affiliations and associations of the specified constituent id or get all affiliations and associations of the specified associated constituent id. If both are specified get all the associations and affiliations between them.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Relationships?constituentId={constituentId}&associatedConstituentId={associatedConstituentId}&includeAffiliations={includeAffiliations}&startActiveDate={startActiveDate}&endActiveDate={endActiveDate}&activeOnly={activeOnly}

URI Parameters

Parameter Name Data Type Required Notes
constituentId integer Y Limit results by constituent.
associatedConstituentId integer N
includeAffiliations boolean N Include all of the constituent's affiliates in the results (default: true).
startActiveDate date N
endActiveDate date N
activeOnly boolean N

Request Body

None.

No request body.

Response object type : Collection of Relationship

Response object type Collection of Relationship has the following properties.
Property Name Data Type Length Required Readonly Notes
AssociatedConstituentId integer N
AssociatedConstituentName string N
AssociatedConstituentSortName string N
BirthDate date N
ConstituentId integer
CreatedBy string N
CreatedDateTime date N
CreateLocation string
EndDate date N
GenderId integer N
Id integer
Inactive boolean N
IsAllowedToTransact boolean N
IsEditable boolean N
IsIncludedInSearchResults boolean N
NameIndicator integer N
Note string N
PrimaryIndicator boolean N
Rank integer N
ReciprocalRelationshipId integer N
RelationshipCategoryDescription string N
RelationshipCategoryId integer N
RelationshipContext string N
RelationshipTypeDescription string N
RelationshipTypeId integer N
Salary decimal number N
StartDate date N
Title string N
UpdatedBy string N
UpdatedDateTime date N
[
  {
    "AssociatedConstituentName": "sample string 1",
    "AssociatedConstituentId": 2,
    "AssociatedConstituentSortName": "sample string 3",
    "CreatedDateTime": "2025-04-24T09:41:55.9057256-07:00",
    "CreatedBy": "sample string 4",
    "ConstituentId": 5,
    "EndDate": "2025-04-24T09:41:55.9057256-07:00",
    "Inactive": true,
    "IsAllowedToTransact": true,
    "IsIncludedInSearchResults": true,
    "UpdatedBy": "sample string 6",
    "CreateLocation": "sample string 7",
    "UpdatedDateTime": "2025-04-24T09:41:55.9057256-07:00",
    "Note": "sample string 8",
    "PrimaryIndicator": true,
    "RelationshipCategoryDescription": "sample string 10",
    "RelationshipCategoryId": 11,
    "RelationshipContext": "sample string 12",
    "Id": 1,
    "RelationshipTypeDescription": "sample string 13",
    "RelationshipTypeId": 14,
    "ReciprocalRelationshipId": 15,
    "StartDate": "2025-04-24T09:41:55.9057256-07:00",
    "Salary": 1.0,
    "Title": "sample string 16",
    "BirthDate": "2025-04-24T09:41:55.9057256-07:00",
    "GenderId": 1,
    "IsEditable": true,
    "NameIndicator": 1,
    "Rank": 17
  },
  {
    "AssociatedConstituentName": "sample string 1",
    "AssociatedConstituentId": 2,
    "AssociatedConstituentSortName": "sample string 3",
    "CreatedDateTime": "2025-04-24T09:41:55.9057256-07:00",
    "CreatedBy": "sample string 4",
    "ConstituentId": 5,
    "EndDate": "2025-04-24T09:41:55.9057256-07:00",
    "Inactive": true,
    "IsAllowedToTransact": true,
    "IsIncludedInSearchResults": true,
    "UpdatedBy": "sample string 6",
    "CreateLocation": "sample string 7",
    "UpdatedDateTime": "2025-04-24T09:41:55.9057256-07:00",
    "Note": "sample string 8",
    "PrimaryIndicator": true,
    "RelationshipCategoryDescription": "sample string 10",
    "RelationshipCategoryId": 11,
    "RelationshipContext": "sample string 12",
    "Id": 1,
    "RelationshipTypeDescription": "sample string 13",
    "RelationshipTypeId": 14,
    "ReciprocalRelationshipId": 15,
    "StartDate": "2025-04-24T09:41:55.9057256-07:00",
    "Salary": 1.0,
    "Title": "sample string 16",
    "BirthDate": "2025-04-24T09:41:55.9057256-07:00",
    "GenderId": 1,
    "IsEditable": true,
    "NameIndicator": 1,
    "Rank": 17
  }
]
<Relationships xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Relationship>
    <AssociatedConstituentId>2</AssociatedConstituentId>
    <AssociatedConstituentName>sample string 1</AssociatedConstituentName>
    <AssociatedConstituentSortName>sample string 3</AssociatedConstituentSortName>
    <BirthDate>2025-04-24T09:41:55.9057256-07:00</BirthDate>
    <ConstituentId>5</ConstituentId>
    <CreateLocation>sample string 7</CreateLocation>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDateTime>2025-04-24T09:41:55.9057256-07:00</CreatedDateTime>
    <EndDate>2025-04-24T09:41:55.9057256-07:00</EndDate>
    <GenderId>1</GenderId>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <IsAllowedToTransact>true</IsAllowedToTransact>
    <IsEditable>true</IsEditable>
    <IsIncludedInSearchResults>true</IsIncludedInSearchResults>
    <NameIndicator>1</NameIndicator>
    <Note>sample string 8</Note>
    <PrimaryIndicator>true</PrimaryIndicator>
    <Rank>17</Rank>
    <ReciprocalRelationshipId>15</ReciprocalRelationshipId>
    <RelationshipCategoryDescription>sample string 10</RelationshipCategoryDescription>
    <RelationshipCategoryId>11</RelationshipCategoryId>
    <RelationshipContext>sample string 12</RelationshipContext>
    <RelationshipTypeDescription>sample string 13</RelationshipTypeDescription>
    <RelationshipTypeId>14</RelationshipTypeId>
    <Salary>1</Salary>
    <StartDate>2025-04-24T09:41:55.9057256-07:00</StartDate>
    <Title>sample string 16</Title>
    <UpdatedBy>sample string 6</UpdatedBy>
    <UpdatedDateTime>2025-04-24T09:41:55.9057256-07:00</UpdatedDateTime>
  </Relationship>
  <Relationship>
    <AssociatedConstituentId>2</AssociatedConstituentId>
    <AssociatedConstituentName>sample string 1</AssociatedConstituentName>
    <AssociatedConstituentSortName>sample string 3</AssociatedConstituentSortName>
    <BirthDate>2025-04-24T09:41:55.9057256-07:00</BirthDate>
    <ConstituentId>5</ConstituentId>
    <CreateLocation>sample string 7</CreateLocation>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDateTime>2025-04-24T09:41:55.9057256-07:00</CreatedDateTime>
    <EndDate>2025-04-24T09:41:55.9057256-07:00</EndDate>
    <GenderId>1</GenderId>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <IsAllowedToTransact>true</IsAllowedToTransact>
    <IsEditable>true</IsEditable>
    <IsIncludedInSearchResults>true</IsIncludedInSearchResults>
    <NameIndicator>1</NameIndicator>
    <Note>sample string 8</Note>
    <PrimaryIndicator>true</PrimaryIndicator>
    <Rank>17</Rank>
    <ReciprocalRelationshipId>15</ReciprocalRelationshipId>
    <RelationshipCategoryDescription>sample string 10</RelationshipCategoryDescription>
    <RelationshipCategoryId>11</RelationshipCategoryId>
    <RelationshipContext>sample string 12</RelationshipContext>
    <RelationshipTypeDescription>sample string 13</RelationshipTypeDescription>
    <RelationshipTypeId>14</RelationshipTypeId>
    <Salary>1</Salary>
    <StartDate>2025-04-24T09:41:55.9057256-07:00</StartDate>
    <Title>sample string 16</Title>
    <UpdatedBy>sample string 6</UpdatedBy>
    <UpdatedDateTime>2025-04-24T09:41:55.9057256-07:00</UpdatedDateTime>
  </Relationship>
</Relationships>
Change Version Description Contract Old New
Property Removed 15.1.0 Gender has been removed from Relationship Relationship Gender
Property Added 15.1.0 GenderId has been added to Relationship Relationship Relationship.GenderId
Parameter Changed 15.0.0 constituentId has been marked as required. Required