Upsert Constituent Message

The "UpsertConstituent" message is sent from the Global Partner (GP) to the Global Ministry Center (GMC).

The "UpsertConstituent" message will act as an insert to the GMC Source System database if the constituent does not exist. If the constituent exists in the GMC Source System database, the "UpsertConstituent" message will act as an update to the constituent.

Once the sent "UpsertConstituent" message has been processed by the GMC, a corresponding "ConstituentUpserted" message will eventually be returned to the GP from the GMC. This is an asynchronous process).

Sample Message
Parameters
Error Messages

Sample Message

This is an example only.

    <EsbEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                 xmlns="http://schemas.ci.org/ci/messaging/common/2011/04/">

    <EsbHeader>
      <SendersName>[string]</SendersName>
        <SendersAppName>[string]</SendersAppName>
        <SendersTrackingId>[GUID]</SendersTrackingId>
        <ToAddress>[string]</ToAddress>
        <FromAddress>[string]</FromAddress>
        <MessageType schemaLocation=
"http://schemas.ci.org/ci/messaging/compass/2013/02/CompassMessages.xsd"
>http://schemas.ci.org/ci/messaging/compass/2013/02/UpsertConstituent

</
MessageType>
        <RequestId>[string]</RequestId>
      </EsbHeader>
      <EsbBody>
        <UpsertConstituent
               SchemaVersion ="1.0"
               xmlns="http://schemas.ci.org/ci/messaging/compass/2013/02/">
          <PartnerCountryCode>AA</PartnerCountryCode>
          <ConstituentId>[string]</ConstituentId>
          <Name>[string]</Name>
          <FirstName>[string]</FirstName>
          <LastName>[string]</LastName>
          <TransactionDate>mm-dd-yyyy</TransactionDate>
          <SentDate>mm-dd-yyyy</SentDate>
        </UpsertConstituent>
      </EsbBody>
    </EsbEnvelope>

Parameters

Name Description
EsbEnvelope Headers
SendersName Supplied by Cornerstone Connect during GP setup
SendersAppName Supplied by Cornerstone Connect during GP setup
SendersTrackingId Supplied by Cornerstone Connect during GP setup
ToAddress Supplied by Cornerstone Connect during GP setup
FromAddress Supplied by Cornerstone Connect during GP setup
MessageType http://schemas.ci.org/ci/messaging/compass/2013/02/UpdateConstituent
RequestId Unique number created by GP in order to track specific messages. A message returned from Compass will have the RequestId populated in the RequestCorrelationId.
EsbBody
UpsertConstituent
PartnerCountryCode IP country code sending the message
ConstituentId Constituent id
Name Full name of the constituent (required)
FirstName First name of the constituent (optional)
LastName Last name of the constituent (required)
TransactionDate Date the GP solidified the transaction. This can be the same day or earlier than the SentDate.
SentDate Automatically populated when the message is sent

Possible Error Messages Returned from the Compass Party Host

Error Message Text Error Message Description
PartnerCountryCode is required  
ConstituentId is required
Name is required
LastName is required
TransactionDate is required
Unable to obtain db_id from DB table for code = {value} The PartnerCountryCode provided does not exist in the DB
LastModifiedUser ({value}) does not exist The user does not exist in the DB
LastModifiedUser ({value}) is not active The user is not active in the DB
ConstituentId ({value}) does not exist The ConstituentId provided does not exist in the DB
ConstituentId (@con_id): {value} is not active The ConstituentId provided is not ‘A’ or active
FirstName (@first_name): {value} exceeds 60 characters
LastName (@last_name): {value} exceeds 60 characters
Name (@name): {value} exceeds 60 characters

Docs Navigation