- Previous: REST Get Child Image V1
- Up: Private REST Services
- Next: REST Get Community V1
REST Get Child Information V1
The REST call, Get Child Information, provides information on a child enrolled in the Child Development Sponsorship Program (CDSP).
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.
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/children/{childkey}/information?ClientReferenceId=[string]&api_key=[string]
Production: https://api2.compassion.com/ci/v1/children/{childkey}/information?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 | Fixed 9 |
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 |
---|---|---|
ChildKey | Code assigned by Compassion International when the child is registered in the Child Sponsorship Program. | number |
ChildName | Name of the child. | string |
ChildAbbreviatedName |
Child name abbreviated to 30 characters. |
string |
ChildPersonalName | First name or nickname that is used to address the child. | string |
Gender | Child's gender. | string |
BirthDate | Child's birth date. | string |
Age | Child's age. | string |
BirthDateKnownFlag | Flag indicating if child actual birth date is known. | boolean |
StartDate | Date that the first set of data for the CDSP Child was entered into the Compassion system. | string |
FieldStartDate | The first Registration Date of the CDSP Child. It is recorded as the first day of the month the registration occurred. | string |
LastCaseStudyDate | Date the last case study was completed for the child. | string |
LastCaseStudyModifiedDate | Date a portion of the current case study was modified. | string |
OverAgeFlag | Flag indicating if the child is allowed to continue in the program beyond the maximum age. | boolean |
SiblingFlag | Flag indicating if the child has brothers or sisters in the CDSP Program. | boolean |
OrphanFlag | Flag indicating if the child has brothers or sisters in the CDSP Program. | boolean |
HandicappedFlag | Indicator identifying a child as handicapped. | boolean |
ChildAttendingSchoolFlag | Flag indicating if the child is attending school. | boolean |
USSchoolEquivalent |
Equivalent US school grade level child is in. Values can be: |
string |
SchoolPerformance | Performance of child in school - average, below average or above average. | string |
CDSPCompletionDate | Date child is expected to complete the CDSP Program. | string |
CSPGraduationFlag | Flag designating a beneficiary as being a CSP graduate. | boolean |
CSPEnrollDate | string | |
CSPProject | An Implementing Church Partner that is a CSP Implementor. | string |
SponsorFlag | Flag indicating if the child is sponsored. | boolean |
ProgramStatus | One of three states of a project: active, phase out, or terminated. | string |
ParticipationStopDate | The date and time when the participation ended with Compassion. | string |
BeginWaitTime | The date and time when the child first started waiting for sponsorship. | string |
ChildBasic | Child Key | string |
ChristianActivities |
Values can include:
There is also free text for other Christian activities. |
string |
FamilyDuties |
Values can include:
There is also free text for other family duties. |
string |
HobbiesAndSports |
Values can include:
|
string |
Health |
Values can include:
The following can have a value of (Crippled/Birth, Crippled/Disease, Crippled/Injury)
There is also free text for diseases: example: Kidney diseases or Congenital Heart Diseases etc. |
string |
Schooling |
Values can include:
|
string |
Guardians |
Values can include:
|
string |
NaturalParents | Values can include:
|
string |
Employment |
Values can include:
|
string |
FamilySize |
|
string |
ParticipationID | Id of the current participation | number |
XML Sample Successful Response
<ChildInformationDetail xmlns="http://schemas.ci.org/ci/common/ipg/2014/10/">
<ChildID>nnnnnnn<ChildID>
<ChildKey>aannnnnnn</ChildKey>
<ChildName>[string]</ChildName>
<ChildAbbreviatedName>[string]</ChildAbbreviatedName>
<ChildPersonalName>[string]</ChildPersonalName>
<Gender>M</Gender>
<BirthDate>1995-07-28T00:00:00</BirthDate>
<Age>17</Age>
<BirthDateKnownFlag>true</BirthDateKnownFlag>
<StartDate>2002-05-10T09:56:55</StartDate>
<FieldStartDate>2002-04-01T00:00:00</FieldStartDate>
<LastCaseStudyDate>2012-04-01T00:00:00</LastCaseStudyDate>
<LastCaseStudyModifiedDate>2012-05-04T04:50:56</LastCaseStudyModifiedDate>
<OverAgeFlag>true</OverAgeFlag>
<SiblingFlag>false</SiblingFlag>
<OrphanFlag>false</OrphanFlag>
<HandicappedFlag>false</HandicappedFlag>
<ChildAttendingSchool>true</ChildAttendingSchool>
<USSchoolEquivalent>[string]</USSchoolEquivalent>
<SchoolPerformance>[string]</SchoolPerformance>
<CDSPCompletionDate>2017-07-01T00:00:00</CDSPCompletionDate>
<CSPGraduateFlag>false</CSPGraduateFlag>
<CSPEnrollDate></CSPEnrollDate>
<CSPProject></CSPProject>
<SponsorFlag>true</SponsorFlag>
<ProgramStatus>[string]</ProgramStatus>
<ParticipationStopDate></ParticipationStopDate>
<BeginWaitTime></BeginWaitTime>
<ChildBiography>
<ChildBasic>[string]</ChildBasic>
<ChristianActivities>[string]</ChristianActivities>
<FamilyDuties>[string]</FamilyDuties>
<HobbiesAndSports>[string]</HobbiesAndSports>
<Health></Health>
<Schooling>[string]</Schooling>
<Guardians>[string]</Guardians>
<NaturalParents>[string]</NaturalParents>
<Employment>[string]</Employment>
<FamilySize>[string]</FamilySize>
</ChildBiography>
<ParticipationID>{number]</ParticipationID>
</ChildInformationDetail>
JSON Sample Successful Response
{
"childID":nnnnnnn
"childKey:"aannnnnnn"
"childName":"[string]",
"childAbbreviatedName":"[string]",
"childPersonalName":"[string]",
"gender":"F",
"birthDate":"2010-08-29T00:00:00",
"age":"3",
"birthDateKnownFlag":true,
"startDate":"2012-09-20T15:48:55",
"fieldStartDate":"2012-09-20T00:00:00",
"lastCaseStudyDate":"2012-09-20T00:00:00",
"lastCaseStudyModifiedDate":"2012-09-20T15:48:56",
"overAgeFlag":true,
"siblingFlag":true,
"orphanFlag":false,
"handicappedFlag":false,
"childAttendingSchool":false,
"usSchoolEquivalent":"[number]",
"schoolPerformance":"[string]",
"cdspCompletionDate":"[string]",
"cspGraduateFlag":false,
"cspEnrollDate":"2010-12-23T00:00:00",
"cspProject":"BDCS8",
"sponsorFlag":false,
"programStatus":"[string]",
"participationStopDate":"",
"beginWaitTime":"2013-04-04T00:00:00",
"childBiography":{
"childBasic":"[string]",
"christianActivities":"[string]",
"familyDuties":"[string]",
"hobbiesAndSports":"[string]",
"health":"[string]",
"schooling":"[string]",
"guardians":"[string]",
"naturalParents":"[string]",
"employment":"[string]",
"familySize":"[string]"
},
"participationID": [string]
}
Sample Unsuccessful Responses
XML Unsuccessful Response
<Error>
<ID>[string]</ID>
<Message>Invalid Child key. Child key must be 2 alpha characters followed by 7 numeric characters.</Message>
</Error>
JSON Unsuccessful Response
{
"error": {
"id": "[string]"
"message": "Invalid Child key. Child key must be 2 alpha characters followed by 7 numeric characters."
}
}
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 |
- Previous: REST Get Child Image V1
- Up: Private REST Services
- Next: REST Get Community 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.