Job Seekers Shift updates

This page allows for updates to the shift to the system from a Job Seeker. Like Apply, Reconfirmation, Cancellation, Check-in, Check-out

Post Shift updates

POST https://www.ondemandstaffing.app/api/v1/shifts/shift_update_status

This endpoint allows you to post updates regarding a shift from the Job Seeker

Headers

Name	Type	Description
Authentication	string	User's auth token

Request Body

Name	Type	Description
break_start_time	string	Provids a local time when the break started. Must be a datetime format.
break_end_time	string	Provides a local time when the break ended. Must be in datetime format.
edit_break_index	number	Given one shift could have more than one breaks. The value of key: shift_breaks is an array of hashes. Each hash representing one break. In order to edit a break, we must specify their index position within the array. Without this index position we will update first break.
check_in_time	string	Must be datetime. Optional to send check_in time if different from the current time.
check_out_time	string	Must be datetime. Optional to send Check-out time for the shift and candidate. Could be used for update.
message	string	This could be one of the following messages: 'apply': When user wants to apply to a job. 'decline': When user is declining a job that s/he is not hired for. s/he could decline a job from available jobs. s/he would decline a job they have applied for, but no longer interested now. If a user is assigned to a job, s/he must 'cancel' the shift. We can send a value as: 'decline_reason' with reason for decline. 'confirm' When user wants to reconfirm about a specific upcoming shift. 'check-in': When user wants to check-in for a job. 'break-start': When the user wants to start a break. 'break-end': When the user wants to end a break. 'edit-breaks': When the user wants to edit an existing break or create a new break with specific time that is not current. Edit breaks must include: break_start_time and break_end_time parameters. 'check-out' : When user wants to check-out from a shift. 'cancel' When a user wants to cancel an upcoming shift. 'timesheet_custom_responses' if the user wants to submit the custom check-out question. You must include the keys: 'subject' & 'value' for this.
shifts	string	Comma separated Shift ids for which action needs to be taken. Cannot be an array. Just a comma separated string.
tenant	string	Unique Tenant Key
subject	string	Required for checkout custom data update.
value	string	Required for checkout custom data update.

200 If success for message 'apply', 'check-in', 'confirm','cancel':

{ status: 200  , data: { opertaion_status: 'Success'}, message: "Message confirming the action is taken."}

400

{ status: 400  , data: { opertaion_status: 'Error'}, message: "Message type is invalid"}

500 Exception happens

{ status: 500  , data: { opertaion_status: 'Error'}, message: "Exception occured"}