Create an Appointment

1 min

POST

https://developer.digitail.io/api/v1/appointments

Permissions needed: CREATE_APPOINTMENTS Create Appointment Start Date and End Date is set as is format(2022-10-20 10:09

), no alterations are done, so queries will return the exact date and time that was set. - Status enum is visible under the appointments change status method - record_id, room_id and examination_id must be set as null if not used.

Query Parameters

includestring
Description
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

Body Parameters

bodyappointmentrequestbodystorerequired
Description
Appointment Create/Update Request Body
- clinic_idintegerrequired
  Example
  1
  Description
  Clinic Id
- vet_idintegerrequired
  Example
  1
  Description
  Vet Id
- patient_idintegerrequired
  Example
  1
  Description
  Pet id
- visit_type_idintegerrequired
  Example
  1
  Description
  Id of the VisitType
- observationsstring
  Description
  Observations
- statusinteger
  Example
  1
  Description
  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
  Allowed
  123456789
- notification_messagestring
  Description
  Notification message
- reminder_notificationsobject[]required
  Example
```
[
  {
    "id": 1,
    "period": 1,
    "periodType": 0,
    "notificationType": 0
  },
  {
    "id": 2,
    "period": 1,
    "periodType": 1,
    "notificationType": 0
  }
]
```
  Description
  Reminder notifications. Send an empty array for none.
  - idinteger
    Example
    1
  - periodinteger
    Example
    2
    Description
    Reminder will be sent X days/weeks/months (period_type) before the appointment
  - period_typeinteger
    Example
    2
    Description
    0 - Day, * 1 - Week, * 2 - Month,
    Allowed
    012
  - notification_typeinteger
    Example
    1
    Description
    0 - Upcoming Reminder, * 1 - Recommended Reminder, * 2 - Product Reminder,
    Allowed
    012
- record_idinteger
  Description
  Record ID - set null if not used
- room_idinteger
  Description
  Room ID - set null if not used
- examination_idinteger
  Description
  Examination ID - set null if not used
- printable_file_idsinteger[]
  Example
```
[
  1,
  2
]
```
  Description
  Consent forms
- video_linkstring
  Description
  Video link
- datetime_start_utcstringrequired
  Example
  2022-06-16T13:42:38Z
  Description
  Start Date in UTC ISO Zulu format
- datetime_end_utcstringrequired
  Example
  2022-06-16T14:42:38Z
  Description
  End Date in UTC ISO Zulu format
- service_package_idsinteger[]
  Example
```
[
  1,
  2
]
```
  Description
  Service package ids
- user_notestring
  Example
  Daisy has not been feeling well
  Description
  Notes introduced by the pet parent
- recurrencestring
  Example
  FREQ=DAILY;COUNT=10
  Description
  recurrence defined by RFC 5545
- sourceinteger
  Description
  0 - Added by clinic 1 - Requested via Web 2 - Requested via App
- requires_payment_depositboolean
- pet_parentobject
  - idinteger
  - emailstring
  - send_emailboolean
  - namestring
  - last_namestring
  - phonestring
    Example
    +16175551212
    Description
    Phone number in E.164 format
  - send_smsboolean
  - addressstring
  - address_2string
  - referral_source_typestring<google_search | social_media | referral | walk_in | local_event | paid_ad | blog | signage | walk_by | online_reviews | vet_referral | other>
    Description
    How the client heard about the clinic. google_search: Google search; social_media: social media; referral: word of mouth; walk_in: walked in; local_event: local event; paid_ad: paid ad; blog: blog; signage: signage; walk_by: drove or walked by; online_reviews: online reviews; vet_referral: referred by a veterinarian or clinic; other: free text in referral_source_details. group_clinic is set by the system only and is rejected here.
    Allowed
    google_searchsocial_mediareferralwalk_inlocal_eventpaid_adblogsignagewalk_byonline_reviewsvet_referralother
  - referral_source_detailsstring
- petobject
  - nicknamestring
  - species_idinteger
  - breed_idinteger
  - birthday_is_estimatedboolean
  - birthdatestring
    Example
    1990-01-01
  - genderstring<male | female | unknown>
    Allowed
    malefemaleunknown
  - hormonal_statusinteger
    Allowed
    012
- drop_offobject
  Description
  Drop-off scheduling data. Required when visit type has drop-off enabled.
  - timestring
    Example
    09:00
    Description
    Drop-off time in HH
    format
  - vet_idinteger
    Example
    1
    Description
    Vet ID who handles the drop-off

Responses

200successful operation

