USA Web Random Child

The USA Web Random Child API is a RESTful API.

The service returns a random child that is currently available on the Compassion.com website.

This is a simple service to return a single, available child. If more control is needed to define criteria about the child, please use the Child Search service.

Sample Requests

https://webapi.compassion.com/children/random?api_key=[string]
https://webapi.compassion.com/children/random.json?api_key=[string]
https://webapi.compassion.com/children/random.xml?api_key=[string]

Request Parameters

NameDescriptionRequiredData TypeConstraints
api_key Querystring Parameter. Mashery-supplied key for accessing Compassion International services Yes String  

Specifying Format

By default, all requests will be returned as JSON. There are two ways to indicate an explicit format – either by using an extension on the endpoint (.json or .xml) or by setting the Accept header in the initial request (“application/json” or “application/xml”).

Sample Responses

JSON (/children/random.json)

{
    "childKey": "ME9630260",
    "childName": "John Doe",
    "childPersonalName": "John",
    "countryName": "Mexico",
    "gender": "M",
    "age": 2,
    "birthDate": "2011-07-11T00:00:00",
    "waitingSinceDate": "2012-10-31T00:00:00",
    "orphan": false,
    "specialNeeds": false,
    "hivAffectedArea": false
}


XML (/children/random.xml)

<Child>
    <ChildKey>ME8920367</ChildKey>
    <ChildName>Jane Smith</ChildName>
    <ChildPersonalName>Jane</ChildPersonalName>
    <CountryName>Mexico</CountryName>
    <Gender>F</Gender>
    <Age>2</Age>
    <BirthDate>2011-02-24T00:00:00</BirthDate>
    <WaitingSinceDate>2013-05-08T00:00:00</WaitingSinceDate>
    <Orphan>false</Orphan>
    <SpecialNeeds>false</SpecialNeeds>
    <HivAffectedArea>false</HivAffectedArea>
</Child>

0 Comments

New comments are not being accepted at this time.

Docs Navigation