Contents x
    Enquiry data
    • 19 Nov 2024
    • 1 Minute to read
    • PDF
    Contents

    Enquiry data

    • Updated on 19 Nov 2024
    • 1 Minute to read
    • PDF
    Article summary

    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"

    dateToNostringe.g. "2018-11-25T09:10:00"

    excludeAnonymised 

    No 

    string

    true/false exclude all anonymised records

    Default: true

    categoryIdNo string

    List of category IDs.

    1: General Enquiry

    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"
      },
      "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
    }
  ],
  "error": []
}

    Tour Booking Response

    The key 'categorySpecificData' will also appear for tour categories showing the times and dates of the booking 

    The response body will contain a JSON object of data.

    {
  "data": [
    {
      "id": 12345,
      "category": {
        "id": 20,
        "name": "Onsite Tour Booking Request"
      },
      "member": {
        "id": 123456,
        "name": "Hallamshire"
        "postcode": "RG19 7PY"
      },
      "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": {
        "bookingDate": "Thursday 19th November 2020",
        "bookingTime": "11:00 AM",
        "bookingType": "Onsite Tour Booking"
      }
    }
  ],
  "error": []
}
    Was this article helpful?
    What's Next