POST api/v1/needs/{needId}/request
Book an open need.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| needId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
ApiResponseModelOfScheduleAssignmentModel| Name | Description | Type | Additional 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": "dd0c382e-f841-4bba-9465-3cf0a346e3f8",
"NeedId": "ae686a4a-5e17-4836-8c8f-44c4f14531c4",
"RequestId": "71ba6ec2-6a2b-4329-b54e-9a8342e7dbe7",
"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-08-28T23:10:14.4515007-05:00",
"StartTime": "2026-08-28T23:10:14.4515007-05:00",
"EndTime": "2026-08-28T23:10:14.4671134-05:00",
"ActualStartTime": "2026-08-28T23:10:14.4671134-05:00",
"ActualEndTime": "2026-08-28T23:10:14.4671134-05: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"
]
}