1. Create User Notes (api2/notes/user)
This method allows creating new User Notes.
URL
| Server |
URL |
HTTP Type |
| UAT |
https://api-ca-uat.iinsightonline.com/api2/notes/user |
POST |
| PRODUCTION |
https://api-ca.iinsightonline.com/api2/notes/user |
POST |
Authorization
| Parameter |
Value |
Mandatory |
| Type |
Bearer Token |
Yes |
| Token |
The token is generated using the /auth/login method |
Yes |
Request Parameters
| Parameter |
Value |
Mandatory |
| case_ids |
Case IDs (comma-separated, e.g., 1,2,3) |
Yes |
| employee_id |
Employee ID (numeric, e.g., 1) |
Yes |
| role_id |
Employee's Role ID (numeric, optional) |
No |
| title |
Note title (string) |
Yes |
| date_created |
Date (format: dd-mm-yyyy, optional) |
No |
| time_created |
Time (format: hh:mm am/pm, optional) |
No |
| is_privileged |
Privileged Note (Yes/No, optional) |
No |
| description |
Note description (max length: 4M chars, optional) |
No |
| signature |
Employee signature (Base64 image, optional) |
No |
| template |
Template title (string, optional) |
No |
| billing_ids |
Billing IDs (comma-separated, optional) |
No |
Response
{
"status": "success",
"message": "User notes created successfully",
"data": [
{
"note_id": 119246,
"case_id": "2",
"billing_id": "1"
},
{
"note_id": 119248,
"case_id": "3",
"billing_id": "4"
}
]
}
2. Create Admin Notes (api2/notes/admin)
This method allows the creation of new Admin Notes.
URL
| Server |
URL |
HTTP type |
| UAT |
https://api-ca-uat.iinsightonline.com/api2/notes/admin |
POST |
| PRODUCTION |
https://api-ca.iinsightonline.com/api2/notes/admin |
POST |
Authorization
| Parameter |
Value |
Mandatory |
| Type |
Bearer Token |
Yes |
| Token |
The token is generated using the /auth/login method |
Yes |
Query Params
| Parameter |
Description |
Mandatory |
| case_ids |
Case IDs (e.g., 1,2,3) |
Yes |
| title |
Note title (e.g., "Note 1") |
Yes |
| date_created |
Date created (format: dd-mm-yyyy) |
No |
| time_created |
Time created (format: hh:mm AM/PM) |
No |
| is_privileged |
Privileged note (options: Yes/No) |
No |
| description |
Note description (max length: 4 million chars) |
No |
Response
{
"status": "success",
"message": "Admin notes created successfully",
"data": [
{
"note_id": 117078,
"case_id": "20"
},
{
"note_id": 117080,
"case_id": "21"
},
{
"note_id": 117082,
"case_id": "22"
},
{
"note_id": 117084,
"case_id": "23"
}
]
}
3. Delete Notes (api2/notes/delete_note)
This method will allow to delete a User/Admin note.
URL
| Server |
URL |
HTTP type |
| UAT |
https://api-ca-uat.iinsightonline.com/api2/notes/delete_note |
DELETE |
| PRODUCTION |
https://api-ca.iinsightonline.com/api2/notes/delete_note |
DELETE |
Authorization
| Parameter |
Value |
Mandatory |
| Type |
Bearer Token |
Yes |
| Token |
The token is generated using the /auth/login method |
Yes |
Query Params (As it's DELETE method this need to go on the x-www-form-urlencoded)
| Parameter |
Value |
Mandatory |
| id |
Note ID (i.e.: 1) |
Yes |
Response
{
"response": "Note deleted successfuly",
}