Function: working_plan
Result: the list of elements
Department business hours
Access level: admin
- id — Id
- name — Name
Delete
Function: working_plan.delete
Delete
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of working_plan function.
Result: successful operation or error message
Business hours
Function: working_plan.edit
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- elid — unique identifier (id element of working_plan function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of working_plan function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Name. Enter a name that will be displayed in the drop-down lists
- day_active — . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
- day_0_allday — . (Optional parameter. To enable the option click "on".)
- day_0_begin — .
- day_0_end — .
- day_active — . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
- day_1_allday — . (Optional parameter. To enable the option click "on".)
- day_1_begin — .
- day_1_end — .
- day_active — . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
- day_2_allday — . (Optional parameter. To enable the option click "on".)
- day_2_begin — .
- day_2_end — .
- day_active — . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
- day_3_allday — . (Optional parameter. To enable the option click "on".)
- day_3_begin — .
- day_3_end — .
- day_active — . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
- day_4_allday — . (Optional parameter. To enable the option click "on".)
- day_4_begin — .
- day_4_end — .
- day_active — . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
- day_5_allday — . (Optional parameter. To enable the option click "on".)
- day_5_begin — .
- day_5_end — .
- day_active — . (Optional parameter. To enable the option click "on".) Select the check box to make this day a working day
- day_6_allday — . (Optional parameter. To enable the option click "on".)
- day_6_begin — .
- day_6_end — .
Name
Function: working_plan.day
Result: the list of elements
Days off and changes to business hours
Access level: admin
- id — Id
- affected_date — Date
- description — Description
Edit properties of the selected exception
Function: working_plan.day.edit
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- plid — parent list unique identifier (id element of working_plan function).
- elid — unique identifier (id element of working_plan.day function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of working_plan function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of working_plan function).
- elid — unique identifier (id element of working_plan.day function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- type — Type. Select an exception type
- day_begin — Openning time. Enter the opening time
- day_end — Closing time. Enter the closing time
- note — Comment . Enter additional information related to the exception
Copy exceptions
Function: working_plan.day.copy
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- plid — parent list unique identifier (id element of working_plan function).
- elid — unique identifier (id element of working_plan.day function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of working_plan function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of working_plan function).
- elid — unique identifier (id element of working_plan.day function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- plan — Copy from. Select the department's business hours from which you want to copy the exceptions
- first_day — Start date. Exceptions will be copied from the selected date
- last_day — End date. Select the end date of the range to copy the exceptions
Add
Function: working_plan.day.create
Access level: admin
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
- Parameters:
- plid — parent list unique identifier (id element of working_plan function).
- elid — unique identifier (id element of working_plan.day function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of working_plan function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of working_plan function).
- elid — unique identifier (id element of working_plan.day function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- affected_date — Date. Select date(s) for this exception. You can use the "-" character for providing a range of dates, e.g. '2001-01-01 — 2001-01-31'. Start a new line for each date
- type — Type. Select an exception type
- day_begin — Openning time. Enter the opening time
- day_end — Closing time. Enter the closing time
- note — Comment . Enter additional information related to the exception
Delete
Function: working_plan.day.delete
Delete
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of working_plan.day function.
Result: successful operation or error message