Department Shift

Create a shift for a department. `startTime` and `endTime` are 24-hour HHmm times; an end time earlier than the start time is an overnight shift. Each `availableEquipment` entry must be equipment in the department and can be listed only once. The server fills `equipmentName` from the equipment, so a client value is ignored. Omitted optional fields take their defaults: no days, 0 simultaneous equipment, no maximum daily new jobs and no equipment.

Changed on
post/api/department-shifts

Request

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

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.

departmentIdstring required

Id of the department that works this shift. The department must exist and not be deleted. It cannot be changed after the shift is created. Please reference the /api/departments endpoint.

Response

Department shift created; the body holds its id

idstring required

The id of the created record

Changes