Consultation request example

Prev Next

This is an example of the data sent by a consultation request event. The values in categorySpecificData will be included if the information has been captured.

{
    "type":"tour.create",
    "timestamp":"2025-04-01T10:26:10.344522Z",
    "data":{
        "id": 12345,
        "category": {
            "id": 20,
            "name": "Onsite Tour/Consultation Request"
        },
        "member": {
            "id": 123456,
            "name": "Hallamshire",
            "postcode": "RG17 9PY"
         },
         "group": {
            "id": 786543,
            "name": "Hallamshire Care Group",
            "postcode": "RG17 9PY"
         },
         "emailto": "manager@example.com",
         "emailfrom": "johnsmith@example.com",
         "entrydate": "2025-04-01 10:26:07",
         "bodycontent": "<p><strong>Booking Details</strong><br><br><strong>First Name:</strong> John<br><br><strong>Last Name:</strong> Smith<br><br><strong>Email Address:</strong> johnsmith@example.com<br><br><strong>Contact Number:</strong> 01488 684321<br><br><strong>Preferred Date & Time:</strong>Tuesday 1st April 2025 at 11:00<br><br><strong>Who is need of care:</strong> A parent<br><br><strong>Type of care:</strong> Older person residential<br><br><strong>How soon is care needed:</strong> 6 months +<br><br><strong>Type of funding:</strong> Self funding (Private)<br><br><strong>Postcode for care:</strong><strong> RG17 9PY<br><br><strong>Comments:</strong><br>Afternoons preferable.</p>",
         "firstname": "John",
         "surname": "Smith",
         "address1": null,
         "address2": null,
         "address3": null,
         "town": null,
         "postcode": null,
         "telephone": "01488 684321",
         "isAnonymised": "No",
         "categorySpecificData": {
             "bookingDate": "Tuesday 1st April 2025",
             "bookingDateTime": "2025-04-01T11:00:00+01:00",
             "bookingTime": "11:00",
             "bookingType": "Home Consultation",
             "comment": "Afternoons preferable.",
             "whoIsNeedOfCare": "A parent",
             "careNeededType": "Visiting care",
             "howSoonType": "6 months +",
             "fundingType": "Fully private (self-funded)",
             "contractDuration": "Permanent/Long-term",
             "postcodeForCare": "RG17 9PY",
             "personNeedingCareName": "James Smith"
         }
    }
}

Care Data Options

Some of the care data is chosen from predefined lists and is available in categorySpecificData.  Here is all the possible values for these lists.

{
    "bookingType": [
        "Home Consultation",
        "Video Call Consultation"
    ],
    "whoIsNeedOfCare": [
        "Myself",
        "A parent",
        "A partner",
        "Another family member",
        "A friend",
        "A client"
    ],
    "careNeededType": [
        "Visiting care",
        "Live-in care",
        "Not sure"
    ],
    "howSoonType": [
        "Immediately (1 day – 1 week)",
        "1 week – 1 month",
        "1–3 months",
        "3–6 months",
        "6+ months"
    ],
    "fundingType": [
        "Fully private (self-funded)",
        "Direct Payment from Local Authority or NHS",
        "Arranged and funded by Local Authority",
        "Arranged and funded by NHS",
        "Not sure"
    ],
    "contractDuration":[
        "Permanent/Long-term",
        "Respite/Short-term"
    ]
}