Create Email Message

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

The "CreateEmail" message is to add an Email Address for an existing constituent in the GMC Source System database.

If the email already exists, the email is updated. If it does not exist, the email is created.

Once the sent "CreateEmail" message has been processed by the GMC, a corresponding "EmailCreated" 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/CreateEmail
</MessageType>
        <RequestId>[string]</RequestId>
      </EsbHeader>
      <EsbBody>
        <CreateEmail SchemaVersion ="1.0"
               xmlns="http://schemas.ci.org/ci/messaging/compass/2013/02/">
          <PartnerCountryCode>AA</PartnerCountryCode>
          <ConstituentId>[string]</ConstituentId>
          <EmailAddress>aaa@bbb.com</EmailAddress>
          <SentDate>mm-dd-yyyy</SentDate>
        </CreateEmail>
      </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/CreateEmail
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
CreateEmail
PartnerCountryCode IP country code sending the message
ConstituentId
EmailAddress Email address of the constituent
SentDate Automatically populated when the message is sent

Possible Error Messages Returned from the Compass Party Host

Error Message Text Error Message Description
PartnerCountryCode (@partner_country_code) is required  
PartnerCountryCode (' + @partner_country_code + ') not found The PartnerCountryCode provided does not exist in the DB
Originating DB is not a Compass partner The PartnerCountryCode provided is not in the DB as a partner country
ConstituentId is required
Constituent ({value}) does not exist The ConstituentId provided does not exist in the DB
EmailAddress (@email_address) is required
Error selecting email type for descr = Personal The EmailAddress provided could not be found as a personal email in the DB
CompassUser (@last_mod_cu_descr) is required
CompassUser ({value}) not found The user does not exist in the DB

Docs Navigation