HeyDonto API Documentation (1.0)

API documentation for HeyDonto API

Powered by HeyDonto
Overview
Languages
Servers
Mock server

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

Sandbox

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

Production

https://api.heydonto.com/

Site Appointment Types

Operations

Appointment Type

Operations

Brands

Operations

Dental Practices

Operations

Dental Services

Operations

Organizations

Operations

Practice Management Systems

Operations

Sites

Operations

Codes

Operations

Retrieve all codes

Request

Security
bearer
Query
titlestring

The title of the code

Example: title=Nutritional Counseling
pagenumber>= 0

Page number (0-based)

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

Number of items per page

Default 10
Example: pageSize=10
sortBy[0][field]string

First sort field

Enum"id""code""title""category""categoryCode""createdAt""updatedAt"
sortBy[0][dir]string

First sort direction

Enum"asc""desc"
sortBy[1][field]string

Second sort field

Enum"id""code""title""category""categoryCode""createdAt""updatedAt"
sortBy[1][dir]string

Second sort direction

Enum"asc""desc"
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/code?page=0&pageSize=10&sortBy%5B0%5D%5Bdir%5D=asc&sortBy%5B0%5D%5Bfield%5D=id&sortBy%5B1%5D%5Bdir%5D=asc&sortBy%5B1%5D%5Bfield%5D=id&title=Nutritional%20Counseling' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of codes retrieved successfully.

Bodyapplication/json
dataArray of objects(CodeDto)required

Array of codes

data[].​titlestringrequired

The title of the code

Example: "Medical Code Title"
data[].​codestringrequired

The unique code associated with the title

Example: "M1234"
data[].​categorystringrequired

The category of the code

Example: "Dental"
data[].​categoryCodestringrequired

The unique code for the category

Example: "D4567"
data[].​isEnabledboolean

Indicates whether the code is enabled

Example: true
data[].​idnumberrequired

The ID of the code to be updated

Example: 123
data[].​createdAtstringrequired

The date and time the code was created

Example: "2021-05-01T12:00:00Z"
data[].​updatedAtstringrequired

The date and time the code was last updated

Example: "2021-05-01T12:00:00Z"
metaobjectrequired

Pagination metadata

meta.​pagenumberrequired

Current page number (0-based)

Example: 0
meta.​pageSizenumberrequired

Number of items per page

Example: 10
meta.​totalnumberrequired

Total number of items

Example: 150
meta.​totalPagesnumberrequired

Total number of pages

Example: 15
meta.​hasNextbooleanrequired

Whether there is a next page

Example: true
meta.​hasPreviousbooleanrequired

Whether there is a previous page

Example: false
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "page": 0,
    "pageSize": 10,
    "total": 150,
    "totalPages": 15,
    "hasNext": true,
    "hasPrevious": false
  }
}

Create a new code

Request

Security
bearer
Bodyapplication/jsonrequired
titlestringrequired

The title of the code

Example: "Medical Code Title"
codestringrequired

The unique code associated with the title

Example: "M1234"
categorystringrequired

The category of the code

Example: "Dental"
categoryCodestringrequired

The unique code for the category

Example: "D4567"
isEnabledboolean

Indicates whether the code is enabled

Example: true
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/code \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Medical Code Title",
    "code": "M1234",
    "category": "Dental",
    "categoryCode": "D4567",
    "isEnabled": true
  }'

Responses

Code created successfully.

Bodyapplication/json
titlestringrequired

The title of the code

Example: "Medical Code Title"
codestringrequired

The unique code associated with the title

Example: "M1234"
categorystringrequired

The category of the code

Example: "Dental"
categoryCodestringrequired

The unique code for the category

Example: "D4567"
isEnabledboolean

Indicates whether the code is enabled

Example: true
idnumberrequired

The ID of the code to be updated

Example: 123
createdAtstringrequired

The date and time the code was created

Example: "2021-05-01T12:00:00Z"
updatedAtstringrequired

The date and time the code was last updated

Example: "2021-05-01T12:00:00Z"
Response
application/json
{
  "title": "Medical Code Title",
  "code": "M1234",
  "category": "Dental",
  "categoryCode": "D4567",
  "isEnabled": true,
  "id": 123,
  "createdAt": "2021-05-01T12:00:00Z",
  "updatedAt": "2021-05-01T12:00:00Z"
}

Update an existing code

Request

Security
bearer
Path
codeIdnumberrequired
Bodyapplication/jsonrequired
titlestringrequired

The title of the code

Example: "Medical Code Title"
codestringrequired

The unique code associated with the title

Example: "M1234"
categorystringrequired

The category of the code

Example: "Dental"
categoryCodestringrequired

The unique code for the category

Example: "D4567"
isEnabledboolean

Indicates whether the code is enabled

Example: true
idnumberrequired

The ID of the code to be updated

Example: 123
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/code/{codeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Medical Code Title",
    "code": "M1234",
    "category": "Dental",
    "categoryCode": "D4567",
    "isEnabled": true,
    "id": 123
  }'

Responses

Code updated successfully.

Bodyapplication/json
titlestringrequired

The title of the code

Example: "Medical Code Title"
codestringrequired

The unique code associated with the title

Example: "M1234"
categorystringrequired

The category of the code

Example: "Dental"
categoryCodestringrequired

The unique code for the category

Example: "D4567"
isEnabledboolean

Indicates whether the code is enabled

Example: true
idnumberrequired

The ID of the code to be updated

Example: 123
createdAtstringrequired

The date and time the code was created

Example: "2021-05-01T12:00:00Z"
updatedAtstringrequired

The date and time the code was last updated

Example: "2021-05-01T12:00:00Z"
Response
application/json
{
  "title": "Medical Code Title",
  "code": "M1234",
  "category": "Dental",
  "categoryCode": "D4567",
  "isEnabled": true,
  "id": 123,
  "createdAt": "2021-05-01T12:00:00Z",
  "updatedAt": "2021-05-01T12:00:00Z"
}

Delete a code

Request

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

Responses

Code deleted successfully.

Response
No content

Site Assistants

Operations

Periomeasure

Operations

Availability

Operations

Users

Operations

Billing Information

Operations