POST api/v1/NeedNotes

Creates a new Need Note

Request Information

URI Parameters

None.

Body Parameters

NeedNoteCreateModel
NameDescriptionTypeAdditional 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": "bf9d4a5e-b06e-4369-8da9-c10a88b48e9e",
  "AssignmentId": "4537f05e-6b50-4545-a29b-2704f6bb1fbd",
  "Note": "sample string 2",
  "ActionId": 1,
  "DepartmentShiftId": 1,
  "CreatedDate": "2026-10-27T12:51:40.6220338-05:00"
}

Response Information

Resource Description

ApiResponseModelOfNeedNoteModel
NameDescriptionTypeAdditional 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": "6a98866f-4835-4a75-8f76-4157fcd5d263",
      "NeedID": "86092836-9758-4540-99fe-acae0481c0fb",
      "AssignmentID": "770a4303-61cf-4549-aed2-8f0d96ae0d1e",
      "CreateDate": "2026-10-27T12:51:40.6376498-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"
  ]
}