REST Get Child Case Study V1

The REST call, Get Child Case Study, returns data for an child actively enrolled in the Child Development Sponsorship Program (CDSP). Each field is included as an element in the response.

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}/casestudy?ClientReferenceId=[string]&api_key=[string]

Production: https://api2.compassion.com/ci/v1/children/{childkey}/casestudy?ClientReferenceId=[string]&api_key=[string] 

Request Parameters

NameDescriptionRequiredData TypeConstraints
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
ChildId Child identifier number
ChildKey Same value as input string
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
Format: 2008-03-01T00:00:00-07:00

BirthDateKnownFlag Flag indicating if child actual birth date is known boolean
CSPGraduateFlag Flag designating a child as a CSP graduate
boolean
CSPEnrollDate Date this child was enrolled into Compassion's Child Survival Program string
CSPProject Key Child Survival Program code string
ChildCaseStudyDate string
Format: 2008-03-01T00:00:00-07:00
CaseStudyChildKey string
BasicChildInternalComment string
OverAgeAllowed Flag indicating if the child is allowed to continue in the program beyond the maximum age boolean
ChristianActivities Section containing Christian activites 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
string
OtherChristianActivities Other Christian activities the child is engaged in that are not included above. This is free text. string
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
string
OtherFamilyDuties Other family duties that are not included above. This is free text. string
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
string
OtherHobbies Other hobbies or sports the child participates in. This is free text. string
HealthConditions Section containing health condtions 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:
string
OtherHealthConditions Other health conditions the child has that are not listed above. This is free text. string
Schooling Section containing schooling information of the child
ChildAttendingSchool boolean boolean
ReasonNotAttending This is free text. string
PreSchoolLevel string string
KindergartenLevel string string
PrimarySchoolLevel string string
MiddleSchoolLevel string string
HighSchoolLevel string 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)

string
VocationalSchoolLevel string string
VocationalCourseOfStudy This is free text string
ApprenticeshipLevel string string
ApprenticeshipCourseOfStudy This is free text string
CollegeOrUniversityLevel string string
CollegeCourseOfStudy string string
OtherSchoolLevel string string
OtherCourseOfStudy This is free text string
SchoolPerformance

Values can be:

  • Below Average
  • Average
  • Above Average
string
ChildsBestSubject This is free text string
FutureHighSchoolDate yyyymmdd string
FutureHighSchoolCourseStudy This is free text string
FutureUniversityDate yyyymmdd string
FutureUniversityCourseOfStudy This is free text string
FutureBibleSchoolDate yyyymmdd string
FutureBibleSchoolCourseOfStudy This is free text string
FutureVocationalDate yyyymmdd string
FutureVocationalCourseOfStudy This is free text string
Future Other SchoolDescription This is free text string
FutureOtherCourseStudy This is free text string
PlannedCompletionDate Date the child is expected to complete the Ministry Program. yyyymmdd
string
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 boolean boolean
MaritalStatusOfParents Describes marital status of parents string
FatherAlive boolean boolean
FatherLivingWithChild boolean boolean
FatherSupportingChild boolean boolean
MotherAlive boolean boolean
MotherLivingWithChild boolean boolean
MotherSupportingChild boolean boolean
FatherHandicapped boolean boolean
FathersHandicap Describes father's handicap string
MotherHandicapped boolean boolean
MothersHandicap Describes mother's handicap string
FatherChronicallyIll boolean boolean
FathersChronicIllness Describes father's illness string
MotherChronicallyIll boolean boolean
MothersChronicIllness Describes mother's illness string
FatherMentallyIll boolean boolean
MotherMentallyIll boolean boolean
FatherInPrison boolean boolean
MotherInPrison boolean boolean
Employment Section describing parents or guardians employment
FatherOrMaleGuardianIsEmployed boolean boolean
FatherOrMaleGuardianIsAtTimesEmployed boolean boolean
FatherOrMaleGuardianIsUnemployed boolean boolean
NoFatherOrMaleGuardian boolean boolean
FatherOrMaleGuardianIsAFarmer boolean boolean
FatherOrMaleGuardianSellsInMarket boolean boolean
FatherOrMaleGuardianIsAChurchWorker boolean boolean
FatherOrMaleGuardianIsAProjectWorker boolean boolean
FatherOrMaleGuardianIsATeacher boolean boolean
FatherOrMaleGuardianIsALaborer Type of laborer string
FatherOrMaleGuardianOtherEmployment Other type of employment string
MotherOrFemaleGuardianIsEmployed boolean boolean
MotherOrFemaleGuardianIsAtTimesEmployed boolean boolean
MotherOrFemaleGuardianIsUnemployed boolean boolean
NoMotherOrFemaleGuardian boolean boolean
MotherOrFemaleGuardianIsAFarmer boolean boolean
MotherOrFemaleGuardianSellsInMarket boolean boolean
MotherOrFemaleGuardianIsAChurchWorker boolean boolean
MotherOrFemaleGuardianIsAProjectWorker boolean boolean
MotherOrFemal Guardian IsATeacher boolean boolean
MotherOrFemaleGuardianIsALaborer Type of laborer string
MotherOrFemaleGuardianOtherEmployment Other type of employment string
FamilySize Section describing family size the child lives in
TotalFamilyFemalesUnder18 string string
TotalFamilyMalesUnder18 string string
FirstBrotherOrSister Other sibling in Compassion program string
SecondBrotherOrSister Other sibling in Compassion program string
ChildCaseStudyLastModifiedDate Last date Child Case Study was modified string
Format: 2008-03-01T00:00:00-07:00

