Skip to content

Latest commit

 

History

History
434 lines (401 loc) · 11.2 KB

attendees.md

File metadata and controls

434 lines (401 loc) · 11.2 KB
Raw

Attendees

Get Attendees

Resources

  • GET /attendees get all attendees
  • GET /group_appointments/:id/attendees get all attendees for a specified group appointment
  • GET /individual_appointments/:id/attendees get all attendees for a specified individual appointment

Example Request

curl https://api.au1.cliniko.com/v1/attendees \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)'

Example Response

{
  "attendees": [
    {
      "id": 1,
      "created_at": "2016-06-28T21:33:26Z",
      "updated_at": "2016-06-28T21:33:26Z",
      "arrived": null,
      "booking_ip_address": null,
      "cancellation_note": null,
      "cancellation_reason": null,
      "cancellation_reason_description": "",
      "email_reminder_sent": false,
      "invoice_status": null,
      "notes": null,
      "online_booking_policy_accepted": null,
      "sms_reminder_sent": false,
      "treatment_note_status": null,
      "deleted_at": null,
      "cancelled_at": null,
      "booking": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/bookings/1"
        }
      },
      "patient": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/82"
        }
      },
      "invoices": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices"
        }
      },
      "links": {
        "self": "https://api.au1.cliniko.com/v1/attendees/1"
      }
    }
  ],
  "total_entries": 2037,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/attendees?page=1",
    "next": "https://api.au1.cliniko.com/v1/attendees?page=2"
  }
}

Get Deleted Attendees

Resources

  • GET /attendees/deleted get all deleted attendees
  • GET /group_appointments/:id/attendees get all deleted attendees for a specified group appointment
  • GET /individual_appointments/:id/attendees get all deleted attendees for a specified individual appointment

Example Request

curl https://api.au1.cliniko.com/v1/attendees/deleted \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)'

Example Response

{
  "attendees": [
    {
      "id": 1,
      "created_at": "2016-06-28T21:33:26Z",
      "updated_at": "2016-06-28T21:33:26Z",
      "arrived": null,
      "booking_ip_address": null,
      "cancellation_note": null,
      "cancellation_reason": null,
      "cancellation_reason_description": "",
      "email_reminder_sent": false,
      "invoice_status": null,
      "notes": null,
      "online_booking_policy_accepted": null,
      "sms_reminder_sent": false,
      "treatment_note_status": null,
      "deleted_at": "2016-06-28T21:33:26Z",
      "cancelled_at": null,
      "booking": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/bookings/1"
        }
      },
      "patient": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/82"
        }
      },
      "invoices": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices"
        }
      },
      "links": {
        "self": "https://api.au1.cliniko.com/v1/attendees/1"
      }
    }
  ],
  "total_entries": 143,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/attendees/deleted?page=1",
    "next": "https://api.au1.cliniko.com/v1/attendees/deleted?page=2"
  }
}

Get Cancelled Attendees

Resources

  • GET /attendees/cancelled get all cancelled attendees
  • GET /group_appointments/:id/attendees get all cancelled attendees for a specified group appointment
  • GET /individual_appointments/:id/attendees get all cancelled attendees for a specified individual appointment

Example Request

curl https://api.au1.cliniko.com/v1/attendees/cancelled \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)'

Example Response

{
  "attendees": [
    {
      "id": 1,
      "created_at": "2016-06-28T21:33:26Z",
      "updated_at": "2016-06-28T21:33:26Z",
      "arrived": null,
      "booking_ip_address": null,
      "cancellation_note": "Last minute cancellation",
      "cancellation_reason": 50,
      "cancellation_reason_description": "Other",
      "email_reminder_sent": false,
      "invoice_status": null,
      "notes": null,
      "online_booking_policy_accepted": null,
      "sms_reminder_sent": false,
      "treatment_note_status": null,
      "deleted_at": null,
      "cancelled_at": null"2016-06-28T21:33:26Z",
      "booking": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/bookings/1"
        }
      },
      "patient": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/82"
        }
      },
      "invoices": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices"
        }
      },
      "links": {
        "self": "https://api.au1.cliniko.com/v1/attendees/1"
      }
    }
  ],
  "total_entries": 2037,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/attendees?page=1",
    "next": "https://api.au1.cliniko.com/v1/attendees?page=2"
  }
}

