Availability Management
View availability & calendar of Job seeker: Including scheduled shifts, auto availability and days blocked off.
Get complete calendar view of existing availability for a job seeker.
Get a detailed calendar View
GET https://api.wolf.xyz/api/v1/shifts/my_calendar_schedule
Query Parameters
tenant*
String
Tenant key
start_date
String
Start date from when the records are requested for. Must be in ISO 8601 format. YYYY-MM-DD. If no date is provided, today's date would be taken as default.
Headers
Authentication*
String
Authentication token for the job seeker requesting.
{
'operation_status': 'Success',
'response_data': {
'2022-01-01': {
'shifts': [{Array of Shifts}],
'availability': [{Array of Auto availability}],
'blocked': [{Array of dates blocked with reasons.}]
},
'2022-01-02': {
'shifts': [{Array of Shifts}],
'availability': [{Array of Auto availability}],
'blocked': [{Array of dates blocked with reasons.}]
},
'2022-01-03': {
'shifts': [{Array of Shifts}],
'availability': [{Array of Auto availability}],
'blocked': [{Array of dates blocked with reasons.}]
},
'2022-01-04': {
'shifts': [{Array of Shifts}],
'availability': [{Array of Auto availability}],
'blocked': [{Array of dates blocked with reasons.}]
}
}
}Add availability for a given date.
Add new availability for a given date.
POST https://api.wolf.xyz/api/v1/shifts/toggle_availability
Provide a date for which a candidate is available to work.
Query Parameters
tenant*
String
Tenant key for the job seeker
task*
String
Value must be: "is_available"
date*
String
Date in ISO 8601 format. YYYY-MM-DD
Headers
Authentication*
String
Authentication token for the job seeker.
{ status: 200 , data: { operation_status: 'Success'}, message: "We have updated your availability"}Remove an existing availability for a given date.
Remove an existing availability for a job seeker.
POST https://api.wolf.xyz/api/v1/shifts/toggle_availability
If a user already has marked her/himself as available for a given date, we can remove it using this api.
Query Parameters
tenant*
String
Tenant Key for the platform
task*
String
value must be: "remove_is_available"
date*
String
Date is in ISO 8601 format YYYY-MM-DD
Headers
Authentication*
String
Authentication token for the job seeker
{ status: 200 , data: { operation_status: 'Success'}, message: "We have updated your availability"}Add availability block for a given date.
Block off a date when a candidate is not available to work.
POST https://api.wolf.xyz/api/v1/shifts/toggle_availability
When a date is blocked off, we would not consider the candidate for a given date.
Query Parameters
tenant*
String
Tenant key for the job seeker
task*
String
Value must be: "is_not_available"
date*
String
Date in ISO 8601 format YYYY-MM-DD format
block_start
String
Time in 24 hours format. If no value is provided 00:00 is taken as default
block_end
String
Time in 24 hours format. If no value is provided 23:59:59 is taken as default.
source_message*
String
Reason for blocking. Visibile to everyone.
Headers
authentication*
String
Authentication token for the job seeker
Remove an existing availability block.
Remove a block already placed by the candidate.
POST
If a candidate has manually added a block on the calendar. use this api to remove it.
Query Parameters
tenant*
String
Tenant key for the job seeker
task*
String
value must be: "remove_is_not_available"
block_id*
String
ID of the block already placed by the candidate.
Headers
authentication*
String
Authentication token for the job seeker
Last updated
Was this helpful?