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": "d05be211-e8c8-449b-9982-61ed9bbf6844",
  "AssignmentId": "e3d44ec4-570a-4562-b35d-c984ce4700b5",
  "Note": "sample string 2",
  "ActionId": 1,
  "DepartmentShiftId": 1,
  "CreatedDate": "2026-11-18T08:06:46.3475179-06: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": "c21e6ce7-c4e9-4959-b68b-ace53ee89db7",
      "NeedID": "f29a6426-8861-42b9-93d4-ce594bb1fea9",
      "AssignmentID": "da014fc6-8284-4356-8c99-9d9ec71f06e3",
      "CreateDate": "2026-11-18T08:06:46.3475179-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"
  ]
}