Detailed Description

Examples for Pull Activities

Example 1 - Pull activities when activities are available to pull

This example demonstrates the following:

Successfully pulling one or more activities.

XML

Request

Method	URL
PUT	`/ws/v12/interaction/activity/pull`

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/xml
Accept-Language	en-US

Request body
Request body is not allowed.

Response
HTTP/1.1 200 OK

<activities
    xmlns=" http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
    xmlns:ns2=" http://bindings.egain.com/ws/model/v12/gen/interaction/case"
    xmlns:ns3=" http://bindings.egain.com/ws/model/v12/gen/platform"
    xmlns:ns4=" http://bindings.egain.com/ws/model/v12/gen/common"
    xmlns:ns5=" http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
    xmlns:ns6=" http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
    xmlns:ns7=" http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
    xmlns:ns8=" http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint"
    xmlns:ns9=" http://bindings.egain.com/ws/model/v12/gen/interaction/attachment"
    xmlns:ns10=" http://bindings.egain.com/ws/model/v12/gen/mail/alias"
    xmlns:ns11=" http://bindings.egain.com/ws/model/v12/gen/live/entrypoint">
    <activityid="1000">
        <linkrel="self"href=" /system/ws/v12/interaction/activity/1000"/>
    </activity>
</activities>

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/xml

JSON

Request

Method	URL
PUT	`/ws/v12/interaction/activity/pull`

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/json
Accept-Language	en-US

Request body
Request body is not allowed.

Response
HTTP/1.1 200 OK

{  
  "activity":[  
    {  
      "link":{  
        "rel":"self",
        "href":"/system/ws/v12/interaction/activity/1000"
      },
      "id":1000
    }
  ]
}

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/json

Example 2 - Pull activities when no activities are available to pull

This example demonstrates the following:

The scenario when there are no activities in the queues configured in "Pull Options".

XML

Request

Method	URL
PUT	`/ws/v12/interaction/activity/pull`

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/xml
Accept-Language	en-US

Request body
Request body is not allowed.

Response
HTTP/1.1 204 No Content

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/xml

JSON

Request

Method	URL
PUT	`/ws/v12/interaction/activity/pull`

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/json
Accept-Language	en-US

Request body
Request body is not allowed.

Response
HTTP/1.1 204 No Content

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/json