HeyDonto API Documentation (1.0)

API documentation for HeyDonto API

Powered by HeyDonto

Overview

Servers

Mock server

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

Sandbox

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

Production

https://api.heydonto.com/

AppointmentType

Operations

Brands

Operations

Dental Practices

Operations

Dental Services

Operations

Organizations

Operations

Practice Management Systems

Operations

Sites

Operations

Codes

Operations

Retrieve all codes

Request

curl -i -X GET \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/code \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of codes retrieved successfully.

Bodyapplication/jsonArray [

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

]

Response

application/json

[
  {
    "title": "Medical Code Title",
    "code": "M1234",
    "category": "Dental",
    "categoryCode": "D4567",
    "isEnabled": true
  }
]

Create a new code

Request

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

Response

application/json

{
  "title": "Medical Code Title",
  "code": "M1234",
  "category": "Dental",
  "categoryCode": "D4567",
  "isEnabled": true
}

Update an existing code

Request

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

Response

application/json

{
  "title": "Medical Code Title",
  "code": "M1234",
  "category": "Dental",
  "categoryCode": "D4567",
  "isEnabled": true,
  "id": 123
}

Delete a code

Request

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

application/json

{
  "message": "Unauthorized",
  "statusCode": 401
}

Site Assistants

Operations

Periomeasure

Operations

Availability

Operations