ConstituentTypes Test
ReferenceData/ConstituentTypes
Create a new constituent type.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/ReferenceData/ConstituentTypes

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : ConstituentType

Request object type ConstituentType has the following properties.
Property Name Data Type Length Required Readonly Notes
AddressTypeId integer Y
FK: TR_ADDRESS_TYPE.id   Resource: AddressTypes
ConstituentGroup ConstituentGroupSummary Y
FK: TR_CUST_GROUP.id   Resource: ConstituentGroups
CreatedBy string N Auto-assigned
CreatedDateTime date N Auto-assigned
CreateLocation string N Auto-assigned
DefaultAffiliatedConstituentTypeId integer N
FK: TR_CUST_TYPE.id   Resource: ConstituentTypes
DefaultAffiliationTypeId integer N
FK: TR_AFFILIATION_TYPE.id   Resource: AffiliationTypes
DefaultIndicator boolean N
DefaultSalutationId integer Y
FK: TR_SALUTATION_FORMAT.id
Description string Y
ElectronicAddressTypeId integer Y
FK: TR_EADDRESS_TYPE.id   Resource: ElectronicAddressTypes
GiftAidIndicator boolean Y Indicates constituents of this type can be eligible for gift aid payments. (UK only feature)
Id integer N Auto-assigned
Inactive boolean Y
LoginTypeId integer N
FK: TR_LOGIN_TYPE.id   Resource: LoginTypes
UpdatedBy string N Auto-assigned
UpdatedDateTime date N Auto-assigned
{
  "AddressTypeId": 1,
  "CreatedDateTime": "2025-04-24T04:15:35.6240631-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "ConstituentGroup": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "DefaultIndicator": true,
  "DefaultSalutationId": 1,
  "DefaultAffiliatedConstituentTypeId": 1,
  "DefaultAffiliationTypeId": 1,
  "Description": "sample string 3",
  "ElectronicAddressTypeId": 1,
  "GiftAidIndicator": true,
  "Id": 1,
  "Inactive": true,
  "UpdatedDateTime": "2025-04-24T04:15:35.6240631-07:00",
  "UpdatedBy": "sample string 6",
  "LoginTypeId": 1
}
<ConstituentType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddressTypeId>1</AddressTypeId>
  <ConstituentGroup>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </ConstituentGroup>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T04:15:35.6240631-07:00</CreatedDateTime>
  <DefaultAffiliatedConstituentTypeId>1</DefaultAffiliatedConstituentTypeId>
  <DefaultAffiliationTypeId>1</DefaultAffiliationTypeId>
  <DefaultIndicator>true</DefaultIndicator>
  <DefaultSalutationId>1</DefaultSalutationId>
  <Description>sample string 3</Description>
  <ElectronicAddressTypeId>1</ElectronicAddressTypeId>
  <GiftAidIndicator>true</GiftAidIndicator>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <LoginTypeId>1</LoginTypeId>
  <UpdatedBy>sample string 6</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:15:35.6240631-07:00</UpdatedDateTime>
</ConstituentType>

Response object type : ConstituentType

Response object type ConstituentType has the following properties.
Property Name Data Type Length Required Readonly Notes
AddressTypeId integer Y
FK: TR_ADDRESS_TYPE.id   Resource: AddressTypes
ConstituentGroup ConstituentGroupSummary Y
FK: TR_CUST_GROUP.id   Resource: ConstituentGroups
CreatedBy string N Auto-assigned
CreatedDateTime date N Auto-assigned
CreateLocation string N Auto-assigned
DefaultAffiliatedConstituentTypeId integer N
FK: TR_CUST_TYPE.id   Resource: ConstituentTypes
DefaultAffiliationTypeId integer N
FK: TR_AFFILIATION_TYPE.id   Resource: AffiliationTypes
DefaultIndicator boolean N
DefaultSalutationId integer Y
FK: TR_SALUTATION_FORMAT.id
Description string Y
ElectronicAddressTypeId integer Y
FK: TR_EADDRESS_TYPE.id   Resource: ElectronicAddressTypes
GiftAidIndicator boolean Y Indicates constituents of this type can be eligible for gift aid payments. (UK only feature)
Id integer N Auto-assigned
Inactive boolean Y
LoginTypeId integer N
FK: TR_LOGIN_TYPE.id   Resource: LoginTypes
UpdatedBy string N Auto-assigned
UpdatedDateTime date N Auto-assigned
{
  "AddressTypeId": 1,
  "CreatedDateTime": "2025-04-24T04:15:35.6240631-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "ConstituentGroup": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "DefaultIndicator": true,
  "DefaultSalutationId": 1,
  "DefaultAffiliatedConstituentTypeId": 1,
  "DefaultAffiliationTypeId": 1,
  "Description": "sample string 3",
  "ElectronicAddressTypeId": 1,
  "GiftAidIndicator": true,
  "Id": 1,
  "Inactive": true,
  "UpdatedDateTime": "2025-04-24T04:15:35.6240631-07:00",
  "UpdatedBy": "sample string 6",
  "LoginTypeId": 1
}
<ConstituentType xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddressTypeId>1</AddressTypeId>
  <ConstituentGroup>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </ConstituentGroup>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T04:15:35.6240631-07:00</CreatedDateTime>
  <DefaultAffiliatedConstituentTypeId>1</DefaultAffiliatedConstituentTypeId>
  <DefaultAffiliationTypeId>1</DefaultAffiliationTypeId>
  <DefaultIndicator>true</DefaultIndicator>
  <DefaultSalutationId>1</DefaultSalutationId>
  <Description>sample string 3</Description>
  <ElectronicAddressTypeId>1</ElectronicAddressTypeId>
  <GiftAidIndicator>true</GiftAidIndicator>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <LoginTypeId>1</LoginTypeId>
  <UpdatedBy>sample string 6</UpdatedBy>
  <UpdatedDateTime>2025-04-24T04:15:35.6240631-07:00</UpdatedDateTime>
</ConstituentType>

No entries in change log for this operation.