From Bright Pattern Documentation
< 3.18:Mobile-web-api-specification
Revision as of 17:57, 17 October 2017 by Tracy (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

Check Availability

Check Availability returns the availability status of configured services.

The notAvailable status normally means that the office providing the requested service is currently closed.

URI

http[s]://<host>:<port>/clientweb/api/v1/availability?tenantUrl=<tenantUrl>

HTTP Method

GET

Authentication

Authorization: MOBILE-API-140-327-PLAIN appId="<Unique app identifier>", clientId="<Unique client ID>"

Parameters

tenantUrl – Specifies the tenant if the request was sent not to the tenant’s domain

Returns

200 – Names of configured services with current status (content type: application/json)

Example

{

"chat": “<available|notAvailable>”

}

Errors

401 – Unauthorized



< Previous | Next >
< Previous | Next >