Perform a GET request to
https://api.carehome.co.uk/index.cfm/enquiry/
With the following fields in a JSON encoded string, making sure to observe an "application/json" content header as part of your request.
Key | Required | Data Type | Description |
api_key | Yes | 40 character string | Member API Key |
dateFrom | No | string | e.g. "2018-01-25T09:10:00" |
| dateTo | No | string | e.g. "2018-11-25T09:10:00" |
excludeAnonymised | No | string | true/false exclude all anonymised records Default: true |
| categoryId | No | string | List of category IDs. 2: Brochure Request 4: Care Enquiry 5: Job Enquiry 20: Onsite Tour Booking Request 21: Virtual Tour Booking Request 62: Care Enquiry via Phone 63: Care Enquiry via Care Help Team |
Example API Request URL
https://api.carehome.co.uk/index.cfm/enquiry/?api_key=00000&dateFrom=2018-01-01T09:10:00&dateTo=2018-01-01T09:10:00&excludeAnonymised=false |
API Response
The API will return a '200 Found Records.' on success and 4xx on validation failure.
The response body will contain a JSON object of data.
{
"data": [
{
"id": 12345,
"category": {
"id": 1,
"name": "General Enquiry",
},
"member": {
"id": 123456,
"name": "Hallamshire"
"postcode": "RG17 9PY"
},
"group": {
"id": 786543,
"name": "Hallamshire Care Group"
"postcode": "RG17 9PY"
},
"to": "anon@anon.com",
"from": "anon@anon.com",
"date": "2013-03-18 22:17:07",
"content": "anon",
"firstName": "anon",
"surname": "anon",
"address1": "anon",
"address2": "anon",
"address3": "anon",
"town": "anon",
"postcode": "anon",
"telephone": "anon",
"isAnonymised": true,
"categorySpecificData": {
"specificData": "Value"
}
}
],
"error": []
}Category Specific Data
The key 'categorySpecificData' is a JSON object that will contain different key value pairs dependent on the enquiry type and whether the information has been captured.
Key | Data Type | Notes |
bookingDate | Date | The requested date of the tour. |
bookingDateTime | Date | The request date and time of the tour in ISO format. |
bookingTime | Time | The requested time of the tour. |
bookingType | String | The requested type of the tour. Applies to Tour enquiries only |
comment | String | The user’s comments to supplement the enquiry. Applies to all enquiry types excluding General & Job. |
whoIsNeedOfCare | String | The relationship between the enquirer and the person in need of care. Applies to all enquiry types excluding General & Job. |
typeOfCare | String | The type of care required. Applies to all enquiry types excluding General & Job. |
howSoonIsCareNeeded | String | How soon the care is needed. Applies to all enquiry types excluding General & Job. |
lengthOfStay | String | The length of stay required. Applies to all enquiry types excluding General & Job. |
fundingType | String | The type of funding available. Applies to all enquiry types excluding General & Job. |
enquirerInterestedInATour | String | Yes / No answer to whether the enquirer would like a tour. Applies to all enquiry types excluding General. Job & Tour. |
agentOfferedATour | String | Yes / No answer to whether the agent offered a tour. |
personNeedingCareName | String | Name of the person needing care. |
personNeedingCareAge | Number | Age of the person needing care. |
personNeedingCareGender | String | Gender of the person needing care. |