Appointment booking service.
Creates a new appointment from a booking request.
media type | data type | description |
---|---|---|
application/json | Booking (JSON) | the booking |
media type | data type | description |
---|---|---|
text/plain | (custom) | the appointment reference |
POST /bookings
Content-Type: application/json
Accept: text/plain
{
"location" : 12345,
"schedule" : 12345,
"appointmentType" : 12345,
"start" : "...",
"end" : "...",
"title" : "...",
"firstName" : "...",
"lastName" : "...",
"email" : "...",
"phone" : "...",
"mobile" : "...",
"patientName" : "...",
"notes" : "..."
}
HTTP/1.1 201 Created
Content-Type: text/plain
...
Cancels a booking.
name | type | description |
---|---|---|
reference | path | the booking reference |
media type | data type | description |
---|---|---|
application/json | object (JSON) | a 204 response on success |
DELETE /bookings/{reference} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...
Returns a booking given its reference.
name | type | description |
---|---|---|
reference | path | the booking reference |
media type | data type | description |
---|---|---|
application/json | Booking (JSON) | the booking |
GET /bookings/{reference} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"location" : 12345,
"schedule" : 12345,
"appointmentType" : 12345,
"start" : "...",
"end" : "...",
"title" : "...",
"firstName" : "...",
"lastName" : "...",
"email" : "...",
"phone" : "...",
"mobile" : "...",
"patientName" : "...",
"notes" : "..."
}