Update Project Message

Update Project message is sent from Compassion International (CI) to the Global Partner (GP).

The message informs the GP that a project status or information has been updated and services should be called to get new information.

The receiving system is responsible for determining which information has been updated.

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://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 schemaLocation
=
"http://schemas.ci.org/ci/messaging/compass/2013/02/CompassMessages.xsd"
>http://schemas.ci.org/ci/messaging/compass/2013/02/UpdateProject
</
MessageType>
        <RequestId>[string]</RequestId>
      </EsbHeader>
      <EsbBody>
        <UpdateProject>
          <PartnerCountryCode>AA</PartnerCountryCode>
          <ProjectKey>[string]</ProjectKey>
          <TransactionDate>mm-dd-yyyy</TransactionDate>
          <SentDate>mm-dd-yyyy</SentDate>

          <ProjectType>[string]</ProjectType>
        </UpdateProject>
      </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/UpdateProject
RequestId Unique number created by Compass in order to track specific messages
EsbBody
UpdateProject
PartnerCountryCode
IP country code to which the message is sent
ProjectKey
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
ProjectType i.e. CDSPProject

Available Services

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

Service Name Input Key Service Key
Project Services
Get Program Implementor 201303 (will be deprecated) or Get Program Implementor 201309

Note: For a suspended project, this service requires searching the 'StatusComment" field for the word "SUSPENSION". Then making sure that the "SUSPENSION" entry is the latest entry.

ProjectKey from UpdateProject message ImplementorKeyLegacy
Get CDSP Implementor

Recommended service to determine if a CDSP project is suspended.

If Status = A (active) and (DisburseGifts = false or DisburseFunds = false or DisburseUnsponsoredFunds = false or NewSponsorshipsAllowed = false or AdditionalQuaotaAllowed = false)then Project is suspended
<endif>

ProjectKey from UpdateProject message
Note: CDSP is determined by the <ProjectType> in the UpdateProject message or by the ImplementorKeyLegacy from GetProgramImplementor
CDSPImplementorKey
Get CSP Implementor

 

Recommended service to determine if a CSP project is suspended.

If Status = A (active) and (DisburseGifts = false or DisburseFunds = false or DisburseUnsponsoredFunds = false or NewSponsorshipsAllowed = false or AdditionalQuaotaAllowed = false) then Project is suspended
<endif>

ProjectKey from UpdateProject message
Note: CSP is determined by the <ProjectType> in the UpdateProject message or ImplementorKeyLegacy from GetProgramImplementor
Get Project Age Group ProjectKey from Update Project message or ImplementorKeyLegacy from GetProgramImplementor ProjectKey
Get Local Church Partner LocalChurchPartner Id from GetProgramImplementor LocalChurchPartnerId

Docs Navigation