Rankings Test
CRM/Rankings?constituentId={constituentId}&includeAffiliations={includeAffiliations}
Get details of all the rankings for the specified constituent id and all its visible affiliation's rankings as well. To exclude rankings of the visible affiliations pass includeAffiliations=false. To Get The primary rankings alone, pass primaryOnly=true.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Rankings?constituentId={constituentId}&includeAffiliations={includeAffiliations}

URI Parameters

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

Request Body

None.
No request body.

Response object type : Collection of Ranking

Response object type Collection of Ranking has the following properties.
Property Name Data Type Length Required Readonly Notes
Constituent Entity N
CreatedBy string N
CreatedDateTime date N
CreateLocation string N
EditIndicator boolean
Id integer N
Rank integer N
RankType RankTypeSummary N
UpdatedBy string N
UpdatedDateTime date N 
[
  {
    "Id": 1,
    "CreatedDateTime": "2025-04-24T05:19:00.3337482-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "UpdatedDateTime": "2025-04-24T05:19:00.3337482-07:00",
    "UpdatedBy": "sample string 3",
    "Constituent": {
      "Id": 1
    },
    "RankType": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true,
      "ControlGroup": {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      }
    },
    "Rank": 1,
    "EditIndicator": true
  },
  {
    "Id": 1,
    "CreatedDateTime": "2025-04-24T05:19:00.3337482-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "UpdatedDateTime": "2025-04-24T05:19:00.3337482-07:00",
    "UpdatedBy": "sample string 3",
    "Constituent": {
      "Id": 1
    },
    "RankType": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true,
      "ControlGroup": {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      }
    },
    "Rank": 1,
    "EditIndicator": true
  }
]
<Rankings xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Ranking>
    <Constituent>
      <Id>1</Id>
    </Constituent>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T05:19:00.3337482-07:00</CreatedDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <Rank>1</Rank>
    <RankType>
      <ControlGroup>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </ControlGroup>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </RankType>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:19:00.3337482-07:00</UpdatedDateTime>
  </Ranking>
  <Ranking>
    <Constituent>
      <Id>1</Id>
    </Constituent>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T05:19:00.3337482-07:00</CreatedDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <Rank>1</Rank>
    <RankType>
      <ControlGroup>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </ControlGroup>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </RankType>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:19:00.3337482-07:00</UpdatedDateTime>
  </Ranking>
</Rankings>
Change Version Description Contract Old New
Parameter Changed 15.0.0 constituentId has been marked as required. Required