SOAP Get Child Case Study 201412

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

The SOAP call Get Child Case Study returns data for an active child. 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. It does not list the activities the child is not engaged in.

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/ci/childinformation/2014/12/GetChildCaseStudy
URL
Prod:    https://api2.compassion.com/ci.services/childinformation/2014/12/getchildcasestudy?api_key=[string]
IPTest: https://api2.compassion.com/iptest/ci.services/childinformation/2014/12/getchildcasestudy?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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetChildCaseStudyRequest SchemaVersion='1.0xmlns="http://schemas.ci.org/ci/services/childinformation/2014/12/">
      <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>
    </GetChildCaseStudyRequest>
  </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
ChildID Child identifier
ChildKey Same value as input
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
BirthDateKnownFlag Flag indicating if child actual birth date is known
CSPGraduateFlag Flag designating a child as a CSP graduate
CSPEnrollDate Date this child was enrolled into Compassion's Child Survival Program
CSPProject Key Child Survival Program code
ChildCaseStudyDate
CaseStudyChildKey
BasicChildInternalComment
OverAgeAllowed Flag indicating if the child is allowed to continue in the program beyond the maximum age
ChristianActivities Section containing Christian activities the child participates in
ChristianActivity
List of activities that the child is engaged in.
Values can be:
  • Sunday School/Church
  • Bible Class
  • Camp
  • Youth Group
  • Vacation Bible School
  • Choir
OtherChristianActivities Other Christian activities the child is engaged in that are not included above. This is free text.
FamilyDuties Section containing family duties the child participates in.
FamilyDuty List of duties that the child participates in
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
OtherFamilyDuties Other family duties that are not included above. This is free text.
HobbiesandSports Section containing hobbies and sports the child participates in.
Hobby List of hobbies or sports the child is participates in.
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
  • MusicalInstrument: followed by free text
OtherHobbies Other hobbies or sports the child participates in. This is free text.
HealthConditions Section containing health conditions of the child
HealthCondition List of health conditions:
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:
OtherHealthConditions Other health conditions the child has that are not listed above. This is free text.
Schooling Section containing schooling information of the child
ChildAttendingSchool T, F, NULL
ReasonNotAttending Reason child is not attending school. This is free text.
PreSchoolLevel string
KindergartenLevel string
PrimarySchoolLevel string
MiddleSchoolLevel string
HighSchoolLevel string
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)

VocationalSchoolLevel string
VocationalCourseOfStudy This is free text
ApprenticeshipLevel string
ApprenticeshipCourseOfStudy This is free text
CollegeOrUniversityLevel string
CollegeCourseOfStudy string
OtherSchoolLevel string
OtherCourseOfStudy This is free text
SchoolPerformance Values can be:
  • Below Average
  • Average
  • Above Average
ChildsBestSubject This is free text
FutureHighSchoolDate yyyymmdd
FutureHighSchoolCourseStudy This is free text
FutureUniversityDate yyyymmdd
FutureUniversityCourseOfStudy This is free text
FutureBibleSchoolDate yyyymmdd
FutureBibleSchoolCourseOfStudy This is free text
FutureVocationalDate yyyymmdd
FutureVocationalCourseOfStudy This is free text
Future Other SchoolDescription This is free text
FutureOtherCourseStudy This is free text
PlannedCompletionDate Date the child is expected to complete the Ministry Program. yyyymmdd
Guardians Section describing the child's guardians
Guardian

List of child's guardians

Values can be:

  • Mother
  • Father
  • Uncle
  • Aunt
  • Grandfather
  • Grandmother
  • Brother
  • Sister
  • Stepfather
  • Stepmother
  • Godfather
  • Godmother
  • Friends
  • Institutional Worker
  • Foster Parents
  • Other Relatives