object
- dataobject
  - idinteger
    Example
    1
  - event_idinteger
  - clinic_idinteger
    Example
    1
  - room_idinteger
  - guestboolean
  - pet_idinteger
    Example
    1
  - record_idinteger
  - generated_recordobject
    Description
    Record created from this appointment. Only present when externalRefRecord is included; carries has_quick_soap.
    - data
  - statusstring<1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9>
    Example
    1
    Description
    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
    Allowed
    123456789
  - datetimestring
    Example
    2022-06-16 15:12:38
  - end_datetimestring
    Example
    2022-06-16 15:42:38
  - datetime_start_utcstring<date-time>
    Example
    2023-12-01T09:00:00.000000Z
    Format
    date-time
  - datetime_end_utcstring<date-time>
    Example
    2023-12-01T10:00:00.000000Z
    Format
    date-time
  - observationsstring
  - user_notestring
  - pet_namestring
  - owner_namestring
  - patientdata
  - roomroom
  - eventobject
    Description
    A scheduled event in a clinic. Viewable on the calendar.
    - idinteger
      Example
      1
    - address_idinteger
      Example
      1
    - clinic_idinteger
      Example
      1
    - capacityinteger
      Example
      25
    - datestring<date-time>
      Example
      2022-06-16 15:12:38
      Format
      date-time
    - namestring
      Example
      Event Name
    - preferencesstring<capacity-based | schedule-based>
      Allowed
      capacity-basedschedule-based
    - appointments_numberinteger
      Example
      5
    - visit_typesitems[]
  - vetdata
  - created_by_vetdata
    Description
    The staff member who created the appointment. Only rendered when the createdByVet include is requested (staff only); null when the appointment has no creating vet.
  - owner_emailstring
  - owner_phonestring
  - reminder_notificationsobject
    Example
    [ { "id": 1, "period": 1, "periodType": 0, "notificationType": 0 }, { "id": 2, "period": 1, "periodType": 1, "notificationType": 0 } ]
  - newRequestsobject[]
  - consentFormsobject[]
  - video_linkstring
    Example
    https://example.com/1234235345.mp4
  - notification_messagestring
  - cancellation_reasonstring
  - recurrencestring
    Example
    FREQ=DAILY;COUNT=10
    Description
    recurrence defined by RFC 5545
  - has_google_cal_errorboolean
  - durationinteger
  - occasionstring
  - tokenstring
  - visit_type_idinteger
  - visit_typeitems
  - last_confirmed_atstring<date-time>
    Example
    2023-12-01T09:00:00.000000Z
    Format
    date-time
  - confirmed_bystring<client | staff>
    Example
    client
    Allowed
    clientstaff
  - confirmation_sourcestring<phone | sms_reminder | email_reminder | pet_portal | public_calendar | crm>
    Example
    sms_reminder
    Allowed
    phonesms_reminderemail_reminderpet_portalpublic_calendarcrm
  - reconfirmedboolean
  - is_reschedulableboolean
  - is_cancelableboolean
  - drop_offobject
    Description
    Drop-off scheduling data. Present when dropOff is included.
    - idinteger
      Example
      1
    - timestring
      Example
      09:00
      Description
      Drop-off time in HH
      format
    - vet_idinteger
      Example
      1
    - appointment_idinteger
      Example
      1
    - vetobject
      Description
      Vet resource, present when dropOff.vet is included
    - datetimestring
      Example
      2023-12-01T09:00:00Z
      Description
      Full UTC datetime computed from appointment date + drop-off time

curl

curl --request POST \
     --url https://developer.digitail.io/api/v1/appointments \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "clinic_id": 1,
     "vet_id": 1,
     "patient_id": 1,
     "visit_type_id": 1,
     "reminder_notifications": [
     {}
     ],
     "datetime_start_utc": "2022-06-16T13:42:38Z",
     "datetime_end_utc": "2022-06-16T14:42:38Z"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "clinic_id": 1,
   "vet_id": 1,
   "patient_id": 1,
   "visit_type_id": 1,
   "reminder_notifications": [
      {}
   ],
   "datetime_start_utc": "2022-06-16T13:42:38Z",
   "datetime_end_utc": "2022-06-16T14:42:38Z"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/appointments", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/appointments")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "clinic_id": 1,
   "vet_id": 1,
   "patient_id": 1,
   "visit_type_id": 1,
   "reminder_notifications": [
      {}
   ],
   "datetime_start_utc": "2022-06-16T13:42:38Z",
   "datetime_end_utc": "2022-06-16T14:42:38Z"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/appointments"

payload = json.dumps({
   "clinic_id": 1,
   "vet_id": 1,
   "patient_id": 1,
   "visit_type_id": 1,
   "reminder_notifications": [
      {}
   ],
   "datetime_start_utc": "2022-06-16T13:42:38Z",
   "datetime_end_utc": "2022-06-16T14:42:38Z"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// successful operation
{
  "data": {
    "id": 1,
    "event_id": 0,
    "clinic_id": 1,
    "room_id": 0,
    "guest": false,
    "pet_id": 1,
    "record_id": 0,
    "generated_record": {},
    "status": "1",
    "datetime": "2022-06-16 15:12:38",
    "end_datetime": "2022-06-16 15:42:38",
    "datetime_start_utc": "2023-12-01T09:00:00.000000Z",
    "datetime_end_utc": "2023-12-01T10:00:00.000000Z",
    "observations": "",
    "user_note": "",
    "pet_name": "",
    "owner_name": "",
    "patient": {},
    "room": {},
    "event": {
      "id": 1,
      "address_id": 1,
      "clinic_id": 1,
      "capacity": 25,
      "date": "2022-06-16 15:12:38",
      "name": "Event Name",
      "preferences": "",
      "appointments_number": 5,
      "visit_types": [
        ""
      ]
    },
    "vet": {},
    "created_by_vet": {},
    "owner_email": "",
    "owner_phone": "",
    "reminder_notifications": {},
    "newRequests": [
      {}
    ],
    "consentForms": [
      {}
    ],
    "video_link": "https://example.com/1234235345.mp4",
    "notification_message": "",
    "cancellation_reason": "",
    "recurrence": "FREQ=DAILY;COUNT=10",
    "has_google_cal_error": false,
    "duration": 0,
    "occasion": "",
    "token": "",
    "visit_type_id": 0,
    "visit_type": {},
    "last_confirmed_at": "2023-12-01T09:00:00.000000Z",
    "confirmed_by": "client",
    "confirmation_source": "sms_reminder",
    "reconfirmed": false,
    "is_reschedulable": false,
    "is_cancelable": false,
    "drop_off": {
      "id": 1,
      "time": "09:00",
      "vet_id": 1,
      "appointment_id": 1,
      "vet": {},
      "datetime": "2023-12-01T09:00:00Z"
    }
  }
}