- Previous: Update Constituent Message
- Up: Private Messaging APIs
- Next: Upsert Constituent Message
Update Email Message
The "Update Email" message is sent from the Global Partner (GP) to the Global Ministry Center (GMC).
The "UpdateEmail" message is to modify an existing Email Address on an existing constituent in the GMC Source System database.
If the email already exists, the email is updated. If it does not exist, the email is created.
Once the sent "UpdateEmail" message has been processed by the GMC, a corresponding "EmailUpdated" message will eventually be returned to the GP from the GMC. This is an asynchronous process.
Sample Message
Parameters
Error Messages
Sample Message
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/UpdateEmail
</MessageType>
<RequestId>[string]</RequestId>
</EsbHeader>
<EsbBody>
<UpdateEmail SchemaVersion ="1.0"
xmlns="http://schemas.ci.org/ci/messaging/compass/2013/02/">
<PartnerCountryCode>AA</PartnerCountryCode>
<ConstituentId>[string]</ConstituentId>
<EmailAddress>aaa@bbb.com</EmailAddress>
<SentDate>mm-dd-yyyy</SentDate>
</UpdateEmail>
</EsbBody>
</EsbEnvelope>
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/UpdateEmail |
| 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 | |
| UpdateEmail | |
| PartnerCountryCode | IP country code sending the message |
| ConstituentId | |
| EmailAddress | ChildKey |
| SentDate | Automatically populated when the message is sent |
Possible Error Messages Returned from the Compass Party Host
| Error Message Text | Error Message Description |
|---|---|
| PartnerCountryCode (@partner_country_code) is required | |
| PartnerCountryCode (' + @partner_country_code + ') not found | The PartnerCountryCode provided does not exist in the DB |
| Originating DB is not a Compass partner | The PartnerCountryCode provided is not in the DB as a partner country |
| ConstituentId is required | |
| Constituent ({value}) does not exist | The ConstituentId provided does not exist in the DB |
| EmailAddress (@email_address) is required | |
| Error selecting email type for descr = Personal | The EmailAddress provided could not be found as a personal email in the DB |
| CompassUser (@last_mod_cu_descr) is required | |
| CompassUser ({value}) not found | The user does not exist in the DB |
- Previous: Update Constituent Message
- Up: Private Messaging APIs
- Next: Upsert Constituent 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.