Create Constituent Message

The "CreateConstituent" message is sent from the Global Partner (GP) to Global Ministry Center (GMC).

The message adds a new constituent from the GP to the GMC Source System database.

Once the sent "CreateConstituent" message has been processed by the GMC, a corresponding "ConstituentCreated" message will eventually be returned to the GP from the GMC. This is an asynchronous process).

Sample Message
Parameters
Error Messages

Sample Message

Below is an example of a "CreateConstituent" message to https://apitest.compassion.com/US/1/EsdOnRamp with soap action of http://services.ci.org/public/ci/onramp/2013/02/PublishMessage, traced through Fiddler. Please code to this example.

Areas highlighted in CYAN are added automatically by WCF for ws Federated security.
Areas highlighted in GREEN are added automatically by WCF.

POST https://apitest.compassion.com/US/1/EsdOnRampHTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Host: apitest.compassion.com
Content-Length: 3267
Expect: 100-continue
Accept-Encoding: gzip, deflate
 
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <s:Header>
    <a:Action s:mustUnderstand="1">http://services.ci.org/public/ci/onramp/2013/02/PublishMessage</a:Action>
    <SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
NLSFDC_APP
</SendersAppName>

    <SendersName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
CI\NLSFDC
</SendersName>

    <SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
    <a:MessageID>urn:uuid:90e16fa5-af76-4a5e-bffd-ccd0ccb83e80</a:MessageID>
    <a:ReplyTo>
      <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address>
    </a:ReplyTo>
    <a:To s:mustUnderstand="1">https://apitest.compassion.com/US/1/EsdOnRamp</a:To>
    <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
      <u:Timestamp u:Id="_0">
        <u:Created>2014-08-05T19:55:58.318Z</u:Created>
        <u:Expires>2014-08-05T20:00:58.318Z</u:Expires>
      </u:Timestamp>
      <SecurityContextToken u:Id="uuid-4bd33590-ab17-44ed-89b9-79dc8e8e472f-2" xmlns="http://docs.oasis-open.org/ws-sx/ws-secureconversation/200512">
        <Identifier>urn:uuid:b5c0a5d3-34b7-4a41-baee-58190e2147df</Identifier>
      </SecurityContextToken>
      <Signature xmlns="http://www.w3.org/2000/09/xmldsig#">
        <SignedInfo>
          <CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
          <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#hmac-sha1"/>
          <Reference URI="#_0">
            <Transforms>
              <Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
             </Transforms>
             <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
             <DigestValue>j5ZChHUuXFgSAh2ZIWZkbSAUiiE=</DigestValue>
           </Reference>
         </SignedInfo>
         <SignatureValue>0WrWt3CTlRuiajbSMo29ZdMujr4=</SignatureValue>
         <KeyInfo>
           <o:SecurityTokenReference>
             <o:Reference URI="#uuid-4bd33590-ab17-44ed-89b9-79dc8e8e472f-2"/>
           </o:SecurityTokenReference>
        </KeyInfo>
      </Signature>
    </o:Security>
  </s:Header>
  <s:Body>

    <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/CreateConstituent

</
MessageType>
           <RequestId>[string]</RequestId>
         </EsbHeader>
         <EsbBody>
           <CreateConstituent SchemaVersion ="1.0" xmlns="http://schemas.ci.org/ci/messaging/compass/2013/02/">
           <PartnerCountryCode>AA</PartnerCountryCode>
           <ConstituentId>[string]</ConstituentId>
           <Name>[string]</Name>
           <FirstName>[string]</FirstName>
           <LastName>[string]</LastName>
           <TransactionDate>mm-dd-yyyy</TransactionDate>
          <SentDate>mm-dd-yyyy</SentDate>
        </CreateConstituent>
      </EsbBody>
    </EsbEnvelope>

  </s:Body>

 

</s:Envelope>

Parameters

Name Description
EsbEnvelope Headers
SendersName Supplied by Cornerstone Connect during GP setup
SendersAppName Supplied by Cornerstone Connect during GP setup
SendersTrackingId Supplied by Cornerstone Connect during GP setup
ToAddress Supplied by Cornerstone Connect during GP setup
FromAddress Supplied by Cornerstone Connect during GP setup
MessageType http://schemas.ci.org/ci/messaging/compass/2013/02/CreateConstituent
RequestId Unique number created by GP in order to track specific messages. A message returned from Compass will have the RequestId populated in the RequestCorrelationId.
EsbBody
CreateConstituent  
PartnerCountryCode
IP country code sending the message
ConstituentId New constituent id
Name Full name of the new constituent (required)
FirstName First name of the new constituent (optional)
LastName Last name of the new constituent (required)
TransactionDate Date the GP solidified the transaction. This can be the same day or earlier than the SentDate.
SentDate Automatically populated when the message is sent

Possible Error Messages Returned from the Compass Party Host

Error Message Text Error Message Description
PartnerCountryCode is required  
ConstituentId is required  
Name is required  
LastName is required  
TransactionDate is required
Unable to obtain db_id from DB table for code = {value} The PartnerCountryCode provided does not exist in the DB
LastModifiedUser ({value}) does not exist The user does not exist in the DB
LastModifiedUser ({value}) is not active The user is not active in the DB
ConstituentId (@con_id): {value} already exists The ConstituentId provided already exists in the DB
FirstName (@first_name): {value} exceeds 60 characters  
LastName (@last_name): {value} exceeds 60 characters  
Name (@name): {value} exceeds 60 characters
ConstituentId (@con_id): {value} cannot be larger than {value}  

Docs Navigation