SOAP Get Child Exit Detail 201310

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

The SOAP call Get Child Exit Detail 201310 provides details of a child departure from a CDSP program.

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/2013/10/GetChildExitDetail
URL
Prod:    https://api2.compassion.com/ci.services/childinformation/2013/10/getchildexitdetail?api_key=[string]
IPTest: https://api2.compassion.com/iptest/ci.services/childinformation/2013/10/getchildexitdetail?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">
    <GetChildExitDetailRequest xmlns="http://schemas.ci.org/ci/services/childinformation/2013/10/">
      <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>
    </GetChildExitDetailRequest>
  </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 Compassion-generated unique text identifier for the child
ChildName Full name of the child
Gender Gender of the child
Age Age of the child in years
ExitDate Date on which the exit is final (yyyy-mm-ddTnn:nn:nn-nn:nn)
DateLastAttendedProject The date when the child was last attending project activities (yyyy-mm-ddTnn:nn:nn-nn:nn)
ReportDate Date on which the exit report is completed (yyyy-mm-ddTnn:nn:nn-nn:nn)
ReasonForAged  
ExitFacilitator Name of the person who facilitated the exit.
Note: This data is not available for Compassion Connect exits.
CountryDirectorOrDesignate Name of the country director or designated supervisor responsible to oversee the exit
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'
ProfessesFaithInJesusChrist Indicates whether the child has made a profession of faith
ProfessedFaithWhileRegistered Indicates whether the child made a profession of faith while part of the Compassion program
FaithDescription Narrative description of the spiritual life of the child
CompletedPrimarySchool Indicates whether the child has completed primary school
USGradeEquivalentCompleted Grade level completed by the child according to the US Grade Level system
AreaOfStudy The primary area of study of the educational program in which the child participated
ReceivedVocationalTraining Indicates whether the child received vocational training
VocationalSkillsLearned List of skills learned if the child received vocational training
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'
HealthDescription Description of the overall health of the child.
Note: This data is not available for Compassion Connect exits.
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'
SocialBehaviorDescription Description of the social development of the child.
Note: This data is not available for Compassion Connect exits.
ExitDescription Narrative description of the situation which led to exit.
Note: This data is not available for Compassion Connect exits.
StepsToPreventExitDescription Describes the steps taken to prevent the exit.
Note: This data is not available for Compassion Connect exits.
FuturePlansDescription Description of the child's future plans
ChildNewSituationDescription Description of child's new situation as well as how they benefited from Compassion program
ExitReason Primary reason for exit from program
OtherExitReason Secondary reason for exit from program
LastChildLetterSent Indicates whether last letter has been completed and sent
ReasonForRejection

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/">[string]</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/">[number]</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/">[string]</SendersName>   
    <
SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersAppName>   
    <SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
  </s:Header>
  <s:Body>
    <GetChildExitDetailResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/childinformation/2013/10/">
      <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>
        <ChildExitDetailCollection rowcount="1">
          <ChildExitDetail  xmlns="http://schemas.ci.org/ci/common/ipg/2013/10/">
            <ChildKey>[string]</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]</ProfessedFaithWhileRegisted>
            <FaithDescription>[string]</FaithDescription>
            <CompletedPrimarySchool>[string]</CompletedPrimarySchool>
            <USGradeEquivalentCompleted>[string]</USGradeEquivalentCompleted>
            <AreaOfStudy>[string]</AreaOfStudy>
            <ReceivedVocationalTraining>[string]</ReceivedVocationalTraining>
            <VocationalSkillsLearned>[string]</VocationalSkillsLearned>
            <FreeOfPovertyRelatedDisease>[string]</FreeOfPovertyRelatedDisease>
            <HealthDescription>[string]</HealthDescription>
            <AvoidedRecentNegativeSocialBehavior>[string]</AvoidedRecentNegativeSocialBehavior>
            <SocialBehaviorDescription>[string]</SocialBehaviorDescription>
            <ExitDescription>[string]</ExitDescription>
            <StepsToPreventExitDescription>[string]</StepsToPreventExitDescription>
            <FuturePlansDescription>[string]</FuturePlansDescription>
            <ChildNewSituationDescription>[string]</ChildNewSituationDescription>
            <ExitReason>[string]</ExitReason>
            <OtherExitReason>[string]</OtherExitReason>
            <LastChildLetterSent>[string]</LastChildLetterSent>
            <ReasonForRejection>[string]</ReasonForRejection>
        </ChildExitDetail>
      </ChildExitDetailCollection>
    </GetChildExitDetailResponse>
  </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/">[string]</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/">[number]</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/">[string]</SendersName>   
    <
SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersAppName>   
    <SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
  </s:Header>
  <s:Body>
    <GetChildExitDetailResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/childinformation/2013/10/">
      <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>
        <ErrorResponse  SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
          <ErrorName>[string]</ErrorName>
          <DateTimestamp>[string]</DateTimestamp>
          <SendersAppName>[string]</SendersAppName>
          <ServiceName>[string]</ServiceName>
          <ErrorId>[string]</ErrorId>
          <ErrorCode>[string]</ErrorCode>
          <ErrorMessage>[string]</ErrorMessage>
        <ErrorResponse>[string]</ErrorResponse>
    </GetChildExitDetailResponse>
  </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 / Parameter Failure
HTTP 502 Bad Gateway
HTTP 503 API Maintenance / Service Unavailable
HTTP 504 Gateway Timeout

Docs Navigation