- Previous: IP OnRamp Service Configuration
- Up: Private Messaging APIs
- Next: Message and Service Relationships
Available Message Types
The Global Partner (GP) should be familiar with:
- Command messages that the GP can send to the Global Ministry Center (GMC).
For example, the GP can send a "UpsertConstituent" message to the GMC Source System to create or update a constituent in the GMC database. - Response messages from the GMC.
For example, if the GP sends an “UpsertConstituent” message to the GMC Source System database, the GMC Source System database will respond with a “ConstituentUpserted” message indicating the status of the message request. The "Status" field will contain either “Success” or "Failure" along with a reason the message operation was unsuccessful. - Dependencies that exist between messages.
Messages must be sent in the order that the GMC Source System database expects to receive them.
For example, a "CreateEmail" message cannot be processed in the GMC Source System database before a "UpsertConstituent" message is processed. - One-way messages which the GP may receive from the GMC Source System database.
For example, when the GMC needs to notify an GP that a child has been allocated to them, an “AllocateChild” message will be sent from the GMC Source System database to the GP. The GMC Source System database does not expect a response from this message
Click on each message to get detailed information on the message and how to call the related service/s.
See Message and Service Relationship for a chart of messages and services relationships.
Message Name | Message Description | Dependency | From and To | Response Message | Available Services |
---|---|---|---|---|---|
Constituent Messages | |||||
UpsertConstituent | Inserts constituent into GMC Source System database if constituent does not exist. If constituent exists then updates constituent. | None | From GP To GMC Source System database |
ConstituentUpserted | No |
CreateConstituent |
New constituent information. Email address is not included in this information. A "CreateEmail" message must be sent if there is an email for the constituent. |
None |
From GP |
ConstituentCreated | No |
CreateEmail​ |
If the constituent email exists, the email is updated. If the email does not exist, the email is created. This message is sent after the constituent has been successfully created. |
CreateConstituent (or UpsertConstituent) message succeeded. |
From GP |
EmailCreated | No |
UpdateConstituent (deprecated - use UpsertConstituent instead) |
Updates constituent information. | CreateConstituent message succeeded. | From GP To GMC Source System database |
ConstituentUpdated | No |
UpdateEmail | If the constituent email exists, the email is updated. If the email does not exist, the email is created. | CreateEmail succeeded. |
From GP |
EmailUpdated | No |
Child Messages | |||||
AllocateChild | Notification that child allocated to GP. | None |
From GMC Source System database |
None | |
DeallocateChild | Notification that child is deallocated from an GP. | None |
From GMC Source System database |
None |
No |
UpdateChild | Notification that child was updated in Compass. | None |
From GMC Source System database |
None | |
Update Project | Notification that a project information was updated or the project status changed. | None |
From GMC Source System database |
None | |
DepartChild​ | Notification that child departed Compassion program. | None | From GMC Source System database To GP |
None | Yes Message and Service Relationships |
Constituent-Child Relationship Messages | |||||
CreateCommitment | New constituent commitment to a child. |
CreateConstituent message succeeded. |
From GP To GMC Source System database |
CommitmentCreated | No |
CancelCommitment | Cancellation of any constituent commitment to a child. | CreateCommitment message succeeded. | From GP To GMC Source System database |
CommitmentCancelled | No |
CreateGift | Constituent gift to a child, a child's family, or a donation to Compassion. | CreateCommitment message succeeded (for CDSP gift). | From GP To GMC Source System database |
GiftCreated | No |
Miscellaneous Messages | |||||
Error Ministry Operating Event | Standard Error message returning by the messaging system. It includes the original message and error information indicating why the message is being returned. | Messaging System |
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.