From Bright Pattern Documentation
Jump to: navigation, search
Tracy (talk | contribs)
No edit summary
Tracy (talk | contribs)
No edit summary
Line 12: Line 12:


== Response ==
== Response ==
*200 OK  
{|border="1" style="border-collapse:collapse" cellpadding="5"
 
| '''Code'''
| '''Description'''
| '''Example'''
|-
| 200
| OK
|
  {
  {
     “availability”: [ true | false ]  
     “availability”: [ true | false ]  
  }
  }
|-
| True
| "Number of ready agents" > 0 for the specific service (i.e., at least one agent is available)
| -
|-
| False
| "Number of ready agents" is 0 for the specific service (i.e., no agent is available)
| -
|}


*True – "Number of ready agents" > 0 for the specific service (i.e., at least one agent is available)
*False – "Number of ready agents" is 0 for the specific service (i.e., no agent is available)





Revision as of 00:01, 28 August 2018

<translate>

Get Available Agents

Gets "true" or "false" value for agents ready to handle a specific service.

URI

https://{tenant_url:port}/statsapi/info/check_available_agents?service={service-name}

HTTP Method

GET

Note: No authentication or subscription is needed.

Response

Code Description Example
200 OK
{
    “availability”: [ true | false ] 
}
True "Number of ready agents" > 0 for the specific service (i.e., at least one agent is available) -
False "Number of ready agents" is 0 for the specific service (i.e., no agent is available) -




</translate>