• Register

Private IPG LDP Registered Student Information

The LDP Registered Student Information API is a RESTful API.

The service provides information on an active, registered LDP student.

LDP is a ministry program that launches outstanding graduates from Compassion's Child Sponsorship Program into their full God-given potential. LDP students are equipped with a university degree, mentored in their Christian life and instilled with a passion to serve so that it transforms their community and nation.

Sample Request

The actual request requires soft-authentication.
This is an example only.

https://api2.compassion.com/us/1/student/registered/information?StudentKey=aannnnnnn&ClientReferenceId=ddddd&api_key=xxxxx

Request Parameters

Name Description Required Data Type Constraints
StudentKey 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
StudentKey Same as the input
StudentId System generated unique identifier that never changes.
StudentName Full name.
BirthDate Birth date.
BirthDateKnownFlag Flag indicating if the actual birth date is known.
AllocationGPAMemberName Name of the GPA (Global Partner Alliance) where the student is allocated
LDPAllocation Assignment of the LDP student to a GPA (Global Partner Alliance).
LastCaseStudyDate Date the last case study was completed for the student.
LastCaseStudyModifiedDate Date a portion of the current case study was modified.
HandicappedFlag Indicator identifying a child as handicapped.
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.
StudentFieldStartDate Date when the student was first associated with Compassion in the field.
FieldStartDate Date when the student started in a specific program in the field.
StudentStartDate Date when the student was entered into Compassion's database.
StartDate Date when the participation was entered into the Compassion system.
SponsoredStudentStatus Status indicating whether the student is sponsored or unsponsored.
SponsorshipStartDate Start date of current (or last, if stopped) sponsorship.
SponsorshipStopDate Stop date of last sponsorship.

Abbreviated Sample Successful Response

<PublicLDPRegisteredStudentInformationResponse SchemaVersion="1.0" ResponseCode="0" ClientReferenceId="string" SendersName="string" SendersAppName="string" SendersTrackingId="string">
  <StudentKey>aannnnnnn</StudentKey>
  <LDPStudentCollection rowcount="1">
    <LDPStudentInformation>
      <StudentKey>aannnnnnn</StudentKey>
      <StudentId>nnnn</StudentId>
      <StudentName>string</StudentName>
      <BirthDate>2005-04-17T00:00:00</BirthDate>
      <BirthDateKnownFlag>T</BirthDateKnownFlag>
      <Gender>M</Gender>
      <AllocationGpaMemberName>Compassion USA</AllocationGpaMemberName>
      <LDPStudentAllocation>Compassion USA</LDPStudentAllocation>
      <CourseOfStudy>Public Accounting</CourseOfStudy>
      <LastCaseStudyDate>2007-07-01T00:00:00</LastCaseStudyDate>
      <LastCaseStudyModifiedDate>2009-01-22T13:25:51</LastCaseStudyModifiedDate>
      <HandicappedFlag>F</HandicappedFlag>
      <SiblingFlag>F</SiblingFlag>
      <OrphanFlag>F</OrphanFlag>
      <LDPStudentFieldStartDate>1995-12-01T00:00:00</LDPStudentFieldStartDate>
      <LDPStudentRegistrationFieldStartDate>2008-12-16T13:13:17</LDPStudentRegistrationFieldStartDate>
      <LDPStudentStartDate>1995-12-01T00:00:00</LDPStudentStartDate>
      <LDPStudentRegistrationStartDate>2008-12-16T13:13:17</LDPStudentRegistrationStartDate>
      <SponsoredStudentStatus>Unsponsored</SponsoredStudentStatus>
      <SponsorshipStartDate/>
      <SponsorshipStopDate/>
    </LDPStudentInformation>
  </LDPStudentCollection>
</PublicLDPRegisteredStudentInformationResponse>

Abbreviated Sample Unsuccessful Response

The service operation will provide the following response when there are missing or badly formatted required parameters.
Exception Returned: (ResponseCode = "1", HTTP Status Code ="404")

<PublicLdpRegisteredStudentInformationResponse ResponseCode="1" SchemaVersion="1.0" ClientReferenceId="string" SendersAppName="string" SendersTrackingId="string" SendersName="string">
  <StudentKey>input value</StudentKey>
  <ExceptionMessage>Incorrect parameter: StudentKey must follow the correct format 'AANNNNNNN'. </ExceptionMessage>
</PublicLdpRegisteredStudentInformationResponse>

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

version 5 as of 8 years ago by wcgoerke

0 Comments

New comments are not being accepted at this time.

Docs Navigation