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": "0ee8051d-b997-44eb-a75b-020afbbee733",
"AssignmentId": "a4b43591-e283-490d-98ba-aa7f5a4ad67a",
"Note": "sample string 2",
"ActionId": 1,
"DepartmentShiftId": 1,
"CreatedDate": "2026-01-03T23:10:24.2034783-06: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": "624059af-a617-4022-81e6-19d1cb1af99b",
"NeedID": "6abe9085-99af-4e82-b7d2-d6961ec33040",
"AssignmentID": "298abf0c-88b2-4a1d-8901-3fa3b3936d1b",
"CreateDate": "2026-01-03T23:10:24.2034783-06: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"
]
}