SOAP Get Child Information 201211

This service will be deprecated. Please use SOAP Get Child Information 201310.

Note: This service is not available in our interactive API option.

The SOAP call Get Child Information 201211 provides information on a child enrolled in the Child Development Sponsorship Program (CDSP).

Most of the data returned applies to the requested child. For example, the field Christian Activities lists only the activities the requested child is actively engaged in.

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
Sample Successful Response
Sample Unsuccessful Response
Error Response Codes

Sample Request

This is an example only.

Action
http://services.ci.org/public/ci/childinformation/2012/11/GetChildInformation
URL
Prod:    https://api2.compassion.com/ci.services/childinformation/2012/11/getchildinformation?api_key=[string]
IPTest: https://api2.compassion.com/iptest/ci.services/childinformation/2012/11/getchildinformation?api_key=[string]

XML
<s:Envelope xmlns:s='http://schemas.xmlsoap.org/soap/envelope/'>
  <s:Header>
    <ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</ClientReferenceId>
  </s:Header>
  <s:Body>
    <GetChildInformationRequest SchemaVersion="1.0" xmlns="http://schemas.ci.org/public/ci/services/childinformation/2012/11/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="ChildKey" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
    </GetChildInformationRequest>
  </s:Body>
</s:Envelope>

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

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)

SchoolPerformance 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
ChildBasic Child Key
ChristianActivities

Values can be:

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

There is also free text for other Christian activities.

FamilyDuties

Values can be:

  • 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.

HobbiesAndSports

Values can be:

  • 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
Health

Values can be:

  • 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.

Schooling

Values can be:

  • 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)
Guardians

Values can be:

  • Mother
  • Father
  • Uncle
  • Aunt
  • Grandfather
  • Grandmother
  • Brother
  • Sister
  • Stepfather
  • Stepmother
  • Godfather
  • Godmother
  • Friends
  • Institutional Worker
  • Foster Parents
  • Other Relatives
NaturalParents Values can be:
  • 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
Employment

Values can be:

  • 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) [employmnt is spelled this way in Compass and the DVL]
  • Mother/FG employed
FamilySize
  • Number Of Children Living At Home = n

Sample Successful Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
 
 <s:Header>   
    <ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</ClientReferenceId>
    <SendingNode xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendingNode>
    <MessageStreamId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageStreamId>
    <EventSequenceNumber xmlns="http://schemas.ci.org/ci/services/common/2011/04/">8</EventSequenceNumber>
    <MessageId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageId>
    <RelatesTo xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</RelatesTo>
    <SendersName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">CI\esbservice</SendersName>   
    <
SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendersAppName>   
    <SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
  </s:Header>
  <s:Body>
    <GetChildInformationResponse SchemaVersion="1.0" ResponseCode="0" xmlns="http://schemas.ci.org/public/ci/services/childinformation/2012/11/">
      <RequestCriteria SchemaVersion="1.0xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="ChildKey" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
      <ChildInformationDetail>
        <ChildKey>[string]</ChildKey>
        <ChildName>[string]</ChildName>
        <ChildAbbreviatedName>[string]</ChildAbbreviatedName>
        <ChildPersonalName>[string]</ChildPersonalName>
        <Gender>M</Gender>
        <BirthDate>1995-07-28T00:00:00</BirthDate>
        <Age>17</Age>
        <BirthDateKnownFlag>T</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>T</OverAgeFlag>
        <SiblingFlag>F</SiblingFlag>
        <OrphanFlag>F</OrphanFlag>
        <HandicappedFlag>F</HandicappedFlag>
        <ChildAttendingSchool>T</ChildAttendingSchool>
        <USSchoolEquivalent>12</USSchoolEquivalent>
        <SchoolPerformance>Average</SchoolPerformance>
        <CDSPCompletionDate>2017-07-01T00:00:00</CDSPCompletionDate>
        <CSPGraduateFlag>F</CSPGraduateFlag>
        <CSPEnrollDate xsi:nil="truexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <CSPProject/>
        <SponsorFlag>T</SponsorFlag>
        <ProgramStatus>A</ProgramStatus>
        <ParticipationStopDate xsi:nil="truexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <BeginWaitTime xsi:nil="truexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        <ChildBiography>
          <ChildBasic>[string]</ChildBasic>
          <ChristianActivities>Sunday School/Church</ChristianActivities>
          <FamilyDuties>Gardening/Farming,Carries Water,Teaching Others</FamilyDuties>
          <HobbiesAndSports>Art/Drawing,Reading,Running,Story Telling</HobbiesAndSports>
          <Health/>
          <Schooling>US School Equivalent: 12,Child's best subject: Biology</Schooling>
          <Guardians>Uncle,Aunt</Guardians>
          <NaturalParents>Were never married,Father alive</NaturalParents>
          <Employment>Father/MG at times employed,Father/MG other employment</Employment>
          <FamilySize>Number Of Children Living at Home = 6</FamilySize>
        </ChildBiography>
      </ChildInformationDetail>
    </GetChildInformationResponse>
  </s:Body>
</s:Envelope>

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

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</ClientReferenceId>
    <SendingNode xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendingNode>
    <MessageStreamId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageStreamId>
    <EventSequenceNumber xmlns="http://schemas.ci.org/ci/services/common/2011/04/">3</EventSequenceNumber>
    <SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendersAppName>   
    <RelatesTo xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</RelatesTo>
    <MessageId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageId>
    <SendersName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">NT AUTHORITY\SYSTEM</SendersName>   
    <SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
  </s:Header>

  <s:Body>
    <GetChildInformationResponse ResponseCode="1" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/childinformation/2012/11/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="ChildKey" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
      <ErrorResponse SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <ErrorName>Validation Error</ErrorName>
        <DateTimestamp>2014-08-18T08:59:28.4554624-06:00</DateTimestamp>
        <SendersAppName>PublicSimpleRequestReplySoapService</SendersAppName>
        <ServiceName>PublicSimpleRequestReplySoapService</ServiceName>
        <ErrorId>ce5946a9-bb45-4430-b639-5f2035ac5d1d</ErrorId>
        <ErrorCode>4004</ErrorCode>
        <ErrorMessage>Incorrect parameter: ChildKey must follow the correct format 'AANNNNNNN'.</ErrorMessage>
      </ErrorResponse>
    </GetChildInformationResponse>
  </s:Body>
</s:Envelope>

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