Get Attendee

Resources

  • GET /attendees/:id get a specified attendee

Example Request

curl https://api.au1.cliniko.com/v1/attendees/1 \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)'

Example Response

{
  "id": 1,
  "created_at": "2016-06-28T21:33:26Z",
  "updated_at": "2016-06-28T21:33:26Z",
  "arrived": null,
  "booking_ip_address": null,
  "cancellation_note": null,
  "cancellation_reason": null,
  "cancellation_reason_description": "",
  "email_reminder_sent": false,
  "invoice_status": null,
  "notes": null,
  "online_booking_policy_accepted": null,
  "sms_reminder_sent": false,
  "treatment_note_status": null,
  "deleted_at": null,
  "cancelled_at": null,
  "booking": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/bookings/1"
    }
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/82"
    }
  },
  "invoices": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/attendees/1"
  }
}

Create Attendee

Resources

  • POST /attendees create an attendee

Example Request

curl https://api.au1.cliniko.com/v1/attendees \
  -u API_KEY: \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)' \
  -d '{ "booking_id": "1", "patient_id": "1" }' \
  -X POST

Example Response

Headers { Location: https://api.au1.cliniko.com/attendees/1 }

{
  "id": 1,
  "created_at": "2016-06-28T21:33:26Z",
  "updated_at": "2016-06-28T21:33:26Z",
  "arrived": null,
  "booking_ip_address": null,
  "cancellation_note": null,
  "cancellation_reason": null,
  "cancellation_reason_description": "",
  "email_reminder_sent": false,
  "invoice_status": null,
  "notes": null,
  "online_booking_policy_accepted": null,
  "sms_reminder_sent": false,
  "treatment_note_status": null,
  "deleted_at": null,
  "cancelled_at": null,
  "booking": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/bookings/1"
    }
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/82"
    }
  },
  "invoices": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/attendees/1"
  }
}

Update Attendee

Resources

  • PUT /attendees/:id update an attendee

Example Request

curl https://api.au1.cliniko.com/v1/attendees/1 \
  -u API_KEY: \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)' \
  -d '{ "arrived": true }' \
  -X PUT

Example Response

{
  "id": 1,
  "created_at": "2016-06-28T21:33:26Z",
  "updated_at": "2016-06-28T21:33:26Z",
  "arrived": true,
  "booking_ip_address": null,
  "cancellation_note": null,
  "cancellation_reason": null,
  "cancellation_reason_description": "",
  "email_reminder_sent": false,
  "invoice_status": null,
  "notes": null,
  "online_booking_policy_accepted": null,
  "sms_reminder_sent": false,
  "treatment_note_status": null,
  "deleted_at": null,
  "cancelled_at": null,
  "booking": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/bookings/1"
    }
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/82"
    }
  },
  "invoices": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/attendees/1"
  }
}

Delete Attendee

Resources

  • DELETE /attendees/:id delete an attendee

Example Request

curl https://api.au1.cliniko.com/v1/attendees/1 \
  -u API_KEY: \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)' \
  -X DELETE

Example Response A status code of 204 no content will be returned if successful

Cancel Attendee

Resources

  • PATCH /attendees/:id/cancel cancel an attendee

Notes

The cancellation_reason information is mandatory. Only attendees of group appointments can be cancelled via this endpoint. Cancelling an individual appointment should be done via the cancel endpoint for individual appointments.

Example Request

curl https://api.au1.cliniko.com/v1/attendees/1/cancel \
  -u API_KEY: \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'User-Agent: APP_VENDOR_NAME (APP_VENDOR_EMAIL)' \
  -d '{ "cancellation_reason": 50, "cancellation_note": "A note" }' \
  -X PATCH

Example Response A status code of 204 no content will be returned if successful

Cancellation Reason Codes

  • 10 Feeling better
  • 20 Condition worse
  • 30 Sick
  • 31 COVID-19 related
  • 40 Away
  • 50 Other
  • 60 Work

Filtering Attendees

For any route that returns a set of attendees, you can filter them by:

  • booking_id Integer
  • created_at DateTime
  • id Integer
  • patient_id Integer
  • updated_at DateTime

See Filtering Results for details on how to apply filters.