NaturalParents Section describing the child's natural parents
NaturalParentsTogether T, F, NULL
MaritalStatusOfParents Describes marital status of parents
FatherAlive T, F, NULL
FatherLivingWithChild T, F, NULL
FatherSupportingChild T, F, NULL
MotherAlive T, F, NULL
MotherLivingWithChild T, F, NULL
MotherSupportingChild T, F, NULL
FatherHandicapped T, F, NULL
FathersHandicap Describes father's handicap
MotherHandicapped T, F, NULL
MothersHandicap Describes mother's handicap
FatherChronicallyIll T, F, NULL
FathersChronicIllness Describes father's illness
MotherChronicallyIll T, F, NULL
MothersChronicIllness Describes mother's illness
FatherMentallyIll T, F, NULL
MotherMentallyIll T, F, NULL
FatherInPrison T, F, NULL
MotherInPrison T, F, NULL
Employment Section describing parents or guardians employment
FatherOrMaleGuardianIsEmployed T, F, NULL
FatherOrMaleGuardianIsAtTimesEmployed T, F, NULL
FatherOrMaleGuardianIsUnemployed T, F, NULL
NoFatherOrMaleGuardian T, F, NULL
FatherOrMaleGuardianIsAFarmer T, F, NULL
FatherOrMaleGuardianSellsInMarket T, F, NULL
FatherOrMaleGuardianIsAChurchWorker T, F, NULL
FatherOrMaleGuardianIsAProjectWorker T, F, NULL
FatherOrMaleGuardianIsATeacher T, F, NULL
FatherOrMaleGuardianIsALaborer Type of laborer
FatherOrMaleGuardianOtherEmployment Other type of employment
MotherOrFemaleGuardianIsEmployed T, F, NULL
MotherOrFemaleGuardianIsAtTimesEmployed T, F, NULL
MotherOrFemaleGuardianIsUnemployed T, F, NULL
NoMotherOrFemaleGuardian T, F, NULL
MotherOrFemaleGuardianIsAFarmer T, F, NULL
MotherOrFemaleGuardianSellsInMarket T, F, NULL
MotherOrFemaleGuardianIsAChurchWorker T, F, NULL
MotherOrFemaleGuardianIsAProjectWorker T, F, NULL
MotherOrFemal Guardian IsATeacher T, F, NULL
MotherOrFemaleGuardianIsALaborer Type of laborer
MotherOrFemaleGuardianOtherEmployment Other type of employment
FamilySize Section describing family size the child lives in
TotalFamilyFemalesUnder18 string
TotalFamilyMalesUnder18 string
FirstBrotherOrSister Other sibling in Compassion program
SecondBrotherOrSister Other sibling in Compassion program
ChildCaseStudyLastModifiedDate 'yyyy-MM-dd'T'HH:mm:ss.SS'-'hh:mm' (Indicates when this specific record was last updated - includes date and time with GMT offset)

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/">PubChldInfo_TC-002</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>
    <GetChildCaseStudyResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/childinformation/2014/12/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="ChildKey" value="aannnnnnn" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
      <ChildCaseStudyCollection rowcount="1">
        <ChildCaseStudy xmlns="http://schemas.ci.org/ci/common/ipg/2014/12/">
          <ChildID>[string]</ChildID>
          <ChildKey>[string]</ChildKey>
          <ChildName>[string]</ChildName>
          <ChildAbbreviatedName>[string]</ChildAbbreviatedName>
          <ChildPersonalName>[string]</ChildPersonalName>
          <Gender>F</Gender>
          <BirthDate>yyyymmdd</BirthDate>
          <BirthDateKnownFlag>T</BirthDateKnownFlag>
          <CSPGraduateFlag>F</CSPGraduateFlag>
          <CSPEnrollDate/>
          <CSPProjectKey/>
          <ChildCaseStudyDate>2014-02-01T00:00:00-07:00</ChildCaseStudyDate>
          <CaseStudyChildKey>aannnnnnn</CaseStudyChildKey>
          <BasicChildInternalComment/>
          <OverAgeAllowed>T</OverAgeAllowed>
          <ChristianActivities>
            <ChristianActivity>Sunday School/Church</ChristianActivity>
            <ChristianActivity>Bible Class</ChristianActivity>
            <ChristianActivity>Vacation Bible School</ChristianActivity>
          </ChristianActivities>
          <OtherChristianActivities>Helping others read the bible</OtherChristianActivities>
          <FamilyDuties>
            <FamilyDuty>Washing Clothes</FamilyDuty>
            <FamilyDuty>Making Beds</FamilyDuty>
            <FamilyDuty>Cleaning</FamilyDuty>
            <FamilyDuty>Carries Water</FamilyDuty>
            <FamilyDuty>Child Care</FamilyDuty>
          </FamilyDuties>
          <OtherFamilyDuties>None</OtherFamilyDuties>
          <HobbiesAndSports>
            <Hobby>Group Games</Hobby>
            <Hobby>Bicycling</Hobby>
            <Hobby>Walking</Hobby>
            <Hobby>Reading</Hobby>
            <Hobby>Jump Rope</Hobby>
          </HobbiesAndSports>
          <OtherHobbies>None</OtherHobbies>
          <HealthConditions>
            <HealthCondition>Regular Medical Treatment</HealthCondition>
          </HealthConditions>
          <OtherHealthConditions>None</OtherHealthConditions>
          <Schooling>
            <ChildAttendingSchool>T</ChildAttendingSchool>
            <ReasonNotAttending/>
            <PreSchoolLevel>00</PreSchoolLevel>
            <KindergartenLevel>00</KindergartenLevel>
            <PrimarySchoolLevel>00</PrimarySchoolLevel>
            <MiddleSchoolLevel>00</MiddleSchoolLevel>
            <HighSchoolLevel>11</HighSchoolLevel>
            <USSchoolEquivalent>11</USSchoolEquivalent>
            <VocationalSchoolLevel>00</VocationalSchoolLevel>
            <VocationalCourseOfStudy/>
            <ApprenticeshipLevel>00</ApprenticeshipLevel>
            <ApprenticeshipCourseOfStudy/>
            <CollegeOrUniversityLevel>00</CollegeOrUniversityLevel>
            <CollegeCourseOfStudy/>
            <OtherSchoolLevel>00</OtherSchoolLevel>
            <OtherCourseOfStudy/>
            <SchoolPerformance>Average</SchoolPerformance>
            <ChildsBestSubject>[string]</ChildsBestSubject>
            <FutureHighSchoolDate/>
            <FutureHighSchoolCourseOfStudy/>
            <FutureUniversityDate/>
            <FutureUniversityCourseOfStudy/>
            <FutureBibleSchoolDate/>
            <FutureBibleSchoolCourseOfStudy/>
            <FutureVocationalDate/>
            <FutureVocationalCourseOfStudy/>
            <FutureOtherSchoolDescription/>
            <FutureOtherSchoolDate/>
            <FutureOtherSchoolCourseOfStudy/>
            <PlannedCompletionDate>yyyymmdd</PlannedCompletionDate>
          </Schooling>
          <Guardians>
            <Guardian>Father</Guardian>
            <Guardian>Mother</Guardian>
          </Guardians>
          <NaturalParents>
            <NaturalParentsTogether>T</NaturalParentsTogether>
            <MaritalStatusOfParents>Now married</MaritalStatusOfParents>
            <FatherAlive>T</FatherAlive>
            <FatherLivingWithChild>T</FatherLivingWithChild>
            <FatherSupportingChild>T</FatherSupportingChild>
            <MotherAlive>T</MotherAlive>
            <MotherLivingWithChild>T</MotherLivingWithChild>
            <MotherSupportingChild>F</MotherSupportingChild>
            <FatherHandicapped>F</FatherHandicapped>
            <FathersHandicap/>
            <MotherHandicapped>F</MotherHandicapped>
            <MothersHandicap/>
            <FatherChronicallyIll>F</FatherChronicallyIll>
            <FathersChronicIllness/>
            <MotherChronicallyIll>F</MotherChronicallyIll>
            <MothersChronicIllness/>
            <FatherMentallyIll>F</FatherMentallyIll>
            <MotherMentallyIll>F</MotherMentallyIll>
            <FatherInPrison>F</FatherInPrison>
            <MotherInPrison>F</MotherInPrison>
          </NaturalParents>
          <Employment>
            <FatherOrMaleGuardianIsEmployed>F</FatherOrMaleGuardianIsEmployed>
            <FatherOrMaleGuardianIsAtTimesEmployed>T</FatherOrMaleGuardianIsAtTimesEmployed>
            <FatherOrMaleGuardianIsUnemployed>F</FatherOrMaleGuardianIsUnemployed>
            <NoFatherOrMaleGuardian>F</NoFatherOrMaleGuardian>
            <FatherOrMaleGuardianIsAFarmer>F</FatherOrMaleGuardianIsAFarmer>
            <FatherOrMaleGuardianSellsInMarket>F</FatherOrMaleGuardianSellsInMarket>
            <FatherOrMaleGuardianIsAChurchWorker>F</FatherOrMaleGuardianIsAChurchWorker>
            <FatherOrMaleGuardianIsAProjectWorker>F</FatherOrMaleGuardianIsAProjectWorker>
            <FatherOrMaleGuardianIsATeacher>F</FatherOrMaleGuardianIsATeacher>
            <FatherOrMaleGuardianIsALaborer>Daily Labour</FatherOrMaleGuardianIsALaborer>
            <FatherOrMaleGuardianOtherEmployment/>
            <MotherOrFemaleGuardianIsEmployed>F</MotherOrFemaleGuardianIsEmployed>
            <MotherOrFemaleGuardianIsAtTimesEmployed>F</MotherOrFemaleGuardianIsAtTimesEmployed>
            <MotherOrFemaleGuardianIsUnemployed>T</MotherOrFemaleGuardianIsUnemployed>
            <NoMotherOrFemaleGuardian>F</NoMotherOrFemaleGuardian>
            <MotherOrFemaleGuardianIsAFarmer>F</MotherOrFemaleGuardianIsAFarmer>
            <MotherOrFemaleGuardianSellsInMarket>F</MotherOrFemaleGuardianSellsInMarket>
            <MotherOrFemaleGuardianIsAChurchWorker>F</MotherOrFemaleGuardianIsAChurchWorker>
            <MotherOrFemaleGuardianIsAProjectWorker>F</MotherOrFemaleGuardianIsAProjectWorker>
            <MotherOrFemaleGuardianIsATeacher>F</MotherOrFemaleGuardianIsATeacher>
            <MotherOrFemaleGuardianIsALaborer/>
            <MotherOrFemaleGuardianOtherEmployment/>
          </Employment>
          <FamilySize>
            <TotalFamilyFemalesUnder18>01</TotalFamilyFemalesUnder18>
            <TotalFamilyMalesUnder18>01</TotalFamilyMalesUnder18>
            <FirstBrotherOrSister/>
            <SecondBrotherOrSister/>
          </FamilySize>
          <ChildCaseStudyLastModifiedDate>2013-05-31T06:42:18.43-06:00</ChildCaseStudyLastModifiedDate>

        </ChildCaseStudy>
      </ChildCaseStudyCollection>
    </GetChildCaseStudyResponse>
  </s:Body>
</s:Envelope>

Sample Unsuccessful Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PubChldInfo_TC-002</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>
    <GetChildCaseStudyResponse ResponseCode="0SchemaVersion="1.0xmlns="http://schemas.ci.org/ci/services/childinformation/2014/12/">
      <RequestCriteria SchemaVersion="1.0xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="ChildKeyvalue="aannnnnnncomparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
      <ErrorResponse SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <ErrorName>Validation Error</ErrorName>
        <DateTimestamp>2015-01-26T13:39:26.3673155-07:00</DateTimestamp>
        <SendersAppName>PublicSimpleRequestReplySoapService</SendersAppName>
        <ServiceName>PublicSimpleRequestReplySoapService</ServiceName>
        <ErrorId>[guid]</ErrorId>
        <ErrorCode>4004</ErrorCode>
        <ErrorMessage>Incorrect data type: childKey can only be 9 digit alphanumeric string (AANNNNNNN).</ErrorMessage>
      </ErrorResponse>
    </GetChildCaseStudyResponse>
  </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