XML Sample Successful Response

<ChildCaseStudy  xmlns="http://schemas.ci.org/ci/common/ipg/2014/10/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ChildID>[number]</ChildID>
  <ChildKey>[string]</ChildKey>
  <ChildName>[string]</ChildName>
  <ChildAbbreviatedName>[string]</ChildAbbreviatedName>
  <ChildPersonalName>[string]</ChildPersonalName>
  <Gender>M</Gender>
  <BirthDate>1995-07-28T00:00:00-06:00</BirthDate>
  <BirthDateKnownFlag>true</BirthDateKnownFlag>
  <CSPGraduateFlag>false</CSPGraduateFlag>
  <CSPEnrollDate />
  <CSPProjectKey />
  <ChildCaseStudyDate>2012-04-01T00:00:00-06:00</ChildCaseStudyDate>
  <CaseStudyChildKey>[string]</CaseStudyChildKey>
  <BasicChildInternalComment />
  <OverAgeAllowed>true</OverAgeAllowed
  <ChristianActivities>
    <ChristianActivity>Sunday School/Church</ChristianActivity>
    <ChristianActivity>Bible Class</ChristianActivity
  </ChristianActivities>
  <OtherChristianActivities>None</OtherChristianActivities
  <FamilyDuties>
    <FamilyDuty>Washing Clothes</FamilyDuty>
    <FamilyDuty>Gardening/Farming</FamilyDuty>
    <FamilyDuty>Running Errands</FamilyDuty>
    <FamilyDuty>Making Beds</FamilyDuty>
    <FamilyDuty>Cleaning</FamilyDuty>
    <FamilyDuty>Carries Water</FamilyDuty>
    <FamilyDuty>Teaching Others</FamilyDuty>
    <FamilyDuty>Kitchen Help</FamilyDuty
  </FamilyDuties>
  <OtherFamilyDuties>None</OtherFamilyDuties
  <HobbiesAndSports>
    <Hobby>Group Games</Hobby>
    <Hobby>Soccer/Football</Hobby>
    <Hobby>Bicycling</Hobby>
    <Hobby>Walking</Hobby>
    <Hobby>Volleyball</Hobby>
    <Hobby>Running</Hobby>
    <Hobby>Reading</Hobby>
    <Hobby>Art/Drawing</Hobby>
    <Hobby>Singing</Hobby>
    <Hobby>Other Ball Games</Hobby>
    <Hobby>Story Telling</Hobby>
  </HobbiesAndSports>
  <OtherHobbies>Swinging</OtherHobbies>
  <HealthConditions />
  <OtherHealthConditions>None</OtherHealthConditions
  <Schooling>
    <ChildAttendingSchool>true</ChildAttendingSchool>
    <ReasonNotAttending />
    <PreSchoolLevel>00</PreSchoolLevel>
    <KindergartenLevel>00</KindergartenLevel>
    <PrimarySchoolLevel>00</PrimarySchoolLevel>    
    <MiddleSchoolLevel>04</MiddleSchoolLevel>
    <HighSchoolLevel>00</HighSchoolLevel>
    <USSchoolEquivalent>12</USSchoolEquivalent>
    <VocationalSchoolLevel>00</VocationalSchoolLevel>
    <VocationalCourseOfStudy />
    <ApprenticeshipLevel>00</ApprenticeshipLevel>
    <ApprenticeshipCourseOfStudy />
    <CollegeOrUniversityLevel>00</CollegeOrUniversityLevel>
    <CollegeCourseOfStudy />
    <OtherSchoolLevel>00</OtherSchoolLevel>
    <OtherCourseOfStudy />
    <SchoolPerformance>Average</SchoolPerformance>
    <ChildsBestSubject>Biology</ChildsBestSubject>
    <FutureHighSchoolDate />
    <FutureHighSchoolCourseOfStudy />
    <FutureUniversityDate />
    <FutureUniversityCourseOfStudy />
    <FutureBibleSchoolDate />
    <FutureBibleSchoolCourseOfStudy />
    <FutureVocationalDate />
    <FutureVocationalCourseOfStudy />
    <FutureOtherSchoolDescription />
    <FutureOtherSchoolDate />
    <FutureOtherSchoolCourseOfStudy />
    <PlannedCompletionDate>[yyyymmdd]</PlannedCompletionDate
  </Schooling
  <Guardians>
    <Guardian>Uncle</Guardian>
    <Guardian>Aunt</Guardian
  </Guardians
  <NaturalParents>
    <NaturalParentsTogether>false</NaturalParentsTogether>
    <MaritalStatusOfParents>[string]</MaritalStatusOfParents>
    <FatherAlive>true</FatherAlive>
    <FatherLivingWithChild>false</FatherLivingWithChild>
    <FatherSupportingChild>false</FatherSupportingChild
    <MotherAlive>true</MotherAlive>
    <MotherLivingWithChild>false</MotherLivingWithChild>
    <MotherSupportingChild>false</MotherSupportingChild>
    <FatherHandicapped>false</FatherHandicapped>
    <FathersHandicap /> 
    <MotherHandicapped>false</MotherHandicapped>
    <MothersHandicap />
    <FatherChronicallyIll>false</FatherChronicallyIll>
    <FathersChronicIllness />  
    <MotherChronicallyIll>false</MotherChronicallyIll>
    <MothersChronicIllness />
    <FatherMentallyIll>false</FatherMentallyIll>
    <MotherMentallyIll>false</MotherMentallyIll>
    <FatherInPrison>false</FatherInPrison>
    <MotherInPrison>false</MotherInPrison
  </NaturalParents
  <Employment>
    <FatherOrMaleGuardianIsEmployed>false</FatherOrMaleGuardianIsEmployed>
    <FatherOrMaleGuardianIsAtTimesEmployed>true</FatherOrMaleGuardianIsAtTimesEmployed>
    <FatherOrMaleGuardianIsUnemployed>false</FatherOrMaleGuardianIsUnemployed>
    <NoFatherOrMaleGuardian>false</NoFatherOrMaleGuardian>
    <FatherOrMaleGuardianIsAFarmer>false</FatherOrMaleGuardianIsAFarmer>
    <FatherOrMaleGuardianSellsInMarket>false</FatherOrMaleGuardianSellsInMarket>
    <FatherOrMaleGuardianIsAChurchWorker>false</FatherOrMaleGuardianIsAChurchWorker>
    <FatherOrMaleGuardianIsAProjectWorker>false</FatherOrMaleGuardianIsAProjectWorker>
    <FatherOrMaleGuardianIsATeacher>false</FatherOrMaleGuardianIsATeacher>
    <FatherOrMaleGuardianIsALaborer />
    <FatherOrMaleGuardianOtherEmployment>[string]</FatherOrMaleGuardianOtherEmployment>
    <MotherOrFemaleGuardianIsEmployed>false</MotherOrFemaleGuardianIsEmployed>
    <MotherOrFemaleGuardianIsAtTimesEmployed>true</MotherOrFemaleGuardianIsAtTimesEmployed>
    <MotherOrFemaleGuardianIsUnemployed>false</MotherOrFemaleGuardianIsUnemployed>
    <NoMotherOrFemaleGuardian>false</NoMotherOrFemaleGuardian>
    <MotherOrFemaleGuardianIsAFarmer>false</MotherOrFemaleGuardianIsAFarmer>
    <MotherOrFemaleGuardianSellsInMarket>true</MotherOrFemaleGuardianSellsInMarket>
    <MotherOrFemaleGuardianIsAChurchWorker>false</MotherOrFemaleGuardianIsAChurchWorker>
    <MotherOrFemaleGuardianIsAProjectWorker>false</MotherOrFemaleGuardianIsAProjectWorker>
    <MotherOrFemaleGuardianIsATeacher>false</MotherOrFemaleGuardianIsATeacher>
    <MotherOrFemaleGuardianIsALaborer />
    <MotherOrFemaleGuardianOtherEmployment>[string]</MotherOrFemaleGuardianOtherEmployment
  </Employment
  <FamilySize>
    <TotalFamilyFemalesUnder18>01</TotalFamilyFemalesUnder18>
    <TotalFamilyMalesUnder18>05</TotalFamilyMalesUnder18>
    <FirstBrotherOrSister />
    <SecondBrotherOrSister />
  </FamilySize
  <ChildCaseStudyLastModifiedDate>2012-04-01T00:00:00-06:00</ChildCaseStudyLastModofiedDate>
</ChildCaseStudy>

JSON Sample Successful Response

{
  "childID":[number],
  "childKey":"[string]",
  "childName":"[string]",
  "childAbbreviatedName":"[string]",
  "childPersonalName":"[string]",
  "gender":"M",
  "birthDate":"1995-07-28T00:00:00-06:00",
  "birthDateKnownFlag":true,
  "cspGraduateFlag":true,
  "cspEnrollDate":"",
  "cspProjectKey":"",
  "childCaseStudyDate":"2012-04-01T00:00:00-06:00",
  "caseStudyChildKey":"[string]",
  "basicChildInternalComment":"[string]",
  "overAgeAllowed":true,
  "christianActivities":[
    "Sunday School/Church"
  ],
  "otherChristianActivities": "None",
  "familyDuties":[
    "Washing Clothes",
    "Gardening/Farming",
    "Running Errands",
    "Making Beds",
    "Cleaning",
    "Carries Water",
    "Teaching Others",
    "Kitchen Help"
  ],
  "otherFamilyDuties":"None",
  "hobbiesAndSports":[
    "Group Games",
    "Soccer/Football",
    "Bicycling",
    "Walking",
    "Volleyball",
    "Running",
    "Reading",
    "Art/Drawing",
    "Singing",
    "Other Ball Games",
    "Story Telling"
  ],
  "otherHobbies":"Swinging",
  "healthConditions":[
  ],

  "otherHealthConditions":"None",
  "schooling":{
    "childAttendingSchool":true,
    "reasonNotAttending":"[string]",
    "preSchoolLevel":"00",
    "kindergartenLevel":"00",
    "primarySchoolLevel":"00",
    "middleSchoolLevel":"04",
    "highSchoolLevel":"00",
    "usSchoolEquivalent":"12",
    "vocationalSchoolLevel":"00",
    "vocationalCourseOfStudy":"[string]",
    "apprenticeshipLevel":"00",
    "apprenticeshipCourseOfStudy":"[string]",
    "collegeOrUniversityLevel":"00",
    "collegeCourseOfStudy":"[string]",
    "otherSchoolLevel":"00",
    "otherCourseOfStudy":"[string]",
    "schoolPerformance":"Average",
    "childsBestSubject":"Biology",
    "futureHighSchoolDate":"[string]",
    "futureHighSchoolCourseOfStudy":"[string]",
    "futureUniversityDate":"[string]",
    "futureUniversityCourseOfStudy":"[string]",
    "futureBibleSchoolDate":"[string]",
    "futureBibleSchoolCourseOfStudy":"[string]",
    "futureVocationalDate":"[string]",
    "futureVocationalCourseOfStudy":"[string]",
    "futureOtherSchoolDescription":"[string]",
    "futureOtherSchoolDate":"[string]",
    "futureOtherSchoolCourseOfStudy":"[string]",
    "plannedCompletionDate":"[yyyymmdd]"
  },
  "guardians":[
    "Father",
    "Mother"
  ],
  "naturalParents":{
    "naturalParentsTogether":true,
    "maritalStatusOfParents":"[string]",
    "fatherAlive":true,
    "fatherLivingWithChild":true,
    "fatherSupportingChild":true,
    "motherAlive":true,
    "motherLivingWithChild":true,
    "motherSupportingChild":true,
    "fatherHandicapped":true,
    "fathersHandicap":"[string]",
    "motherHandicapped":false,
    "mothersHandicap":"[string]",
    "fatherChronicallyIll":false,
    "fathersChronicIllness":"[string]",
    "motherChronicallyIll":false,
    "mothersChronicIllness":"[string]",
    "fatherMentallyIll":false,
    "motherMentallyIll":false,
    "fatherInPrison": false,
    "motherInPrison": false
  },
  "employment":{
    "fatherOrMaleGuardianIsEmployed":false,
    "fatherOrMaleGuardianIsAtTimesEmployed":true,
    "fatherOrMaleGuardianIsUnemployed":false,
    "noFatherOrMaleGuardian":false,
    "fatherOrMaleGuardianIsAFarmer":false,
    "fatherOrMaleGuardianSellsInMarket":false,
    "fatherOrMaleGuardianIsAChurchWorker":false,
    "fatherOrMaleGuardianIsAProjectWorker":false,
    "fatherOrMaleGuardianIsATeacher":false,
    "fatherOrMaleGuardianIsALaborer":"[string]",
    "fatherOrMaleGuardianOtherEmployment":"[string]",
    "motherOrFemaleGuardianIsEmployed":false,
    "motherOrFemaleGuardianIsAtTimesEmployed":true,
    "motherOrFemaleGuardianIsUnemployed":false,
    "noMotherOrFemaleGuardian":false,
    "motherOrFemaleGuardianIsAFarmer":false,
    "motherOrFemaleGuardianSellsInMarket":true,
    "motherOrFemaleGuardianIsAChurchWorker":false,
    "motherOrFemaleGuardianIsAProjectWorker":false,
    "motherOrFemaleGuardianIsATeacher":false,
    "motherOrFemaleGuardianIsALaborer":"[string]",
    "motherOrFemaleGuardianOtherEmployment:"[string]"
  },
  "familySize":{
    "totalFamilyFemalesUnder18":"[string]",
    "totalFamilyMalesUnder18":"[string]",
    "firstBrotherOrSister":"[string]",
    "secondBrotherOrSister":"[string]"
  },
  "childCaseStudyLastModifiedDate":"2012-04-01T00:00:00-06:00"
}

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

