Detailed Description

Create activity note

Overview

This API allows the logged in user to create a note for an activity. Only one note can be created at a time.

Since: 12.0 ES1

APIs

Method	URL	Description
POST	`/ws/v12/interaction/activity/{ID}/note`	Create a note for the activity.

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 'Add' action on the 'Notes' resource.
The activity must belong to either the user's home department, or to the department in which the user is a foreign user.

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
Content-Type	Media type sent by the 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`

Request Body

The request body is mandatory. Request body can be in either XML or JSON format.

Elements required in the request body

Name	Description
content	Content of the note. Must be at least 1 character, and must not exceed 1500 characters. Refer list of Allowed Characters.

Request body XML schemas:

Note Schema

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`
Location	Location of the new created resource	N/A

Response body XML schemas:

Error - used in case of error

HTTP status codes

Success Status codes

201 - Created

The request was successfully executed.

Failure Status codes

400 - Bad Request

Any query parameter is sent in the request.
Elements provided do not adhere to the rules stated in the Request Body section.

401 - Unauthorized

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

403 - Forbidden

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

406 - Not Acceptable

Invalid 'Accept-Language' header value.

500 - Internal server error

Examples:

Example 1 - Create an activity note