Create Commitment Message

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

The "CreateCommitment" message is to add commitment to an existing Constituent in the GMC Source System database.

Once the sent "CreateCommitment" message has been processed by the GMC, a corresponding "CommitmentCreated" 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/CreateCommitment
</MessageType>
        <RequestId>[string]</RequestId>
      </EsbHeader>
      <EsbBody>
        <CreateCommitment SchemaVersion ="1.0"
               xmlns="http://schemas.ci.org/ci/messaging/compass/2013/02/">
          <PartnerCountryCode>AA</PartnerCountryCode>
          <ConstituentId>[string]</ConstituentId>
          <NeedKey>[string]</NeedKey>
          <TransactionDate>mm-dd-yyyy</TransactionDate>
          <SentDate>mm-dd-yyyy</SentDate>

          <ConstituentActivityType>[string]</ConstituentActivityType>
        </CreateCommitment>
      </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/CreateCommitment
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
CreateConstituent  
PartnerCountryCode
IP country code sending the message
ConstituentId  
NeedKey Child key
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
ConstituentActivityType ConstituentActivityType can be:
  • ChildSponsorship
  • ChildCorrespondenceSponsorship

Possible Error Messages Returned from the Compass Party Host

Message Description of Error Message
Program for this Need is not active The program associated with the NeedKey provided is not active.
Program for this Need is not allowing new commitments The program associated with the NeedKey provided is not allowing new commitments.
Need ({needKey}) is already associated with this Constituent ({value}) for this ConActSyscode ({value}) The NeedKey provided is already sponsored by this ConstituentId.
An active commitment exists for Need ({value}) There is already an active commitment for the NeedKey provided.

Docs Navigation