Organisations

Endpoints for creating and managing organisations which own or deal with billing for physical practice sites.

Upsert organisation

Creates or updates an organisation in the slipstream practice registry and returns a unique identifier

Securityazure_auth
Request
path Parameters
OrganisationIdentifier
required
string (PmsSpecificOrganisationId)

The PMS-specific id that uniquely identifies an organisation (What you call the organisation in your software), which owns one or more practice sites

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 organisation to onboard

Name
required
string

The human-readable name for the organisation.

Website
string <uri>

The website for the organisation.

PrimaryEmailAddress
string <email>

Primary email address for the organisation, used for general communications.

BillingEmailAddress
string <email>

Primary email address for billing-specific mail for the organisation.

PhoneNumber
string <phone>

Contact phone number for the organisation in E.164 format

Responses
200

Organisation identity

201

Organisation identity

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)

post/management/organisations/{OrganisationIdentifier}
Request samples
application/json
{
  • "Name": "Dental Mega Corp",
  • "PrimaryEmailAddress": "admin@dental-mega-corp.com",
  • "BillingEmailAddress": "billing@dental-mega-corp.com",
  • "PhoneNumber": "+1 555-555-5555"
}
Response samples
application/json
{
  • "Name": "All your teeth are belong to us LTD",
  • "PracticeManagementSoftware": "Unknown",
  • "PmsSpecificOrganisationId": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003",
  • "OrganisationSlug": "s8n6EzC"
}

Get an organisation

Fetches the details of a given organisation in slipstream

Securityazure_auth
Request
path Parameters
OrganisationIdentifier
required
string (PmsSpecificOrganisationId)

The PMS-specific id that uniquely identifies an organisation (What you call the organisation in your software), which owns one or more practice sites

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 requested organisation

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/organisations/{OrganisationIdentifier}
Request samples
Response samples
application/json
{
  • "Identity": {
    },
  • "PrimaryEmailAddress": "admin@dental-mega-corp.com",
  • "BillingEmailAddress": "billing@dental-mega-corp.com",
  • "PhoneNumber": "+1 555-555-5555"
}

Delete an organisation

Deletes an organisation from the slipstream practice registry. Will fail if the organisation owns any practice sites - delete the sites first

Securityazure_auth
Request
path Parameters
OrganisationIdentifier
required
string (PmsSpecificOrganisationId)

The PMS-specific id that uniquely identifies an organisation (What you call the organisation in your software), which owns one or more practice sites

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

OK

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/organisations/{OrganisationIdentifier}
Request samples
Response samples
application/json
"fGkYxz"

Get organisation identity

Fetches the identity of a given organisation in slipstream

Securityazure_auth
Request
path Parameters
OrganisationIdentifier
required
string (PmsSpecificOrganisationId)

The PMS-specific id that uniquely identifies an organisation (What you call the organisation in your software), which owns one or more practice sites

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

Organisation identity

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)

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)

get/management/organisations/{OrganisationIdentifier}/identity
Request samples
Response samples
application/json
{
  • "Name": "All your teeth are belong to us LTD",
  • "PracticeManagementSoftware": "Unknown",
  • "PmsSpecificOrganisationId": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003",
  • "OrganisationSlug": "s8n6EzC"
}