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:
blank
1
2
3
4
5
6
7
8
9
10
11
12
13
14
K (Kindergarten)
P (Primary)
PK (pre-Kindergarten)

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:

  • Sunday School/Church
  • Bible Class
  • Camp
  • Youth Group
  • Vacation Bible School
  • Choir

There is also free text for other Christian activities.

string
FamilyDuties

Values can include:

  • Washing Clothes
  • Making Beds
  • Cleaning
  • Carries Water
  • Kitchen Help
  • Animal Care
  • Running Errands
  • Child Care
  • Buying/Selling in Market
  • Gathers Firewood
  • Gardening/Farming
  • Sewing
  • Teaching Others

There is also free text for other family duties.

string
HobbiesAndSports

Values can include:

  • Art/Drawing
  • Baseball
  • Basketball
  • Bicycling
  • Cars
  • Dolls
  • Group Games
  • Hide and Seek
  • Jacks
  • Jump Rope
  • Listening to Music
  • Marbles
  • Musical Instrument
  • Other Ball Games
  • Other Sports Or Hobbies
  • Ping Pong
  • Play House
  • Reading
  • Rolling a hoop
  • Running
  • Singing
  • Soccer/Footbal
  • Story Telling
  • Swimming
  • Volleyball
  • Walking
string
Health

Values can include:

  • Epilepsy
  • Asthma
  • Polio
  • Developmentally Disabled
  • Speech: (values: Defective, Mute)
  • Hearing Left Ear: (values: Defective, Deaf)
  • Hearing Right Ear: (values: Defective, Deaf)
  • Sight Left Eye: (values: Defective, Blind)
  • Sight Right Eye: (values: Defective, Blind)
  • Regular Medical Treatmnt
  • Regular Medication
  • None

The following can have a value of (Crippled/Birth, Crippled/Disease, Crippled/Injury)

  • Left Leg due to:
  • Right Leg due to:
  • Left Foot due to:
  • Right Foot due to:
  • Left Arm due to:
  • Right Arm due to:
  • Left Hand due to:
  • Right Hand due to:
  • Spine due to:

There is also free text for diseases: example: Kidney diseases or Congenital Heart Diseases etc.

string
Schooling

Values can include:

  • Child Attending School
  • Reason not attending school because: (free text)
  • School Performance: values: Below Average, Average, Above Average)
  • Child's best subject: (free text)
  • Completion Date: yyyymmdd
  • US School Equivalent: nn
  • Pre-School: nn
  • Kindergarten: nn
  • Primary School: nn
  • Middle School: nn
  • High School: nn
  • Vocational School Level: nn
  • Vocatl: Course of Study: (free text)
  • Apprenticeship Level: nn
  • Appren: Course of Study (free text)
  • College/University Level: nn
  • College: Course of Study: (free text)
  • Other School Level: nn
  • Other: Course of Study: (free text)
  • Future High School Date: yyyymmdd
  • Future HS Course Study: (free text)
  • Future Vocational Date: yyyymmdd
  • Future Voctl Course Study: (free text)
  • Future Bible School date: yyyymmdd
  • Future BS Course Study: (free text)
  • Future University Date: yyyymmdd
  • Future Univ. Course Study: (free text)
  • Future Other School Date: yyyymmdd
  • Future Other School Desc: (free text)
  • Future Other Course Study: (free text)
string
Guardians

Values can include:

  • Mother
  • Father
  • Uncle
  • Aunt
  • Grandfather
  • Grandmother
  • Brother
  • Sister
  • Stepfather
  • Stepmother
  • Godfather
  • Godmother
  • Friends
  • Institutional Worker
  • Foster Parents
  • Other Relatives
string
NaturalParents Values can include:
  • Natural Parents together
  • Now Married
  • Were married, now separated by death
  • Now divorced or permanently separated
  • Were never married
  • Father alive
  • Father living with child
string
Employment

Values can include:

  • Father/MG employed
  • Father/MG at times employ
  • Father/MG unemployed
  • No Father nor M.Guardian
  • Father/MG is a Farmer
  • Father/MG sells in market
  • Father/MG church worker
  • Father/MG project worker
  • Father/MG is teacher
  • Father/MG is a laborer
  • Father/MG other employmnt (free text) [yes, employmnt is spelled this way in Compass and the DVL]
  • Mother/FG employed
string
FamilySize
  • Number Of Children Living At Home = n<
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

Docs Navigation