Detailed Description

Examples for GET case Notes

Example 1 - Get all notes of a case

This example demonstrates the following:

Get all the notes of a case.

XML

Request

Method	URL
GET	`/ws/v12/interaction/case/2025/note`

Request headers

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

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" standalone="yes"?>
<ns3:notes
    xmlns="http://bindings.egain.com/ws/model/v12/gen/platform"
    xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/common"
    xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/interaction/notes">
    <ns3:note id="1003">
        <ns3:created date="2019-04-11T09:41:28.000Z">
            <ns2:user id="1013">
                <name>John Summers</name>
                <firstName>John</firstName>
                <lastName>Summers</lastName>
            </ns2:user>
        </ns3:created>
        <ns3:content>Case reopened as customer has experienced same issue again while doing transaction.</ns3:content>
        <ns3:link rel="self" href="/system/ws/v12/interaction/case/2025/note/1003"/>
    </ns3:note>
    <ns3:note id="1005">
        <ns3:created date="2019-04-11T09:45:28.000Z">
            <ns2:user id="1013">
                <name>John Summers</name>
                <firstName>John</firstName>
                <lastName>Summers</lastName>
            </ns2:user>
        </ns3:created>
        <ns3:content>Issue is resolved. So closing the case again.</ns3:content>
        <ns3:link rel="self" href="/system/ws/v12/interaction/case/2025/note/1005"/>
    </ns3:note>
</ns3:notes>

JSON

Request

Method	URL
GET	`/ws/v12/interaction/case/2025/note`

Request headers

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

Response
HTTP/1.1 200 OK

Response headers

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

Response body

{
  "note": [
     {
      "created": {
        "user": {
          "name": "John Summers",
          "firstName": "John",
          "lastName": "Summers",
          "id": 1013
        },
        "date": "2019-04-09T07:25:46.000Z"
      },
      "content": "Case reopened as customer has experienced same issue again while doing transaction.",
      "link": [
        {
          "rel": "self",
          "href": "/system/ws/v12/interaction/case/2025/note/1003"
        }
      ],
      "id": 1003
    },
    {
      "created": {
        "user": {
          "name": "John Summers",
          "firstName": "John",
          "lastName": "Summers",
          "id": 1013
        },
        "date": "2019-04-09T07:25:47.000Z"
      },
      "content": "Issue is resolved. So closing the case again.",
      "link": [
        {
          "rel": "self",
          "href": "/system/ws/v12/interaction/case/2025/note/1005"
        }
      ],
      "id": 1005
    }
  ]
}