- Previous: REST Get Child Case Study V1
- Up: Private REST Services
- Next: REST Get Child Image V1
REST Get Child Exit Details V1
The REST call, Get Child Exit Details, provides details of a child exit from a CDSP program.
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").
Sample Requests
Request Parameters
Response Parameters
XML Sample Successful Response
JSON Sample Successful Response
Sample Unsuccessful Response
Error Response Codes
Sample Request
This is an example only.
IPTest: https://api2.compassion.com/iptest/ci/v1/children/{childkey}/exitdetails?ClientReferenceId=[string]&api_key=[string]
Production: https://api2.compassion.com/ci/v1/children/{childkey}/exitdetails?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 | Sting | 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 | Date Type Returned |
---|---|---|
ChildKey | Compassion-generated unique text identifier for the child | string |
ChildName | Full name of the child | string |
Gender | Gender of the child | string |
Age | Age of the child in years | string |
ExitDate | Date on which the exit is final | string Format:yyyy-mm-ddTnn:nn:nn-nn:nn |
DateLastAttendedProject | The date when the child was last attending project activities | string Format:yyyy-mm-ddTnn:nn:nn-nn:nn |
ReportDate | Date on which the exit report is completed | string Format:yyyy-mm-ddTnn:nn:nn-nn:nn |
ReasonForAged | string | |
ExitFacilitator | Name of the person who facilitated the exit. Note: This data is not available for Compassion Connect exits. | string |
CountryDirectorOrDesignate | Name of the country director or designated supervisor responsible to oversee the exit | string |
PresentedWithGospel | Indicates whether the child had been presented with the gospel. Note: This data is not available for Compassion Connect exits. The field defaults to 'false'. | boolean |
ProfessesFaithInJesusChrist | Indicates whether the child has made a profession of faith | boolean |
ProfessedFaithWhileRegistered | Indicates whether the child made a profession of faith while part of the Compassion program | boolean |
FaithDescription | Narrative description of the spiritual life of the child | string |
CompletedPrimarySchool | Indicates whether the child has completed primary school | boolean |
USGradeEquivalentCompleted | Grade level completed by the child according to the US Grade Level system | string |
AreaOfStudy | The primary area of study of the educational program in which the child participated | string |
ReceivedVocationalTraining | Indicates whether the child received vocational training | boolean |
VocationalSkillsLearned | List of skills learned if the child received vocational training | string |
FreeOfPovertyRelatedDisease | Indicates whether the child is free from diseases normally associated with poverty. Note: This data is not available for Compassion Connect exits. The field defaults to 'false' | boolean |
HealthDescription | Description of the overall health of the child | string |
AvoidedRecentNegativeSocialBehavior | Indicates whether the child has had any recent negative behavior toward others. Note: This data is not available for Compassion Connect exits. The field defaults to 'false'. | boolean |
SocialBehaviorDescription | Description of the social development of the child. Note: This data is not available for Compassion Connect exits. | string |
ExitDescription | Narrative description of the situation which led to exit. Note: This data is not available for Compassion Connect exits. | string |
StepsToPreventExitDescription | Describes the steps taken to prevent the exit. Note: This data is not available for Compassion Connect exits. | string |
FuturePlansDescription | Description of the child's future plans. | string |
ChildNewSituationDescription | Description of child's new situation as well as how they benefited from Compassion program | string |
ExitReason | Primary reason for exit from program | string |
OtherExitReason | Secondary reason for exit from program | string |
LastChildLetterSent | Indicates whether last letter has been completed and sent | boolean |
ReasonForRejection | string |
XML Sample Successful Response
<ChildExitDetail xmlns="http://schemas.ci.org/ci/common/ipg/2014/10/" xmlns="http://www.w3.org/2001/XMLSchema-instance">
<ChildKey>aannnnnnn</ChildKey>
<ChildName>[string]</ChildName>
<Gender>[string]</Gender>
<age>[string]</age>
<ExitDate>yyyy-mm-ddTnn:nn:nn-nn:nn</ExitDate>
<DateLastAttendedProject>yyyy-mm-ddTnn:nn:nn-nn:nn</DateLastAttendedProject>
<ReportDate>yyyy-mm-ddTnn:nn:nn-nn:nn</ReportDate>
<ReasonForAged>[string]</ReasonForAged>
<ExitFacilitator>[string]</ExitFacilitator>
<CountryDirectorOrDesignate>[string]</CountryDirectorOrDesignate>
<PresentedWithGospel>[string]</PresentedWithGospel>
<ProfessesFaithInJesusChrist>[string]</ProfessesFaithInJesusChrist>
<ProfessedFaithWhileRegistered>[string]</ProfessedFaithWhileRegistered>
<FaithDescription>[string]</FaithDescription>
<CompletedPrimarySchool>[boolean]</CompletedPrimarySchool>
<USGradeEquivalentCompleted>[string]</USGradeEquivalentCompleted>
<AreaOfStudy>[string]</AreaOfStudy>
<ReceivedVocationalTraining>[boolean]</ReceivedVocationalTraining>
<VocationalSkillsLearned>[string]</VocationalSkillsLearned>
<FreeOfPovertyRelatedDisease>[boolean]</FreeOfPovertyRelatedDisease>
<HealthDescription>[string]</HealthDescription>
<AvoidedRecentNegativeSocialBehavior>[boolean]</AvoidedRecentNegativeSocialBehavior>
<SocialBehaviorDescription>[string]</SocialBehaviorDescription>
<ExitDescription>[string]</ExitDescription>
<StepsToPreventExitDescription>[string]</StepsToPreventExitDescription>
<FuturePlansDescription>[string]</FuturePlansDescription>
<ChildNewSituationDescription>[string]</ChildNewSituationDescription>
<ExitReason>[string]</ExitReason>
<OtherExitReason>[string]</OtherExitReason>
<LastChildLetterSent>[boolean]</LastChildLetterSent>
<ReasonForRejection>[string]</ReasonForRejection>
</ChildExitDetail>
JSON Sample Successful Response
{
"childKey" : "aannnnnnn",
"childName" : "[string]",
"gender" : "[string]",
"age" : "8",
"exitDate" : "1900-01-01T00:00:00-07:00",
"dateLastAttendedProject" : "1900-01-01T00:00:00-07:00",
"reportDate" : "1900-01-01T00:00:00-07:00",
"reasonForAged" : "[string]",
"exitFacilitator" : "[string]",
"countryDirectorOrDesignate" : "[string]",
"presentedWithGospel" : "[boolean]",
"professesFaithInJesusChrist" : "[boolean]",
"professedFaithWhileRegistered" : "[boolean]",
"faithDescription" : "[string]",
"completedPrimarySchool" : "8",
"usGradeEquivalentCompleted" : "8",
"areaOfStudy" : "[string]",
"receivedVocationalTraining" : "8",
"vocationalSkillsLearned" : "[string]",
"freeOfPovertyRelatedDisease" : "8",
"healthDescription" : "[string]",
"avoidedRecentNegativeSocialBehavior" : "8",
"socialBehaviorDescription" : "[string]",
"exitDescription" : "[string]",
"stepsToPreventExitDescription" : "[string]",
"futurePlansDescription" : "[string]",
"childNewSituationDescription" : "[string]",
"exitReason" : "[string]",
"otherExitReason" : "[string]",
"lastChildLetterSent" : "[boolean]",
"reasonForRejection" : "[string]",
}
Sample Unsuccessful Responses
The table below indicates the HTTP error response and HTTP Error message.
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
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 Case Study V1
- Up: Private REST Services
- Next: REST Get Child Image 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.