REST Get CSP Implementor V1

The REST service, CSP Implementor, provides information on a CSP implementor based on the CSP 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").

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
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/cspimplementors/{cspimplementorkeylegacy}?ClientReferenceId=[string]&api_key=[string]
Production:  https://api2.compassion.com/ci/v1/cspimplementors/{cspimplementorkeylegacy}?ClientReferenceId=[string]&api_key=[string] 

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 Data Type Returned
CSPImplementorId Value of the CSP Implementor Id associated with the input parameter number
PartyId
Value of the Party Id associated with the input parameter
string
CSPImplementorKey Does not return a value string
CSPImplementorKeyLegacy Same value as input string
Name

Name of the CSP Implementor

string
StartDate Date the partnership began string
StopDate Date the partnership ended string
FirstEnteredDate Date the implementor information was first entered in Compassion system string
LastUpdateDate Date the implementor information was first received or an update was received string
LastReviewDate Date the annual information update was received string
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
ExternalStatus Status exposed to the external clients string
StatusDate Date the program status became effective string
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
Descripton Description of the project string
CognitiveorVocationalActivities Project activities targeted to 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 physical development string
SocialorEmotionalActivites Project activities targeted to social/emotional development string
SpiritualActivities Project activities targeted to spiritual development string
DisburseGifts Flag indicating if gifts may be disbursed to the CSP Implementor boolean
DisburseFunds Flag indicating if funds, not including gifts can be disbursed to the CSP Implementor boolean
DisburseUnsponsoredFunds Flag indicating if unsponsored funds can be disbursed to the CSP Implementor 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 CSP Implementor – High Precision string
GPSCoordinateLatitudeLowPrecision GPS Latitude of the location of the CSP Implementor – Low Precision string
GPSCoordinateLongitudeHighPrecision GPS Longitude of the location of the CSP Implementor – High Precision string
GPSCoordinateLongitudeLowPrecision GPS Longitude of the location of the CSP 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
LastModifiedDate Date record was created or modified string

XML Sample Successful Response

<CSPImplementor   xmlns="http://schemas.ci.org/ci/common/eim/2014/10/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CSPImplementorID>[number]</CSPImplementorID>
  <PartyID>[string]</PartyID>
  <CSPImplementorKey />  
  <CSPImplementorKeyLegacy >[string]</CSPImplementorKeyLegacy>  
  <Name>[string]</ Name>  
  <StartDate>1984-07-18T00:00:00-06:00</StartDate>  
  <StopDate>2002-06-30T00:00:00-06:00</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 T</Status>  
  <ExternalStatus>T</ExternalStatus>  
  <StatusDate>2002-09-06T00:00:00-06:00</StatusDate>  
  <StatusComment  />  
  <DateStatusDateEntered />  
  <Description >
    [text]
  </ Description >
 
  <CognitiveOrVocationalActivities />  
  <OtherActivities />  
  <ParentOrFamilyActivities />  
  <PhysicalOrHealthActivities  />  
  <SocialOrEmotionalActivities  />  
  <SpiritualActivities  />    
  <DisburseGifts>true</DisburseGifts>  
  <DisburseFunds>false</DisburseFunds>  
  <DisburseUnsponsoredFunds>false</DisburseUnsponsoredFunds>  
  <NewSponsorshipsAllowed>false</NewSponsorshipsAllowed>  
  <AdditionalQuotaAllowed>false</AdditionalQuotaAllowed>  
  <ContactEmailAddress />  
  <ContactPersonName>[string]</ContactPersonName>  
  <ContactPhoneNumber  />  
  <ContactTitle>Project Director</ContactTitle >  
  <FaxNumber  />  
  <GPSCoordinateLatitudeHighPrecision />  
  <GPSCoordinateLatitudeLowPrecision />  
  <GPSCoordinateLongitudeHighPrecision />  
  <GPSCoordinateLongitudeLowPrecision />  
  <MailingAddressLine1>NOT AVAILABLE AT THIS TIME</MailingAddressLine1>  
  <MailingAddressLine2>NOT AVAILABLE AT THIS TIME</MailingAddressLine2>    
  <MailingAddressLine3  />  
  <MailingAddressLine4  />  
  <PhysicalAddressLine1 />  
  <PhysicalAddressLine2  />  
  <PhysicalAddressLine3 />  
  <PhysicalAddressLine4 />  
  <LinkedProjectKey  />  
  <LinkedProjectName  />  
  <ActivityHoursPerWeek>0 </ActivityHoursPerWeek>  
  <DescriptionModificationDate>2000-03-24T16:20:17.7-07:00</DescriptionModificationDate>  
  <LastModifiedDate >2002-09-06T10:19:01.8-06:00</LastModifiedDate>
</CSPImplementor>

JSON Sample Successful Response

{
  "cspImplementorID":[number],
  "partyID":"[string]",
  "cspImplementorKey":"[string]",
  "cspImplementorKeyLegacy":"[string]",
  "name":"[string]",
  "startDate":"1984-07-18T00:00:00-06:00",
  "stopDate":"2002-06-30T00:00:00-06: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":"[string]",
  "description":"[string]",
  "cognitiveOrVocationalActivities":"[string]",
  "otherActivities":"[string]",
  "parentOrFamilyActivities":"[string]",
  "physicalOrHealthActivities":"[string]",
  "socialOrEmotionalActivities":"[string]",
  "spiritualActivities":"[string]", 
  "disburseGifts":true,
  "disburseFunds":true,
  "disburseUnsponsoredFunds":true,
  "newSponsorshipsAllowed":true,
  "additionalQuotaAllowed":true,
  "contactEmailAddress":"[string]",
  "contactPersonName":"[string]",
  "contactPhoneNumber":"[string]",
  "contactTitle":"Project Director",
  "faxNumber":"[string]",
  "gpsCoordinateLatitudeHighPrecision":"[number]",
  "gpsCoordinateLatitudeLowPrecision":"[number]",
  "gpsCoordinateLongitudeHighPrecision":"[number]",
  "gpsCoordinateLongitudeLowPrecision":"[number]",
  "mailingAddressLine1":"NOT AVAILABLE AT THIS TIME",
  "mailingAddressLine2":"NOT AVAILABLE AT THIS TIME",
  "mailingAddressLine3":"[string]",
  "mailingAddressLine4":"[string]",
  "physicalAddressLine1":"[string]",
  "physicalAddressLine2":"[string]",
  "physicalAddressLine3":"[string]",
  "physicalAddressLine4":"[string]",
  "linkedProjectKey":"[string]",
  "linkedProjectName":"[string]",
  "activityHoursPerWeek":"0",
  "descriptionModificationDate":"2000-03-24T16:20:17.7-07:00",
  "lastModifiedDate": "2002-09-06T10:19:01.8-06:00"
}

Sample Unsuccessful Responses

XML Unsuccessful Response
<Error
  <ID>[string]</ID
  <Message>'CSPImplementorKeyLegacy' can only be a five-character alphabetic code.</Message>
</Error>


 

JSON Unsuccessful Response
{
  "error": {
    "id": "[string]"
    "message" "'CDSPImplementorKeyLegacy' can only be a five-character alphabetic code."
  }
}

Error Response Codes

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

Docs Navigation