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
(deprecated - use UpsertConstituent instead)

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
To GMC Source System database

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
To GMC Source System database

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
To GMC Data Source System

EmailUpdated No
Child Messages
AllocateChild Notification that child allocated to GP. None

From GMC Source System database
To GP

None

Yes
Message and Service Relationships

DeallocateChild Notification that child is deallocated from an GP. None

From GMC Source System database
To GP

None

No

UpdateChild Notification that child was updated in Compass. None

From GMC Source System database
To GP

None

Yes
Message and Service Relationships

Update Project Notification that a project information was updated or the project status changed. None

From GMC Source System database
To GP

None

Yes
Message and Service Relationships

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