All Classes Functions Pages
CompleteActivityExamples Class Reference

More...

Detailed Description

Examples for completing activities

Example 1 - Complete activities of multiple cases

This example demonstrates the following:

  • Completing multiple activities. In this example, two activities are completed.
  • Response representation when the case of one of the activities remains open, and the other activities' case is closed.

XML

Request

Method URL
PUT /ws/v12/interaction/activity/complete

Request headers

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

Request body: 

<?xml version="1.0" encoding="UTF-8"?>
<activities xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"> 
  <activity id="1025">
      <lastModified date="2015-07-14T23:51:58.000Z" />
   </activity>
    <activity id="1039">
      <lastModified date="2015-07-14T23:51:58.000Z" />
   </activity>
</activities>

Response:
HTTP/1.1 200 OK

Response headers

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

Response body: 

<?xml version="1.0" encoding="UTF-8"?>
<activities xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/activity" 
xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/mail/alias" 
xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/live/entrypoint" 
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">
    <activity id="1025">
        <link rel="self" href="/system/ws/v12/interaction/activity/1025" />
        <case id="1023">
            <ns2:link rel="self" href="/system/ws/v12/interaction/case/1023" />
            <ns2:status>
                <ns4:value>closed</ns4:value>
                <ns4:displayValue>Closed</ns4:displayValue>
            </ns2:status>
        </case>
    </activity>
    <activity id="1039">
        <link rel="self" href="/system/ws/v12/interaction/activity/1039" />
        <case id="1032">
            <ns2:link rel="self" href="/system/ws/v12/interaction/case/1032" />
            <ns2:status>
                <ns4:value>open</ns4:value>
                <ns4:displayValue>Open</ns4:displayValue>
            </ns2:status>
        </case>
    </activity>
</activities>

     

JSON

Request

Method URL
PUT /ws/v12/interaction/activity/complete

Request headers

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

Request body: 

{
  "activity": [
    {
      "id": "1025",
      "lastModified": {
        "date": "2015-07-14T23:51:58.000Z"
      }
    },
    {
      "id": "1039",
      "lastModified": {
        "date": "2015-07-14T23:51:58.000Z"
      }
    }
   ]
}

Response:
HTTP/1.1 200 OK

Response headers

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

Response body: 

{
    "activity": [
        {
            "id": 1025,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/activity/1025"
            },
            "case": {
                "id": 1023,
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case/1023"
                },
                "status": {
                    "value": "closed",
                    "displayValue": "Closed"
                }
            }
        },
        {
            "id": 1039,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/activity/1039"
            },
            "case": {
                "id": 1032,
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case/1032"
                },
                "status": {
                    "value": "open",
                    "displayValue": "Open"
                }
            }
        }
    ]   
}

     


Example 2 - Complete single activity resulting in case getting closed

This example demonstrates the following:

  • Completing a single activity.
  • Response representation when the case gets closed.

XML

Request

Method URL
PUT /ws/v12/interaction/activity/complete

Request headers

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

Request body: 

<?xml version="1.0" encoding="UTF-8"?>
<activities xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"> 
  <activity id="1025">
      <lastModified date="2015-07-14T23:51:58.000Z" />
   </activity>
</activities>

Response:
HTTP/1.1 200 OK

Response headers

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

Response body: 

<?xml version="1.0" encoding="UTF-8"?>
<activities xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/activity" 
xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/mail/alias" 
xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/live/entrypoint" 
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">
    <activity id="1025">
        <link rel="self" href="/system/ws/v12/interaction/activity/1025" />
        <case id="1023">
            <ns2:link rel="self" href="/system/ws/v12/interaction/case/1023" />
            <ns2:status>
                <ns4:value>closed</ns4:value>
                <ns4:displayValue>Closed</ns4:displayValue>
            </ns2:status>
        </case>
    </activity>
</activities>

     

JSON

Request

Method URL
PUT /ws/v12/interaction/activity/complete

Request headers

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

Request body: 

{
  "activity": [
    {
      "id": "1025",
      "lastModified": {
        "date": "2015-07-14T23:51:58.000Z"
      }
    }
   ]
}

Response:
HTTP/1.1 200 OK

Response headers

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

Response body: 

{
    "activity": [
        {
            "id": 1025,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/activity/1025"
            },
            "case": {
                "id": 1023,
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case/1023"
                },
                "status": {
                    "value": "closed",
                    "displayValue": "Closed"
                }
            }
        }
    ]   
}

     

Example 3 - Complete single activity without a case

This example demonstrates the following:

  • Completing a single activity, which does not have a case.

XML

Request

Method URL
PUT /ws/v12/interaction/activity/complete

Request headers

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

Request body: 

<?xml version="1.0" encoding="UTF-8"?>
<activities xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"> 
  <activity id="1025">
      <lastModified date="2015-07-14T23:51:58.000Z" />
   </activity>
</activities>

Response:
HTTP/1.1 200 OK

Response headers

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

Response body: 

 <?xml version="1.0" encoding="UTF-8"?>
<activities xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/activity" 
xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/mail/alias" 
xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/live/entrypoint" 
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">
    <activity id="1025">
        <link rel="self" href="/system/ws/v12/interaction/activity/1025" />
    </activity>
</activities>

     

JSON

Request

Method URL
PUT /ws/v12/interaction/activity/complete

Request headers

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

Request body: 

{
  "activity": [
    {
      "id": "1025",
      "lastModified": {
        "date": "2015-07-14T23:51:58.000Z"
      }
    }
   ]
}

Response:
HTTP/1.1 200 OK

Response headers

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

Response body: 

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