Addresses Test
CRM/Addresses
Create a new address for a Constituent by sending an XML or JSON representation of an Address object using HTTP POST.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Addresses

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : Address

Request object type Address has the following properties.
Property Name Data Type Length Required Readonly Notes
AddressType AddressTypeSummary Y Categorizing of address along business requirements or address use.
FK: TR_ADDRESS_TYPE.id   Resource: AddressTypes
AffiliatedConstituent Entity N Constituent which is linked to this address through an Affiliation.
AltSalutationType SalutationTypeSummary N Overriding salutation type to be used when this address is chosen.
FK: TR_SIGNOR.id   Resource: SalutationTypes
City string 30 N Required if Country has city required (ReqCity = true).
Constituent Entity Y Owning constituent of the address. If the constituent is a household, primary affiliates may inherit the address. The constituent will not always be the same as the requesting constituent.
FK: T_CUSTOMER.customer_no   Resource: Constituents
Country CountrySummary N Not required for system default country.
FK: TR_COUNTRY.id   Resource: Countries
CreatedBy string N readonly Auto-assigned
CreatedDateTime date N readonly Auto-assigned
CreateLocation string N readonly Auto-assigned
DeliveryPoint string 8 N
EditIndicator boolean N readonly Readonly property indicating edit rights based on AddressType control group.
EndDate date N Optional date to mark when an address is no longer in use.
GeoArea integer N Optional classification of an address to a geographical region. Backed by a reference DB table TR_GEO_AREA which is user defined.
Id integer N Unique key for Address.Auto-assigned
Inactive boolean Y Inactive addresses are not available for output and cannot be primary for a constituent.
IsFromAffiliation boolean N readonly Indicates that this address is returned because of a constituent's affiliation.Whether address is assigned based on an affiliation.
Label boolean Y Whether this address can be used for Label output.
Months string 12 Y String consisting of 12 'Y' or 'N' characters indicating the availability of this address based on each calendar month, January being position 1 and December being position 12. An address available only for summer months (June, July, August) would be sent as "NNNNNYYYNNNN".
NcoaAction integer N NCOA Processing flag indicating the current action.
NcoaSession integer N NCOA unique session id for utility run.
PostalCode string 10 Y Postal code, zip code, locale code. The usage, format, and edit mask is determined by Country settings.
PostalCodeFormatted string N readonly Formatted postal code based on country formatting.
PrimaryIndicator boolean Y Every constituent who has an address (depending on system default rules) must have a primary address.
StartDate date N The date the address begins being active.
State StateSummary Y State, locale, or province for this address. Usage requirement determined by Country settings.
FK: TR_STATE.id   Resource: States
Street1 string 64 Y Required line for address. Order of Street properties determined by system defaults (ADDRESS_STREET_ORDER).
Street1Address StreetAddress N readonly Street1 parsed into its street and number components. For internal use.
Street2 string 64 N Optional line for address. Order of Street properties determined by system defaults (ADDRESS_STREET_ORDER).
Street3 string 64 N Optional line for address. Order of Street properties determined by system defaults (ADDRESS_STREET_ORDER). Ability to use street3 determined by System Default: ADDRESS_USE_STREET3.
UpdatedBy string N readonly Auto-assigned
UpdatedDateTime date N readonly Auto-assigned 
{
  "Id": 1,
  "AffiliatedConstituent": {
    "Id": 1
  },
  "AltSalutationType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "AddressType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "City": "sample string 1",
  "CreatedDateTime": "2025-04-24T05:03:23.3115008-07:00",
  "CreateLocation": "sample string 2",
  "CreatedBy": "sample string 3",
  "Constituent": {
    "Id": 1
  },
  "DeliveryPoint": "sample string 4",
  "EndDate": "2025-04-24T05:03:23.3115008-07:00",
  "GeoArea": 1,
  "Inactive": true,
  "Label": true,
  "UpdatedDateTime": "2025-04-24T05:03:23.3115008-07:00",
  "UpdatedBy": "sample string 5",
  "Months": "sample string 6",
  "NcoaAction": 1,
  "NcoaSession": 1,
  "PostalCode": "sample string 7",
  "PostalCodeFormatted": "sample string 8",
  "PrimaryIndicator": true,
  "StartDate": "2025-04-24T05:03:23.3115008-07:00",
  "State": {
    "Description": "sample string 1",
    "StateCode": "sample string 2",
    "Id": 1,
    "Inactive": true,
    "Country": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "Street1": "sample string 9",
  "Street1Address": {
    "Number": "sample string 1",
    "Street": "sample string 2"
  },
  "Street2": "sample string 10",
  "Street3": "sample string 11",
  "Country": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "EditIndicator": true,
  "IsFromAffiliation": true
}
<Address xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddressType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </AddressType>
  <AffiliatedConstituent>
    <Id>1</Id>
  </AffiliatedConstituent>
  <AltSalutationType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </AltSalutationType>
  <City>sample string 1</City>
  <Constituent>
    <Id>1</Id>
  </Constituent>
  <Country>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </Country>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedDateTime>2025-04-24T05:03:23.3115008-07:00</CreatedDateTime>
  <DeliveryPoint>sample string 4</DeliveryPoint>
  <EditIndicator>true</EditIndicator>
  <EndDate>2025-04-24T05:03:23.3115008-07:00</EndDate>
  <GeoArea>1</GeoArea>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IsFromAffiliation>true</IsFromAffiliation>
  <Label>true</Label>
  <Months>sample string 6</Months>
  <NcoaAction>1</NcoaAction>
  <NcoaSession>1</NcoaSession>
  <PostalCode>sample string 7</PostalCode>
  <PostalCodeFormatted>sample string 8</PostalCodeFormatted>
  <PrimaryIndicator>true</PrimaryIndicator>
  <StartDate>2025-04-24T05:03:23.3115008-07:00</StartDate>
  <State>
    <Country>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Country>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <StateCode>sample string 2</StateCode>
  </State>
  <Street1>sample string 9</Street1>
  <Street1Address>
    <Number>sample string 1</Number>
    <Street>sample string 2</Street>
  </Street1Address>
  <Street2>sample string 10</Street2>
  <Street3>sample string 11</Street3>
  <UpdatedBy>sample string 5</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:03:23.3115008-07:00</UpdatedDateTime>
</Address>

Response object type : Address

Response object type Address has the following properties.
Property Name Data Type Length Required Readonly Notes
AddressType AddressTypeSummary Y Categorizing of address along business requirements or address use.
FK: TR_ADDRESS_TYPE.id   Resource: AddressTypes
AffiliatedConstituent Entity N Constituent which is linked to this address through an Affiliation.
AltSalutationType SalutationTypeSummary N Overriding salutation type to be used when this address is chosen.
FK: TR_SIGNOR.id   Resource: SalutationTypes
City string 30 N Required if Country has city required (ReqCity = true).
Constituent Entity Y Owning constituent of the address. If the constituent is a household, primary affiliates may inherit the address. The constituent will not always be the same as the requesting constituent.
FK: T_CUSTOMER.customer_no   Resource: Constituents
Country CountrySummary N Not required for system default country.
FK: TR_COUNTRY.id   Resource: Countries
CreatedBy string N readonly Auto-assigned
CreatedDateTime date N readonly Auto-assigned
CreateLocation string N readonly Auto-assigned
DeliveryPoint string 8 N
EditIndicator boolean N readonly Readonly property indicating edit rights based on AddressType control group.
EndDate date N Optional date to mark when an address is no longer in use.
GeoArea integer N Optional classification of an address to a geographical region. Backed by a reference DB table TR_GEO_AREA which is user defined.
Id integer N Unique key for Address.Auto-assigned
Inactive boolean Y Inactive addresses are not available for output and cannot be primary for a constituent.
IsFromAffiliation boolean N readonly Indicates that this address is returned because of a constituent's affiliation.Whether address is assigned based on an affiliation.
Label boolean Y Whether this address can be used for Label output.
Months string 12 Y String consisting of 12 'Y' or 'N' characters indicating the availability of this address based on each calendar month, January being position 1 and December being position 12. An address available only for summer months (June, July, August) would be sent as "NNNNNYYYNNNN".
NcoaAction integer N NCOA Processing flag indicating the current action.
NcoaSession integer N NCOA unique session id for utility run.
PostalCode string 10 Y Postal code, zip code, locale code. The usage, format, and edit mask is determined by Country settings.
PostalCodeFormatted string N readonly Formatted postal code based on country formatting.
PrimaryIndicator boolean Y Every constituent who has an address (depending on system default rules) must have a primary address.
StartDate date N The date the address begins being active.
State StateSummary Y State, locale, or province for this address. Usage requirement determined by Country settings.
FK: TR_STATE.id   Resource: States
Street1 string 64 Y Required line for address. Order of Street properties determined by system defaults (ADDRESS_STREET_ORDER).
Street1Address StreetAddress N readonly Street1 parsed into its street and number components. For internal use.
Street2 string 64 N Optional line for address. Order of Street properties determined by system defaults (ADDRESS_STREET_ORDER).
Street3 string 64 N Optional line for address. Order of Street properties determined by system defaults (ADDRESS_STREET_ORDER). Ability to use street3 determined by System Default: ADDRESS_USE_STREET3.
UpdatedBy string N readonly Auto-assigned
UpdatedDateTime date N readonly Auto-assigned 
{
  "Id": 1,
  "AffiliatedConstituent": {
    "Id": 1
  },
  "AltSalutationType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "AddressType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "City": "sample string 1",
  "CreatedDateTime": "2025-04-24T05:03:23.3115008-07:00",
  "CreateLocation": "sample string 2",
  "CreatedBy": "sample string 3",
  "Constituent": {
    "Id": 1
  },
  "DeliveryPoint": "sample string 4",
  "EndDate": "2025-04-24T05:03:23.3115008-07:00",
  "GeoArea": 1,
  "Inactive": true,
  "Label": true,
  "UpdatedDateTime": "2025-04-24T05:03:23.3115008-07:00",
  "UpdatedBy": "sample string 5",
  "Months": "sample string 6",
  "NcoaAction": 1,
  "NcoaSession": 1,
  "PostalCode": "sample string 7",
  "PostalCodeFormatted": "sample string 8",
  "PrimaryIndicator": true,
  "StartDate": "2025-04-24T05:03:23.3115008-07:00",
  "State": {
    "Description": "sample string 1",
    "StateCode": "sample string 2",
    "Id": 1,
    "Inactive": true,
    "Country": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "Street1": "sample string 9",
  "Street1Address": {
    "Number": "sample string 1",
    "Street": "sample string 2"
  },
  "Street2": "sample string 10",
  "Street3": "sample string 11",
  "Country": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "EditIndicator": true,
  "IsFromAffiliation": true
}
<Address xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AddressType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </AddressType>
  <AffiliatedConstituent>
    <Id>1</Id>
  </AffiliatedConstituent>
  <AltSalutationType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </AltSalutationType>
  <City>sample string 1</City>
  <Constituent>
    <Id>1</Id>
  </Constituent>
  <Country>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </Country>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedDateTime>2025-04-24T05:03:23.3115008-07:00</CreatedDateTime>
  <DeliveryPoint>sample string 4</DeliveryPoint>
  <EditIndicator>true</EditIndicator>
  <EndDate>2025-04-24T05:03:23.3115008-07:00</EndDate>
  <GeoArea>1</GeoArea>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <IsFromAffiliation>true</IsFromAffiliation>
  <Label>true</Label>
  <Months>sample string 6</Months>
  <NcoaAction>1</NcoaAction>
  <NcoaSession>1</NcoaSession>
  <PostalCode>sample string 7</PostalCode>
  <PostalCodeFormatted>sample string 8</PostalCodeFormatted>
  <PrimaryIndicator>true</PrimaryIndicator>
  <StartDate>2025-04-24T05:03:23.3115008-07:00</StartDate>
  <State>
    <Country>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Country>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <StateCode>sample string 2</StateCode>
  </State>
  <Street1>sample string 9</Street1>
  <Street1Address>
    <Number>sample string 1</Number>
    <Street>sample string 2</Street>
  </Street1Address>
  <Street2>sample string 10</Street2>
  <Street3>sample string 11</Street3>
  <UpdatedBy>sample string 5</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:03:23.3115008-07:00</UpdatedDateTime>
</Address>
Change Version Description Contract Old New
Property Added 15.2.41 Street1Address has been added to Address Address Address.Street1Address
Property Added 15.2.41 Street1Address has been added to Address Address Address.Street1Address