Documentation Powered by ReDoc

DIPLOMAT DENTAL API (1.0.0)

Download OpenAPI specification:Download

Touch4IT: hi@touch4it.com License: All rights reserved. Terms of Service

This is public API for DIPLOMAT DENTAL's business partners. Basic authentication is used with credentials diplomatdental:fs6Uutmq8aPrq3Tr for staging environment and diplomatdental:g4JY77X7P6nXHgc4 for production environment. Users are required to authenticate with their email and password credentials. Cookie is returned in Set-Cookie header of login response and has maxAge set to 86400000 (1 day), use it for all following requests in Cookie header to authenticate. Only resources associated with user accounts are returned.

Authentication

CookieAuthentication

Security Scheme Type API Key
Cookie parameter name: sid

BasicAuthentication

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Users

Login

Authenticate user with email and password combination.

Authorizations:
BasicAuthentication
Request Body schema: application/json

User credentials

email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@email.com",
  • "password": "gAUzTeMBybjpum8F"
}

Response samples

Content type
application/json
{
  • "_id": "5cc8344ed09d6c0010698e8e",
  • "firstName": "user",
  • "lastName": "user",
  • "email": "user@email.com",
  • "phone": "+421000000000",
  • "address": "Vrbovská cesta 17",
  • "city": "Piešťany",
  • "country": "Slovakia",
  • "postalCode": "92101",
  • "roles": {
    }
}

Dental Units

Get my dental units

Dental units associated with current authenticated user account are returned.

Authorizations:
CookieAuthenticationBasicAuthentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get dental unit detail

Detailed information about dental unit.

Authorizations:
CookieAuthenticationBasicAuthentication
path Parameters
id
required
string
Example: 5c3f11d9999eb1010f245da3

ID of dental unit

Responses

Response samples

Content type
application/json
{
  • "_id": "5c3f11d9999eb1010f245da3",
  • "extIdentifiers": {
    },
  • "name": {
    },
  • "description": {
    },
  • "meta": {
    }
}

Get dental unit journal

Interactions data of dental unit created in one day. Output starting in a time specified by from parameter and ends with the end of that day 23:59.59.999 (UTC). When querying data periodically, send datetime of previous request in from parameter so you get only new records. That helps to benefit from smaller and quicker responses and also reduces server's load. Use pagination parameters to get all records when total exceeds limit. Records are sorted by time property.

Authorizations:
CookieAuthenticationBasicAuthentication
path Parameters
id
required
string
Example: 5c3f11d9999eb1010f245da3

ID of dental unit

query Parameters
from
required
string
Example: from=2021-10-18T00:00:00.000Z

UTC ISO 8601 date to return logs from (to the end of that day)

$limit
integer multiple of 1 [ 0 .. 1000 ]
Default: 1000
Example: $limit=1000

Pagination parameter limiting number of records returned

$skip
integer multiple of 1 >= 0
Default: 0
Example: $skip=0

Pagination parameter skipping first n records in response

Responses

Response samples

Content type
application/json
{
  • "total": 873,
  • "limit": 1000,
  • "skip": 0,
  • "data": [
    ]
}