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
Operations
Operations
Operations
Operations
Operations

Retrieve all practice management systems

Request

Security
bearer
Query
titlestring

The title of the Practice Management System

Example: title=Dentrix
isEnabledboolean

Filter by enabled status

Example: isEnabled=true
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""title""createdAt""updatedAt"
sortBy[0][dir]string

First sort direction

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

Second sort field

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

Second sort direction

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

Responses

List of practice management systems retrieved successfully.

Bodyapplication/json
dataArray of objects(PracticeManagementSystemDto)required

Array of Practice Management Systems

data[].​titlestringrequired

The title of the practice management system

Example: "OpenDental"
data[].​isCloudBasedboolean

Indicates whether the practice management system is cloud based

Example: true
data[].​isEnabledboolean

Indicates whether the practice management system is enabled

Example: true
data[].​idnumberrequired

The ID of the practice management system to be updated

Example: 123
data[].​createdAtstringrequired

The date the practice management system was created

Example: "2021-07-01T00:00:00.000Z"
data[].​updatedAtstringrequired

The date the practice management system was last updated

Example: "2021-07-01T00:00:00.000Z"
metaobjectrequired
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 practice management system

Request

Security
bearer
Bodyapplication/jsonrequired
titlestringrequired

The title of the practice management system

Example: "OpenDental"
isCloudBasedboolean

Indicates whether the practice management system is cloud based

Example: true
isEnabledboolean

Indicates whether the practice management system is enabled

Example: true
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/practice-management-system \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "OpenDental",
    "isCloudBased": true,
    "isEnabled": true
  }'

Responses

Practice management system created successfully.

Bodyapplication/json
titlestringrequired

The title of the practice management system

Example: "OpenDental"
isCloudBasedboolean

Indicates whether the practice management system is cloud based

Example: true
isEnabledboolean

Indicates whether the practice management system is enabled

Example: true
idnumberrequired

The ID of the practice management system to be updated

Example: 123
createdAtstringrequired

The date the practice management system was created

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

The date the practice management system was last updated

Example: "2021-07-01T00:00:00.000Z"
Response
application/json
{ "title": "OpenDental", "isCloudBased": true, "isEnabled": true, "id": 123, "createdAt": "2021-07-01T00:00:00.000Z", "updatedAt": "2021-07-01T00:00:00.000Z" }

Update an existing practice management system

Request

Security
bearer
Path
practiceManagementSystemIdnumberrequired
Bodyapplication/jsonrequired
titlestringrequired

The title of the practice management system

Example: "OpenDental"
isCloudBasedboolean

Indicates whether the practice management system is cloud based

Example: true
isEnabledboolean

Indicates whether the practice management system is enabled

Example: true
idnumberrequired

The ID of the practice management system to be updated

Example: 123
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/practice-management-system/{practiceManagementSystemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "OpenDental",
    "isCloudBased": true,
    "isEnabled": true,
    "id": 123
  }'

Responses

Practice management system updated successfully.

Bodyapplication/json
titlestringrequired

The title of the practice management system

Example: "OpenDental"
isCloudBasedboolean

Indicates whether the practice management system is cloud based

Example: true
isEnabledboolean

Indicates whether the practice management system is enabled

Example: true
idnumberrequired

The ID of the practice management system to be updated

Example: 123
createdAtstringrequired

The date the practice management system was created

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

The date the practice management system was last updated

Example: "2021-07-01T00:00:00.000Z"
Response
application/json
{ "title": "OpenDental", "isCloudBased": true, "isEnabled": true, "id": 123, "createdAt": "2021-07-01T00:00:00.000Z", "updatedAt": "2021-07-01T00:00:00.000Z" }

Delete a practice management system

Request

Security
bearer
Path
practiceManagementSystemIdnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/practice-management-system/{practiceManagementSystemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Practice management system deleted successfully.

Response
No content
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations