Skip to main content

Get appointment cancellation by token

GET 
/api/appointment/cancelbytoken

Retrieves appointment cancellation details by token.

Response sample

{
  "id": "string",
  "type": "string",
  "appointment": {
    "id": "string",
    "type": "string",
    "appointmentId": "string",
    "appointmentStartTime": "2019-11-01T12:00:00.000Z",
    "pastAppointment": true,
    "isCancelled": true,
    "isNoShow": true,
    "permitAmendment": true,
    "permitAmendmentReason": 0,
    "permitCancellation": true,
    "permitCancellationReason": 0,
    "duration": 0,
    "doctor": {
      "id": "string",
      "type": "string",
      "name": "Síle Uí Rudaí",
      "bio": "This doctor is a contact lens specialist.",
      "image": {
        "url": "https://www.example.com/image1.jpg" },
      "links": {}},
    "visitType": {
      "id": "fe2dfb30-5775-4918-8a23-768197c257d3",
      "type": "SIGHT TEST",
      "name": "string",
      "description": "string",
      "defaultDuration": 0,
      "visitTypeGroup": {
        "id": "string",
        "type": "string",
        "groupName": "string",
        "displayOrder": 0},
      "links": {}},
    "notes": "string",
    "appointmentSiteDetails": {
      "siteId": "5338c629-9f62-4b29-877d-78544a91f559",
      "name": "OwnBrand",
      "type": "SiteSummary",
      "address": {
        "address1": "Cruiserath Road",
        "address1Seo": "cruiserath road",
        "address2": "",
        "address3": "",
        "postalCode": "D15 N5DX",
        "city": "Dublin",
        "multilanguageCity": {},
        "citySeo": "dublin",
        "phone": "020 915 0199",
        "email": "info@example.com",
        "country": {
          "countryName": "Ireland",
          "countryIsocode2": "IE",
          "countryIsocode3": "IRL" },
      "county": "Dublin" }},
    "links": {}},
  "links": {}
}

Request​

Responses​

Success: Request accepted.