shift_controller

Methods

# (async, static) createShift(req, res) → {Object}

This function creates a shift.

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Created shift
Type
Object

# (async, static) deleteShiftMaterial(req, res) → {Object}

This function deletes a single material from a shift via S3.

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Updated shift without the deleted material
Type
Object

# (async, static) deleteShiftsBySite(req, res) → {String}

This function deletes all shifts from a site

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Message confirming deletion
Type
String

# (async, static) getPostedShiftsBySite(req, res) → {Array.<Object>}

This function returns posted shifts by site.

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Posted shifts belonging to the user's site
Type
Array.<Object>

# (async, static) getShiftById(req, res) → {Object}

This function returns shift by shift Id.

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Shift corresponding to the id
Type
Object

# (async, static) getShiftMaterials(req, res) → {Array.<Object>}

This function retrieves materials from a shift via S3.

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Materials from the shift
Type
Array.<Object>

# (async, static) getShiftsBySite(req, res) → {Array.<Object>}

This function returns shifts by site.

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Shifts belonging to the user's site
Type
Array.<Object>

# (async, static) getShiftsByUser(req, res) → {Array.<Object>}

This function returns shifts belonging to the user.

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Shifts belonging to the user
Type
Array.<Object>

# (async, static) postShift(req, res) → {Object}

This function posts a shift

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Shift posted
Type
Object

# (async, static) returnShift(req, res) → {Object}

This function returns a shift

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Shift returned
Type
Object

# (async, static) takeShift(req, res) → {Object}

This function takes a shift

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Shift taken
Type
Object

# (async, static) unpostShift(req, res) → {Object}

This function unposts a shift

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Shift unposted
Type
Object

# (async, static) updateShiftById(req, res) → {Object}

This function updates shifts by shift id.

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Updated shift
Type
Object

# (async, static) updateShiftMaterials(req, res) → {Object}

This function updates shift materials, to be used after s3 upload middleware.

Parameters:
Name Type Description
req Object

Express request object

res Object

Express response object

Returns:
  • Updated shift with the uploaded materials
Type
Object