From Bright Pattern Documentation
Jump to: navigation, search
(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=
''Check Availability'' returns the current status of configured services.
+
Returns the current status of configured services.
  
The ''notAvailable'' status normally means that the office providing the requested service is currently closed.
 
  
== URI ==
+
== Request ==
http[s]://&lt;host&gt;:&lt;port&gt;/clientweb/api/v1/availability?tenantUrl=&lt;tenantUrl&gt;
+
=== URI ===
 +
http[s]://<host>/clientweb/api/v1/availability?tenantUrl=<tenantUrl>
  
== Method ==
+
=== HTTP Method ===
 
GET
 
GET
  
== Returns ==
 
200 – Names of configured services with current status (content type: application/json)
 
  
=== 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.
 +
|}
  
''&quot;chat&quot;: “&lt;available|notAvailable&gt;”''
+
=== Codes ===
 +
{|border="1" style="border-collapse:collapse" cellpadding="5"
 +
| '''Code'''
 +
| '''Description'''
 +
|-
 +
| 200
 +
| Names of configured services with current status
 +
|-
 +
| 401
 +
| Unauthorized
 +
|}
  
''}''
 
|}
 
  
== Errors ==
 
401 – Unauthorized
 
  
  
  
  
<center>[[mobile-web-api-specification/GeneralInformation|< Previous]]  |  [[mobile-web-api-specification/ExpectedParameters|Next >]]</center>
 
 
</translate>
 
</translate>

Latest revision as of 17:46, 25 February 2020

• 5.2 • 5.3 • 5.8

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



< Previous | Next >