Employee Notes
List all employee Notes
Use this action to retrieve list of active notes of an Employee. All types of notes are listed through this end point.
| |
|---|
| Method | GET: List Employee Notes |
| Parameters | Account ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
|
| Response | | | |
|---|
| Field Name | Details | Example | | Id | Unique ID of the Note | N000289 | | Type | Type of note | Comment, Email etc., | | Created | Date & Time when the note was added | 2019-07-16T19:35:55.45+01:00 | | User | Active username in the account with appropriate access to create note for the employee | User name |
|
Retrieve an employee Note details
Use this action to retrieve more details about an employee note. Various types of employee note details can be retrieved using this end point like comment, email, Record Note, ESS task etc.
| |
|---|
| Method | GET: Retrieve Employee Note Details |
| Parameters | Account ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Note ID - Unique identifier of an Employee Note
|
| Response | | | |
|---|
| Field Name | Details | Example | | Employee | Name of the Employee | Suman Prabhat | | Note Id | Unique ID of the Note | N000271 | | Created | Date & Time when the note was added | 2019-07-16T19:35:55.45+01:00 | | Contact Type | Type of note | Comment, Email etc., | | Duration | Duration in Seconds | 142 | | Start Time | Start time of the note creation | 2019-07-16T19:35:55.45+01:00 | | End Time | End time of the note creation | 2019-07-16T19:45:55.45+01:00 | | Category | | | | Topic | Topic for creating the note | | | Sensitive | Is this sensitive note? | Yes/No | | Regarding | Reason why the note is created | Reason... | | Comment | Link this note to another record | |
|
