Note Integration Point

This integration point provides the ability to:

• Retrieve (GET) the notes of a claim, policy or authorization

• Retrieve (GET) the versions of an existing note

• Create (POST) a new note for a claim, policy or authorization

• Update (POST) an existing note, i.e. create a new version of an existing note

These different integration point operations are described in the sections below. The integration point will provide HTTP status codes as defined in Response Messages.

The operations are protected by the HTTP API access restriction 'notes API'. For the GET operations a grant must be provided with the Read flag set. For the POST operations a grant must be provided with the Create flag set. If the access to the claim, policy or authorization that the note belongs to is restricted by a data access group restriction, then to perform this operation on that note also a grant for that data access group restriction must be provided with the Read (for the GET operations) and Update (for the POST operations) flags set.

Retrieve Notes

To retrieve the notes of a claim, policy or authorization a GET request has to be sent to the following URI:

http://://generic/notes/{subjectId}

The subject id is the technical id of the claim, the gid of the policy or the code of the authorization. The response payload contains a list of all notes (last versions) of a claim, policy or authorization. The payload looks like this:

{
  "items": [
    {
      "id": "",
      "version": "",
      "createdBy": "",
      "creationDate": {
        "value": ""
      },
      "lastUpdatedBy": "",
      "lastUpdatedDate": {
        "value": ""
      },
      "noteText": "",
      "customerField1": "",
      "customerField2": ""
      "links": [
        {
          "href": ...,
          "rel": "self"
        },
        {
          "href": ...,
          "rel": "note:edit",
          "httpMethod": "POST"
        },
        {
          "href": ...,
          "rel": "note:audit",
          "httpMethod": "GET"
        }
      ]
    }
  ],
  "links": [
    {
      "href": ...,
      "rel": "self"
    }
  ]
}

Retrieve Note Versions

If a note has multiple versions, the 'audit' link provides the ability to retrieve all versions of that particular note. The response payload contains a list of all versions of the applicable note. The payload looks like this:

{
  "items": [
    {
      "id": "",
      "version": "",
      "lastVersion": "",
      "createdBy": "",
      "creationDate": {
        "value": ""
      },
      "noteText": "",
      "customerField1": "",
      "customerField2": ""
      "links": [
        {
          "href": ...,
          "rel": "self"
        }
      ]
    }
  ],
  "links": [
    {
      "href": ...,
      "rel": "self"
    }
  ]
}

Create Note

To create a new note for a claim, policy or authorization a POST request has to be sent to the following URI:

http://://notes/{subjectId}

The subject id is the technical id of the claim, the gid of the policy or the code of the authorization. In the request payload the note text must be provided. It is also possible to provide values for dynamic fields. The payload looks like this:

{
  "noteText": "",
  "customerField1": "",
  "customerField2": ""
}

Update Note

The 'edit' link on a note provides the ability to update a particular note. When an existing note is updated a new version of that note is created; existing records of notes are never updated. In the request payload the note text and dynamic field values for the new note version must be provided. The payload has the same structure as in the Create Note request specified above.