- Previous: Public Sponsor Child Image
- Up: Public API
- Next: Private IPG APIs
Public Sponsor Child Information
The Sponsor Child Information API is a RESTful API.
The service provides information on sponsored children (CDSP) or students (LDP) based on the sponsor Id and the sponsor's preferred email address.
CDSP (Child Development Sponsorship Program) connects one child with one sponsor to help that child develop into the extraordinary individual which God ordained.
LDP (Leadership Development Program) launches outstanding graduates from our Child Sponsorship Program into their full, God-given potential. They are equipped with a university degree, mentored in their Christian life and instilled with a passion to serve that transforms their communities and nations.
Sample Requests
Request Parameters
Response Parameters
Sample Successful Response
Sample Unsuccessful Response
Error Response Codes
Sample Request
The actual request requires soft-authentication.
This is an example only.
https://api2.compassion.com/us/1/sponsor/child/information? SponsorId= [string]& EmailAddress= [string]& ClientReferenceId= [string]& api_key= [string]
Request Parameters
Name | Description | Required | Data Type | Constraints |
---|---|---|---|---|
SponsorId | Sponsor Id is assigned by Compassion International to an individual or group when a child in the Child Development Sponsorship Program or a student in the Leadership Program is sponsored through them. Also known as Constituent Id or Supporter Id. | Yes | Numeric | Max 10 |
EmailAddress | Sponsor’s preferred email address on file at Compassion International. Service client should pass in URL encoded value if the email address contains special characters. | Yes | String | Max 60 |
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 |
---|---|
SponsorId | Same value that was in the request. |
The return can contain one or more child keys with the following parameters for each child or student actively sponsored: | |
ChildKey | Code assigned by Compassion International when the child is registered in the Child Sponsorship Program. |
ChildName | Name of the child or student. |
ChildAbbreviatedName | Abbreviated name of the child or student. |
ChildPersonalName | First name or nickname that is used to address the child or student. |
Gender | Child's or student's gender. |
BirthDate | Child's or student's birth date. |
Age | Child's or student's age. |
OrphanFlag | Indicator identifying a child or student as an orphan. Valid values: {"T", "F" or Null} |
HandicappedFlag | Indicator identifying a child or student as handicapped. Valid values: {"T", "F" or Null} |
SchoolPerformanceDescription | Describes a child's or student's school performance. Valid values: {"Average", "Above Average", "Below Average", "Not Available"} |
ParticipationType | Type of Compassion program that the child is currently enrolled in. Valid values: "CDSP" which is Child Sponsorship Program designed to give a child the opportunity to reach his or her God-given potential; "LDP" which is Leadership Development Program designed to provide a university education and Christian leadership training |
CommitmentType | Type of commitment that a sponsor actively has with a child or student. Valid values: "SPON," which is child or project commitment; "CORR," which is a correspondence commitment; "PRAY," which is a prayer commitment; "FSPN," which is a fund commitment; "LVSP," which is a Living commitment |
Sample Successful Response
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")
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 |
- Previous: Public Sponsor Child Image
- Up: Public API
- Next: Private IPG APIs
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.