Cancel Commitment Message

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

The "CancelCommitment" message informs the GMC that a constituent has canceled a commitment.

Once the sent "CancelCommitment" message has been processed by the GMC, a corresponding "CommitmentCanceled" 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/CancelCommitment
</MessageType>
        <RequestId>[string]</RequestId>
      </EsbHeader>
      <EsbBody>
        <CancelCommitment 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>
        </CancelCommitment>
      </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/CancelCommitment
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 (used by Compass)
CancelCommitment  
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
  • LDPSponsorship (IPTest only)
  • LDPCorresondenceSponsorship (IPTest only)

Possible Error Messages Returned from the Compass Party Host

Error Message Text Error Message Description
PartnerCountryCode is required  
ConstituentId is required  
NeedKey is required  
ConstituentActivityType is required  
Invalid PartnerCountryCode (@partner_country_code) The PartnerCountryCode that was provided is not in the Compass DB as a partner country
ConstituentId (@con_id) – {value} does not exist The ConstituentId provided does not exist in the Compass DB
ConstituentId (@con_id) – {value} is not active The status of the ConstituentId provided is not ‘A’ or active
NeedKey (@need_key) – {value} does not exist The NeedKey provided does not exist in the Compass DB
NeedKey (@need_key) – {value} is not a Child Sponsorship need type The need type of the NeedKey provided is not for a CDSP child
NeedKey (@need_key) – {value} is not allocated to {PartnerCountryCode value} The NeedKey provided is not allocated to the partner country that was provided
ConstituentActivityType (@con_act_syscode) must be CHISPN or CORRES  
ConstituentId (@con_id) – {value} does not have a ({ConstituentActivityType value}) commitment to NeedKey (@need_key) – {value} The ConstituentId provided does not have an active commitment to the NeedKey provided
LastModifiedUser ({value}) does not exist The Compass user shown in the parenthesis does not exist in the Compass DB
LastModifiedUser ({value}) is not active The Compass user shown in the parenthesis is not active in the Compass DB

Docs Navigation