Sign in
latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Appointments

Create an Appointment

Permissions needed: CREATE_APPOINTMENTS <strong>Create Appointment</strong> <br/> <br/> Start Date and End Date is set as is format(2022-10-20 10:09:00), no alterations are done, so queries will return the exact date and time that was set. <br/> - Status enum is visible under the appointments change status method <br/> - record_id, room_id and examination_id must be set as null if not used.

post/api/v1/appointments

Query parameters

includestring

Additional info to include. You can use multiple, comma separated. Options: patient,patient.species,patient.breed,patient.crossBreed,patient.owners,patient.owners.appDownloadNotification,patient.owners.clients,room,event, clinic,clinic.rooms,vet,vet.vetRolesAll,requests,notes,visitType,paymentDeposits.paymentLinks

Request body

clinic_idinteger required

Clinic Id

vet_idinteger required

Vet Id

patient_idinteger required

Pet id

visit_type_idinteger required

Id of the VisitType

observationsstring

Observations

status1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

1 - Pending Client Approval 2 - Pending Clinic Approval 3 - Rescheduled Clinic Approval 4 - Rescheduled Client Approval 5 - Confirmed 6 - Canceled By Client 7 - Canceled By Clinic' 8 - Automatically Created' 9 - No Show

notification_messagestring

Notification message

record_idinteger nullable

Record ID - set null if not used

room_idinteger nullable

Room ID - set null if not used

examination_idinteger nullable

Examination ID - set null if not used

printable_file_idsinteger[]

Consent forms

video_linkstring nullable

Video link

datetime_start_utcstring required

Start Date in UTC ISO Zulu format

datetime_end_utcstring required

End Date in UTC ISO Zulu format

service_package_idsinteger[]

Service package ids

user_notestring

Notes introduced by the pet parent

recurrencestring nullable

recurrence defined by RFC 5545

sourceinteger

0 - Added by clinic 1 - Requested via Web 2 - Requested via App

requires_payment_depositboolean

Example request

{
  "clinic_id": 1,
  "vet_id": 1,
  "patient_id": 1,
  "visit_type_id": 1,
  "status": 1,
  "reminder_notifications": [
    {
      "id": 1,
      "period": 1,
      "periodType": 0,
      "notificationType": 0
    },
    {
      "id": 2,
      "period": 1,
      "periodType": 1,
      "notificationType": 0
    }
  ],
  "printable_file_ids": [
    1,
    2
  ],
  "datetime_start_utc": "2022-06-16T13:42:38Z",
  "datetime_end_utc": "2022-06-16T14:42:38Z",
  "service_package_ids": [
    1,
    2
  ],
  "user_note": "Daisy has not been feeling well",
  "recurrence": "FREQ=DAILY;COUNT=10",
  "pet_parent": {
    "phone": "+16175551212"
  },
  "pet": {
    "birthdate": "1990-01-01"
  },
  "drop_off": {
    "time": "09:00",
    "vet_id": 1
  }
}

Response

successful operation