Jump to: navigation, search
(HTCC-28166)
 
 
(7 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
This operation is part of the [[Workbins|Workbins API]] section of the [[Welcome|Web Services API]].
 
This operation is part of the [[Workbins|Workbins API]] section of the [[Welcome|Web Services API]].
 
==Overview==
 
==Overview==
−
Users can request statistics for a specific workbin for an agent.
+
Users can request statistics for workbins that have a specified type for a specified owner.
 
{|
 
{|
 
! Request URL
 
! Request URL
−
| /api/v2/workbins/{id}
+
| /api/v2/workbins
 
|-
 
|-
 
! HTTP Method
 
! HTTP Method
Line 14: Line 14:
 
| api-multimedia
 
| api-multimedia
 
|}
 
|}
 +
 
==Request Agent Workbins Stats==
 
==Request Agent Workbins Stats==
  
Line 29: Line 30:
  
 
===Sample===
 
===Sample===
−
The request involves sending a JSON body as well as adhering to the url path listed above.
+
The request involves sending a JSON body as well as adhering to the URL path listed above.
  
 
====Request====
 
====Request====
Line 40: Line 41:
  
 
====Response====
 
====Response====
−
The response consists of an HTTP response, and several cometd responses. For details on the JSON body result, please refer to the Workbin Resource reference.
+
The response consists of an HTTP response and a CometD response.  
  
 
'''HTTP response'''
 
'''HTTP response'''
Line 50: Line 51:
 
</pre>
 
</pre>
  
−
'''CometD Responses'''
+
'''CometD Response'''
 
<pre>
 
<pre>
 
   {   
 
   {   
Line 83: Line 84:
  
 
===Sample===
 
===Sample===
−
The request involves sending a JSON body as well as adhering to the url path listed above.
+
The request involves sending a JSON body as well as adhering to the URL path listed above.
  
 
====Request====
 
====Request====
Line 96: Line 97:
  
 
====Response====
 
====Response====
−
The response consists of an HTTP response, and several cometd responses. For details on the JSON body result, please refer to the Workbin Resource reference.
+
The response consists of an HTTP response and a CometD response.  
  
 
'''HTTP response'''
 
'''HTTP response'''
Line 106: Line 107:
 
</pre>
 
</pre>
  
−
'''CometD Responses'''
+
'''CometD Response'''
 
<pre>
 
<pre>
 
   {   
 
   {   
Line 138: Line 139:
 
|}
 
|}
 
===Sample===
 
===Sample===
−
The request involves sending a JSON body as well as adhering to the url path listed above.
+
The request involves sending a JSON body as well as adhering to the URL path listed above.
  
 
====Request====
 
====Request====
Line 151: Line 152:
  
 
====Response====
 
====Response====
−
The response consists of an HTTP response, and several cometd responses. For details on the JSON body result, please refer to the Workbin Resource reference.
+
The response consists of an HTTP response and a CometD response.  
  
 
'''HTTP response'''
 
'''HTTP response'''
Line 161: Line 162:
 
</pre>
 
</pre>
  
−
'''CometD Responses'''
+
'''CometD Response'''
 
<pre>
 
<pre>
 
   {   
 
   {   
Line 194: Line 195:
  
 
===Sample===
 
===Sample===
−
The request involves sending a JSON body as well as adhering to the url path listed above.
+
The request involves sending a JSON body as well as adhering to the URL path listed above.
  
 
====Request====
 
====Request====
Line 207: Line 208:
  
 
====Response====
 
====Response====
−
The response consists of an HTTP response, and several cometd responses. For details on the JSON body result, please refer to the Workbin Resource reference.
+
The response consists of an HTTP response and a CometD response.  
  
 
'''HTTP response'''
 
'''HTTP response'''
Line 217: Line 218:
 
</pre>
 
</pre>
  
−
'''CometD Responses'''
+
'''CometD Response'''
 
<pre>
 
<pre>
 
   {   
 
   {   
Line 232: Line 233:
 
</pre>
 
</pre>
 
==Request Agent Workbins Stats by User==
 
==Request Agent Workbins Stats by User==
 +
===Overview ===
 +
Users can request statistics for workbins for a specific agent.
 +
{|
 +
|-
 +
| Request URL
 +
| /api/v2/users/{userId}/workbins
 +
|-
 +
| HTTP Method
 +
| POST
 +
|-
 +
| Required Features
 +
| api-multimedia
 +
|}
 
===Parameters===
 
===Parameters===
 
{|
 
{|
Line 242: Line 256:
 
|}
 
|}
 
===Sample===
 
===Sample===
−
The request involves sending a JSON body as well as adhering to the url path listed above.
+
The request involves sending a JSON body as well as adhering to the URL path listed above.
  
 
====Request====
 
====Request====
Line 253: Line 267:
  
 
====Response====
 
====Response====
−
The response consists of an HTTP response, and several cometd responses. For details on the JSON body result, please refer to the Workbin Resource reference.
+
The response consists of an HTTP response and a CometD response.  
  
 
'''HTTP response'''
 
'''HTTP response'''
Line 263: Line 277:
 
</pre>
 
</pre>
  
−
'''CometD Responses'''
+
'''CometD Response'''
 
<pre>
 
<pre>
 
   {   
 
   {   

Latest revision as of 09:50, November 30, 2017

RequestAgentStats

This operation is part of the Workbins API section of the Web Services API.

Overview

Users can request statistics for workbins that have a specified type for a specified owner.

Request URL /api/v2/workbins
HTTP Method POST
Required Features api-multimedia

Request Agent Workbins Stats

Parameters

Parameter Value
operationName RequestAgentStats

Sample

The request involves sending a JSON body as well as adhering to the URL path listed above.

Request

  POST api/v2/workbins
  {
      "operationName": "RequestAgentStats"
  }

Response

The response consists of an HTTP response and a CometD response.

HTTP response 

  {
     "statusCode": 0,
     "referenceId": 1
  }

CometD Response 

  {  
     "workbinStats":{  
        "bf839abe-81de-4e30-9fa7-f7b8ec0d6415":{  
           "Count":1,
           "Owner":"28383e5523c7479cae4afa8df88d66df",
           "Type":"Agent"
        }
     },
     "messageType": "WorkbinStatsMessage",
     "referenceId": 1
  }

Request Place Workbins Stats

Parameters

Parameter Value
operationName RequestAgentStats
workbinType Place
workbinOwner place name

Sample

The request involves sending a JSON body as well as adhering to the URL path listed above.

Request

  POST api/v2/workbins
  {
      "operationName": "RequestAgentStats",
      "workbinType": "Place",
      "workbinOwner": "Place1",
  }

Response

The response consists of an HTTP response and a CometD response.

HTTP response 

  {
     "statusCode": 0,
     "referenceId": 2
  }

CometD Response 

  {  
     "workbinStats":{  
        "861640a2-154e-4025-8e4f-49b74f805b6d":{  
           "Count":1,
           "Owner":"Place1",
           "Type":"Place"
        }
     },
     "messageType": "WorkbinStatsMessage",
     "referenceId": 2
  }

Request Agent Group Workbins Stats

Parameters

Parameter Value
operationName RequestAgentStats
workbinType AgentGroup
workbinOwner agent group name

Sample

The request involves sending a JSON body as well as adhering to the URL path listed above.

Request

  POST api/v2/workbins
  {
      "operationName": "RequestAgentStats",
      "workbinType": "AgentGroup",
      "workbinOwner": "ServiceAgentGroup",
  }

Response

The response consists of an HTTP response and a CometD response.

HTTP response 

  {
     "statusCode": 0,
     "referenceId": 3
  }

CometD Response 

  {  
     "workbinStats":{  
        "39ac7955-8f82-4610-8090-7a6905a18073":{  
           "Count":1,
           "Owner":"ServiceAgentGroup",
           "Type":"AgentGroup"
        }
     },
     "messageType": "WorkbinStatsMessage",
     "referenceId": 3
  }

Request Place Group Workbins Stats

Parameters

Parameter Value
operationName RequestAgentStats
workbinType PlaceGroup
workbinOwner place group name

Sample

The request involves sending a JSON body as well as adhering to the URL path listed above.

Request

  POST api/v2/workbins
  {
      "operationName": "RequestAgentStats",
      "workbinType": "PlaceGroup",
      "workbinOwner": "ServicePlaceGroup",
  }

Response

The response consists of an HTTP response and a CometD response.

HTTP response 

  {
     "statusCode": 0,
     "referenceId": 4
  }

CometD Response 

  {  
     "workbinStats":{  
        "b28f9314-0a0d-451d-9a9a-45588dcc38c1":{  
           "Count":1,
           "Owner":"ServicePlaceGroup",
           "Type":"PlaceGroup"
        }
     },
     "messageType": "WorkbinStatsMessage",
     "referenceId": 4
  }

Request Agent Workbins Stats by User

Overview

Users can request statistics for workbins for a specific agent.

Request URL /api/v2/users/{userId}/workbins
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName RequestAgentStats

Sample

The request involves sending a JSON body as well as adhering to the URL path listed above.

Request

  POST api/v2/users/28383e5523c7479cae4afa8df88d66df/workbins
  {
      "operationName": "RequestAgentStats"
  }

Response

The response consists of an HTTP response and a CometD response.

HTTP response 

  {
     "statusCode": 0,
     "referenceId": 5
  }

CometD Response 

  {  
     "workbinStats":{  
        "bf839abe-81de-4e30-9fa7-f7b8ec0d6415":{  
           "Count":1,
           "Owner":"28383e5523c7479cae4afa8df88d66df",
           "Type":"Agent"
        }
     },
     "messageType": "WorkbinStatsMessage",
     "referenceId": 5
  }
This page was last edited on November 30, 2017, at 09:50.
Comments or questions about this documentation? Contact us for support!