5 Comments

  1. Emanuel Cino3 years ago

    I have a question regarding this message: what is the difference between the CHILD Get Case Study and CHILD Get Information messages, and what are the use cases where you would use one of these two over the other ?

    Thanks for your help!

    ANSWER: The REST "Get CHILD Get Case Study" and "REST CHILD Get Information" services are similar and contain much of the same information.

    GetChildInformation has a few more fields about the child that are not related to the ecase, but it also does not have a complete ecase.
    The ecase structure is different in each service: GetChildInformation creates a string for each section in the ecase (i.e. <FamilyDuties>Gardening/Farming,Carries Water,Teaching Others</FamilyDuties>), whereas GetChildCaseStudy lists each FamilyDuty as an element: i.e. <FamilyDuties> <FamilyDuty>Washing Clothes</FamilyDuty> <FamilyDuty>Gardening/Farming</FamilyDuty> <FamilyDuty>Running Errands</FamilyDuty> </FamilyDuties>

    GetChildInformation has flags that are a rollup of items in the ecase. For example, "HandicappedFlag" is a rollup of "Health".

    I recommend using GetChildCaseStudy for the ecase fields. It is more complete and generally easier to use.

    DEFINITION of eCase: eCase is data collected by the Local Church Partner that describes a child's life. This is also know as the child's biography.

  2. David Wulliamoz3 years ago

    Hi,

    What are the possible values for the parametre "USSchoolEquivalent"? I expected an "int" but in fact, there are also characters like "P".

    Thank you in advance.

    Best regards,

    Kevin

  3. Suzanne Swanson3 years ago

    Hi David, You are correct and I apologize for the misleading documentation. The documentation has been updated to reflect the correct values.

    The values in USSchoolEquivalent can be: blank 1 2 3 4 5 6 7 8 9 10 11 12 13 14 K (Note-this is Kindergarten) P (Note-this is Primary) PK (Note-this is pre-Kindergarten)

  4. AJ2 years ago

    Hi, What does the following return mean?

     <h1>Developer Inactive</h1>
    

    How can I get this resolved?

    Thank you

    Ashwin

  5. Scott Kelso2 years ago

    Hi AJ, Since this is a Private REST API you need us to give you access, I just now gave you access and created a key for you, so you now should have access with the new key.

Please sign in to post a comment.

Docs Navigation