API batch | Medical office

Here is an API batch to create a location for a doctor or paramedical, including the settings for the scheduling process:

  • each staff has a description (eg: expertise), so that the patient can know more about each doctor ;
  • waiting list is available ;

  • a client can book an appointment for someone else (eg: an elderly or a child) ;

  • the patient can print out a confirmation page.


{
    "requests": [
        {
            "path": "/api/2.1/scheduling/companies",
            "method": "POST",
            "body": {
                "name": "My Location",
                "address": {
                    "city": "",
                    "country": "US",
                    "otherStreet": "",
                    "state": "",
                    "street": "",
                    "zipCode": ""
                },
                "currency": "USD",
                "email": "",
                "phone": "",
                "scheduledItems": "service-staff",
                "timeZone": "US/Eastern",
                "workingHours": [
                    {
                        "day": "monday",
                        "hours": [
                            {
                                "end": "12:00",
                                "start": "09:00"
                            },
                            {
                                "end": "18:00",
                                "start": "14:00"
                            }
                        ]
                    },
                    {
                        "day": "tuesday",
                        "hours": [
                            {
                                "end": "12:00",
                                "start": "09:00"
                            },
                            {
                                "end": "18:00",
                                "start": "14:00"
                            }
                        ]
                    },
                    {
                        "day": "wednesday",
                        "hours": [
                            {
                                "end": "12:00",
                                "start": "09:00"
                            },
                            {
                                "end": "18:00",
                                "start": "14:00"
                            }
                        ]
                    },
                    {
                        "day": "thursday",
                        "hours": [
                            {
                                "end": "12:00",
                                "start": "09:00"
                            },
                            {
                                "end": "18:00",
                                "start": "14:00"
                            }
                        ]
                    },
                    {
                        "day": "friday",
                        "hours": [
                            {
                                "end": "12:00",
                                "start": "09:00"
                            },
                            {
                                "end": "18:00",
                                "start": "14:00"
                            }
                        ]
                    },
                    {
                        "day": "saturday",
                        "hours": [
                            {
                                "end": "12:00",
                                "start": "09:00"
                            }
                        ]
                    },
                    {
                        "day": "sunday",
                        "hours": []
                    }
                ]
            }
        },
        {
            "path": "/api/2.1/scheduling/companies/{id}/services",
            "method": "POST",
            "body": {
                "allowBookingIteration": false,
                "availability": "public",
                "bufferDuration": 0,
                "price": 20,
                "capacity": 1,
                "color": "#770d69",
                "description": "",
                "duration": 15,
                "maxAppointmentsPerDay": 1,
                "name": "Consultation",
                "overNight": false,
                "overNightStartTime": "",
                "payable": false
            }
        },
        {
            "path": "/api/2.1/scheduling/companies/{company.id}/staff",
            "method": "POST",
            "body": {
                "firstName": "Dr Jane",
                "lastName": "Doe",
                "email": "",
                "description": "MD, Pediatrics",
                "services": [
                    {
                        "id": "{id}"
                    }
                ]
            }
        },
        {
            "path": "/api/2.1/scheduling/companies/{company.id}/settings",
            "method": "PUT",
            "body": {
                "rules": {
                    "validation": "auto",
                    "maxAppointmentDate": "months-3",
                    "minAppointmentDate": "hours-1",
                    "waitingList": true
                },
                "widget": {
                    "appointmentForSomeoneElse": true,
                    "displayPrices": true,
                    "displayDuration": false,
                    "displayServicePicture": false,
                    "staffMemberNameFormat": "{staff name} {staff lastname}",
                    "freeSlotsIntervalTime": "service+buffer",
                    "displayConfirmPrintPage": true
                },
                "items": {
                    "serviceAlgorithm": "smart",
                    "staffServiceAllowRandomStaff": false,
                    "scheduledItems": "staff-service"
                }
            }
        }
    ]
}


Login or Signup to post a comment