Skip to content

HeyDonto API Documentation (1.0)

API documentation for HeyDonto API

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/heydonto/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Operations
Operations

Request

Security
bearer
Query
titlestringrequired

The title of the appointment type

Example: title=1 Filling - Returning
pagenumber>= 0

Page number (0-based)

Default 0
Example: page=0
pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10
Example: pageSize=10
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/appointment-type?title=1+Filling+-+Returning&page=0&pageSize=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of appointment types

Bodyapplication/jsonArray [
titlestringrequired

The title of the appointment type

Example: "1 Filling - Returning"
isEnabledboolean

Indicates if the appointment type is enabled

Example: true
idnumberrequired

The unique ID of the appointment type

Example: 123
createdAtstringrequired

The date and time the appointment type was created

Example: "2021-08-01T00:00:00.000Z"
updatedAtstringrequired

The date and time the appointment type was last updated

Example: "2021-08-01T00:00:00.000Z"
]
Response
application/json
[ { "title": "1 Filling - Returning", "isEnabled": true, "id": 123, "createdAt": "2021-08-01T00:00:00.000Z", "updatedAt": "2021-08-01T00:00:00.000Z" } ]

Request

Security
bearer
Bodyapplication/jsonrequired
titlestringrequired

The title of the appointment type

Example: "1 Filling - Returning"
isEnabledboolean

Indicates if the appointment type is enabled

Example: true
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/appointment-type \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "1 Filling - Returning",
    "isEnabled": true
  }'

Responses

The appointment type has been successfully created.

Bodyapplication/json
titlestringrequired

The title of the appointment type

Example: "1 Filling - Returning"
isEnabledboolean

Indicates if the appointment type is enabled

Example: true
Response
application/json
{ "title": "1 Filling - Returning", "isEnabled": true }

Update an existing appointment type

Request

Security
bearer
Path
appointmentTypeIdnumberrequired
Bodyapplication/jsonrequired
titlestringrequired

The title of the appointment type

Example: "1 Filling - Returning"
isEnabledboolean

Indicates if the appointment type is enabled

Example: true
idnumberrequired

The unique ID of the appointment type

Example: 123
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/appointment-type/{appointmentTypeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "1 Filling - Returning",
    "isEnabled": true,
    "id": 123
  }'

Responses

The appointment type has been successfully updated.

Bodyapplication/json
titlestringrequired

The title of the appointment type

Example: "1 Filling - Returning"
isEnabledboolean

Indicates if the appointment type is enabled

Example: true
idnumberrequired

The unique ID of the appointment type

Example: 123
Response
application/json
{ "title": "1 Filling - Returning", "isEnabled": true, "id": 123 }

Request

Security
bearer
Path
appointmentTypeIdnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/appointment-type/{appointmentTypeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The appointment type has been successfully deleted.

Response
No content
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations