From Bright Pattern Documentation
(Created new topic from branched topic Documentation:ServicePattern:mobile-web-api-specification:CheckAvailability:5.1) |
|||
| Line 1: | Line 1: | ||
<translate>= Check Availability= | <translate>= Check Availability= | ||
| − | + | Returns the current status of configured services. | |
| − | |||
| − | == URI == | + | == Request == |
| − | http[s]:// | + | === URI === |
| + | http[s]://<host>/clientweb/api/v1/availability?tenantUrl=<tenantUrl> | ||
| − | == Method == | + | === HTTP Method === |
GET | GET | ||
| − | |||
| − | |||
| − | === Example === | + | == Response == |
| + | === Content type === | ||
| + | application/json | ||
| + | |||
| + | === Example Response === | ||
| + | { | ||
| + | "chat": "<available|notAvailable>" | ||
| + | } | ||
| + | |||
| + | === Status Meanings === | ||
{|border="1" style="border-collapse:collapse" cellpadding="5" | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| − | |'' | + | | '''Status Name''' |
| + | | '''Description''' | ||
| + | |- | ||
| + | | available | ||
| + | | The requested service is available. | ||
| + | |- | ||
| + | | notAvailable | ||
| + | | The office providing the requested service is currently closed. | ||
| + | |} | ||
| − | '' | + | === Codes === |
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''Code''' | ||
| + | | '''Description''' | ||
| + | |- | ||
| + | | 200 | ||
| + | | Names of configured services with current status | ||
| + | |- | ||
| + | | 401 | ||
| + | | Unauthorized | ||
| + | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</translate> | </translate> | ||
Latest revision as of 17:46, 25 February 2020
Check Availability
Returns the current status of configured services.
Request
URI
http[s]://<host>/clientweb/api/v1/availability?tenantUrl=<tenantUrl>
HTTP Method
GET
Response
Content type
application/json
Example Response
{
"chat": "<available|notAvailable>"
}
Status Meanings
| Status Name | Description |
| available | The requested service is available. |
| notAvailable | The office providing the requested service is currently closed. |
Codes
| Code | Description |
| 200 | Names of configured services with current status |
| 401 | Unauthorized |