- Previous: Private USA Web APIs
- Up: Private USA Web APIs
- Next: USA Web Children Available
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
Name | Description | Required | Data Type | Constraints |
---|---|---|---|---|
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>
- Previous: Private USA Web APIs
- Up: Private USA Web APIs
- Next: USA Web Children Available
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.