Booking API

Introduction

The Public Booking API allows external software and services to interact with samedi’s infrastructure. All communication is performed over the HTTP protocol. This API adheres to the REST conventions. GET requests should be used to retrieve information and POST to send data that have an impact on the server. API methods return meaningful HTTP status codes. All data interchanged via this API are formatted as JSON.

The API described here allows developers to access a variety of data such as appointment categories and types, date and time availability of resources, and a limited set of user data. Further, it is possible to validate and book appointments on behalf of patients.

Please note: we strongly recommend to include a privacy policy that the patient has to agree to, informing the patient about what and why information is collected and what it is used for.

Time Formatting

All times are formatted according to the ISO8601 Format and include the time zone offset (e.g. 2014-06-01T09:10:00+02:00 represents 1st of June 2014, 9:10). Any times received from the API should be parsed according to this format and any times posted to the API should follow the same standard.

Following any other format or omitting the timezone information (in this example +02:00 which means Central European Summer Time - CEST) will most likely lead to corrupted results or processing errors.

Character Encoding

All data exchanged via this API should be encoded in the UTF-8 character set. The usage of other character sets may result in errors or the appearance of incomprehensible characters in the calendar views.