logo
Powered by Redocly

Sites

Endpoints for creating and managing physical practice sites where dentistry happens.

Upsert practice site

Creates a practice site in the slipstream practice registry and returns a unique identifier and API Keys which can be used on the site APIs

Securityazure_auth
Request
path Parameters
SiteIdentifier
required
string (PmsSpecificPracticeId)

The PMS-specific id that uniquely identifies a physical practice site (What you call the site in your software)

Example: 04d2f2f0-8f1a-11eb-8dcd-0242ac130003
header Parameters
X-Practice-Management-Software
string (PracticeManagementSoftware)

The intended practice management software for the request, used to disambiguate a pms specific identifier when you have access to multiple PMS systems.

Omit this if you only have access to a single PMS.

Enum Value Description
Unknown

Unknown PMS - not valid

Testing

Used for automated testing, not a real software system

Exact

Exact Dental

Dentally

Dentally Cloud

Ascend

Ascend

Request Body schema: application/json
required

The details of the practice to onboard

Name
required
string

The human-readable name for the practice.

object (StreetAddress)

Information about a street address.

object (StreetAddress)

Information about a street address.

PhoneNumber
string <phone> (PhoneNumber)

Contact phone number for in E.164 format

EmailAddress
string <email> (Email)

An email address

OwningOrganisationSlug
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

A URL-safe unique identifier for an entity (See Sqids)

BillingOrganisationSlug
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

A URL-safe unique identifier for an entity (See Sqids)

Currency
string <ISO-4217> (Currency)

The ISO-4217 currency code used by the practice.

Responses
200

Practice site details with API keys

201

Practice site details with API keys

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

422

Unprocessable - Request was well formed but could not be actioned (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

post/management/sites/{SiteIdentifier}
Request samples
application/json
{
  • "Name": "DentalCare Clinic",
  • "Address": {
    },
  • "PostalAddress": {
    },
  • "PhoneNumber": "+1 555-555-5555",
  • "EmailAddress": "john.smith@example.com",
  • "OwningOrganisationSlug": "s8n6EzC",
  • "BillingOrganisationSlug": "s8n6EzC",
  • "Currency": "USD"
}
Response samples
application/json
{
  • "Identity": {
    },
  • "PracticeSiteApiKeys": {
    }
}

Delete a practice site

Deletes a practice site from the slipstream practice registry. Will also delete the owning organisation if this is the last practice in the organisation.

Securityazure_auth
Request
path Parameters
SiteIdentifier
required
string (PmsSpecificPracticeId)

The PMS-specific id that uniquely identifies a physical practice site (What you call the site in your software)

Example: 04d2f2f0-8f1a-11eb-8dcd-0242ac130003
header Parameters
X-Practice-Management-Software
string (PracticeManagementSoftware)

The intended practice management software for the request, used to disambiguate a pms specific identifier when you have access to multiple PMS systems.

Omit this if you only have access to a single PMS.

Enum Value Description
Unknown

Unknown PMS - not valid

Testing

Used for automated testing, not a real software system

Exact

Exact Dental

Dentally

Dentally Cloud

Ascend

Ascend

Responses
200

The details of the practice deleted, and any organisations which were deleted along with it

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

delete/management/sites/{SiteIdentifier}
Request samples 
curl -i -X DELETE \
  'https://slipstream.hsone.app/api/v1/management/sites/{SiteIdentifier}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Practice-Management-Software: Unknown'
Response samples
application/json
{
  • "Identity": {
    },
  • "DeletedOrganisation": {
    }
}

Get practice identity

Fetches the identity of a given practice in slipstream and API Keys which can be used on the other endpoints

Securityazure_auth
Request
path Parameters
SiteIdentifier
required
string (PmsSpecificPracticeId)

The PMS-specific id that uniquely identifies a physical practice site (What you call the site in your software)

Example: 04d2f2f0-8f1a-11eb-8dcd-0242ac130003
header Parameters
X-Practice-Management-Software
string (PracticeManagementSoftware)

The intended practice management software for the request, used to disambiguate a pms specific identifier when you have access to multiple PMS systems.

Omit this if you only have access to a single PMS.

Enum Value Description
Unknown

Unknown PMS - not valid

Testing

Used for automated testing, not a real software system

Exact

Exact Dental

Dentally

Dentally Cloud

Ascend

Ascend

Responses
200

Practice site details with API keys

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

get/management/sites/{SiteIdentifier}/identity
Request samples 
curl -i -X GET \
  'https://slipstream.hsone.app/api/v1/management/sites/{SiteIdentifier}/identity' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Practice-Management-Software: Unknown'
Response samples
application/json
{
  • "Identity": {
    },
  • "PracticeSiteApiKeys": {
    }
}

List Practice Sites

Lists practice sites in the slipstream practice registry

Securityazure_auth
Request
query Parameters
pageSize
integer <int32> [ 1 .. 250 ]

The page number to retrieve

Example: pageSize=50
nextPageToken
string

A token retrieved from a previous request, used to retrieve the next page of results

Sites
Array of strings or null <slug> (Slug)

The slugs of the sites to return

Example: Sites=s8n6EzC
OwningOrganisations
Array of strings or null <slug> (Slug)

The slugs of the owning organisation to return sites for

Example: OwningOrganisations=s8n6EzC
BillingOrganisations
Array of strings or null <slug> (Slug)

The slugs of the billing organisation to return sites for

Example: BillingOrganisations=s8n6EzC
Countries
Array of strings or null <ISO-3166-3> (Country)

The countries to return sites for

Example: Countries=USA
isActive
boolean or null

Filter active or inactive sites.

Example: isActive=false
header Parameters
X-Practice-Management-Software
string (PracticeManagementSoftware)

The intended practice management software for the request, used to disambiguate a pms specific identifier when you have access to multiple PMS systems.

Omit this if you only have access to a single PMS.

Enum Value Description
Unknown

Unknown PMS - not valid

Testing

Used for automated testing, not a real software system

Exact

Exact Dental

Dentally

Dentally Cloud

Ascend

Ascend

Responses
200

OK

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

get/sites
Request samples 
curl -i -X GET \
  'https://slipstream.hsone.app/api/v1/sites?pageSize=1&nextPageToken=string&Sites=s8n6EzC&OwningOrganisations=s8n6EzC&BillingOrganisations=s8n6EzC&Countries=USA&isActive=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Practice-Management-Software: Unknown'
Response samples
application/json
{
  • "Items": [
    ],
  • "NextPageToken": "eyJ0eXAiOi"
}
➔ Next to Billing