ProRoster - Add assigned demand notes
API Url
Used for inserting one or more notes on an assigned demand.
POST
http://localhost:16010/ProMarkREST/rest/ProRoster/assigned-demands/{id}/notes
Permissions: user
Path parameters
| Field | Type | Description |
|---|---|---|
| Number | id The id of the assigned demand. |
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
| notes | Object[] | Collection of notes. |
| isEmpNote | Boolean | TRUE if the note is to be sent to the employee. |
| text | String | The message itself. |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| notes | Object[] | Collection of notes. |
| id | Number | Unique ID of the note . |
| isEmpNote | Boolean | TRUE if the note is to be sent to the employee. |
| isPublished | Boolean | TRUE if note is published. |
| text | String | The message itself. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
HTTP/1.1 200 OK{"response": {"data": {"notes": [{"id": 123456789,"text": "Please remember to log time","isEmpNote": true,"isPublished": false}]}}}
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data (empty). |
| errorCode | Number | Error code. |
| errorMessage | String | Error description. |