From Bright Pattern Documentation
|
|
| Line 1: |
Line 1: |
| − | <translate>= Check Availability=
| + | #REDIRECT [[Api]] |
| − | 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 ===
| |
| − | {|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>
| |
Latest revision as of 22:57, 6 August 2020
