Allocate Child Message

Allocate Child message is sent from the Compassion International (CI) to the Global Partner (GP).

The message informs the GP that a child has been allocated to them and services should be called to get new information.

Sample Message
Parameters
Available Services

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://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/AllocateChild</MessageType>
       <RequestId>[string]</RequestId>
      </EsbHeader>
      <EsbBody>
        <AllocateChild>
          <PartnerCountryCode>AA</PartnerCountryCode>
          <ChildId>[string]</ChildId>
          <NeedKey>[string]</NeedKey>
          <Event>Allocation</Event>
          <TransactionDate>mm-dd-yyyy</TransactionDate>
          <SentDate>mm-dd-yyyy</SentDate>

          <ChildType>CDSP</ChildType>
        </AllocateChild>
      </EsbBody>
    </EsbEnvelope>

Parameters

Name Description
EsbEnvelope Headers
SendersName Supplied by Compassion 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)
AllocateChild  
PartnerCountryCode
GP country code to which the message is sent
ChildId System generated unique identifier for a child
NeedKey Child key
Event Event should always be "Allocation"
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:
  • CDSPChild
  • LDPChild

Available Services

The following table shows the Private Cornerstone Connect SOAP services available to the GP after the Allocate Child message is received.

Service Name Input Key Service Key
Child Services
Get Child Information NeedKey from AllocateChild message ChildKey
Get Child Image NeedKey from AllocateChild message ChildKey
Get Child Case Study NeedKey from AllocateChild message ChildKey
Project, Community, and Country Services
Get Program Implementor V2 First five characters of the ChildKey from AllocateChild message ImplementorKeyLegacy
Get Country First two characters of the ChildKey from AllocateChild message orISOCountryCode from Get Program Implementor ISOCountryCode
Get CDSP Implementor First five characters of the ChildKey from AllocateChild message or ImplementorKeyLegacy from GetProgramImplementor CDSPImplementorKey
Get Project Age Group First five characters of the ChildKey from AllocateChild message or ImplementorKeyLegacy from GetProgramImplementor ProjectKey
Get Community CommunityId from Get Program Implementor CommunityId
Get Local Church Partner LocalChurchPartner Id from GetProgrammplementor LocalChurchPartnerId

Docs Navigation