Site Details

Endpoints for updating site details, configuring the practice site and advertising capabilities

Update practice site details

Updates the details of a practice site in the Slipstream practice registry

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
Request Body schema: application/json
required

The details of the practice site to onboard

<= 50 properties
PmsSpecificSiteId
string (PmsSpecificPracticeId)

The PMS-specific id that uniquely identifies a physical practice

Name
string or null

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

ApplicationVersion
string <version> (Version)

The version of the software that the practice is running

Currency
string <ISO-4217> (Currency)

The ISO-4217 currency code used by the practice.

WebsiteUrl
string or null <uri>

A URL to the website for the practice.

LogoUrl
string or null <uri>

A URL to the logo for the practice.

PrivacyPolicyUrl
string or null <uri>

A URL to the privacy policy for the practice.

property name*
additional property
any
Responses
200

Practice site details

201

Practice site details

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)

patch/sites/{SiteSlug}
Request samples
application/json
{}
Response samples
application/json
{
  • "Name": "The Friendly Dentist",
  • "PracticeManagementSoftware": "Unknown",
  • "PmsSpecificSiteId": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003",
  • "SiteSlug": "s8n6EzC",
  • "OwningOrganisationSlug": "s8n6EzC",
  • "BillingOrganisationSlug": "s8n6EzC"
}

Get practice site details

Fetches the full details of a practice site in the slipstream practice registry

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
Responses
200

The details of the requested practice site

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/sites/{SiteSlug}
Request samples
Response samples
application/json
{
  • "PracticeManagementSoftware": "Unknown",
  • "PmsSpecificSiteId": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003",
  • "SiteSlug": "s8n6EzC",
  • "OwningOrganisationSlug": "s8n6EzC",
  • "BillingOrganisationSlug": "s8n6EzC",
  • "Name": "DentalCare Clinic",
  • "Address": {
    },
  • "PostalAddress": {
    },
  • "Coordinates": {
    },
  • "PhoneNumber": "+1 555-555-5555",
  • "EmailAddress": "john.smith@example.com",
  • "ApplicationVersion": "1.2.3",
  • "Currency": "USD",
  • "GooglePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
  • "SiteStatus": "Operational",
}

Update practice site privacy policy

Updates the privacy policy of a practice site in the Slipstream practice registry

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
Request Body schema: multipart/form-data
required

The privacy policy of the practice site

file
string <binary>

Privacy policy document for the practice

Responses
200

The details of the practice file upload

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)

put/sites/{SiteSlug}/privacy-policy
Request samples
Response samples
application/json
{
  • "Url": "string"
}

Delete practice site privacy policy document

Deletes the privacy policy document of a practice site in the Slipstream practice registry

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
Responses
204

Privacy policy removed (no content)

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)

delete/sites/{SiteSlug}/privacy-policy
Request samples
Response samples
application/problem+json
{
  • "title": "The Name field is required.",
  • "detail": "The Name field is required.",
  • "status": 400,
  • "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}

List capabilities

Fetches the list of functionality that a practice site (and the software it is using) supports. See Capabilities for more details.

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
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)

get/sites/{SiteSlug}/capabilities
Request samples
Response samples
application/json
{
  • "enabledCapabilities": [
    ]
}

Add capability

Adds a single capability to the list of functionality that the practice site supports. See Capabilities for more details.

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
capability
required
string (Capability)

The capability to add to the practice, see Capabilities for more details.

Enum Value Description
Billing

Billing and invoicing - indicates that the PMS has the ability to charge the site for services rendered. All paid services are disabled without this capability.

PhysicalPost

Sending physical letters and postcards electronically

OnlineBooking

Enables patients to book appointments online via Slipstream and Jarvis

Sms

Indicates that SMS can be sent on behalf of the practice to its patients

Forms

Indicates that forms can be sent to patients for completion

Payments

Enables online payments to be offered to patients

Example: Billing
Responses
201

Added

204

Already present (no content)

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)

patch/sites/{SiteSlug}/capabilities/{capability}
Request samples
Response samples
application/problem+json
{
  • "title": "The Name field is required.",
  • "detail": "The Name field is required.",
  • "status": 400,
  • "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}

Check capability

Checks if the practice supports a capability. See Capabilities for more details.

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
capability
required
string (Capability)

The capability to add to the practice, see Capabilities for more details.

Enum Value Description
Billing

Billing and invoicing - indicates that the PMS has the ability to charge the site for services rendered. All paid services are disabled without this capability.

PhysicalPost

Sending physical letters and postcards electronically

OnlineBooking

Enables patients to book appointments online via Slipstream and Jarvis

Sms

Indicates that SMS can be sent on behalf of the practice to its patients

Forms

Indicates that forms can be sent to patients for completion

Payments

Enables online payments to be offered to patients

Example: Billing
Responses
200

Capability Status

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/sites/{SiteSlug}/capabilities/{capability}
Request samples
Response samples
application/json
true

Remove capability

Removes a capability from a practice. See Capabilities for more details.

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
capability
required
string (Capability)

The capability to add to the practice, see Capabilities for more details.

Enum Value Description
Billing

Billing and invoicing - indicates that the PMS has the ability to charge the site for services rendered. All paid services are disabled without this capability.

PhysicalPost

Sending physical letters and postcards electronically

OnlineBooking

Enables patients to book appointments online via Slipstream and Jarvis

Sms

Indicates that SMS can be sent on behalf of the practice to its patients

Forms

Indicates that forms can be sent to patients for completion

Payments

Enables online payments to be offered to patients

Example: Billing
Responses
204

Capability removed (no content)

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/sites/{SiteSlug}/capabilities/{capability}
Request samples
Response samples
application/problem+json
{
  • "title": "The Name field is required.",
  • "detail": "The Name field is required.",
  • "status": 400,
  • "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}