Private IPG Child Information

The Child Information API is a RESTful API.

The service provides information on a child enrolled in the Child Development Sponsorship Program (CDSP).

CDSP connects one child with one sponsor to help that child develop into the extraordinary individual which God ordained.

Sample Request

The actual request requires soft-authentication.
This is an example only.

https://api2.compassion.com/us/1/child/information?ChildKey=[string]&piType=CDSP&ClientReferenceId=[string]&api_key=[string]

Request Parameters

Name Description Required Data Type Constraints
ChildKey Code assigned by Compassion International when the child is registered in the Child Sponsorship Program. Yes String
pitype Program Implementor Type. The only value supported is CDSP. Optional String

Default: CDSP

Valid Value: CDSP

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
ChildKey Code assigned by Compassion International when the child is registered in the Child Sponsorship Program.
ChildName Name of the child.
ChildAbbreviatedName

Child name abbreviated to 30 characters.

ChildPersonalName First name or nickname that is used to address the child.
Gender Child's gender.
BirthDate Child's birth date.
Age Child's age.
BirthDateKnownFlag Flag indicating if child actual birth date is known.
StartDate Date that the first set of data for the CDSP Child was entered into the Compassion system.
FieldStartDate The first Registration Date of the CDSP Child. It is recorded as the first day of the month the registration occurred.
LastCaseStudyDate Date the last case study was completed for the child.
LastCaseStudyModifiedDate Date a portion of the current case study was modified.
OverAgeFlag Flag indicating if the child is allowed to continue in the program beyond the maximum age.
SiblingFlag Flag indicating if the child has brothers or sisters in the CDSP Program.
OrphanFlag Flag indicating if the child has brothers or sisters in the CDSP Program.
HandicappedFlag Indicator identifying a child as handicapped.
ChildAttendingSchoolFlag Flag indicating if the child is attending school.
USSchoolEquivalent Equivalent US school grade level child is in.
SchoolPerformanceDescription Performance of child in school - average, below average or above average.
CDSPCompletionDate Date child is expected to complete the CDSP Program.
CSPGraduationFlag Flag designating a beneficiary as being a CSP graduate.
CSPEnrollDate
CSPProject An Implementing Church Partner that is a CSP Implementor.
SponsorFlag Flag indicating if the child is sponsored.
ProgramStatus One of three states of a project: active, phase out, or terminated.
ParticipationStopDate The date and time when the participation ended with Compassion.
BeginWaitTime The date and time when the child first started waiting for sponsorship.
ChildBiography

Sample Successful Response

Sample Successful Response

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")

Sample Error Response

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

Docs Navigation