- Previous: Service Overview
- Up: Private SOAP Services
- Next: SOAP Get Child Image 201503
SOAP Get CSP Implementor 201309
Note: This service is not available in our interactive API option.
The SOAP service CSP Implementor provides information on a CSP implementor based on the CSP implementor key.
CSP is Compassion International's Child Survival Program, which equips the worldwide Church to respond to the cry of mothers on behalf of their babies by ensuring a healthy environment and a strong start in life for the poorest and most vulnerable. Using proven child survival strategies, caregivers and their families are equipped to nurture and disciple their children.
A CSP Implementor administers a Compassion Child Survival program.
Sample Request
Request Parameters
Response Parameters
Sample Successful Response
Sample Unsuccessful Response
Error Response Codes
Sample Request
This is an example only.
Action
http://services.ci.org/ci/CSPImplementor/2013/09/GetCSPImplementor
URL
Prod: https://api2.compassion.com/ci.services/cspimplementor/2013/09/getcspimplementor?api_key=[string]
IPTest: https://api2.compassion.com/iptest/ci.services/cspimplementor/2013/09/getcspimplementor?api_key=[string]
XML
<s:Envelope xmlns:s='http://schemas.xmlsoap.org/soap/envelope/'>
<s:Header>
<ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</ClientReferenceId>
</s:Header>
<s:Body>
<GetCSPImplementorRequest SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/CSPImplementor/2013/09/">
<RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
<Criteria operator="And">
<Field name="CSPImplementorKeyLegacy" value="[string]" comparisonOperator="Equals"/>
</Criteria>
</RequestCriteria>
</GetCSPImplementorRequest>
</s:Body>
</s:Envelope>
Request Parameters
Name | Description | Required | Data Type | Constraints |
---|---|---|---|---|
CSPImplementorKeyLegacy | Code assigned by Compassion International when the child is registered in the Child Survival Program. | Yes | String | Fixed 5 |
ClientReferenceId | Uniquely represents the transaction in the client's system. | Optional | String | Max 100 |
api_key | Your Mashery supplied key for an application running Compassion International services. | Yes | String |
Response Parameters
Name | Description |
---|---|
CSPImplementorId | Value of the CSP Implementor Id associated with the input parameter |
PartyId |
Value of the Party Id associated with the input parameter
|
CSPImplementorKey | Does not return a value |
CSPImplementorKeyLegacy | Same value as input |
Name |
Name of the CSP Implementor |
StartDate | Date the partnership began |
StopDate | Date the partnership ended |
FirstEnteredDate | Date the implementor information was first entered in Compassion system |
LastUpdateDate | Date the implementor information was first received or an update was received |
LastReviewDate | Date the annual information update was received |
Status | One character status field indicating if the project is (A)ctive, on (P)hase-out, or (T)erminated. There is not a suspended status. One of the letters are returned in the response. |
ExternalStatus | Status exposed to the external clients |
StatusDate | Date the program status became effective |
StatusComment | Description of why a status date change occurred. e.g. dd/mm/yyyy SUSPENSION - FUNDS HELD |
DateStatusDateEntered | Date status was recorded in Compassion system |
Descripton | Description of the project |
CognitiveorVocationalActivities | Project activities targeted to CSP child cognitive and/or vocational development |
OtherActivities | Project activities not targeted to a particular development activity |
ParentorFamilyActivities | Project activities targeted to parent and family development |
PhysicalorHealthActivities | Project activities targeted to CSP child physical development |
SocialorEmotionalActivites | Project activities targeted to CSP child social/emotional development |
SpiritualActivities | Project activities targeted to CSP child spiritual development |
DisburseGifts | Flag indicating if gifts may be disbursed to the CSP Implementor |
DisburseFunds | Flag indicating if funds, not including gifts can be disbursed to the CSP Implementor |
DisburseUnsponsoredFunds | Flag indicating if unsponsored funds can be disbursed |
NewSponsorshipsAllowed | Flag indicating if commitments can be created |
AdditionalQuotaAllowed | Flag indicating if the quota may be allowed |
ContactEmailAddress | Email address of the contact person |
ContactPersonName |
Name of person to contact |
ContactPhoneNumber | Phone number of the contact person |
ContactTitle | Job title of the contact person |
FaxNumber | |
GPSCoordinateLatitudeHighPrecision | GPS Latitude of the location of the CSP Implementor – High Precision |
GPSCoordinateLatitudeLowPrecision |
GPS Latitude of the location of the CSP Implementor – Low Precision |
GPSCoordinateLongitudeHighPrecision |
GPS Longitude of the location of the CSP Implementor – High Precision |
GPSCoordinateLongitudeLowPrecision |
GPS Longitude of the location of the CSP Implementor – Low Precision |
MailingAddressLine1 | Mailing address |
MailingAddressLine2 |
|
MailingAddressLine3 |
|
MailingAddressLine4 |
|
PhysicalAddressLine1 | Address of the physical location |
PhysicalAddressLine2 | |
PhysicalAddressLine3 | |
PhysicalAddressLine4 | |
LinkedProjectKey | |
LinkedProjectName | |
ActivityHoursPerWeek | |
DescriptionModificationDate | |
LastModifiedDate | Date record was created or modified |
Sample Successful Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PubChldInfo_TC-002</ClientReferenceId>
<SendingNode xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendingNode>
<MessageStreamId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageStreamId>
<EventSequenceNumber xmlns="http://schemas.ci.org/ci/services/common/2011/04/">8</EventSequenceNumber>
<MessageId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageId>
<RelatesTo xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</RelatesTo>
<SendersName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">CI\esbservice</SendersName>
<SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendersAppName>
<SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
</s:Header>
<s:Body>
<GetCSPImplementorResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/cspimplementor/2013/09/">
<RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
<Criteria operator="And">
<Field name="CSPImplementorKeyLegacy" value="[string]" comparisonOperator="Equals"/>
</Criteria>
</RequestCriteria>
<CSPImplementorCollection rowcount="1">
<CSPImplementor xmlns="http://schemas.ci.org/ci/common/eim/2013/09/">
<CSPImplementorID>[string]</CSPImplementorID>
<PartyID>[string]</PartyID>
<CSPImplementorKey/>
<CSPImplementorKeyLegacy>[string]</CSPImplementorKeyLegacy>
<Name>[string]</Name>
<StartDate>2003-05-23T00:00:00</StartDate>
<StopDate/>
<FirstEnteredDate>2006-05-05T00:00:00</FirstEnteredDate>
<LastUpdateDate>2006-05-05T00:00:00</LastUpdateDate>
<LastReviewDate>2013-09-25T00:00:00</LastReviewDate>
<Status>A</Status>
<ExternalStatus>A</ExternalStatus>
<StatusDate>2006-05-05T08:50:53</StatusDate>
<StatusComment></StatusComment>
<DateStatusDateEntered/>
<Description></Description>
<CognitiveOrVocationalActivities></CognitiveOrVocationalActivities>
<OtherActivities></OtherActivities>
<ParentOrFamilyActivities></ParentOrFamilyActivities>
<PhysicalOrHealthActivities></PhysicalOrHealthActivities>
<SocialOrEmotionalActivities></SocialOrEmotionalActivities>
<SpiritualActivities></SpiritualActivities>
<DisburseGifts>T</DisburseGifts>
<DisburseFunds>T</DisburseFunds>
<DisburseUnsponsoredFunds>T</DisburseUnsponsoredFunds>
<NewSponsorshipsAllowed>T</NewSponsorshipsAllowed>
<AdditionalQuotaAllowed>T</AdditionalQuotaAllowed>
<ContactEmailAddress/>
<ContactPersonName></ContactPersonName>
<ContactPhoneNumber></ContactPhoneNumber>
<ContactTitle></ContactTitle>
<FaxNumber/>
<GPSCoordinateLatitudeHighPrecision></GPSCoordinateLatitudeHighPrecision>
<GPSCoordinateLatitudeLowPrecision></GPSCoordinateLatitudeLowPrecision>
<GPSCoordinateLongitudeHighPrecision></GPSCoordinateLongitudeHighPrecision>
<GPSCoordinateLongitudeLowPrecision></GPSCoordinateLongitudeLowPrecision>
<MailingAddressLine1></MailingAddressLine1>
<MailingAddressLine2></MailingAddressLine2>
<MailingAddressLine3></MailingAddressLine3>
<MailingAddressLine4/>
<PhysicalAddressLine1/>
<PhysicalAddressLine2/>
<PhysicalAddressLine3/>
<PhysicalAddressLine4/>
<LinkedProjectKey></LinkedProjectKey>
<LinkedProjectName></LinkedProjectName>
<ActivityHoursPerWeek></ActivityHoursPerWeek>
<DescriptionModificationDate></DescriptionModificationDate>
<LastModifiedDate></LastModifiedDate>
</CSPImplementor>
</CSPImplementorCollection>
</GetCSPImplementorResponse>
</s:Body>
</s:Envelope>
Sample Unsuccessful Response
The service operation will provide the following response when there are missing required parameters.
Exception Returned: (ResponseCode = "1", HTTP Status Code ="404")
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PubChldInfo_TC-002</ClientReferenceId>
<SendingNode xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendingNode>
<MessageStreamId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageStreamId>
<EventSequenceNumber xmlns="http://schemas.ci.org/ci/services/common/2011/04/">3</EventSequenceNumber>
<SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendersAppName>
<RelatesTo xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</RelatesTo>
<MessageId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageId>
<SendersName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">NT AUTHORITY\SYSTEM</SendersName>
<SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
</s:Header>
<s:Body>
<GetCSPImplementorResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/cspimplementor/2013/09/">
<RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
<Criteria operator="And">
<Field name="CSPImplementorKeyLegacy" value="[string]" comparisonOperator="Equals"/>
</Criteria>
</RequestCriteria>
<ErrorResponse SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
<ErrorName>Validation Error</ErrorName>
<DateTimestamp>2015-01-30T17:08:40.2709818-07:00</DateTimestamp>
<SendersAppName>PublicSimpleRequestReplySoapService</SendersAppName>
<ServiceName>PublicSimpleRequestReplySoapService</ServiceName>
<ErrorId>[guid]</ErrorId>
<ErrorCode>4004</ErrorCode>
<ErrorMessage>'CSPImplementorKeyLegacy' must be 5 alphanumeric characters (AAAAN) or (AAANN).</ErrorMessage>
</ErrorResponse>
</GetCSPImplementorResponse>
</s:Body>
</s:Envelope>
Error Response Codes
For ResponseCode = 1, the table below indicates the HTTP error response and corresponding HTTP Error message.
HTTP Error Response | HTTP Error Message |
---|---|
HTTP 400 | Service Parameter Failure |
HTTP 401 | Not Authenticated / Authorized for Service Data |
HTTP 403 | Not Authorized |
HTTP 403 | Account Inactive |
HTTP 403 | Over Queries Per Second Limit |
HTTP 403 | Over Rate Limit |
HTTP 403 | Unknown Referrer |
HTTP 404 | Requested Resource Not Found |
HTTP 408 | Request Timeout |
HTTP 414 | Request URI Too Long |
HTTP 500 | Internal Server Error |
HTTP 502 | Bad Gateway |
HTTP 503 | API Maintenance / Service Unavailable |
HTTP 504 | Gateway Timeout |
- Previous: Service Overview
- Up: Private SOAP Services
- Next: SOAP Get Child Image 201503
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.