POST api/v1/needs/{needId}/request

Book an open need.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
needId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ApiResponseModelOfScheduleAssignmentModel
NameDescriptionTypeAdditional information
Data

ApiResponseDataModelOfScheduleAssignmentModel

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": {
      "Id": "sample string 1",
      "TypeId": 2,
      "Status": "sample string 3",
      "AssignmentId": "d3012c8e-84d0-46cf-a647-d7d558d02ec5",
      "NeedId": "a8b15eb3-8269-4574-8048-8b43788c6527",
      "RequestId": "416b317e-eb6d-476d-841e-3e31dad5b6e1",
      "RequestShiftId": 1,
      "FacilityId": 4,
      "FacilityName": "sample string 5",
      "FacilityCoId": "sample string 6",
      "DepartmentId": 7,
      "DepartmentName": "sample string 8",
      "DepartmentCode": "sample string 9",
      "DepartmentShiftId": 1,
      "ShiftCode": "sample string 10",
      "ShiftDescription": "sample string 11",
      "SkillId": 12,
      "Skill": "sample string 13",
      "ProductiveTypeId": 14,
      "ProductiveType": "sample string 15",
      "Date": "2026-01-02T16:22:51.6575559-06:00",
      "StartTime": "2026-01-02T16:22:51.6575559-06:00",
      "EndTime": "2026-01-02T16:22:51.6575559-06:00",
      "ActualStartTime": "2026-01-02T16:22:51.6575559-06:00",
      "ActualEndTime": "2026-01-02T16:22:51.6575559-06:00",
      "Hours": 1,
      "Minutes": 1,
      "StaffId": 19,
      "UserName": "sample string 20",
      "StaffFirstName": "sample string 21",
      "StaffLastName": "sample string 22",
      "Comment": "sample string 23"
    }
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ]
}