- Previous: Create Gift Message
- Up: Private Messaging APIs
- Next: Depart Child Message
Deallocate Child Message
Deallocate Child message is sent from the Global Ministry Center (GMC) to the Global Partner (GP).
The message informs the GP that a child has been reallocated to a different partner country. The GP whom the child was allocated to will receive this message to notify them that the child is no longer allocated to them.
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/DeallocateChild
</MessageType>
<RequestId>[string]</RequestId>
</EsbHeader>
<EsbBody>
<DeallocateChild>
<PartnerCountryCode>AA</PartnerCountryCode>
<ChildId>[string]</ChildId>
<NeedKey>[string]</NeedKey>
<Event>Deallocation</Event>
<TransactionDate>mm-dd-yyyy</TransactionDate>
<SentDate>mm-dd-yyyy</SentDate>
<ChildType>[string]</ChildType>
</DeallocateChild>
</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/AllocateChild |
RequestId | Unique number created by Compass in order to track specific messages |
EsbBody (populated by Compass) | |
DeallocateChild | |
PartnerCountryCode |
IP country code to which the message is sent |
ChildId | System generated unique identifier for a child |
NeedKey | Child key |
Event | Event is Deallocation |
TransactionDate | Date Compass solidified the transaction. This can be the same day or earlier than the SentDate. |
SentDate | Automatically populated when the message is sent |
ChildType | ChildType can be:
|
- Previous: Create Gift Message
- Up: Private Messaging APIs
- Next: Depart Child 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.