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": "2735f982-b245-443b-9b9c-e8eac2d10dee",
  "AssignmentId": "83367770-c2a5-4329-be58-7b3290407326",
  "Note": "sample string 2",
  "ActionId": 1,
  "DepartmentShiftId": 1,
  "CreatedDate": "2026-01-03T23:29:39.5262335-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": "86458424-24aa-4e5f-af12-6e1fa58ce665",
      "NeedID": "376a0e1d-e0fe-4355-b2b3-b7233c3d60be",
      "AssignmentID": "155c33da-cb8c-4bb0-90f4-dc4ea7210e9c",
      "CreateDate": "2026-01-03T23:29:39.5262335-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"
  ]
}