ContactPointPurposeMaps Test
CRM/ContactPointPurposeMaps?constituentId={constituentId}&includeAffiliations={includeAffiliations}&contactPointId={contactPointId}&contactPointCategoryId={contactPointCategoryId}&purposeId={purposeId}
Get details of all the contact point purposes for the specified constituent (constituentId) and all its visible affiliation's contact point purposes as well. To exclude contact point purposes of the visible affiliations pass includeAffiliations=false. To get contact point purposes for a contact point pass contactPointId.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/ContactPointPurposeMaps?constituentId={constituentId}&includeAffiliations={includeAffiliations}&contactPointId={contactPointId}&contactPointCategoryId={contactPointCategoryId}&purposeId={purposeId}

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).
contactPointId integer N
contactPointCategoryId integer N
purposeId integer N

Request Body

None.
No request body.

Response object type : Collection of ContactPointPurposeMap

Response object type Collection of ContactPointPurposeMap has the following properties.
Property Name Data Type Length Required Readonly Notes
ContactPoint ContactPoint
ContactPointCategory ContactPointCategorySummary N
FK: TR_CONTACT_POINT_CATEGORY.id   Resource: ContactPointCategories
CreatedBy string N
CreatedDateTime date N
CreateLocation string N
EditIndicator boolean
Id integer N
Purpose ContactPointPurposeSummary N
FK: TR_CONTACT_POINT_PURPOSE.id   Resource: ContactPointPurposes
UpdatedBy string N
UpdatedDateTime date N 
[
  {
    "CreatedDateTime": "2025-04-24T09:41:52.6220285-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "ContactPoint": {
      "Id": 1,
      "ConstituentId": 1,
      "ContactPointCategoryId": 2,
      "Type": {
        "Id": 1,
        "Description": "sample string 2"
      },
      "Address": {
        "Id": 1,
        "Street1": "sample string 1",
        "Street2": "sample string 2",
        "Street3": "sample string 3",
        "City": "sample string 4",
        "StateCode": "sample string 5",
        "PostalCode": "sample string 6",
        "CountryId": 1,
        "Inactive": true
      },
      "Phone": {
        "Id": 1,
        "AddressId": 1,
        "PhoneNumber": "sample string 1"
      },
      "ElectronicAddress": {
        "Id": 1,
        "ElectronicAddress": "sample string 1",
        "Inactive": true
      }
    },
    "Id": 1,
    "EditIndicator": true,
    "UpdatedDateTime": "2025-04-24T09:41:52.6220285-07:00",
    "UpdatedBy": "sample string 4",
    "ContactPointCategory": {
      "Id": 1,
      "Description": "sample string 1"
    },
    "Purpose": {
      "Id": 1,
      "Description": "sample string 1",
      "PurposeCategory": {
        "Id": 1,
        "Description": "sample string 1",
        "Inactive": true
      },
      "Inactive": true
    }
  },
  {
    "CreatedDateTime": "2025-04-24T09:41:52.6220285-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "ContactPoint": {
      "Id": 1,
      "ConstituentId": 1,
      "ContactPointCategoryId": 2,
      "Type": {
        "Id": 1,
        "Description": "sample string 2"
      },
      "Address": {
        "Id": 1,
        "Street1": "sample string 1",
        "Street2": "sample string 2",
        "Street3": "sample string 3",
        "City": "sample string 4",
        "StateCode": "sample string 5",
        "PostalCode": "sample string 6",
        "CountryId": 1,
        "Inactive": true
      },
      "Phone": {
        "Id": 1,
        "AddressId": 1,
        "PhoneNumber": "sample string 1"
      },
      "ElectronicAddress": {
        "Id": 1,
        "ElectronicAddress": "sample string 1",
        "Inactive": true
      }
    },
    "Id": 1,
    "EditIndicator": true,
    "UpdatedDateTime": "2025-04-24T09:41:52.6220285-07:00",
    "UpdatedBy": "sample string 4",
    "ContactPointCategory": {
      "Id": 1,
      "Description": "sample string 1"
    },
    "Purpose": {
      "Id": 1,
      "Description": "sample string 1",
      "PurposeCategory": {
        "Id": 1,
        "Description": "sample string 1",
        "Inactive": true
      },
      "Inactive": true
    }
  }
]
<ContactPointPurposeMaps xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ContactPointPurposeMap>
    <ContactPoint>
      <Address>
        <City>sample string 4</City>
        <CountryId>1</CountryId>
        <Id>1</Id>
        <Inactive>true</Inactive>
        <PostalCode>sample string 6</PostalCode>
        <StateCode>sample string 5</StateCode>
        <Street1>sample string 1</Street1>
        <Street2>sample string 2</Street2>
        <Street3>sample string 3</Street3>
      </Address>
      <ConstituentId>1</ConstituentId>
      <ContactPointCategoryId>2</ContactPointCategoryId>
      <ElectronicAddress>
        <ElectronicAddress>sample string 1</ElectronicAddress>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </ElectronicAddress>
      <Id>1</Id>
      <Phone>
        <AddressId>1</AddressId>
        <Id>1</Id>
        <PhoneNumber>sample string 1</PhoneNumber>
      </Phone>
      <Type>
        <Description>sample string 2</Description>
        <Id>1</Id>
      </Type>
    </ContactPoint>
    <ContactPointCategory>
      <Description>sample string 1</Description>
      <Id>1</Id>
    </ContactPointCategory>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T09:41:52.6220285-07:00</CreatedDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <Purpose>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <PurposeCategory>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </PurposeCategory>
    </Purpose>
    <UpdatedBy>sample string 4</UpdatedBy>
    <UpdatedDateTime>2025-04-24T09:41:52.6220285-07:00</UpdatedDateTime>
  </ContactPointPurposeMap>
  <ContactPointPurposeMap>
    <ContactPoint>
      <Address>
        <City>sample string 4</City>
        <CountryId>1</CountryId>
        <Id>1</Id>
        <Inactive>true</Inactive>
        <PostalCode>sample string 6</PostalCode>
        <StateCode>sample string 5</StateCode>
        <Street1>sample string 1</Street1>
        <Street2>sample string 2</Street2>
        <Street3>sample string 3</Street3>
      </Address>
      <ConstituentId>1</ConstituentId>
      <ContactPointCategoryId>2</ContactPointCategoryId>
      <ElectronicAddress>
        <ElectronicAddress>sample string 1</ElectronicAddress>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </ElectronicAddress>
      <Id>1</Id>
      <Phone>
        <AddressId>1</AddressId>
        <Id>1</Id>
        <PhoneNumber>sample string 1</PhoneNumber>
      </Phone>
      <Type>
        <Description>sample string 2</Description>
        <Id>1</Id>
      </Type>
    </ContactPoint>
    <ContactPointCategory>
      <Description>sample string 1</Description>
      <Id>1</Id>
    </ContactPointCategory>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T09:41:52.6220285-07:00</CreatedDateTime>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <Purpose>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <PurposeCategory>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </PurposeCategory>
    </Purpose>
    <UpdatedBy>sample string 4</UpdatedBy>
    <UpdatedDateTime>2025-04-24T09:41:52.6220285-07:00</UpdatedDateTime>
  </ContactPointPurposeMap>
</ContactPointPurposeMaps>
Change Version Description Contract Old New
Parameter Changed 15.0.0 constituentId has been marked as required. Required