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

Response Parameters

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.