- Previous: Private Tax Year PDF
- Up: Private USA APIs
- Next: Private Constituent Lookup
Private Consigned Child Keys
The Consigned Child Keys API is a RESTful API.
This service provides external Compassion clients the ability to retrieve a list of children and their consignment expiration dates based on a consignment identifier. Children are consigned to a consignment identifier for potential sponsorship at events, concerts, or via Compassion.com or Compassion.mobi. Children whose consignment has expired will not be included in the response.
Sample Request
This is an example only.
https://api2.compassion.com/us/1/needmarketing/consignedchildkeys?consignmentid=1269375&ClientReferenceId=ddddd&api_key=xxxxx
Request Parameters
Name | Description | Required | Data Type | Constraints |
---|---|---|---|---|
ConsignmentId | The Id that child(ren) are consigned to. | Yes | Integer | |
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 |
---|---|
ConsignmentId | Same value that was in the request. |
ISOCountryCode | Two-character code assigned to a country by the International Organization for Standardization (ISO) which the children are consigned in. Currently, US is the only valid country code for consignment. |
ChildKey | Uniquely identifies a child. |
ConsignmentExpirationDate | Consignment expiration date for the child. Any child key with a consignment date that occurs in the past will be filtered out of the result set. |
Abbreviated Sample Successful Response
<PublicConsignedChildKeysResponse ResponseCode="0" ClientReferenceId="ddddd">
<ConsignmentId>12345678</ConsignmentId>
<ISOCountryCode>US</ISOCountryCode>
<ConsignedChildKeyCollection rowcount="1">
<ConsignedChildKey>
<ChildKey>String</ChildKey>
<ConsignmentExpirationDate>yyyy-mm-ddThh:mm:ssZ</ConsignmentExpirationDate>
</ConsignedChildKey>
</ConsignedChildKeyCollection>
</PublicConsignedChildKeysResponse>
Abbreviated 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")
<PublicConsignedChildKeysResponse ResponseCode="1">
<ConsignmentId>1234567a</ConsignmentId>
<ISOCountryCode>US</ISOCountryCode>
<ConsignedChildKeyCollection rowcount="0"/>
<ExceptionMessage>Incorrect data type: consignment ID can only be numeric digits (0-9).</ExceptionMessage>
</PublicConsignedChildKeysResponse>
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 Referer |
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: Private Tax Year PDF
- Up: Private USA APIs
- Next: Private Constituent Lookup
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.