- Previous: Sample REST End-To-End Test Plan
- Up: Compassion API Library
- 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 Request
Request Parameters
Response Parameters
XML Sample Successful Response
JSON Sample Successful Response
Sample Unsuccessful Responses
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 | 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 | Data 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 |
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 char) |
ExternalStatus | Status exposed to the external clients | string (1 char) |
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 | 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 |
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>XYZ Child Development Center</ 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]</