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": "a6ef29e8-d59b-48dd-81ce-d4f3b3da71da",
  "AssignmentId": "faffcffe-9acd-4d5d-bb18-5b70586e92e4",
  "Note": "sample string 2",
  "ActionId": 1,
  "DepartmentShiftId": 1,
  "CreatedDate": "2026-07-13T20:16:00.2166323-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": "939310b2-6ca3-4193-8982-7e5773cba444",
      "NeedID": "ae0b0846-5cc9-4c25-a78f-89335d2a0e4f",
      "AssignmentID": "64210dc5-07de-47e7-84f0-39cc8ec2a719",
      "CreateDate": "2026-07-13T20:16:00.2322121-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"
  ]
}