Detailed Description

Get customer note by ID

Overview

This API allows the user to get a specific note of a customer.

Since: 12.0 ES1

APIs

Method	URL	Description
GET	`/ws/v12/interaction/customer/{ID1}/note/{ID2}`	Retrieve a specific note of a customer. ID1: Customer ID ID2: Note ID

Authentication

Authentication is required. The client must be logged in to call this API. Each API request must contain X-egain-session request header returned by Login API.

Permissions

All of the following are required:

User must have 'View' action on the 'Notes' resource.
The user must be able to view the customer provided in the URI. Refer Get Customers by IDs API for more information.

Licenses

The logged in user must have the following licenses:

Any User Licenses

Request

Request headers

Name	Description	Allowed values	Default value
X-egain-session	Session ID obtained from Login API response header	N/A	N/A
Accept	Content type accepted by client	`application/xml` or `application/json`	N/A
Accept-Language	Language locale accepted by client (used for locale specific fields in resource representation and in error responses)	Supported 'Accept-Language' header codes	`default system language`

Supported API specific query parameters

None

Supported common query parameters

None

Response

Response headers

Name	Description	Possible values
X-egain-session	Session ID of the current user session	N/A
Content-Type	Media type of response body	`application/xml` or `application/json`

Response body xml schemas

v12-schema-interaction-notes - used in case of success
schema-kb-WSError - used in case of error

Summary attributes always returned in server response

Summary attributes of Note Resource

Additional attributes returned in server response if explicitly requested by client

None

HTTP status codes

Success Status codes

200 - OK

Note of the customer is returned.

Failure Status codes

400 - Bad Request

Any query parameter is sent in the request.
The ID of the note does not belong to the provided customer.

401 - Unauthorized

X-egain-session request header is missing.
Session is invalid.

403 - Forbidden

The user does not have the appropriate permissions. Refer the Permissions section for details.

404 - Not Found

Customer ID provided in the URI does not exist.
Note ID provided in the URI does not exist.

406 - Not Acceptable

Invalid 'Accept-Language' header value.

500 - Internal server error

Examples:

Example 1 - Get details of a customer note