- Previous: Commitment Canceled Message
- Up: Private Messaging APIs
- Next: Constituent Created Message
Commitment Created Message
The "CommitmentCreated" message is sent from the Global Ministry Center (GMC) to the Global Partner (GP).
This message is a response to the "CreateCommitment" message sent by the GP. This message informs the GP of success or failure of the "CreateCommitment" message. Note that this is an asynchronous process. A "CommitmentCreated" message will eventually be generated by the GMC and sent to the GP in response to each "CreateCommitment" message they have previously sent. This response message can be within just a few minutes or even several hours of the previously sent corresponding "CreateCommitment" message.
Sample Message
Parameters
Error Messages
Sample Message
SOAP OnRamps and OffRamps exist to provide delivery of this EsbEnvelope. Therefore, the EsbEnvelope should pass through OnRamps and OffRamps unchanged.
SOAP headers needed for making the call to the OnRamp are independent of headers inside the EsbEnvelope. The SOAP envelope and headers are not shown here.
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>http://schemas.ci.org/ci/messaging/compass/2013/02/CommitmentCreated</MessageType>
<RequestCorrelationId>[string]</RequestCorrelatonId>
<RequestId>[string]</RequestId>
</EsbHeader>
<EsbBody>
<CommitmentCreated>
<ConstituentId>[string]</ConstituentId>
<NeedKey>[string]</NeedKey>
<CommitmentId>mm-dd-yyyy</CommitmentId>
<Status>[string]</Status>
<Messages>
<Message>[string]</Message>
</Messages>
</CommitmentCreated>
</EsbBody>
</EsbEnvelope>
Parameters
Name | Description |
---|---|
EsbEnvelope Headers | |
SendersName | Supplied by Cornerstone Connect during setup |
SendersAppName | Supplied by Cornerstone Connect during setup |
SendersTrackingId | Supplied by Cornerstone Connect during setup |
ToAddress | Supplied by Cornerstone Connect during setup |
FromAddress | Supplied by Cornerstone Connect during setup |
MessageType | http://schemas.ci.org/ci/messaging/compass/2013/02/CommitmentCreated |
RequestCorrelationId | Contains the RequestId of the inbound message to which this is a response. |
RequestId | Unique number added by the sender in order to track specific messages |
EsbBody (used by Compass) | |
CommitmentCreated | |
ConstituentId | ConstituentId sent to the GMC Source System database in the "UpdateConstituent" message |
NeedKey | ChildKey |
CommitmentId | Contains the generated commitment identity value. Note: This is the cm_id column value in the cm table (within the Compass Application database) which is an identity value that resulted from the insert of the new commitment. It is only informational and the GP does not need to store it, since it is not ever used in subsequent web service or message calls. This value can just be ignored by the GP. |
Status | Status will always return either "Success" or "Failure" when the message completes. In general, the value in this parameter should always be checked to determine if the message was successful. If there was a failure, there will be explanation text in 'Messages' parameter. |
Messages | Returned if there is a failure condition |
Error Messages
Error Message Text | Error Message Description |
---|---|
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 |
Timeout expired. The timeout period elapsed prior to completion of the operation or the server is not responding.> | Try the corresponding Create Commitment message again as it did not successfully complete when it was previously submitted. |
- Previous: Commitment Canceled Message
- Up: Private Messaging APIs
- Next: Constituent Created Message
Docs Navigation
- Compassion API Library
- Standards Documents
- Legacy APIs (Deprecating)
- Web Services Handshake (Legacy) - Notification and Command Messages
- Public API
- Private IPG APIs
- Private REST Services
- REST Get CDSP Implementor V1
- REST Get Child Case Study V1
- REST Get Child Exit Details V1
- REST Get Child Image V1
- REST Get Child Information V1
- REST Get Community V1
- REST Get Country V1
- REST Get CSP Implementor V1
- REST Get Local Church Partner V1
- REST Get Program Implementor V1
- REST Get Project Age Groups V1
- REST Get Child Image V1 - 2015/03
- Private Messaging APIs
- Quick Start Guide
- OffRamp Prerequisites and Setup
- IP OnRamp Service Configuration
- Available Message Types
- Message and Service Relationships
- Troubleshooting
- General Error Messages from Compass Party Host
- EsdMessageErrorMOE Sample
- Sample REST End-To-End Test Plan
- SOAP Wrapper Sample for Messages to GMC
- Allocate Child Message
- Cancel Commitment Message
- Commitment Canceled Message
- Commitment Created Message
- Constituent Created Message
- Constituent Updated Message
- Constituent Upserted Message
- Create Commitment Message
- Create Constituent Message
- Create Email Message
- Create Gift Message
- Deallocate Child Message
- Depart Child Message
- Email Created Message
- Email Updated Message
- Gift Created Message
- Update Child Message
- Update Constituent Message
- Update Email Message
- Upsert Constituent Message
- Update Project Message
- Private SOAP Services
- SOAP Get Child Exit Detail 201211
- SOAP Get Child Exit Detail 201310
- SOAP Get CDSP Implementor 201309
- SOAP Get Child Image 201211
- SOAP Get Child Case Study 201310
- SOAP Get Child Case Study 201412
- SOAP Get Child Information 201211
- SOAP Get Child Information 201310
- SOAP Get Community 201309
- SOAP Get Country Information 201104
- SOAP Get Local Church Partner 201309
- SOAP Get Program Implementor 201303
- SOAP Get Program Implementor 201309
- SOAP Get Project Age Group 201309
- Service Overview
- SOAP Get CSP Implementor 201309
- SOAP Get Child Image 201503
- Private USA APIs
- Private USA Web APIs
- private cornerstone connect messaging
- private cornerstone test
- public api
0 Comments
New comments are not being accepted at this time.