FUfulcrumpro
Department Shift

Update a department shift by id. This is a full replacement: every field is saved from the request, and an omitted field is cleared to its default, so omitting `days`, `simultaneousEquipment` or `availableEquipment` clears them. The shift's department cannot change; a `departmentId` in the body is ignored. Each `availableEquipment` entry must be equipment in the shift's department and can be listed only once, and the server fills `equipmentName` from the equipment. The latest schedule is marked out of date.

Changed on
put/api/department-shifts/{id}

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/department-shifts/{id}
  • Auth
    none declared

Path parameters

idstring required

Request body

namestring required

Name of the shift.

startTimestring required

Time the shift starts, as a four-digit 24-hour clock value in HHmm format, "0000" to "2359": "0000" is midnight, "0800" is 8:00 AM and "1730" is 5:30 PM.

endTimestring required

Time the shift ends, in the same HHmm format as startTime. An end time earlier than the start time means the shift runs overnight and ends on the next day. An end time equal to the start time is allowed.

unlimitedCapacityboolean nullable

When true, the shift has no limit on how many pieces of equipment can run at the same time, and simultaneousEquipment is not applied on any day. Omitted or null is saved as false.

maxDailyNewJobsinteger nullable

Maximum number of new jobs to schedule per shift, 0 or more. Omitted or null means no maximum.

Response

The updated department shift

idstring

Unique id of the shift.

departmentIdstring nullable

Id of the department that works this shift.

namestring nullable

Name of the shift.

startTimestring nullable

Time the shift starts, as a four-digit 24-hour clock value in HHmm format: "0000" is midnight, "0800" is 8:00 AM and "1730" is 5:30 PM. Returned exactly as stored.

endTimestring nullable

Time the shift ends, in the same HHmm format as startTime. An end time earlier than the start time means the shift runs overnight and ends on the next day. Returned exactly as stored.

lengthOfShiftInMinutesinteger nullable

Length of the shift in minutes, from startTime to endTime. An overnight shift wraps past midnight, so "2200" to "0600" is 480. Equal start and end times give 0. Null when either time is not a valid HHmm value (four digits, hours 00 to 23, minutes 00 to 59).

unlimitedCapacityboolean

When true, the shift has no limit on how many pieces of equipment can run at the same time, and simultaneousEquipment is not applied on any day.

maxDailyNewJobsinteger nullable

Maximum number of new jobs to schedule per shift. Null when no maximum is set.

deletedboolean

Indicates whether this shift has been deleted.

Changes