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": "e33ec305-a24c-47f6-8267-a2b777f0e7e7",
  "AssignmentId": "57a202d8-b9d9-41ed-b671-768b7278e1c8",
  "Note": "sample string 2",
  "ActionId": 1,
  "DepartmentShiftId": 1,
  "CreatedDate": "2026-07-28T23:51:33.8253075-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": "9be3e0bf-f04f-43b1-87da-dc8293c2139a",
      "NeedID": "859d65fc-aaa6-424c-ab80-acd6067e71c1",
      "AssignmentID": "49dd5a88-fb27-4bb0-824a-de64a3b2a09b",
      "CreateDate": "2026-07-28T23:51:33.8253075-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"
  ]
}