POST api/v1/NeedNotes
Creates a new Need Note
Request Information
URI Parameters
None.
Body Parameters
NeedNoteCreateModel| Name | Description | Type | Additional information |
|---|---|---|---|
| NeedId | globally unique identifier |
Required |
|
| AssignmentId | globally unique identifier |
None. |
|
| Note | string |
String length: inclusive between 0 and 1000 |
|
| ActionId | integer |
None. |
|
| DepartmentShiftId | integer |
None. |
|
| CreatedDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"NeedId": "18f539f1-a8e5-4b6f-903e-91636e29704a",
"AssignmentId": "e5a3176e-c4a2-4264-beae-5a3d33c16466",
"Note": "sample string 2",
"ActionId": 1,
"DepartmentShiftId": 1,
"CreatedDate": "2026-10-27T13:37:10.3195756-05:00"
}
Response Information
Resource Description
ApiResponseModelOfNeedNoteModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfNeedNoteModel |
None. |
|
| Errors | Collection of string |
None. |
|
| Warnings | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"PageSize": 1,
"Page": 2,
"TotalPages": 3,
"TotalResults": 4,
"Results": {
"NeedNoteID": "8dcabdd8-047a-445b-8305-438527ca7168",
"NeedID": "a9d7a1e0-45b0-4049-91b6-4b67faa07fb1",
"AssignmentID": "785b9b08-8c17-429c-8fb8-f6ccf54e3ac3",
"CreateDate": "2026-10-27T13:37:10.3195756-05:00",
"CreateUser": "sample string 4",
"CreateApp": "sample string 5",
"Note": "sample string 6",
"Version": "QEA=",
"ActionID": 1,
"Action": "sample string 7",
"DepartmentShiftID": 1,
"ShiftCode": "sample string 8"
}
},
"Errors": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
]
}