- Previous: Private REST Services
- Up: Private REST Services
- Next: REST Get Child Case Study V1
REST Get CDSP Implementor V1
The REST service, CDSP Implementor, provides information on a CDSP implementor based on the CDSP Implementor Key.
The service returns JSON as default. The service will also return XML. This is controlled by the Accept parameter in the Message Header (i.e., for XML, it should be "Accept: application/xml" and for JSON, it should be "Accept: application/json").
CDSP connects one child with one sponsor to help that child develop into the extraordinary individual which God ordained.
A CDSP Implementor administers a Compassion Child Development Sponsorship program.
Sample Requests
Request Parameters
Response Parameters
Sample Successful Response
Sample Unsuccessful Response
Error Response Codes
Sample Request
This is an example only.
IPTest: https://api2.compassion.com/iptest/ci/v1/cdspimplementors/{cdspimplementorkeylegacy}?ClientReferenceId=[string]&api_key=[string]
Production: https://api2.compassion.com/ci/v1/cdspimplementors/{cdspimplementorkeylegacy}?ClientReferenceId=[string]&api_key=[string]
Request Parameters
Name | Description | Required | Data Type | Constraints |
---|---|---|---|---|
CDSPImplementorKeyLegacy | Code assigned by Compassion International when the child is registered in the Child Sponsorship Program. | Yes | Sting | 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 | Date Type Returned |
---|---|---|
CDSPImplementorId | Value of the CDSP Implementor Id associated with the input parameter | number |
PartyId | Value of the Party Id associated with the input parameter | string |
CDSPImplementorKey | Does not return a value | string |
CDSPImplementorKeyLegacy | Same value as input | string |
Name | Name of the CDSP Implementor | string |
StartDate | Date the partnership began | string Format: 2008-03-01T00:00:00-07:00 |
StopDate | Date the partnership ended | string Format: 2008-03-01T00:00:00-07:00 |
FirstEnteredDate | Date the implementor information was first entered in Compassion system | string Format: 2008-03-01T00:00:00-07:00 |
LastUpdateDate | Date the implementor information was first received or an update was received | string Format: 2008-03-01T00:00:00-07:00 |
LastReviewDate | Date the annual information update was received | string Format: 2008-03-01T00:00:00-07:00 |
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. | string (1 dhar) |
ExternalStatus | Status exposed to the external clients | string (1 dhar) |
StatusDate | Date the program status became effective | string Format: 2008-03-01T00:00:00-07:00 |
StatusComment | Description of why a program status date was changed. e.g. mm-dd-yy SUSPENSION: LINKED CSP EC-Cxx ALSO SUSPENDED. | string |
DateStatusDateEntered | Date status was recorded in Compassion system | string Format: 2008-03-01T00:00:00-07:00 |
Descripton | Description of the project | string |
ActivitiesforNonSchoolChildren | Project activities specifically for CDSP children who do not attend school | string |
CognitiveorVocationalActivities | Project activities targeted to CDSP child cognitive and/or vocational development | string |
OtherActivities | Project activities not targeted to a particular development activity | string |
ParentorFamilyActivities | Project activities targeted to parent and family development | string |
PhysicalorHealthActivities | Project activities targeted to CDSP child physical development | string |
SocialorEmotionalActivites | Project activities targeted to CDSP child social/emotional development | string |
SpiritualActivities | Project activities targeted to CDSP child spiritual development | string |
AnnualSchoolCostinDollars | Annual cost for a child to attend school in the community where the CDSP Implementor is located | number |
DisburseGifts | Flag indicating if gifts may be disbursed to the CDSP Implementor or to the CDSP child | boolean |
DisburseFunds | Flag indicating if funds, not including gifts can be disbursed to the CDSP Implementor or CDSP children | boolean |
DisburseUnsponsoredFunds | DisburseUnsponsoredFunds Flag indicating if unsponsored funds can be disbursed to the CDSP Implementor or CDSP child | boolean |
NewSponsorshipsAllowed | Flag indicating if commitmentscan be created | boolean |
AdditionalQuotaAllowed | Flag indicating if the quota may be continued | boolean |
ContactEmailAddress | Email address of the contact person | string |
ContactPersonName | Name of person to contact | string |
ContactPhoneNumber | Phone number of the contact person | string |
ContactTitle | Job title of the contact person | string |
FaxNumber | Fax number | string |
GPSCoordinateLatitudeHighPrecision | GPS Latitude of the location of the CDSP Implementor – High Precision | string |
GPSCoordinateLatitudeLowPrecision | GPS Latitude of the location of the CDSP Implementor – Low Precision | string |
GPSCoordinateLongitudeHighPrecision | GPS Longitude of the location of the CDSP Implementor – High Precision | string |
GPSCoordinateLongitudeLowPrecision | GPS Longitude of the location of the CDSP Implementor – Low Precision | string |
MailingAddressLine1 | Mailing address | string |
MailingAddressLine2 | string | |
MailingAddressLine3 | string | |
MailingAddressLine4 | string | |
PhysicalAddressLine1 | Address of the physical location | string |
PhysicalAddressLine2 | string | |
PhysicalAddressLine3 | string | |
PhysicalAddressLine4 | string | |
LinkedProjectKey | string | |
LinkedProjectName | string | |
ActivityHoursPerWeek | string | |
DescriptionModificationDate | string Format: 2008-03-01T00:00:00-07:00 |
|
LastModifiedDate | Date record was created or modified | string Format: 2008-03-01T00:00:00-07:00 |
Sample Successful Response
XML Sample Successful Response
<CDSPImplementor xmlns="http://schemas.ci.org/ci/common/eim/2014/10/">
<CDSPImplementorID>[number]</CDSPImplementorID>
<PartyID>[string]</PartyID>
<CDSPImplementorKey/>
<CDSPImplementorKeyLegacy>[string]</CDSPImplementorKeyLegacy>
<Name>[string]</Name>
<StartDate>1984-07-18T00:00:00-06:00</StartDate>
<StopDate>[string]</StopDate>
<FirstEnteredDate>1900-01-01T00:00:00-07:00</FirstEnteredDate>
<LastUpdateDate>1900-01-01T00:00:00-07:00</LastUpdateDate>
<LastReviewDate>1900-01-01T00:00:00-07:00</LastReviewDate>
<Status>A</Status>
<ExternalStatus>A</ExternalStatus>
<StatusDate>2002-09-06T00:00:00-06:00</StatusDate>
<StatusComment>[string]</StatusComment>
<DateStatusDateEntered>1900-01-01T00:00:00-07:00</DateStatusDateEntered>
<Description>[text]</Description>
<ActivitiesForNonSchoolChildren>[string]</ActivitiesForNonSchoolChildren>
<CognitiveOrVocationalActivities>[string]</CognitiveOrVocationalActivities>
<OtherActivities>[string]</OtherActivities>
<ParentOrFamilyActivities>[string]</ParentOrFamilyActivities>
<PhysicalOrHealthActivities>[string]</PhysicalOrHealthActivities>
<SocialOrEmotionalActivities>[string]</SocialOrEmotionalActivities>
<SpiritualActivities>[string]</SpiritualActivities>
<AnnualSchoolCostInDollars>9068.8000</AnnualSchoolCostInDollars>
<DisburseGifts>true</DisburseGifts>
<DisburseFunds>false</DisburseFunds>
<DisburseUnsponsoredFunds>false</DisburseUnsponsoredFunds>
<NewSponsorshipsAllowed>false</NewSponsorshipsAllowed>
<AdditionalQuotaAllowed>false</AdditionalQuotaAllowed>
<ContactEmailAddress>[string]</ContactEmailAddress>
<ContactPersonName>[string]</ContactPersonName>
<ContactPhoneNumber>[string]</ContactPhoneNumber>
<ContactTitle>[string]</ContactTitle>
<FaxNumber>[string]</FaxNumber>
<GPSCoordinateLatitudeHighPrecision>[number]</GPSCoordinateLatitudeHighPrecision>
<GPSCoordinateLatitudeLowPrecision>[number]</GPSCoordinateLatitudeLowPrecision>
<GPSCoordinateLongitudeHighPrecision>[number]</GPSCoordinateLongitudeHighPrecision>
<GPSCoordinateLongitudeLowPrecision>[number]</GPSCoordinateLongitudeLowPrecision>
<MailingAddressLine1>[string]</MailingAddressLine1>
<MailingAddressLine2>[string]</MailingAddressLine2>
<MailingAddressLine3>[string]</MailingAddressLine3>
<MailingAddressLine4>[string]</MailingAddressLine4>
<PhysicalAddressLine1>[string]</PhysicalAddressLine1>
<PhysicalAddressLine2>[string]</PhysicalAddressLine2>
<PhysicalAddressLine3>[string]</PhysicalAddressLine3>
<PhysicalAddressLine4>[string]</PhysicalAddressLine4>
<LinkedProjectKey>[string]</LinkedProjectKey>
<LinkedProjectName>[string]</LinkedProjectName>
<ActivityHoursPerWeek>[string]</ActivityHoursPerWeek>
<DescriptionModificationDate>2000-03-24T16:20:17.7-07:00</DescriptionModificationDate>
<LastModifiedDate>>2002-09-06T10:19:01.8-06:00</LastModifiedDate>
</CDSPImplementor>
JSON Sample Successful Response
{
"cdspImplementorID":"[number]",
"partyID":"[string]",
"cdspImplementorKey":"",
"cdspImplementorKeyLegacy":"[string]",
"name":"[string]",
"startDate":"1984-07-18T00:00:00-06:00",
"stopDate":"2010-08-29T00:00:00",
"firstEnteredDate":"1900-01-01T00:00:00-07:00",
"lastUpdateDate":"1900-01-01T00:00:00-07:00",
"lastReviewDate":"1900-01-01T00:00:00-07:00",
"status":"A",
"externalStatus":"A",
"statusDate":"2002-09-06T00:00:00-06:00",
"statusComment":"[string]",
"dateStatusDateEntered":"2002-09-06T00:00:00-06:00",
"description":"[string]",
"activitiesForNonSchoolChildren":"[string]",
"cognitiveOrVocationalActivities":"[string]",
"otherActivities":"[string]",
"parentOrFamilyActivities":"[string]",
"physicalOrHealthActivities":"[string]",
"socialOrEmotionalActivities":"[string]",
"spiritualActivities":"[string]",
"annualSchoolCostInDollars":9068.8000,
"disburseGifts":true,
"disburseFunds":false,
"disburseUnsponsoredFunds":false,
"newSponsorshipsAllowed":false,
"additionalQuotaAllowed":false,
"contactEmailAddress":"[string]",
"contactPersonName":"[string]",
"contactPhoneNumber":"[string]",
"contactTitle":"[string]",
"faxNumber":"[string]",
"gpsCoordinateLatitudeHighPrecision":"[number]",
"gpsCoordinateLatitudeLowPrecision":"[number]",
"gpsCoordinateLongitudeHighPrecision":"[number]",
"gpsCoordinateLongitudeLowPrecision":"[number]",
"mailingAddressLine1":"[string]",
"mailingAddressLine2":"[string]",
"mailingAddressLine3":"[string]",
"mailingAddressLine4":"[string]",
"physicalAddressLine1":"[string]",
"physicalAddressLine2":"[string]",
"physicalAddressLine3":"[string]",
"physicalAddressLine4":"[string]",
"linkedProjectKey":"[string]",
"linkedProjectName":"[string]",
"activityHoursPerWeek":"[number]",
"descriptionModificationDate":"2000-03-24T16:20:17.7-07:00",
"lastModifiedDate":"2000-03-24T16:20:17.7-07:00",
}
Sample Unsuccessful Responses
XML Unsuccessful Response
<Error>
<ID>[string]</ID>
<Message>'CDSPImplementorKeyLegacy' can only be a five-character alphabetic cide.</Message>
</Error>
JSON Unsuccessful Response
{
"error": {
"id":"[string]"
"message":"'cdspImplementorKeyLegacy' can only be a five-character alphabetic code."
}
}
Error Response Codes
For ResponseCode = 1, the table below indicates the HTTP error response and 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: Private REST Services
- Up: Private REST Services
- Next: REST Get Child Case Study V1
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.