kepler.api.time_slot module¶

The module contains the functionality for REST API calls for time slots.

class kepler.api.time_slot.AddTimeSlotParams¶

Bases: kepler.api.api_util.ApiParamsBase

The parameter class for REST API call add_time_slot.

end_time = Specifies the end time of the time slot.¶

max_reservations = Specifies the maximum number of reservations that can be made...¶

start_time = Specifies the start time of the time slot.¶

time_slot_supervisor_id_list = The list of ID(s) of the supervisor(s...¶

unit_type_id = Specifies the ID of the unit type of the created time slot.¶

class kepler.api.time_slot.DeleteTimeSlotParams¶

Bases: kepler.api.api_util.ApiParamsBase

The parameter class for the REST API call delete_time_slot.

time_slot_id = The ID of the time slot to be deleted.¶

class kepler.api.time_slot.GetTimeSlotEventsParams¶

Bases: kepler.api.api_util.ApiParamsBase

The parameter class for REST API call get_time_slot_events.

end_time = The time span filter end point¶

start_time = The time span filter start point¶

unit_id = Filters the returned time slots by the unit ID.¶

unit_type_id = Filters the returned time slots by the unit type.¶

class kepler.api.time_slot.GetTimeSlotsParams¶

Bases: kepler.api.api_util.ApiParamsBase

The parameters class for REST API call get_time_slots.

current_user = True, if only current user's supervision shifts are to be returned.¶

end_time = The time span filter end point. Default is a month forwards from now.¶

only_active = True, if only active reservations are to be returned (i.e.¶

start_time = The time span filter start point. Default is a week backwards from now.¶

supervisor_id = Filters the returned time slots by the user ID of the user who is a...¶

time_slot_id = If specified, the call returns only the time slot with the specified ID.¶

kepler.api.time_slot.add_time_slot(request)¶

The function implements the REST API call add_time_slot.

kepler.api.time_slot.delete_time_slot(request)¶

The function implements the REST API call delete_time_slot.

kepler.api.time_slot.get_supervisor_time_slot_events(request, user_id, start, end)¶

The function returns the list of time slots as calendar events that the specified user is supervising. Only time slots that belong to the specified time interval are returned.

kepler.api.time_slot.get_supervisor_time_slots(user_id, start, end)¶

The function returns the list of time slots that the specified user is supervising. Only time slots that belong to the specified time interval are returned.

kepler.api.time_slot.get_time_slot_edit_info(request)¶

The function implements the REST API call get_time_slot_edit_info.

kepler.api.time_slot.get_time_slot_events(request)¶

The function implements the REST API call get_time_slot_events.

kepler.api.time_slot.get_time_slots(request)¶

The function implements the REST API call get_time_slots.

kepler.api.time_slot.get_user_primary_email(user)¶

The utility function returns the primary email of the specified user.