User Employment

class moco_wrapper.models.UserEmployment(moco)

Class for handling user employment schemes.

Every user has an employment entry, which defines how many hours every day he should be at work.

create(user_id: int, pattern: dict, from_date: datetime.date, to_date: datetime.date = None)

Creates an user employment

Parameters:

• user_id (int) – Id of the user to create the employment for
• pattern (dict) – Work hours during the morning and the afternoon on each workday
• from_date (datetime, str) – When employment comes into effect
• to_date (datetime, str) – When the employment stops being in effect default (None)

from moco_wrapper import Moco

user_id = 123
pattern = {
    "am": [4,4,4,4,4],
    "pm": [4,4,4,4,4]
}

m = Moco()
new_schedule = m.UserEmployment.create(
    user_id=user_id,
    pattern=pattern
)

delete(employment_id)

Deletes an user employment

Parameters:employment_id (int) – Employment to delete

static endpoints() → List[moco_wrapper.util.endpoint.endpoint.Endpoint]

Returns all endpoints associated with the model

Returns:List of Endpoint objects Return type:moco_wrapper.util.endpoint.Endpoint

get(employment_id: int)

Retrieve a single employment:

Parameters:employment_id (int) – Id of the employment Returns:Employment object Return type:moco_wrapper.util.response.ObjectResponse

getlist(from_date: datetime.date = None, to_date: datetime.date = None, user_id: int = None, sort_by: str = None, sort_order: str = 'asc', page: int = 1)

Retrieve a list of employments.

Parameters:

• from_date (datetime.date, str) – Start date (default None)
• to_date (datetime.date, str) – End date (default None)
• user_id (int) – User id (default None)
• sort_by (str) – Field to sort results by (default None)
• sort_order (str) – asc or desc (default "asc")
• page (int) – Page number (default 1)

Returns:

List of employment objects

Return type:

moco_wrapper.util.response.PagedListResponse