{"docs":{"name":"Phoenix","info":"\n<p>Phoenix JSON API Specification</p>\n","copyright":null,"doc_url":"/doc/1.0","api_url":"/api","resources":{"application":{"doc_url":"/doc/1.0/application","id":"application","api_url":"/api","name":"Application","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/application/version","name":"version","apis":[{"api_url":"/api/version","http_method":"GET","short_description":"Get the server version","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>None</p>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/application/healthcheck","name":"healthcheck","apis":[{"api_url":"/api/healthcheck","http_method":"GET","short_description":"AWS Healthcheck","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>None</p>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"businesses":{"doc_url":"/doc/1.0/businesses","id":"businesses","api_url":"/api","name":"Businesses","short_description":"Businesses you are employed at","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/businesses/time_clock_app_business_image","name":"time_clock_app_business_image","apis":[{"api_url":"/api/businesses/:id/time_clock_app_business_images/:image_id","http_method":"GET","short_description":"Get the specified time clock app business image","deprecated":null}],"formats":["json"],"full_description":"\n<p>Returns time clock app business image Used by time clock app and platform admin</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image_id","full_name":"image_id","description":"\n<p>ID of the image to fetch</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"x_lifelenz_device","full_name":"x_lifelenz_device","description":"\n<p>Device type of the user</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"documents":{"doc_url":"/doc/1.0/documents","id":"documents","api_url":"/api","name":"Documents","short_description":"Generic Document","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/documents/content","name":"content","apis":[{"api_url":"/api/businesses/:business_id/documents/:id/content","http_method":"GET","short_description":"Show a specific document","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee rights or be employee manager</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Document ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"employee_documents":{"doc_url":"/doc/1.0/employee_documents","id":"employee_documents","api_url":"/api","name":"Employee_documents","short_description":"Employee Document","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/employee_documents/content","name":"content","apis":[{"api_url":"/api/businesses/:business_id/employee_documents/:id/content","http_method":"GET","short_description":"Show a specific employee document","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be given the document</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Employee Document ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"employments":{"doc_url":"/doc/1.0/employments","id":"employments","api_url":"/api","name":"Employments","short_description":"Employment profile information","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/employments/image","name":"image","apis":[{"api_url":"/api/businesses/:business_id/employments/:employment_id/image","http_method":"GET","short_description":"Get specific employment avatar image","deprecated":null}],"formats":null,"full_description":"\n<p>Returns employment avatar image.</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>An employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"x_lifelenz_device","full_name":"x_lifelenz_device","description":"\n<p>Device type of the user</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/employments/update_image","name":"update_image","apis":[{"api_url":"/api/businesses/:business_id/employments/:employment_id/image","http_method":"PUT","short_description":"Update employment image","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be logged in and user attached to the employment record</p>\n","errors":[],"params":[{"name":"image","full_name":"image","description":"\n<p>Image to be used as the user avatar</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid data URI","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>An employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/employments/delete_image","name":"delete_image","apis":[{"api_url":"/api/businesses/:business_id/employments/:employment_id/image","http_method":"DELETE","short_description":"Delete employment image","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be logged in and user attached to the employment record</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>An employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"services":{"doc_url":"/doc/1.0/services","id":"services","api_url":"/api","name":"Services","short_description":"Status of various services","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/services/services","name":"services","apis":[{"api_url":"/api/services","http_method":"GET","short_description":"Get connectivity and version statuses of various services API talks to","deprecated":null},{"api_url":"/api/services","http_method":"POST","short_description":"Get connectivity and version statuses of various services API talks to","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>None</p>\n","errors":[],"params":[{"name":"email","full_name":"email","description":"\n<p>Email address of the user</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n<p>Password of the user</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auth_token","full_name":"auth_token","description":"\n<p>User auth token</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sign_out","full_name":"sign_out","description":"\n<p>If true, signs out from the app</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-async_jobs":{"doc_url":"/doc/1.0/admin-async_jobs","id":"admin-async_jobs","api_url":"/api","name":"Admin::Async_jobs","short_description":"AsyncJobs","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-async_jobs/show","name":"show","apis":[{"api_url":"/api/admin/businesses/:business_id/async_jobs/:id","http_method":"GET","short_description":"Get a specific async job","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be a schedule-manager in the schedule of the job</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Async Job ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-async_jobs/process_result","name":"process_result","apis":[{"api_url":"/api/admin/businesses/:business_id/async_jobs/:id/process_result","http_method":"POST","short_description":"Process the result of an async job","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be the owner of the job</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Async Job ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"success","full_name":"success","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shifts","full_name":"shifts","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"messages","full_name":"messages","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"error","full_name":"error","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-blackout_days":{"doc_url":"/doc/1.0/admin-blackout_days","id":"admin-blackout_days","api_url":"/api","name":"Admin::Blackout_days","short_description":"Blackout days of a schedule","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-blackout_days/index_by_schedule","name":"index_by_schedule","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/blackout_days","http_method":"GET","short_description":"Get blackout days for the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-blackout_days/create","name":"create","apis":[{"api_url":"/api/admin/businesses/:business_id/blackout_days","http_method":"POST","short_description":"Create a blackout day period for the schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule Id of the blackout day</p>\n","required":{"attributes":["schedule_id"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"must be a UUID<br>can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"\n<p>Title of the blackout day</p>\n","required":{"attributes":["title"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>blackout period start date</p>\n","required":{"attributes":["start_date","end_date"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>blackout period end date (exclusive)</p>\n","required":{"attributes":["start_date","end_date"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-blackout_days/show","name":"show","apis":[{"api_url":"/api/admin/businesses/:business_id/blackout_days/:id","http_method":"GET","short_description":"Show a blackout day period","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Blackout Day ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-blackout_days/update","name":"update","apis":[{"api_url":"/api/admin/businesses/:business_id/blackout_days/:id","http_method":"PATCH","short_description":"Update a blackout day","deprecated":null},{"api_url":"/api/admin/businesses/:business_id/blackout_days/:id","http_method":"PUT","short_description":"Update a blackout day","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Blackout Day ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule Id of the blackout day</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"must be a UUID<br>can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"title","full_name":"title","description":"\n<p>Title of the blackout day</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>blackout period start date</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>blackout period end date (exclusive)</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-blackout_days/destroy","name":"destroy","apis":[{"api_url":"/api/admin/businesses/:business_id/blackout_days/:id","http_method":"DELETE","short_description":"Delete a blackout day period","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Blackout Day ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-business_office_locations":{"doc_url":"/doc/1.0/admin-business_office_locations","id":"admin-business_office_locations","api_url":"/api","name":"Admin::Business_office_locations","short_description":"Office or store locations where employees work","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-business_office_locations/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/business_office_locations","http_method":"GET","short_description":"Get all business office locations for the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID if get primary business location for given schedule</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-business_office_locations/timezones","name":"timezones","apis":[{"api_url":"/api/admin/business_office_locations/timezones","http_method":"GET","short_description":"Get a list of available timezones","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-business_roles":{"doc_url":"/doc/1.0/admin-business_roles","id":"admin-business_roles","api_url":"/api","name":"Admin::Business_roles","short_description":"Roles that employees perform for the business (eg. Barista, Cleaner, etc.)","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-business_roles/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/business_roles","http_method":"GET","short_description":"Get all business roles for the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-businesses":{"doc_url":"/doc/1.0/admin-businesses","id":"admin-businesses","api_url":"/api","name":"Admin::Businesses","short_description":"Businesses that employ users","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-businesses/index","name":"index","apis":[{"api_url":"/api/admin/businesses","http_method":"GET","short_description":"Get all businesses the current user is employed at","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be logged in</p>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/show","name":"show","apis":[{"api_url":"/api/admin/businesses/:id","http_method":"GET","short_description":"Get a specific business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_locations","name":"import_locations","apis":[{"api_url":"/api/admin/businesses/:id/import_locations","http_method":"POST","short_description":"Import business office locations to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>business_location_code (required)</p>\n</li><li>\n<p>office_name (required)</p>\n</li><li>\n<p>street_number</p>\n</li><li>\n<p>street</p>\n</li><li>\n<p>locality</p>\n</li><li>\n<p>region</p>\n</li><li>\n<p>postcode</p>\n</li><li>\n<p>country</p>\n</li><li>\n<p>latitude</p>\n</li><li>\n<p>longitude</p>\n</li><li>\n<p>time_zone</p>\n</li><li>\n<p>remove (boolean - when true, record is deleted instead of created/updated)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a location to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of location details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_roles","name":"import_roles","apis":[{"api_url":"/api/admin/businesses/:id/import_roles","http_method":"POST","short_description":"Import business roles to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>business_role_code (required)</p>\n</li><li>\n<p>business_role_name (required)</p>\n</li><li>\n<p>description</p>\n</li><li>\n<p>role_rate</p>\n</li><li>\n<p>manager</p>\n</li><li>\n<p>symbol (1 to 2 characters)</p>\n</li><li>\n<p>color (must be a member of BusinessRole::COLOR_PALETTE)</p>\n</li><li>\n<p>business_role_category_code</p>\n</li><li>\n<p>replace_by_aos</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a role to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights &amp; access to the shift’s schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of role details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_on_cost_definitions","name":"import_on_cost_definitions","apis":[{"api_url":"/api/admin/businesses/:id/import_on_cost_definitions","http_method":"POST","short_description":"Import on cost definitions","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>name</p>\n</li><li>\n<p>code</p>\n</li><li>\n<p>description</p>\n</li><li>\n<p>external</p>\n</li><li>\n<p>remove  (Used to flag row for deletion instead of insert / update)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a role to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of role details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_on_cost_definition_timeboxes","name":"import_on_cost_definition_timeboxes","apis":[{"api_url":"/api/admin/businesses/:id/import_on_cost_definition_timeboxes","http_method":"POST","short_description":"Import on cost definition timeboxes","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Will delete any existing timeboxes for any existing requested on-cost definition. Valid column names are:</p>\n\n<pre>- on_cost_definition_name/ on_cost_definition_code (required)\n- start_date\n- end_date\n- on_costs: An array of json objects containing:\n    -  on_cost_percentage: number, // A floating point percentage to be added to shift cost\n    -  employment_types: [int],    // An array of integers representing employment types to match - null or empty list means match all\n    -  management_type: int,       // An indicator of what management type to match, 0 = either, 1 = manager only, 2 = employee only. null or missing indicated match any\n    -  minimum_age: int,           // If this is present, the employee&#39;s age must be at least this value\n    -  maximum_age: int            If this is present, the employee&#39;s age must be at most this value</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a role to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of role details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employments","name":"import_employments","apis":[{"api_url":"/api/admin/businesses/:id/import_employments","http_method":"POST","short_description":"Import business employees to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>email</p>\n</li><li>\n<p>first_name</p>\n</li><li>\n<p>last_name</p>\n</li><li>\n<p>status</p>\n</li><li>\n<p>security_role</p>\n</li><li>\n<p>employment_type</p>\n</li><li>\n<p>date_of_birth</p>\n</li><li>\n<p>nickname</p>\n</li><li>\n<p>metadata (A hash of custom values)</p>\n</li><li>\n<p>image (data_uri)</p>\n</li><li>\n<p>rating</p>\n</li></ul>\n\n<p>status defines whether the employment is active.  Valid values are ‘active’ and ‘inactive’</p>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an employment to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of employment details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"source","full_name":"source","description":"\n<p>Optional source label</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_draft_employments","name":"import_draft_employments","apis":[{"api_url":"/api/admin/businesses/:id/import_draft_employments","http_method":"POST","short_description":"Import business draft employees to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>application_code (required)</p>\n</li><li>\n<p>application_date</p>\n</li><li>\n<p>primary_job_title_id (required if primary_job_title_rate is non empty)</p>\n</li><li>\n<p>primary_job_title_rate (required if primary_job_title_id is non empty)</p>\n</li><li>\n<p>home_schedule_id (required)</p>\n</li><li>\n<p>employment_type (required if min_duration_per_week is non empty and business setting contracts_use_employment_type is true)</p>\n</li><li>\n<p>min_duration_per_week (required if employment_type is non empty and contracts_use_min_duration_per_week is true)</p>\n</li><li>\n<p>org_start_date (required)</p>\n</li><li>\n<p>email</p>\n</li><li>\n<p>first_name</p>\n</li><li>\n<p>last_name</p>\n</li><li>\n<p>security_role</p>\n</li><li>\n<p>date_of_birth</p>\n</li><li>\n<p>nickname</p>\n</li><li>\n<p>metadata (A hash of custom values)</p>\n</li><li>\n<p>image (data_uri)</p>\n</li><li>\n<p>rating</p>\n</li><li>\n<p>school_id</p>\n</li><li>\n<p>payroll_code</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an draft employment to import.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of draft employment details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_roles","name":"import_employment_roles","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_roles","http_method":"POST","short_description":"Import roles an employee can perform to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>business_role_code (required)</p>\n</li><li>\n<p>role_rate</p>\n</li><li>\n<p>skill_level</p>\n</li><li>\n<p>rating (deprecated)</p>\n</li><li>\n<p>remove</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an employment role to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of employment role details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_rates","name":"import_employment_rates","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_rates","http_method":"POST","short_description":"Import employment rates","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- employment_code (Required)\n- start_date (Required)\n- end_date\n- rate (Required)\n- code\n- job_title_code\n- rate_preference_index\n- prior_agreed_rate\n- annual_salary</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a rate to import or update.</p>\n\n<span id=\"label-Validation\" class=\"legacy-anchor\"></span>\n<h2 id=\"validation\"><a href=\"#validation\">Validation</a></h2>\n\n<p>During partial import, no data for an employment will be modified unless all records for that employment passed into this endpoint are valid. This means they must not overlap with each other, have a start date and pass model validations. For an employee, rows not matching start_date and rate_preference_index from the given input rows would be deleted. If an employment_rate with the given start_date and rate_preference_index is found, it will be updated if there is any change detected.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of location details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"source","full_name":"source","description":"\n<p>Optional source label</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_histories","name":"import_employment_histories","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_histories","http_method":"POST","short_description":"Import employment histories","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- employment_code (Required)\n- status (Required)\n- start_date\n- end_date\n- employment_status_change_reason_code\n- code\n- proposed_return_date\n- actual_return_date</pre>\n\n<p>Dates are interpreted to mean the start of day at the employees home schedule. If an employee is missing a home store:</p>\n\n<pre>- An error will be raised if dates_fallback_to_utc_if_employee_missing_home_schedule is FALSE (the default)\n- Falls back to UTC midnight if dates_fallback_to_utc_if_employee_missing_home_schedule is TRUE</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a rate to import or update.</p>\n\n<span id=\"label-Validation\" class=\"legacy-anchor\"></span>\n<h2 id=\"validation\"><a href=\"#validation\">Validation</a></h2>\n\n<p>If dates_fallback_to_utc_if_employee_missing_home_schedule is FALSE, then employee must have a current home schedule.</p>\n\n<p>During partial import, no data for an employment will be modified unless all records for that employment passed into this endpoint are valid. This means they must not overlap with each other &amp; have a start time.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dates_fallback_to_utc_if_employee_missing_home_schedule","full_name":"dates_fallback_to_utc_if_employee_missing_home_schedule","description":"\n<p>When true, start_date and end_date params to fallback to UTC midnight if an employee has no home schedule. Default to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of history details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"source","full_name":"source","description":"\n<p>Optional source label</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_schedule_histories","name":"import_employment_schedule_histories","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_schedule_histories","http_method":"POST","short_description":"Import employment schedule histories","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- employment_code (Required)\n- schedule_code (Required)\n- start_date (Required)\n- end_date (Required)\n- code\n- is_home_schedule (Required)</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a employment schedule history to import or update.</p>\n\n<p>During partial import, no data for an employment schedule history will be modified unless all records for that employment schedule history passed into this endpoint are valid. This means they must not overlap with each other &amp; have a start date.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"close_current_open_home_schedule","full_name":"close_current_open_home_schedule","description":"\n<p>When true, all open ended schedule histories will be closed by start_time from import data</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tolerate_repetitive_home_stores","full_name":"tolerate_repetitive_home_stores","description":"\n<p>When true, any record with the same home store but later start_date as existing will be ignored. Defaults to false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of history details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_home_stores","name":"import_home_stores","apis":[{"api_url":"/api/admin/businesses/:id/import_home_stores","http_method":"POST","short_description":"Import home stores","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- employment_code (Required)\n- schedule_code (Required)\n- start_date\n- end_date\n- code</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a record to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mode","full_name":"mode","description":"\n<p>The import mode. Options are:</p>\n\n<pre>- full_replace_history   - In this mode, the entire home store history is replaced with what is provided per employee\n- soft_replace_history   - In this mode, the history is upserted using start_date and employment_code as key\n- current_value_only     - In this mode, only the current home store (at time of import) is provided per employee\n- replace_recent_history - In this mode, the most recently history is replaced with that provided per employee</pre>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>full_replace_history</code>, <code>soft_replace_history</code>, <code>current_value_only</code>, <code>replace_recent_history</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of history details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"source","full_name":"source","description":"\n<p>Optional source label</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_shared_stores","name":"import_shared_stores","apis":[{"api_url":"/api/admin/businesses/:id/import_shared_stores","http_method":"POST","short_description":"Import shared stores","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- employment_code (Required)\n- schedule_code (Required)\n- start_date\n- end_date\n- code</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a record to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mode","full_name":"mode","description":"\n<p>The import mode. Options are:</p>\n\n<pre>- soft_replace_history   - In this mode, the history is upsert updated using start_date, schedule_code and employment_code as key</pre>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>soft_replace_history</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of history details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_metadata","name":"import_employment_metadata","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_metadata","http_method":"POST","short_description":"Import employment metadata for an employee in the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>metadata_type_name (required)</p>\n</li><li>\n<p>details (required)</p>\n</li><li>\n<p>start_time</p>\n</li><li>\n<p>end_time</p>\n</li></ul>\n\n<span id=\"label-Usage\" class=\"legacy-anchor\"></span>\n<h2 id=\"usage\"><a href=\"#usage\">Usage</a></h2>\n\n<p>Supports timeboxed and non-timeboxed metadata. Not guaranteed to correctly handle date values (instead of date-time) for columns start_time, end_time. Non-Timeboxed:</p>\n<ul><li>\n<p>Delete existing record (for employment_code/metadata_type_name) by sending row with details as null.</p>\n</li></ul>\n\n<p>Timeboxed:</p>\n<ul><li>\n<p>Should send complete timelines from the earliest timebox changed.</p>\n</li><li>\n<p>Records starting onward from the earliest start_time provided will be completely removed, replaced with the new timeboxes provided.</p>\n</li><li>\n<p>Records starting before and ending after the earliest start_time provided will have its end_time set to the earliest start_time provided (to prevent overlap).</p>\n</li><li>\n<p>Does not support sending details as null.</p>\n</li><li>\n<p>Setting start_time to null (and setting end_time to null if not so already) deletes all existing records (for employment_code/metadata_type_name), replacing with the new timeboxes provided.</p>\n</li><li>\n<p>If partial_success is true, any deletions/updates that take place to make room for the imported rows will be rolled-back.</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an employment metadata to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of employment metadata details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"source","full_name":"source","description":"\n<p>Optional source label</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_schedules","name":"import_employment_schedules","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_schedules","http_method":"POST","short_description":"Import schedules an employee can work in to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>schedule_code (required)</p>\n</li><li>\n<p>group_admin</p>\n</li><li>\n<p>general_manager</p>\n</li><li>\n<p>schedule_manager_with_pay</p>\n</li><li>\n<p>schedule_manager</p>\n</li><li>\n<p>shift_manager</p>\n</li><li>\n<p>schedulable</p>\n</li><li>\n<p>remove (boolean - when true, record is deleted instead of created/updated)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an employment schedules to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of employment schedules details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_securities","name":"import_employment_securities","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_securities","http_method":"POST","short_description":"Import employee securities in to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>pin</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an employment security to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of employment security details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_schedules","name":"import_schedules","apis":[{"api_url":"/api/admin/businesses/:id/import_schedules","http_method":"POST","short_description":"Import schedules to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>schedule_code (required)</p>\n</li><li>\n<p>parent_schedule_code</p>\n</li><li>\n<p>primary_business_location_code</p>\n</li><li>\n<p>schedule_name (required)</p>\n</li><li>\n<p>is_group</p>\n</li><li>\n<p>data_lake_id</p>\n</li><li>\n<p>pay_period_requires_approval</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a schedule to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of schedule details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_role_categories","name":"import_role_categories","apis":[{"api_url":"/api/admin/businesses/:id/import_role_categories","http_method":"POST","short_description":"Import business role categories to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>code (required)</p>\n</li><li>\n<p>business_role_category_name (required)</p>\n</li><li>\n<p>parent_category_code</p>\n</li><li>\n<p>order</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a business role category to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of role categories to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_availabilities","name":"import_employment_availabilities","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_availabilities","http_method":"POST","short_description":"Import employee availabilities to the given business. Will replace all existing availabilities for respective employments.","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>availability_code (required)</p>\n</li><li>\n<p>start_date (required)</p>\n</li><li>\n<p>end_date</p>\n</li><li>\n<p>event_type (required)</p>\n</li><li>\n<p>days_of_week (required) (e.g. [“saturday”, “thursday”, “tuesday”])</p>\n</li><li>\n<p>start_time (required)</p>\n</li><li>\n<p>end_time (required)</p>\n</li><li>\n<p>consecutive_days_off_waived</p>\n</li><li>\n<p>max_duration_per_week (duration in seconds)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an employment availabilities to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of employment availability details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_max_hours","name":"import_employment_max_hours","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_max_hours","http_method":"POST","short_description":"Import employee max hours to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>max_hour_code (required)</p>\n</li><li>\n<p>start_date (required)</p>\n</li><li>\n<p>end_date</p>\n</li><li>\n<p>max_hours (required)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an employment max hours to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"replace","full_name":"replace","description":"\n<p>Whether to delete all existing employment max hours entries prior to import</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of employment max hours details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_day_parts","name":"import_day_parts","apis":[{"api_url":"/api/admin/businesses/:id/import_day_parts","http_method":"POST","short_description":"Import day parts to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>name (required)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a day part to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of day part details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_day_part_templates","name":"import_day_part_templates","apis":[{"api_url":"/api/admin/businesses/:id/import_day_part_templates","http_method":"POST","short_description":"Import day part templates to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>name (required)</p>\n</li><li>\n<p>details (required)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a day part template to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of day part template details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_job_title_types","name":"import_job_title_types","apis":[{"api_url":"/api/admin/businesses/:id/import_job_title_types","http_method":"POST","short_description":"Import job titles types to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>job_title_type_code (required)</p>\n</li><li>\n<p>name (required)</p>\n</li><li>\n<p>order</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a job title type to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of job title type details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_job_titles","name":"import_job_titles","apis":[{"api_url":"/api/admin/businesses/:id/import_job_titles","http_method":"POST","short_description":"Import job titles to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>job_title_code (required)</p>\n</li><li>\n<p>job_title_type_code (required)</p>\n</li><li>\n<p>name (required)</p>\n</li><li>\n<p>description</p>\n</li><li>\n<p>salaried</p>\n</li><li>\n<p>is_manager</p>\n</li><li>\n<p>min_pay_rate</p>\n</li><li>\n<p>max_pay_rate</p>\n</li><li>\n<p>level</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a job title to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of job title details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_metadata_types","name":"import_metadata_types","apis":[{"api_url":"/api/admin/businesses/:id/import_metadata_types","http_method":"POST","short_description":"Import metadata types to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>name (required)</p>\n</li><li>\n<p>object_class (required)</p>\n</li><li>\n<p>data_type (required)</p>\n</li><li>\n<p>valid_values</p>\n</li><li>\n<p>minimum</p>\n</li><li>\n<p>maximum</p>\n</li><li>\n<p>display_name</p>\n</li><li>\n<p>required (required)</p>\n</li><li>\n<p>is_timeboxed (required)</p>\n</li><li>\n<p>encrypted (required)</p>\n</li><li>\n<p>internal_access (required)</p>\n</li><li>\n<p>obfuscated_number</p>\n</li><li>\n<p>description</p>\n</li></ul>\n\n<span id=\"label-Usage\" class=\"legacy-anchor\"></span>\n<h2 id=\"usage\"><a href=\"#usage\">Usage</a></h2>\n\n<p>external is set to true for each new row. Only allows updating rows where external is true.</p>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a metadata type to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of metadata types details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_misc_pay_types","name":"import_misc_pay_types","apis":[{"api_url":"/api/admin/businesses/:id/import_misc_pay_types","http_method":"POST","short_description":"Import miscellaneous pay types to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>misc_pay_type_code (required)</p>\n</li><li>\n<p>name (required)</p>\n</li><li>\n<p>actual_work_date_required</p>\n</li><li>\n<p>hour_based</p>\n</li><li>\n<p>description</p>\n</li><li>\n<p>is_manager</p>\n</li><li>\n<p>is_crew</p>\n</li><li>\n<p>remove (boolean - when true, record is deleted instead of created/updated)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a miscellaneous pay type to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of miscellaneous pay type details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_unavailability_events","name":"import_unavailability_events","apis":[{"api_url":"/api/admin/businesses/:id/import_unavailability_events","http_method":"POST","short_description":"Import unavailability events to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>time_off_type_code (required)</p>\n</li><li>\n<p>hours_requested (required)</p>\n</li><li>\n<p>title</p>\n</li><li>\n<p>reason</p>\n</li><li>\n<p>start_date_time (required)</p>\n</li><li>\n<p>end_date_time (required)</p>\n</li><li>\n<p>time_zone</p>\n</li><li>\n<p>status</p>\n</li><li>\n<p>manager_employment_code</p>\n</li><li>\n<p>manager_message</p>\n</li><li>\n<p>manager_response_time</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an unavailability event to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of unavailability event details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_external_codes","name":"import_employment_external_codes","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_external_codes","http_method":"POST","short_description":"Import external codes in to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>schedule_code (Required)</p>\n</li><li>\n<p>employment_code (Required)</p>\n</li><li>\n<p>external_code (Required)</p>\n</li><li>\n<p>external_subcode (Required)</p>\n</li><li>\n<p>rate_preference_index (Required)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a time card to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows with different employment_codes. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of time card details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_time_off_balances","name":"import_time_off_balances","apis":[{"api_url":"/api/admin/businesses/:id/import_time_off_balances","http_method":"POST","short_description":"Import time off balances in to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>employment_code (Required)</p>\n</li><li>\n<p>time_off_type_code (Required)</p>\n</li><li>\n<p>hours_balance (Required)</p>\n</li><li>\n<p>accrued_to (Required)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a time off balance to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of time off balance details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_time_off_types","name":"import_time_off_types","apis":[{"api_url":"/api/admin/businesses/:id/import_time_off_types","http_method":"POST","short_description":"Import time off balance types in to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>time_off_type_code (Required)</p>\n</li><li>\n<p>name (Required)</p>\n</li><li>\n<p>has_balance (Required)</p>\n</li><li>\n<p>ignore_auto_reject (Required)</p>\n</li><li>\n<p>deleted (boolean - when true, record is soft deleted/updated)</p>\n</li><li>\n<p>paid (boolean - Indicates whether the leave request of this type would be paid)</p>\n</li><li>\n<p>employment_types (Array of strings, with allowed values being “full_time”, “part_time”, “casual” and “permanent”)</p>\n</li><li>\n<p>short_name</p>\n</li><li>\n<p>is_manager_by_proxy_only</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a time off balance to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of time off types to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_status_change_reasons","name":"import_employment_status_change_reasons","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_status_change_reasons","http_method":"POST","short_description":"Import employment status change reasons","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- display_text (Required)\n- code (Required)\n- status (Required)\n- remove</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an employment status change reason to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of reason details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-businesses/import_employment_contracts","name":"import_employment_contracts","apis":[{"api_url":"/api/admin/businesses/:id/import_employment_contracts","http_method":"POST","short_description":"Import employment contracts","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- code \n- employment_code (Required)\n- employment_type\n- min_duration_per_week\n- start_date (Required)\n- end_date\n- remove</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines an employment contract to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of contracts to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"source","full_name":"source","description":"\n<p>Optional source label</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-day_part_templates":{"doc_url":"/doc/1.0/admin-day_part_templates","id":"admin-day_part_templates","api_url":"/api","name":"Admin::Day_part_templates","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-day_part_templates/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/day_part_templates","http_method":"GET","short_description":"Get all day part templates for the given business","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have at least group admin rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-day_part_templates/create","name":"create","apis":[{"api_url":"/api/admin/businesses/:business_id/day_part_templates","http_method":"POST","short_description":"Create a day part template for the given business","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>Day Part Template name</p>\n","required":{"attributes":["name"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"details","full_name":"details","description":"\n<p>Day Part Template details.</p>\n\n<pre>format: [{\n            day_part: &quot;breakfast&quot;,\n            days: {\n             &quot;0&quot;: {\n                start_time: &quot;09:00&quot;,\n                end_time: &quot;10:00&quot;\n              }\n            }\n          },\n          {\n            day_part: &quot;lunch&quot;,\n            days: {\n             &quot;0&quot;: {\n                start_time: &quot;12:00&quot;,\n                end_time: &quot;14:00&quot;\n              }\n            }\n        }]</pre>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-day_part_templates/show","name":"show","apis":[{"api_url":"/api/admin/businesses/:business_id/day_part_templates/:id","http_method":"GET","short_description":"Get a day part template info for the given business","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have at least group admin rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Day Part Template ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-day_part_templates/update","name":"update","apis":[{"api_url":"/api/admin/businesses/:business_id/day_part_templates/:id","http_method":"PATCH","short_description":"Update day part template","deprecated":null},{"api_url":"/api/admin/businesses/:business_id/day_part_templates/:id","http_method":"PUT","short_description":"Update day part template","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Day Part Template ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>Day Part Template name</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"details","full_name":"details","description":"\n<p>Day Part Template details.</p>\n\n<pre>format: [{\n            day_part: &quot;breakfast&quot;,\n            days: {\n             &quot;0&quot;: {\n                start_time: &quot;09:00&quot;,\n                end_time: &quot;10:00&quot;\n              }\n            }\n          },\n          {\n            day_part: &quot;lunch&quot;,\n            days: {\n             &quot;0&quot;: {\n                start_time: &quot;12:00&quot;,\n                end_time: &quot;14:00&quot;\n              }\n            }\n        }]</pre>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-day_part_templates/destroy","name":"destroy","apis":[{"api_url":"/api/admin/businesses/:business_id/day_part_templates/:id","http_method":"DELETE","short_description":"Delete day part template","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Day Part Template ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"admin-day_parts":{"doc_url":"/doc/1.0/admin-day_parts","id":"admin-day_parts","api_url":"/api","name":"Admin::Day_parts","short_description":"Day Parts for the business (eg. Morning, Lunch, Afternoon)","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-day_parts/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/day_parts","http_method":"GET","short_description":"Get all day parts for the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n<p>Array of Day Part IDs to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-day_parts/show","name":"show","apis":[{"api_url":"/api/admin/businesses/:business_id/day_parts/:id","http_method":"GET","short_description":"Get a specific day part","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Day Part ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-day_parts/create","name":"create","apis":[{"api_url":"/api/admin/businesses/:business_id/day_parts","http_method":"POST","short_description":"Create a day part for the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>The name of the day part</p>\n","required":{"attributes":["name"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-day_parts/update","name":"update","apis":[{"api_url":"/api/admin/businesses/:business_id/day_parts/:id","http_method":"PATCH","short_description":"Update day part","deprecated":null},{"api_url":"/api/admin/businesses/:business_id/day_parts/:id","http_method":"PUT","short_description":"Update day part","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Day Part ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>The name of the day part</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-day_parts/destroy","name":"destroy","apis":[{"api_url":"/api/admin/businesses/:business_id/day_parts/:id","http_method":"DELETE","short_description":"Delete day part","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Day Part ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-employment_histories":{"doc_url":"/doc/1.0/admin-employment_histories","id":"admin-employment_histories","api_url":"/api","name":"Admin::Employment_histories","short_description":"An association of an employee to employment histories","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-employment_histories/lookup","name":"lookup","apis":[{"api_url":"/api/admin/businesses/:business_id/employment_histories/lookup","http_method":"POST","short_description":"Get employment history for given employments","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights</p>\n","errors":[],"params":[{"name":"employment_ids","full_name":"employment_ids","description":"\n<p>An array of employment IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-employment_schedules":{"doc_url":"/doc/1.0/admin-employment_schedules","id":"admin-employment_schedules","api_url":"/api","name":"Admin::Employment_schedules","short_description":"An association of an employee to a schedule","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-employment_schedules/upsert","name":"upsert","apis":[{"api_url":"/api/admin/businesses/:business_id/employment_schedules","http_method":"PUT","short_description":"Create or update employment schedule for the given business, employment and schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin rights for the schedule Must be able to manage the employee</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"group_admin","full_name":"group_admin","description":"\n<p>Whether the employee has group_admin rights to the schedule.  Default false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"general_manager","full_name":"general_manager","description":"\n<p>Whether the employee has general_manager rights to the schedule.  Default false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_manager_with_pay","full_name":"schedule_manager_with_pay","description":"\n<p>Whether the employee has schedule_manager_with_pay rights to the schedule. Default false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_manager","full_name":"schedule_manager","description":"\n<p>Whether the employee has schedule_manager rights to the schedule. Default false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_manager","full_name":"shift_manager","description":"\n<p>Whether the employee has shift_manager rights to the schedule. Default false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedulable","full_name":"schedulable","description":"\n<p>Whether the employee should be schedulable.  Default false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-employments":{"doc_url":"/doc/1.0/admin-employments","id":"admin-employments","api_url":"/api","name":"Admin::Employments","short_description":"Employments of users in businesses","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-employments/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/employments","http_method":"GET","short_description":"Get all employments for the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_office_location_id","full_name":"business_office_location_id","description":"\n<p>Business Office Location ID to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n<p>Email address to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"accepted_invite","full_name":"accepted_invite","description":"\n<p>Accepted invite status to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_inactive_employments","full_name":"exclude_inactive_employments","description":"\n<p>Optionally filter inactive employments</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed_employments_only","full_name":"managed_employments_only","description":"\n<p>Optionally filter to only employments the current user has permission to manage</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>If present, return only employments in the given schedule</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_business_roles","full_name":"include_business_roles","description":"\n<p>When true, include employment roles. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-employments/lookup","name":"lookup","apis":[{"api_url":"/api/admin/businesses/:business_id/employments/lookup","http_method":"POST","short_description":"Get employments by id","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n<p>An array of contract IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-employments/business_invite","name":"business_invite","apis":[{"api_url":"/api/admin/businesses/:business_id/employments/:id/business_invite","http_method":"GET","short_description":"Get the business invite of a specific employment","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be able to manage the employee as a service manager</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-employments/update","name":"update","apis":[{"api_url":"/api/admin/businesses/:business_id/employments/:id","http_method":"PATCH","short_description":"Update employment","deprecated":null},{"api_url":"/api/admin/businesses/:business_id/employments/:id","http_method":"PUT","short_description":"Update employment","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Cannot modify your own employment, or an employment with a security_role higher than you. Must have employee manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"\n<p>Email Address</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"must be an unique valid email address with max length 70","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"first_name","full_name":"first_name","description":"\n<p>First Name</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 35","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"last_name","full_name":"last_name","description":"\n<p>Last Name</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 36","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_of_birth","full_name":"date_of_birth","description":"\n<p>Date of Birth</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"image","full_name":"image","description":"\n<p>Image to be used as the employment avatar</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a valid data URI","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_rate","full_name":"employment_rate","description":"\n<p>The minimum rate an employee will be paid. Default is 0</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"must be a number, must be greater than or equal to 0, must be less than or equal to 99999.9999999999","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"security_role","full_name":"security_role","description":"\n<p>The security role the employee has within the business. Default is employee</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>employee</code>, <code>employee-manager</code>, <code>business-owner</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n<p>3rd party unique ID for the employment</p>\n","required":false,"allow_nil":{"attributes":["code"],"options":{"allow_blank":false,"allow_nil":true,"maximum":50,"minimum":1}},"allow_blank":null,"validator":"must be string >= 1 and <= 50<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_type","full_name":"employment_type","description":"\n<p>The employment type of the employee</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_roles","full_name":"business_roles","description":"\n<p>An array of roles the employee can perform. This list will replace any already assigned to the employee.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"Must be an array of IDs or EmploymentRole objects with attributes business_role_id, skill_level_id, and role_rate","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_office_locations","full_name":"business_office_locations","description":"\n<p>An array of locations the employee can work at. This list will replace any already assigned to the employee.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"Must be an array of IDs or EmploymentOfficeLocation objects with attributes business_office_location_id","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payroll_code","full_name":"payroll_code","description":"\n<p>Represents payroll ID of employee</p>\n","required":null,"allow_nil":{"attributes":["payroll_code"],"options":{"allow_blank":false,"allow_nil":true,"maximum":50,"minimum":1}},"allow_blank":null,"validator":"must be string >= 1 and <= 50<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"nickname","full_name":"nickname","description":"\n<p>Represents nickname of employee</p>\n","required":null,"allow_nil":{"attributes":["nickname"],"options":{"allow_blank":false,"allow_nil":true,"maximum":35,"minimum":1}},"allow_blank":null,"validator":"must be string >= 1 and <= 35","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata","full_name":"metadata","description":"\n<p>Metadata values</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"school_id","full_name":"school_id","description":"\n<p>School the employee goes to, or NULL if the employee does not attend school.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rating","full_name":"rating","description":"\n<p>Represents rating of the employee</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be a number, must be greater than or equal to 1, must be less than or equal to 5","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"muted_features","full_name":"muted_features","description":"\n<p>Features for which an employee is muted</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-employments/resend_invite","name":"resend_invite","apis":[{"api_url":"/api/admin/businesses/:business_id/employments/:id/resend_invite","http_method":"PUT","short_description":"Resend employment invitation","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be able to manage the employee as a service manager</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-employments/batch_resend_invite","name":"batch_resend_invite","apis":[{"api_url":"/api/admin/businesses/:business_id/employments/batch_resend_invite","http_method":"PUT","short_description":"Resend multiple employment invitation","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n<p>An array of employment IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-employments/image","name":"image","apis":[{"api_url":"/api/admin/businesses/:business_id/employments/:id/image","http_method":"GET","short_description":"Get the employment profile image","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre>Open to public (until cookies are supported)</pre>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"x_lifelenz_device","full_name":"x_lifelenz_device","description":"\n<p>Device type of the user</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-forums":{"doc_url":"/doc/1.0/admin-forums","id":"admin-forums","api_url":"/api","name":"Admin::Forums","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-forums/create","name":"create","apis":[{"api_url":"/api/admin/businesses/:business_id/forums","http_method":"POST","short_description":"Create a forum","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be a schedule manager.</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"topic","full_name":"topic","description":"\n<p>Topic of the forum</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_office_location_id","full_name":"business_office_location_id","description":"\n<p>Id of the Business Office Location linked to this forum</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"user_ids","description":"\n<p>A list of users to add to the forum</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-forums/import","name":"import","apis":[{"api_url":"/api/admin/businesses/:business_id/forums/:id/import","http_method":"PUT","short_description":"Create or update a forum","deprecated":null}],"formats":null,"full_description":"\n<p>Creates a new forum with the given forum_id, forum_name, owner_employment_code and location_code.</p>\n\n<p>If a forum already exists with the given forum_id, the set of employees in the room is updated instead.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business-owner rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Forum ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"topic","full_name":"topic","description":"\n<p>Topic of the forum, used only when creating the forum</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"owner_employment_code","full_name":"owner_employment_code","description":"\n<p>Code of the employment who should be manager of the forum</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"additional_employment_codes","full_name":"additional_employment_codes","description":"\n<p>An array of employment codes.  All these employees will be added to the room</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_code","full_name":"location_code","description":"\n<p>Code of the location the forum is for</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"role_codes","full_name":"role_codes","description":"\n<p>An array of role codes.  Employees who have at least one of these roles &amp; are schedulable in any schedule with that has a primary location identified by location_code will be added to the forum</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-forums/add_users","name":"add_users","apis":[{"api_url":"/api/admin/businesses/:business_id/forums/:id/add_users","http_method":"PUT","short_description":"Add users to a forum","deprecated":null}],"formats":null,"full_description":"\n<p>Note: If the system fails to add users to the room, it is not reported by this endpoint.  Clients should query ejabberd directly to look up the new room affiliations after calling this.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be an owner of the forum.</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>ID of an open forum</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"user_ids","description":"\n<p>An array of user IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-forums/remove_users","name":"remove_users","apis":[{"api_url":"/api/admin/businesses/:business_id/forums/:id/remove_users","http_method":"PUT","short_description":"Remove users from a forum","deprecated":null}],"formats":null,"full_description":"\n<p>Note: If the system fails to add users to the room, it is not reported by this endpoint.  Clients should query ejabberd directly to look up the new room affiliations after calling this.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be an owner of the forum.</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>ID of an open forum</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"user_ids","full_name":"user_ids","description":"\n<p>An array of user IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"admin-job_title_types":{"doc_url":"/doc/1.0/admin-job_title_types","id":"admin-job_title_types","api_url":"/api","name":"Admin::Job_title_types","short_description":"Job title type in businesses","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-job_title_types/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/job_title_types","http_method":"GET","short_description":"Get Job title types for given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-job_title_types/show","name":"show","apis":[{"api_url":"/api/admin/businesses/:business_id/job_title_types/:id","http_method":"GET","short_description":"Get specific Job title type for given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Job Title Type ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-job_title_types/create","name":"create","apis":[{"api_url":"/api/admin/businesses/:business_id/job_title_types","http_method":"POST","short_description":"Create Job title type for business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>The name for Job title type(Required)</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n<p>Ordering position within types. Default: New job title type will be added to last position</p>\n","required":null,"allow_nil":{"attributes":["order"],"options":{"allow_nil":true,"only_integer":true,"greater_than_or_equal_to":0}},"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 0","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n<p>3rd party unique ID for the job title type</p>\n","required":null,"allow_nil":{"attributes":["code"],"options":{"allow_nil":true,"maximum":50}},"allow_blank":null,"validator":"must be string <= 50<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-job_title_types/update","name":"update","apis":[{"api_url":"/api/admin/businesses/:business_id/job_title_types/:id","http_method":"PATCH","short_description":"Update a specific Job title type","deprecated":null},{"api_url":"/api/admin/businesses/:business_id/job_title_types/:id","http_method":"PUT","short_description":"Update a specific Job title type","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Job Title Type ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>The name for Job title type(Required)</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"order","full_name":"order","description":"\n<p>Ordering position within types. Default: New job title type will be added to last position</p>\n","required":false,"allow_nil":{"attributes":["order"],"options":{"allow_nil":true,"only_integer":true,"greater_than_or_equal_to":0}},"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 0","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n<p>3rd party unique ID for the job title type</p>\n","required":false,"allow_nil":{"attributes":["code"],"options":{"allow_nil":true,"maximum":50}},"allow_blank":null,"validator":"must be string <= 50<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-job_title_types/destroy","name":"destroy","apis":[{"api_url":"/api/admin/businesses/:business_id/job_title_types/:id","http_method":"DELETE","short_description":"Destroy a specific job title type","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Job Title Type ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-job_titles":{"doc_url":"/doc/1.0/admin-job_titles","id":"admin-job_titles","api_url":"/api","name":"Admin::Job_titles","short_description":"Job title in businesses","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-job_titles/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/job_titles","http_method":"GET","short_description":"Get Job titles for given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-job_titles/create","name":"create","apis":[{"api_url":"/api/admin/businesses/:business_id/job_titles","http_method":"POST","short_description":"Create Job title for business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_title_type_id","full_name":"job_title_type_id","description":"\n<p>Job Title Type ID (Required)</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>The name for Job title (Required)</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n<p>Description of the Job title</p>\n","required":null,"allow_nil":{"attributes":["description"],"options":{"allow_nil":true,"maximum":500}},"allow_blank":null,"validator":"must be string <= 500","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"salaried","full_name":"salaried","description":"\n<p>Indicates whether the job title is salaried (true) or hourly (false). Default: false</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_manager","full_name":"is_manager","description":"\n<p>Indicates whether job title is marked as manager. Default: false</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deleted","full_name":"deleted","description":"\n<p>Indicates whether job title is marked as deleted. Default: false</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"min_pay_rate","full_name":"min_pay_rate","description":"\n<p>Minimum pay rate for job title (Required)</p>\n","required":true,"allow_nil":{"attributes":["min_pay_rate"],"options":{"allow_nil":true,"greater_than_or_equal_to":0}},"allow_blank":null,"validator":"must be a number, must be greater than or equal to 0","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_pay_rate","full_name":"max_pay_rate","description":"\n<p>Maximum pay rate for job title (Required)</p>\n","required":true,"allow_nil":{"attributes":["max_pay_rate"],"options":{"allow_nil":true,"greater_than_or_equal_to":0}},"allow_blank":null,"validator":"must be a number, must be greater than or equal to 0","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n<p>3rd party unique ID for the shift</p>\n","required":null,"allow_nil":{"attributes":["code"],"options":{"allow_nil":true,"maximum":50}},"allow_blank":null,"validator":"must be string <= 50","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"level","full_name":"level","description":"\n<p>Indicates employment classifications</p>\n","required":null,"allow_nil":{"attributes":["level"],"options":{"allow_nil":true,"greater_than_or_equal_to":1}},"allow_blank":null,"validator":"must be a number, must be greater than or equal to 1","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-job_titles/update","name":"update","apis":[{"api_url":"/api/admin/businesses/:business_id/job_titles/:id","http_method":"PATCH","short_description":"Update a specific Job title","deprecated":null},{"api_url":"/api/admin/businesses/:business_id/job_titles/:id","http_method":"PUT","short_description":"Update a specific Job title","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Job Title ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"job_title_type_id","full_name":"job_title_type_id","description":"\n<p>Job Title Type ID (Required)</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>The name for Job title (Required)</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n<p>Description of the Job title</p>\n","required":false,"allow_nil":{"attributes":["description"],"options":{"allow_nil":true,"maximum":500}},"allow_blank":null,"validator":"must be string <= 500","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"salaried","full_name":"salaried","description":"\n<p>Indicates whether the job title is salaried (true) or hourly (false). Default: false</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_manager","full_name":"is_manager","description":"\n<p>Indicates whether job title is marked as manager. Default: false</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"deleted","full_name":"deleted","description":"\n<p>Indicates whether job title is marked as deleted. Default: false</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"min_pay_rate","full_name":"min_pay_rate","description":"\n<p>Minimum pay rate for job title (Required)</p>\n","required":false,"allow_nil":{"attributes":["min_pay_rate"],"options":{"allow_nil":true,"greater_than_or_equal_to":0}},"allow_blank":null,"validator":"must be a number, must be greater than or equal to 0","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"max_pay_rate","full_name":"max_pay_rate","description":"\n<p>Maximum pay rate for job title (Required)</p>\n","required":false,"allow_nil":{"attributes":["max_pay_rate"],"options":{"allow_nil":true,"greater_than_or_equal_to":0}},"allow_blank":null,"validator":"must be a number, must be greater than or equal to 0","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n<p>3rd party unique ID for the shift</p>\n","required":false,"allow_nil":{"attributes":["code"],"options":{"allow_nil":true,"maximum":50}},"allow_blank":null,"validator":"must be string <= 50","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"level","full_name":"level","description":"\n<p>Indicates employment classifications</p>\n","required":false,"allow_nil":{"attributes":["level"],"options":{"allow_nil":true,"greater_than_or_equal_to":1}},"allow_blank":null,"validator":"must be a number, must be greater than or equal to 1","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-job_titles/destroy","name":"destroy","apis":[{"api_url":"/api/admin/businesses/:business_id/job_titles/:id","http_method":"DELETE","short_description":"Destroy a specific job title","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Job Title ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-metadata_types":{"doc_url":"/doc/1.0/admin-metadata_types","id":"admin-metadata_types","api_url":"/api","name":"Admin::Metadata_types","short_description":"Metadata Types for the business","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-metadata_types/create","name":"create","apis":[{"api_url":"/api/admin/businesses/:business_id/metadata_types","http_method":"POST","short_description":"Create a metadata type for the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>Name of the metadata type</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"object_class","full_name":"object_class","description":"\n<p>The object class this metadata type is attached to.  Valid values are Employment</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>Employment</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_type","full_name":"data_type","description":"\n<p>Data type of the metadata.  Valid values are number, boolean, string, date, timestamp, object</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>number</code>, <code>boolean</code>, <code>string</code>, <code>date</code>, <code>timestamp</code>, <code>object</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"valid_values","full_name":"valid_values","description":"\n<p>Array of valid values for the metadata.  Only applicable for data_types of number, string</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"minimum","full_name":"minimum","description":"\n<p>For integers, the min value.  For strings, the min length.  N/A for others</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"maximum","full_name":"maximum","description":"\n<p>For integers, the max value.  For strings, the max length.  N/A for others</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-misc_pay_types":{"doc_url":"/doc/1.0/admin-misc_pay_types","id":"admin-misc_pay_types","api_url":"/api","name":"Admin::Misc_pay_types","short_description":"Miscellaneous pay types of the business","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-misc_pay_types/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/misc_pay_types","http_method":"GET","short_description":"Get all miscellaneous pay types for the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-misc_pays":{"doc_url":"/doc/1.0/admin-misc_pays","id":"admin-misc_pays","api_url":"/api","name":"Admin::Misc_pays","short_description":"Miscellaneous pays of the employee","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-misc_pays/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:schedule_id/misc_pays","http_method":"GET","short_description":"Get Miscellaneous pays for the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group-admin rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_ids","full_name":"employment_ids","description":"\n<p>An array of employment IDs to optionally filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-populate_schedule_histories":{"doc_url":"/doc/1.0/admin-populate_schedule_histories","id":"admin-populate_schedule_histories","api_url":"/api","name":"Admin::Populate_schedule_histories","short_description":"An association of an schedule to populate history","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-populate_schedule_histories/latest","name":"latest","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:schedule_id/populate_schedule_histories/latest","http_method":"POST","short_description":"Get populate schedule history for given schedules within time range","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-schedule_roles":{"doc_url":"/doc/1.0/admin-schedule_roles","id":"admin-schedule_roles","api_url":"/api","name":"Admin::Schedule_roles","short_description":"An association of a business role to a schedule","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-schedule_roles/index_by_schedule","name":"index_by_schedule","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/schedule_roles","http_method":"GET","short_description":"Get schedule roles for the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedule_roles/create","name":"create","apis":[{"api_url":"/api/admin/businesses/:business_id/schedule_roles","http_method":"POST","short_description":"Create a schedule role mapping","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group-admin rights for the schedule of the schedule role</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule Id of the schedule role mapping</p>\n","required":{"attributes":["business_role_id","schedule_id"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"must be a UUID<br>can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_role_id","full_name":"business_role_id","description":"\n<p>Business Role Id of the schedule role mapping</p>\n","required":{"attributes":["business_role_id","schedule_id"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"must be a UUID<br>can't be blank<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"threshold","full_name":"threshold","description":"\n<p>Number of employees needed per day for the role in the schedule</p>\n","required":{"attributes":["threshold"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"must be an integer, must be greater than 0, must be less than or equal to 1000000<br>can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedule_roles/show","name":"show","apis":[{"api_url":"/api/admin/businesses/:business_id/schedule_roles/:id","http_method":"GET","short_description":"Show a schedule role mapping","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights for the schedule of the schedule role</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule Role ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedule_roles/update","name":"update","apis":[{"api_url":"/api/admin/businesses/:business_id/schedule_roles/:id","http_method":"PATCH","short_description":"Update a schedule role mapping","deprecated":null},{"api_url":"/api/admin/businesses/:business_id/schedule_roles/:id","http_method":"PUT","short_description":"Update a schedule role mapping","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group-admin rights for the schedule of the schedule role</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule Role ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"threshold","full_name":"threshold","description":"\n<p>Number of employees needed per day for the role in the schedule</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"must be an integer, must be greater than 0, must be less than or equal to 1000000<br>can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedule_roles/destroy","name":"destroy","apis":[{"api_url":"/api/admin/businesses/:business_id/schedule_roles/:id","http_method":"DELETE","short_description":"Delete a schedule role mapping","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group-admin rights for the schedule of the schedule role</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule Role ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedule_roles/roles_availability","name":"roles_availability","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/roles_availability","http_method":"GET","short_description":"Get the unavailable roles in a date range for the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_roles","full_name":"all_roles","description":"\n<p>If true, includes all roles of the business, else only the roles with threshold defined. Default false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-schedule_weeks":{"doc_url":"/doc/1.0/admin-schedule_weeks","id":"admin-schedule_weeks","api_url":"/api","name":"Admin::Schedule_weeks","short_description":"Schedule Weeks for the schedule","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-schedule_weeks/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:schedule_id/schedule_weeks","http_method":"GET","short_description":"Get all schedule weeks for the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-schedules":{"doc_url":"/doc/1.0/admin-schedules","id":"admin-schedules","api_url":"/api","name":"Admin::Schedules","short_description":"Employee schedules that contain shifts","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-schedules/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules","http_method":"GET","short_description":"Get all schedules the current user has access to","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/show","name":"show","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id","http_method":"GET","short_description":"Get a specific schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/update","name":"update","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id","http_method":"PATCH","short_description":"Update schedule","deprecated":null},{"api_url":"/api/admin/businesses/:business_id/schedules/:id","http_method":"PUT","short_description":"Update schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin rights for the schedule If trying to set the parent id to something different, must be a group admin of both the current and new parent schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"parent_id","full_name":"parent_id","description":"\n<p>Schedule ID of the parent schedule this schedule belongs to, or NULL if the schedule does not have a parent</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n<p>3rd party unique ID for the schedule</p>\n","required":false,"allow_nil":{"attributes":["code"],"options":{"allow_nil":true,"scope":"business_id"},"klass":"Schedule","covered":[]},"allow_blank":null,"validator":"<br>must be string >= 0 and <= 1000","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_status","full_name":"schedule_status","description":"\n<p>The status of the schedule. Valid values are active and suspended. Default is active</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>active</code>, <code>suspended</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary_business_office_location_id","full_name":"primary_business_office_location_id","description":"\n<p>Business Office Location ID of the primary location this schedule belongs to</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_swap_enabled","full_name":"shift_swap_enabled","description":"\n<p>Indicates whether shift swap feature is enabled</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_swap_needs_approval","full_name":"shift_swap_needs_approval","description":"\n<p>Indicates whether shift swap request needs approval. Effective only when shift swap feature is enabled</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"voluntary_late_clock_out_enabled","full_name":"voluntary_late_clock_out_enabled","description":"\n<p>Indicates whether employees can voluntarily clock out late in the TimeClockApp</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"clock_tracking_enabled","full_name":"clock_tracking_enabled","description":"\n<p>Status of Shift clock-in/out tracking</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"clock_in_threshold","full_name":"clock_in_threshold","description":"\n<p>Minutes before the shift start time in which user can clock in</p>\n","required":null,"allow_nil":{"attributes":["clock_in_threshold"],"options":{"allow_nil":true,"greater_than_or_equal_to":0,"less_than":1440,"only_integer":true}},"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 0, must be less than 1440","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"clock_out_threshold","full_name":"clock_out_threshold","description":"\n<p>Minutes after the shift end time in which user can clock out</p>\n","required":null,"allow_nil":{"attributes":["clock_out_threshold"],"options":{"allow_nil":true,"greater_than_or_equal_to":0,"less_than":1440,"only_integer":true}},"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 0, must be less than 1440","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_earnings","full_name":"show_earnings","description":"\n<p>Indicates whether salary/earnings information should be displayed</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"analytics_enabled","full_name":"analytics_enabled","description":"\n<p>Indicates whether analytics are enabled for the schedule (provided it is enabled for the business)</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data_lake_id","full_name":"data_lake_id","description":"\n<p>Data lake schedule id (used by importer)</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"payroll_cutoff_time","full_name":"payroll_cutoff_time","description":"\n<p>Payroll cutoff time. Default is nil</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be hours and minutes in HH:MM format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_drop_enabled","full_name":"shift_drop_enabled","description":"\n<p>Indicates whether shift drop feature is enabled</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"day_part_template_id","full_name":"day_part_template_id","description":"\n<p>Day part template to apply for this schedule</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rule_set_id","full_name":"rule_set_id","description":"\n<p>ID of the rule set that this schedule is associated with.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pay_cycle_start_date","full_name":"pay_cycle_start_date","description":"\n<p>Start date of the pay cycle</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pay_dates","full_name":"pay_dates","description":"\n<p>Array of integer to determine the day 1 and 2 of bi-monthly pay period</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pay_frequency","full_name":"pay_frequency","description":"\n<p>Pay frequency. Default is ‘weekly’</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>weekly</code>, <code>fortnightly</code>, <code>four_weekly</code>, <code>monthly</code>, <code>quarterly</code>, <code>bi_monthly</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pay_period_enabled","full_name":"pay_period_enabled","description":"\n<p>Indicates whether pay period feature is enabled, Default is false</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pay_period_requires_approval","full_name":"pay_period_requires_approval","description":"\n<p>Indicates whether pay period requires approval after posting. Default is false.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uses_biometrics","full_name":"uses_biometrics","description":"\n<p>Indicates whether biometrics login is enabled, Default is true</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_show_up_threshold","full_name":"shift_show_up_threshold","description":"\n<p>Minutes that shift will shown up on time clock rest screen, Default is 30 minutes</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 0","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"unplanned_shift_start_threshold","full_name":"unplanned_shift_start_threshold","description":"\n<p>Minutes before is considered as unplanned shift start, Default is 60 minutes</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 0","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"approval_needed_for_shift_change","full_name":"approval_needed_for_shift_change","description":"\n<p>Indicates whether manager approval needed on shift change, Default is true</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"approval_needed_for_unplanned_shift","full_name":"approval_needed_for_unplanned_shift","description":"\n<p>Indicates whether manager approval needed on unplanned shift, Default is true</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"approval_needed_for_early_break_end","full_name":"approval_needed_for_early_break_end","description":"\n<p>Indicates whether manager approval needed on early break end, Default is true</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"approval_needed_for_non_compliant_break","full_name":"approval_needed_for_non_compliant_break","description":"\n<p>Indicates whether manager approval needed on non compliant break, Default is true</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"approval_needed_for_pin_login","full_name":"approval_needed_for_pin_login","description":"\n<p>Indicates whether manager approval needed on pin login, Default is true</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"approval_needed_for_minor_violations","full_name":"approval_needed_for_minor_violations","description":"\n<p>Indicates whether manager approval needed on minor violations, Default is true</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"punch_slip_mode","full_name":"punch_slip_mode","description":"\n<p>The status of print punch slip mode. Default is optional.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>always</code>, <code>optional</code>, <code>never</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rest_screen_theme","full_name":"rest_screen_theme","description":"\n<p>Indicates whether dark or light rest screen theme, Default is provided from business config</p>\n","required":null,"allow_nil":{"attributes":["rest_screen_theme"],"options":{"allow_nil":true,"in":["dark","light"],"message":"invalid"},"delimiter":["dark","light"]},"allow_blank":null,"validator":"must be one of <code>dark</code>, <code>light</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_gfe_enabled","full_name":"auto_gfe_enabled","description":"\n<p>Indicates whether GFE is generated automatically or not</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_gfe_config","full_name":"auto_gfe_config","description":"\n<p>Configuration params for auto generating GFE, containing keys: [“start_date”, “at_hour”]</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_publish_enabled","full_name":"auto_publish_enabled","description":"\n<p>Indicates whether the schedule is published automatically or not</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_publish_config","full_name":"auto_publish_config","description":"\n<p>Configuration params for auto publishing the schedule, containing keys: [“start_date”, “at_hour”, “warning_enabled”, “warning_days”, “auto_publish_interval_days”]</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_start_date","full_name":"compliance_start_date","description":"\n<p>If configured, compliance warnings prior to this date will be hidden from the ui</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"labour_cost_percentage_enabled","full_name":"labour_cost_percentage_enabled","description":"\n<p>Indicates whether auto-scheduling should use a labour-cost percentage</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"labour_cost_percentage","full_name":"labour_cost_percentage","description":"\n<p>Array of each day of the week (starting Sunday) with a labour-cost percentage, for use in auto-scheduling</p>\n","required":null,"allow_nil":null,"allow_blank":{"attributes":["labour_cost_percentage"],"options":{"is":7,"allow_blank":true}},"validator":"must be string with length 7","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"populate_schedule_enabled","full_name":"populate_schedule_enabled","description":"\n<p>Indicates whether populate schedule jobs can run on this schedule</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employee_multi_rate_enabled","full_name":"employee_multi_rate_enabled","description":"\n<p>Indicates if employee multi-rate is enabled. Default is false.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_populate_schedule_enabled","full_name":"auto_populate_schedule_enabled","description":"\n<p>Indicates whether populate schedule jobs are run automatically on this schedule</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code><br>must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_populate_schedule_days_in_advance","full_name":"auto_populate_schedule_days_in_advance","description":"\n<p>How many days in advance to auto populate the schedule</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 1, must be less than or equal to 60","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"auto_populate_schedule_at_time","full_name":"auto_populate_schedule_at_time","description":"\n<p>Time of the day the auto populate schedule job should be run</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 0, must be less than or equal to 23","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_clock_app_workflow","full_name":"time_clock_app_workflow","description":"\n<p>Time clock app workflow</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"populate_schedule_replanning_enabled","full_name":"populate_schedule_replanning_enabled","description":"\n<p>Indicates if populate schedule replanning is enabled. Default is false.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"aos_config","full_name":"aos_config","description":"\n<p>Configuration JSON used by AOS</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"idle_timeout_enabled","full_name":"idle_timeout_enabled","description":"","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"idle_timeout_length","full_name":"idle_timeout_length","description":"\n<p>Length of inactivity in minutes before the user is logged out. Must be between 2 and 200.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 2, must be less than or equal to 200","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_can_overlap_leave_request","full_name":"shift_can_overlap_leave_request","description":"\n<p>Allow shifts to overlap leave requests. Default is true.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_can_overlap_unavailability","full_name":"shift_can_overlap_unavailability","description":"\n<p>Allow shifts to overlap unavailability. Default is true.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_multi_rate_enabled","full_name":"shift_multi_rate_enabled","description":"\n<p>Enable schedule to support multi-rate shift, time clock. Default is false.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_clock_role_rate_change_auth_threshold","full_name":"time_clock_role_rate_change_auth_threshold","description":"\n<p>The time in minutes that job rate switch is requested with manager authorize. Default is 10</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 1, must be less than or equal to 15","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"approval_needed_for_role_rate_change","full_name":"approval_needed_for_role_rate_change","description":"\n<p>Indicates whether manager approval needed on role rate change, Default is true</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pay_period_auto_approval_settings","full_name":"pay_period_auto_approval_settings","description":"\n<p>Pay period auto approval settings</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pay_period_auto_approval_enabled","full_name":"pay_period_auto_approval_enabled","description":"\n<p>Whether pay period auto approval is enabled. Default is false.</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"transfer_group_id","full_name":"transfer_group_id","description":"\n<p>Transfer Group ID this schedule belongs to</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sharing_group_id","full_name":"sharing_group_id","description":"\n<p>Sharing Group ID this schedule belongs to</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/unavailability_events","name":"unavailability_events","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/unavailability_events","http_method":"GET","short_description":"Fetch unavailability events for the schedule","deprecated":null}],"formats":["json"],"full_description":"\n<p>If time_range is specified, only events within the given date range will be fetched. If employment_ids is specified, only events raised by the given employments will be fetched. Only returns events for managed employments.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_ids","full_name":"employment_ids","description":"\n<p>Employment Ids to restrict results to</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_shifts","name":"import_shifts","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_shifts","http_method":"POST","short_description":"Import shifts to the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>shift_code (required)</p>\n</li><li>\n<p>planned_roles (required when creating a new shift)</p>\n</li><li>\n<p>business_location_code (required when creating a new shift)</p>\n</li><li>\n<p>shift_start_time (required when creating a new shift)</p>\n</li><li>\n<p>shift_end_time (required when creating a new shift)</p>\n</li><li>\n<p>queued_employment_code</p>\n</li><li>\n<p>shift_description</p>\n</li><li>\n<p>shift_title</p>\n</li><li>\n<p>planned_breaks</p>\n</li><li>\n<p>assignment_status - Valid values are nil (no action), accepted (accept the shift) and rejected (reject the shift).  Only occurs when the shift is published.</p>\n</li><li>\n<p>shift_type - (enum of offer, offer_to_all, roster, time_off)</p>\n</li><li>\n<p>is_absent - Valid values are nil (no action), true or false</p>\n</li><li>\n<p>time_off_type_code (required when creating a time-off shift)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a shift to import.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of shift details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"publish_all","full_name":"publish_all","description":"\n<p>When true, all imported shifts are immediately published. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"skip_active_shifts","full_name":"skip_active_shifts","description":"\n<p>When true, existing published shifts with user(s) assigned are not updated. Defaults to false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_employee_to_role","full_name":"assign_employee_to_role","description":"\n<p>Whether to automatically assign the shifts employee to the shifts role. Defaults to false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_employee_to_location","full_name":"assign_employee_to_location","description":"\n<p>NOTE: DEPRECATED. PARAMETER IGNORED. Whether to automatically assign the shifts employee to the shifts location. Defaults to false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"assign_employee_to_schedule","full_name":"assign_employee_to_schedule","description":"\n<p>Whether to automatically assign the employee to the shifts schedule and make them schedulable. Defaults to false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_blackout_days","name":"import_blackout_days","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_blackout_days","http_method":"POST","short_description":"Import a blackout day to the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- title (required)\n- start_date (required)\n- end_date (required)</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a blackout day entry to import.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of blackout day details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_schedule_roles","name":"import_schedule_roles","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_schedule_roles","http_method":"POST","short_description":"Import a schedule role mapping","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- business_role_code (required)\n- threshold (required)</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a schedule role entry to import.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of schedule role details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_schools","name":"import_schools","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_schools","http_method":"POST","short_description":"Import schools to the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- name (required)\n- start_time_of_day (required)\n- end_time_of_day (required)\n- days_of_week (required)\n- time_zone</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a school entry to import.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of school details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_school_holidays","name":"import_school_holidays","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_school_holidays","http_method":"POST","short_description":"Import school holidays to the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- name (required)\n- school_name (required)\n- start_date (required)\n- end_date (required)\n- start_time_of_day (required)\n- end_time_of_day (required)</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a school holiday entry to import.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of school holiday details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_time_clocks","name":"import_time_clocks","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_time_clocks","http_method":"POST","short_description":"Import time clock entries (clock in/out & actual breaks) to the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>time_clock_code</p>\n</li><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>business_location_code (required)</p>\n</li><li>\n<p>clock_in (required)</p>\n</li><li>\n<p>clock_out</p>\n</li><li>\n<p>breaks</p>\n</li><li>\n<p>shift_code</p>\n</li><li>\n<p>business_role_code</p>\n</li><li>\n<p>deleted</p>\n</li><li>\n<p>employee_approved</p>\n</li><li>\n<p>employee_approval_time</p>\n</li><li>\n<p>clock_in_meta</p>\n</li><li>\n<p>clock_out_meta</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a time clock entry to import.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of time clock details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"replace","full_name":"replace","description":"\n<p>Whether to delete all existing time clock entries within the given time range prior to import</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_time_clock_events","name":"import_time_clock_events","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_time_clock_events","http_method":"POST","short_description":"Import time clock events to the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>time_clock_id (required) - will be used to find or create time clock. If replace param is true, id will be used to scope down the punches that need to be replaced</p>\n</li><li>\n<p>employment_code (required)</p>\n</li><li>\n<p>business_role_code</p>\n</li><li>\n<p>punch_id (required) - will be used to replace the previous punch if found within time clock with the provided code and replace param is true</p>\n</li><li>\n<p>event_type (required)</p>\n</li><li>\n<p>punch_type (require for punch type events)</p>\n</li><li>\n<p>performed_by</p>\n</li><li>\n<p>punch_time (required for clock in and out event)</p>\n</li><li>\n<p>employee_initiated_change</p>\n</li><li>\n<p>punch_method</p>\n</li><li>\n<p>break_type (required for break_start event)</p>\n</li><li>\n<p>paid_break</p>\n</li><li>\n<p>event_code</p>\n</li><li>\n<p>rate_preference_index</p>\n</li><li>\n<p>skip_rules</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a time clock event entry to import.</p>\n\n<p>The skip_rules boolean column is optional, if defined as a column it must be present, and it must only be true if the client software knows for sure that the only things it is adding do not affect rules engine output (such as the event_code column). This allows the rules engine to do less work or be skipped entirely in some circumstances.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of time clock details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"replace","full_name":"replace","description":"\n<p>Whether to delete all existing time clock entries within the given time range prior to import</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_misc_pays","name":"import_misc_pays","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_misc_pays","http_method":"POST","short_description":"Import misc pay entries to the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n\n<pre>- employment_code (required)\n- misc_pay_type_code (required)\n- pay_date (required)\n- seconds (required if misc_pay_type is hour_based)\n- actual_work_date\n- earnings (required if misc_pay_type is not hour_based)\n- code\n- description</pre>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a misc pay entry to import.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of misc pay details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"replace","full_name":"replace","description":"\n<p>Whether to delete all existing misc pay entries within the given time range prior to import</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/aggregate_actuals","name":"aggregate_actuals","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/aggregate_actuals","http_method":"GET","short_description":"Report the total actuals in seconds worked on this schedule per role per day in the date range given","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Date+Parameters\" class=\"legacy-anchor\"></span>\n<h2 id=\"date-parameters\"><a href=\"#date-parameters\">Date Parameters</a></h2>\n\n<p>Parameters start_date and end_date are interpreted as in the time zone of the schedule’s primary business location.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/schedulable_employment_ids","name":"schedulable_employment_ids","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/schedulable_employment_ids","http_method":"POST","short_description":"Employees who are schedulable within this schedule","deprecated":null}],"formats":["json"],"full_description":"\n<p>Returns the availability status of employees who are schedulable within the specified schedule. An employee is schedulable when they have the schedulable flag set to true for this schedule, are not deleted. <strong>start_date_time &amp; end_date_time</strong> defines the time range for which to check employee availability. There are also the following additional optional inputs:</p>\n\n<pre>- When business_role_id is specified, the returned employees are filtered to only those who are assigned those roles.\n- When shift_id is specified, every employee in that shift&#39;s assigned queue are always returned in the results (regardless of any other filters).\n- When employment_ids are specified, results are restricted to the supplied ids.</pre>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_id","full_name":"shift_id","description":"\n<p>Shift ID</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_role_id","full_name":"business_role_id","description":"\n<p>Array of Business Role IDs to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_ids","full_name":"employment_ids","description":"\n<p>Employment Ids to restrict results to</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managers_only","full_name":"managers_only","description":"\n<p>Filter employments by managers. Default to false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/day_part_template","name":"day_part_template","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/day_part_template","http_method":"GET","short_description":"Get day part template information for this schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/day_part_occurrences","name":"day_part_occurrences","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/day_part_occurrences","http_method":"GET","short_description":"Get day parts occurrences for this schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/autobreaks","name":"autobreaks","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/autobreaks","http_method":"POST","short_description":"Generate autobreaks for specified shifts","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_ids","full_name":"shift_ids","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/populate","name":"populate","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/populate","http_method":"POST","short_description":"Populate a date range of the schedule with an optimised set of shifts","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"populate_mode","full_name":"populate_mode","description":"\n<p>The populate mode of aos. Valid values are normal and replanning. Default is normal</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>normal</code>, <code>replanning</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"timeout_sec","full_name":"timeout_sec","description":"\n<p>Timeout for the asynchronous production of results, in seconds</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dry_run","full_name":"dry_run","description":"\n<p>When true, merely test if a call with dry_run: false would succeed</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"duration_seconds","full_name":"duration_seconds","description":"\n<p>Time taken while doing AOS</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/cancel_populate","name":"cancel_populate","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/cancel_populate","http_method":"POST","short_description":"Cancel the current populate schedule job, if any","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_shift_template_categories","name":"import_shift_template_categories","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_shift_template_categories","http_method":"POST","short_description":"Import shift template categories to the given business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>code (required)</p>\n</li><li>\n<p>name (required)</p>\n</li><li>\n<p>parent_category_code</p>\n</li><li>\n<p>order</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a shift template category to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have employee manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of template categories to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-schedules/import_shift_templates","name":"import_shift_templates","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:id/import_shift_templates","http_method":"POST","short_description":"Import shift templates to the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Column+Names\" class=\"legacy-anchor\"></span>\n<h2 id=\"column-names\"><a href=\"#column-names\">Column Names</a></h2>\n\n<p>Column Names is an array of strings, which defines the order of fields in the rows array. Valid column names are:</p>\n<ul><li>\n<p>shift_template_code (required)</p>\n</li><li>\n<p>name (required)</p>\n</li><li>\n<p>description</p>\n</li><li>\n<p>shift_title</p>\n</li><li>\n<p>shift_description</p>\n</li><li>\n<p>shift_type (required)</p>\n</li><li>\n<p>planned_breaks</p>\n</li><li>\n<p>planned_templates (required)</p>\n</li><li>\n<p>shift_template_category_code (required)</p>\n</li></ul>\n\n<span id=\"label-Rows\" class=\"legacy-anchor\"></span>\n<h2 id=\"rows\"><a href=\"#rows\">Rows</a></h2>\n\n<p>Rows is an array of arrays, where each sub-array defines a template to import or update.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights in the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"partial_success","full_name":"partial_success","description":"\n<p>When true, failure of a single row will not prevent import of successful rows. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"column_names","full_name":"column_names","description":"\n<p>An array of column headers, defining the structure of the rows array</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rows","full_name":"rows","description":"\n<p>An array of template details to import</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-shift_drops":{"doc_url":"/doc/1.0/admin-shift_drops","id":"admin-shift_drops","api_url":"/api","name":"Admin::Shift_drops","short_description":"Shift Drop Requests","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-shift_drops/pending_drops","name":"pending_drops","apis":[{"api_url":"/api/admin/businesses/:business_id/shifts/pending_drops","http_method":"GET","short_description":"Pending Shift drop requests submitted for manager approval","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-shift_drops/drop_offers","name":"drop_offers","apis":[{"api_url":"/api/admin/businesses/:business_id/shifts/:id/drop_offers","http_method":"GET","short_description":"Employees the shift drop has been offered to","deprecated":null}],"formats":["json"],"full_description":"\n<pre>== Security</pre>\n\n<p>Must have service manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-shift_drops/add_drop_offers","name":"add_drop_offers","apis":[{"api_url":"/api/admin/businesses/:business_id/shifts/:id/drop_offers","http_method":"PUT","short_description":"Offer the shift drop to additional employees","deprecated":null}],"formats":["json"],"full_description":"\n<pre>== Security</pre>\n\n<p>Must have service manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_ids","full_name":"employment_ids","description":"\n<p>Employment IDs</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-shift_drops/approve_drop","name":"approve_drop","apis":[{"api_url":"/api/admin/businesses/:business_id/shifts/:id/approve_drop","http_method":"PUT","short_description":"Approve the drop request","deprecated":null}],"formats":["json"],"full_description":"\n<pre>== Security</pre>\n\n<p>Must have service manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employment ID to accept the drop request</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_check","full_name":"compliance_warning_check","description":"\n<p>Whether to check the action causes new compliance warnings. Default = ‘do_not_check’.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>do_not_check</code>, <code>check_without_saving</code>, <code>check_and_save</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_severity","full_name":"compliance_warning_severity","description":"\n<p>If supplied compliance warnings with severity less than or equal to compliance_warning_severity will be filtered to perform compliance_warnings_check. Effective when ‘compliance_warnings_check’ is check_without_saving or check_and_save. If this value is ‘0’ no severity filtering is performed. Default: 0.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prevent_critical_errors","full_name":"prevent_critical_errors","description":"\n<p>If supplied and is false, severity 1 errors will not be blocking actions. Default is true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_employee_initiated","full_name":"shift_offer_employee_initiated","description":"\n<p>Whether the change is initiated by employee</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_manager_message","full_name":"shift_offer_manager_message","description":"\n<p>Any message to the employee while requesting for consent</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-shift_drops/reject_drop","name":"reject_drop","apis":[{"api_url":"/api/admin/businesses/:business_id/shifts/:id/reject_drop","http_method":"PUT","short_description":"Reject the drop request","deprecated":null}],"formats":["json"],"full_description":"\n<pre>== Security</pre>\n\n<p>Must have service manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-shifts":{"doc_url":"/doc/1.0/admin-shifts","id":"admin-shifts","api_url":"/api","name":"Admin::Shifts","short_description":"Shifts","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-shifts/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:schedule_id/shifts","http_method":"GET","short_description":"Get all shifts of the schedule","deprecated":null}],"formats":["json"],"full_description":"\n<p>The results will be restricted to the time range if supplied.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-shifts/batch_update","name":"batch_update","apis":[{"api_url":"/api/admin/businesses/:business_id/shifts/batch_update","http_method":"PUT","short_description":"Update multiple shifts","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the shift’s schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shifts","full_name":"shifts","description":"\n<p>An array of shift update objects.  Must contain at minimum the id of the shift.  For allowed attributes, see update shift endpoint.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_check","full_name":"compliance_warning_check","description":"\n<p>Whether to check the action causes new compliance warnings. Default = ‘do_not_check’.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>do_not_check</code>, <code>check_without_saving</code>, <code>check_and_save</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_severity","full_name":"compliance_warning_severity","description":"\n<p>If supplied compliance warnings with severity less than or equal to compliance_warning_severity will be filtered to perform compliance_warnings_check. Effective when ‘compliance_warnings_check’ is check_without_saving or check_and_save. If this value is ‘0’ no severity filtering is performed. Default: 0.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prevent_critical_errors","full_name":"prevent_critical_errors","description":"\n<p>If supplied and is false, severity 1 errors will not be blocking actions. Default is true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_employee_initiated","full_name":"shift_offer_employee_initiated","description":"\n<p>Whether the change is initiated by employee</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_manager_message","full_name":"shift_offer_manager_message","description":"\n<p>Any message to the employee while requesting for consent</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-shifts/destroy","name":"destroy","apis":[{"api_url":"/api/admin/businesses/:business_id/shifts/:id","http_method":"DELETE","short_description":"Delete shift","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reason","full_name":"reason","description":"\n<p>Reason for deleting the shift</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_check","full_name":"compliance_warning_check","description":"\n<p>Whether to check the action causes new compliance warnings. Default = ‘do_not_check’.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>do_not_check</code>, <code>check_without_saving</code>, <code>check_and_save</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_severity","full_name":"compliance_warning_severity","description":"\n<p>If supplied compliance warnings with severity less than or equal to compliance_warning_severity will be filtered to perform compliance_warnings_check. Effective when ‘compliance_warnings_check’ is check_without_saving or check_and_save. If this value is ‘0’ no severity filtering is performed. Default: 0.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prevent_critical_errors","full_name":"prevent_critical_errors","description":"\n<p>If supplied and is false, severity 1 errors will not be blocking actions. Default is true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_employee_initiated","full_name":"shift_offer_employee_initiated","description":"\n<p>Whether the change is initiated by employee</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_manager_message","full_name":"shift_offer_manager_message","description":"\n<p>Any message to the employee while requesting for consent</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force","full_name":"force","description":"\n<p>Whether to force delete the shift. Default = false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-shifts/batch_delete","name":"batch_delete","apis":[{"api_url":"/api/admin/businesses/:business_id/shifts/batch_delete","http_method":"PUT","short_description":"Delete multiple shifts","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights in the business</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"ids","full_name":"ids","description":"\n<p>An array of Shift IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"hard_delete","full_name":"hard_delete","description":"\n<p>Whether to hard delete shifts. Default = false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_check","full_name":"compliance_warning_check","description":"\n<p>Whether to check the action causes new compliance warnings. Default = ‘do_not_check’.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>do_not_check</code>, <code>check_without_saving</code>, <code>check_and_save</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_severity","full_name":"compliance_warning_severity","description":"\n<p>If supplied compliance warnings with severity less than or equal to compliance_warning_severity will be filtered to perform compliance_warnings_check. Effective when ‘compliance_warnings_check’ is check_without_saving or check_and_save. If this value is ‘0’ no severity filtering is performed. Default: 0.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prevent_critical_errors","full_name":"prevent_critical_errors","description":"\n<p>If supplied and is false, severity 1 errors will not be blocking actions. Default is true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_employee_initiated","full_name":"shift_offer_employee_initiated","description":"\n<p>Whether the change is initiated by employee</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_manager_message","full_name":"shift_offer_manager_message","description":"\n<p>Any message to the employee while requesting for consent</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-shifts/cancel_pending_changes","name":"cancel_pending_changes","apis":[{"api_url":"/api/admin/businesses/:business_id/shifts/:id/cancel_pending_changes","http_method":"PUT","short_description":"Cancel changes pending consent from employee","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-time_clock_devices":{"doc_url":"/doc/1.0/admin-time_clock_devices","id":"admin-time_clock_devices","api_url":"/api","name":"Admin::Time_clock_devices","short_description":"Time Clock Device","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-time_clock_devices/create","name":"create","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:schedule_id/time_clock_devices","http_method":"POST","short_description":"Create a time clock device entry","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre>Must have group admin rights for the schedule of time clock device</pre>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule Id of the time clock device</p>\n","required":{"attributes":["schedule_id"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"must be a UUID<br>can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>Name of the time clock device</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-time_clock_devices/destroy","name":"destroy","apis":[{"api_url":"/api/admin/businesses/:business_id/time_clock_devices/:id","http_method":"DELETE","short_description":"Delete Time Clock Device","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre>Must have group admin rights for the schedule of time clock device</pre>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Time Clock Device ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-time_clocks":{"doc_url":"/doc/1.0/admin-time_clocks","id":"admin-time_clocks","api_url":"/api","name":"Admin::Time_clocks","short_description":"Time clock entries of the employees","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-time_clocks/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/schedules/:schedule_id/time_clocks","http_method":"GET","short_description":"Get time clock entries","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule id to filter by</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is exclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_role_id","full_name":"business_role_id","description":"\n<p>Role id to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employment id to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exclude_deleted","full_name":"exclude_deleted","description":"\n<p>Optional filter to exclude deleted time clocks</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-time_clocks/destroy","name":"destroy","apis":[{"api_url":"/api/admin/businesses/:business_id/time_clocks/:id","http_method":"DELETE","short_description":"Destroy a specific time clock entry","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights for the schedule of time clock entry</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Time clock ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-unavailability_events":{"doc_url":"/doc/1.0/admin-unavailability_events","id":"admin-unavailability_events","api_url":"/api","name":"Admin::Unavailability_events","short_description":"Approve or reject unavailability events created by employees","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-unavailability_events/index","name":"index","apis":[{"api_url":"/api/admin/businesses/:business_id/employments/:employment_id/unavailability_events","http_method":"GET","short_description":"Get all unavailability events of an employee","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employment id</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-unavailability_events/show","name":"show","apis":[{"api_url":"/api/admin/businesses/:business_id/unavailability_events/:id","http_method":"GET","short_description":"Fetch a specific unavailability event request of the employee","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Unavailability Event ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-unavailability_events/manager_response","name":"manager_response","apis":[{"api_url":"/api/admin/businesses/:business_id/unavailability_events/:id/manager_response","http_method":"PUT","short_description":"Manager response to a pending unavailability event request","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be able to schedule the employee making the unavailability event request</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Unavailability Event ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"status","full_name":"status","description":"\n<p>Approve or Reject the unavailability event request</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>approved</code>, <code>rejected</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manager_message","full_name":"manager_message","description":"\n<p>Message from the approving manager</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be string <= 500","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"dry_run","full_name":"dry_run","description":"\n<p>When true, determine whether a call with dry_run: false is likely to succeed</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-unavailability_events/violations","name":"violations","apis":[{"api_url":"/api/admin/businesses/:business_id/unavailability_events/:id/violations","http_method":"GET","short_description":"Blackout Day and Role Threshold violations of the Unavailability event for the given schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Unavailability Event ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-unavailability_events/pending_requests","name":"pending_requests","apis":[{"api_url":"/api/admin/businesses/:business_id/unavailability_events/pending_requests","http_method":"GET","short_description":"Unavailability event requests submitted for manager approval","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth-business_invites":{"doc_url":"/doc/1.0/auth-business_invites","id":"auth-business_invites","api_url":"/api","name":"Auth::Business_invites","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/auth-business_invites/show","name":"show","apis":[{"api_url":"/auth/business_invites/:id","http_method":"GET","short_description":"Get a business invite by token","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Open endpoint, no authentication</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Invitation confirmation token</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String of min length 8 and max length 24","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/auth-business_invites/reject","name":"reject","apis":[{"api_url":"/auth/business_invites/:id/reject","http_method":"PUT","short_description":"Business invite rejection","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be logged in</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Invitation confirmation token</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String of min length 8 and max length 24","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth-sessions":{"doc_url":"/doc/1.0/auth-sessions","id":"auth-sessions","api_url":"/api","name":"Auth::Sessions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/auth-sessions/create","name":"create","apis":[{"api_url":"/auth/sign_in","http_method":"POST","short_description":"Sign in to the application & optionally register a device","deprecated":null}],"formats":null,"full_description":"\n<p>If token and category are defined, the device token is registered as part of the sign in</p>\n","errors":[],"params":[{"name":"email","full_name":"email","description":"\n<p>Email address of the user</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n<p>Password of the user</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"token","full_name":"token","description":"\n<p>Device token</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"category","full_name":"category","description":"\n<p>Device category</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>ios</code>, <code>android</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/auth-sessions/destroy","name":"destroy","apis":[{"api_url":"/auth/sign_out","http_method":"DELETE","short_description":"Sign out of the application","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/auth-sessions/renew_auth_token","name":"renew_auth_token","apis":[{"api_url":"/auth/renew_auth_token","http_method":"GET","short_description":"Validate authentication token and get a new valid one","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must provide a valid auth token</p>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"client_support-audit_logs":{"doc_url":"/doc/1.0/client_support-audit_logs","id":"client_support-audit_logs","api_url":"/api","name":"Client_support::Audit_logs","short_description":"Controller to view the audit logs","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/client_support-audit_logs/index","name":"index","apis":[{"api_url":"/client_support/audit_logs","http_method":"GET","short_description":"Get audit logs","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be business-owner of the Business</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>UUID of the business</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"performed_by","full_name":"performed_by","description":"\n<p>UUID of the employment which performed the actions</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"obj_type","full_name":"obj_type","description":"\n<p>Object type to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"obj_id","full_name":"obj_id","description":"\n<p>UUID of the object to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"request_id","full_name":"request_id","description":"\n<p>UUID of the request to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"action_type","full_name":"action_type","description":"\n<p>Type of action to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>created</code>, <code>updated</code>, <code>deleted</code>, <code>specific</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"specific_action","full_name":"specific_action","description":"\n<p>Type of specific_action to filter by</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"limit","full_name":"limit","description":"\n<p>To limit the number of results</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"internal-push_notifications":{"doc_url":"/doc/1.0/internal-push_notifications","id":"internal-push_notifications","api_url":"/api","name":"Internal::Push_notifications","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/internal-push_notifications/create","name":"create","apis":[{"api_url":"/internal/push_notifications","http_method":"POST","short_description":"Create a push notification","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Should be restricted to trusted IPs in production.</p>\n","errors":[],"params":[{"name":"user_id","full_name":"user_id","description":"\n<p>User to notify</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"device_id","full_name":"device_id","description":"\n<p>Device UUID to notify</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"jabber_domain","full_name":"jabber_domain","description":"\n<p>Domain component of user JID (optional)</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"internal-reporting":{"doc_url":"/doc/1.0/internal-reporting","id":"internal-reporting","api_url":"/api","name":"Internal::Reporting","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/internal-reporting/clients_per_store","name":"clients_per_store","apis":[{"api_url":"/internal/reporting/clients_per_store","http_method":"GET","short_description":"Get Data about each store for Internal Reporting purposes","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"internal-test_helper":{"doc_url":"/doc/1.0/internal-test_helper","id":"internal-test_helper","api_url":"/api","name":"Internal::Test_helper","short_description":"For test automation only","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/internal-test_helper/create_account_for_employment","name":"create_account_for_employment","apis":[{"api_url":"/internal/businesses/:business_id/create_account_for_employment","http_method":"POST","short_description":"Create confirmed account, link to employment and accept business invite","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have business owner rights</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_ids","full_name":"employment_ids","description":"\n<p>An array of employment ids</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/internal-test_helper/force_destroy","name":"force_destroy","apis":[{"api_url":"/internal/businesses/:business_id/force_destroy","http_method":"DELETE","short_description":"Force delete the business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be have business owner rights</p>\n\n<p>Cannot be called in production or demo environments</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"internal-workflows":{"doc_url":"/doc/1.0/internal-workflows","id":"internal-workflows","api_url":"/api","name":"Internal::Workflows","short_description":"Workflow storage api for timeclock","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/internal-workflows/upsert","name":"upsert","apis":[{"api_url":"/internal/workflow","http_method":"POST","short_description":"Upload a workflow","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">have</span> <span class=\"ruby-identifier\">business</span> <span class=\"ruby-identifier\">owner</span> <span class=\"ruby-identifier\">rights</span>\n</pre>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"name","description":"\n<p>Workflow name</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"can't be blank<br>must be string <= 100","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"description","full_name":"description","description":"\n<p>Optional description of the workflow. May include current API version</p>\n","required":false,"allow_nil":{"attributes":["description"],"options":{"allow_nil":true,"maximum":500}},"allow_blank":null,"validator":"must be string <= 500","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"content","full_name":"content","description":"\n<p>Full workflow for business</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/internal-workflows/index","name":"index","apis":[{"api_url":"/internal/workflows","http_method":"GET","short_description":"Return list of all workflow(s) in a business (not the content)","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">have</span> <span class=\"ruby-identifier\">business</span> <span class=\"ruby-identifier\">owner</span> <span class=\"ruby-identifier\">rights</span>\n</pre>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/internal-workflows/content","name":"content","apis":[{"api_url":"/internal/workflows/:id/content","http_method":"GET","short_description":"Download a specific workflow","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">have</span> <span class=\"ruby-identifier\">business</span> <span class=\"ruby-identifier\">owner</span> <span class=\"ruby-identifier\">rights</span>\n</pre>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Workflow ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-absent_reasons":{"doc_url":"/doc/1.0/time_clock_app-absent_reasons","id":"time_clock_app-absent_reasons","api_url":"/api","name":"Time_clock_app::Absent_reasons","short_description":"Controller to get absent reasons","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-absent_reasons/index","name":"index","apis":[{"api_url":"/api/time_clock_app/absent_reasons","http_method":"GET","short_description":"Get absent_reasons of a business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-break_types":{"doc_url":"/doc/1.0/time_clock_app-break_types","id":"time_clock_app-break_types","api_url":"/api","name":"Time_clock_app::Break_types","short_description":"Controller to get break types details","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-break_types/index","name":"index","apis":[{"api_url":"/api/time_clock_app/break_types","http_method":"GET","short_description":"Get break_types of a business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-employment_biometric_responses":{"doc_url":"/doc/1.0/time_clock_app-employment_biometric_responses","id":"time_clock_app-employment_biometric_responses","api_url":"/api","name":"Time_clock_app::Employment_biometric_responses","short_description":"Controller to send biometric disclaimer response","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-employment_biometric_responses/respond","name":"respond","apis":[{"api_url":"/api/time_clock_app/employments/:employment_id/employment_biometric_responses/respond","http_method":"POST","short_description":"Respond to the latest biometric disclaimer","deprecated":null}],"formats":["json"],"full_description":"\n<p>Creates a new biometric_disclaimer_response for the time clock and schedule. If declined, automatically delete all biometrics data for the employee (excluding PIN).</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_type","full_name":"response_type","description":"\n<p>Response type to be recorded</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"biometric_disclaimer_id","full_name":"biometric_disclaimer_id","description":"\n<p>Biometric Disclaimer</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"security_type","full_name":"security_type","description":"\n<p>Employment Security Type</p>\n","required":{"attributes":["security_type"],"options":{}},"allow_nil":null,"allow_blank":null,"validator":"can't be blank","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-employment_metadata":{"doc_url":"/doc/1.0/time_clock_app-employment_metadata","id":"time_clock_app-employment_metadata","api_url":"/api","name":"Time_clock_app::Employment_metadata","short_description":"Controller to upsert employment metadata","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-employment_metadata/upsert","name":"upsert","apis":[{"api_url":"/api/time_clock_app/employment_metadata/:id/upsert","http_method":"PUT","short_description":"Upsert the employment metadata","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Employment Metadata ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata_type_name","full_name":"metadata_type_name","description":"\n<p>Metadata type name</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"punch_method","full_name":"punch_method","description":"\n<p>Contains the login method used by the employee to login to the timeclock app</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>manual</code>, <code>biometrics</code>, <code>pin</code>, <code>system</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"updated_by_id","full_name":"updated_by_id","description":"\n<p>The updater id</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>The associated employment id</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_time","full_name":"start_time","description":"\n<p>start time for a time-boxed metadata entry</p>\n","required":false,"allow_nil":{"attributes":["start_time"],"options":{"allow_nil":true}},"allow_blank":null,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"end_time","description":"\n<p>end time for a time-boxed metadata entry</p>\n","required":false,"allow_nil":{"attributes":["end_time"],"options":{"allow_nil":true}},"allow_blank":null,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"details","full_name":"details","description":"\n<p>metadata value</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"punched_at","full_name":"punched_at","description":"\n<p>punched at</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"punched_by_id","full_name":"punched_by_id","description":"\n<p>punched by employee</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-employment_securities":{"doc_url":"/doc/1.0/time_clock_app-employment_securities","id":"time_clock_app-employment_securities","api_url":"/api","name":"Time_clock_app::Employment_securities","short_description":"Controller to view employments securities","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-employment_securities/upsert","name":"upsert","apis":[{"api_url":"/api/time_clock_app/employments/:employment_id/employment_securities/upsert","http_method":"PUT","short_description":"Update or create employment security","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"signature","full_name":"signature","description":"\n<p>Employment Signature</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Employment Security Type</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-employment_securities/destroy","name":"destroy","apis":[{"api_url":"/api/time_clock_app/employments/:employment_id/employment_securities/destroy","http_method":"DELETE","short_description":"Delete employment security","deprecated":null}],"formats":["json"],"full_description":"\n<p>Optionally provide a type parameter of the type to delete.</p>\n\n<p>If not provided, all non “pin” biometric data is deleted.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Employment Security Type</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-employments":{"doc_url":"/doc/1.0/time_clock_app-employments","id":"time_clock_app-employments","api_url":"/api","name":"Time_clock_app::Employments","short_description":"Controller to view employments details","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-employments/index","name":"index","apis":[{"api_url":"/api/time_clock_app/employments","http_method":"GET","short_description":"Get employments of a store","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-employments/show","name":"show","apis":[{"api_url":"/api/time_clock_app/employments/:id","http_method":"GET","short_description":"Get employment details by id","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-employments/lookup","name":"lookup","apis":[{"api_url":"/api/time_clock_app/employments/lookup","http_method":"POST","short_description":"Get employments by id","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>An array of employment IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-employments/terminated_employment_ids","name":"terminated_employment_ids","apis":[{"api_url":"/api/time_clock_app/employments/terminated_employment_ids","http_method":"GET","short_description":"Get terminated employment ids","deprecated":null}],"formats":["json"],"full_description":"\n<p>returns employment ids that have been terminated within the provided time range The results will be restricted to given time range.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-employments/update","name":"update","apis":[{"api_url":"/api/time_clock_app/employments/:id","http_method":"PATCH","short_description":"Update employment details","deprecated":null},{"api_url":"/api/time_clock_app/employments/:id","http_method":"PUT","short_description":"Update employment details","deprecated":null}],"formats":["json"],"full_description":"\n<p>only allow to update locale per employment</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"locale","description":"\n<p>Locale</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-employments/employment_metadata","name":"employment_metadata","apis":[{"api_url":"/api/time_clock_app/employments/employment_metadata","http_method":"POST","short_description":"Get employment metadata details","deprecated":null}],"formats":["json"],"full_description":"\n<p>Returns employment metadata for the passed employment IDs and metadata types. Returns all metadata that was not expired at any point in time between +/- 1 week around the current time.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"employment_ids","full_name":"employment_ids","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"required_metadata","full_name":"required_metadata","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-job_titles":{"doc_url":"/doc/1.0/time_clock_app-job_titles","id":"time_clock_app-job_titles","api_url":"/api","name":"Time_clock_app::Job_titles","short_description":"Controller to get job title details","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-job_titles/index","name":"index","apis":[{"api_url":"/api/time_clock_app/job_titles","http_method":"GET","short_description":"Get job titles of a business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-job_titles/lookup","name":"lookup","apis":[{"api_url":"/api/time_clock_app/job_titles/lookup","http_method":"POST","short_description":"Get job titles by id","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n<p>An array of job title IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-notifications":{"doc_url":"/doc/1.0/time_clock_app-notifications","id":"time_clock_app-notifications","api_url":"/api","name":"Time_clock_app::Notifications","short_description":"Controller to work with employee notifications","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-notifications/summary","name":"summary","apis":[{"api_url":"/api/time_clock_app/notifications/summary","http_method":"POST","short_description":"Get summary of notifications for given set of employment ids","deprecated":null}],"formats":["json"],"full_description":"\n<p>Returns employment notifications count for the passed employment IDs.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"employment_ids","full_name":"employment_ids","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"categories","full_name":"categories","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-notifications/index","name":"index","apis":[{"api_url":"/api/time_clock_app/notifications","http_method":"GET","short_description":"Get all notifications for a given employment id","deprecated":null}],"formats":["json"],"full_description":"\n<p>Returns all employment notifications for the passed employment ID.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"employment_id","full_name":"employment_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"categories","full_name":"categories","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-notifications/notifications_response","name":"notifications_response","apis":[{"api_url":"/api/time_clock_app/notifications/response","http_method":"POST","short_description":"Process notifications of the given notification ids","deprecated":null}],"formats":["json"],"full_description":"\n<p>Process notifications of the given notification ids.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"employment_id","full_name":"employment_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"categories","full_name":"categories","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"actions","full_name":"actions","description":"\n<p>An array of notification and action. Allowed action types are: [accept, reject, acknowledge]</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-schedules":{"doc_url":"/doc/1.0/time_clock_app-schedules","id":"time_clock_app-schedules","api_url":"/api","name":"Time_clock_app::Schedules","short_description":"Controller to view schedule settings","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-schedules/settings","name":"settings","apis":[{"api_url":"/api/time_clock_app/settings","http_method":"GET","short_description":"Get employments of a store","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-schedules/image","name":"image","apis":[{"api_url":"/api/time_clock_app/image","http_method":"GET","short_description":"Get the image for the time clock device","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"x_lifelenz_device","full_name":"x_lifelenz_device","description":"\n<p>Device type of the user</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-sessions":{"doc_url":"/doc/1.0/time_clock_app-sessions","id":"time_clock_app-sessions","api_url":"/api","name":"Time_clock_app::Sessions","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-sessions/sign_in","name":"sign_in","apis":[{"api_url":"/api/time_clock_app/sign_in","http_method":"POST","short_description":"Sign in to time clock device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"\n<p>Email address of the user</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n<p>Password of the user</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-sessions/managed_stores","name":"managed_stores","apis":[{"api_url":"/api/time_clock_app/businesses/:business_id/stores","http_method":"GET","short_description":"Get all stores the current user has managed to","deprecated":null}],"formats":null,"full_description":"\n<p>Schedule is equivalent to store</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be logged in</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-sessions/businesses","name":"businesses","apis":[{"api_url":"/api/time_clock_app/businesses","http_method":"GET","short_description":"Get all businesses the current user belongs to","deprecated":null}],"formats":null,"full_description":"\n<p>Schedule is equivalent to store</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be logged in</p>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-sessions/validate_store","name":"validate_store","apis":[{"api_url":"/api/time_clock_app/businesses/:business_id/stores/:store_id/validate_store","http_method":"GET","short_description":"Check whether store is valid to register a device","deprecated":null}],"formats":null,"full_description":"\n<p>Schedule is equivalent to store</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager trainee rights for the schedule.</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"store_id","full_name":"store_id","description":"\n<p>Store ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-sessions/register_device","name":"register_device","apis":[{"api_url":"/api/time_clock_app/businesses/:business_id/stores/:store_id/register_device","http_method":"POST","short_description":"Register time clock device for shift manager","deprecated":null}],"formats":null,"full_description":"\n<p>Schedule is equivalent to store</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager trainee rights for the schedule.</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"store_id","full_name":"store_id","description":"\n<p>Store ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-sessions/register_device_with_api_key","name":"register_device_with_api_key","apis":[{"api_url":"/api/time_clock_app/businesses/:business_id/stores/register_device_with_api_key","http_method":"POST","short_description":"Register time clock device with an api key","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager trainee rights for the schedule Must have api key and pin.</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employee_code","full_name":"employee_code","description":"\n<p>The external code that is used for an employee in 3rd party systems</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"store_code","full_name":"store_code","description":"\n<p>External code for a store</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pin","full_name":"pin","description":"\n<p>PIN for the employee</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"api_key","full_name":"api_key","description":"\n<p>Secret code that is stored against a business</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"time_clock_app-shifts":{"doc_url":"/doc/1.0/time_clock_app-shifts","id":"time_clock_app-shifts","api_url":"/api","name":"Time_clock_app::Shifts","short_description":"Shifts","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-shifts/index","name":"index","apis":[{"api_url":"/api/time_clock_app/shifts","http_method":"GET","short_description":"Get all published shifts of the schedule","deprecated":null}],"formats":["json"],"full_description":"\n<p>The results will be restricted to given time range.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is inclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-shifts/update_attendance","name":"update_attendance","apis":[{"api_url":"/api/time_clock_app/shifts/:id/update_attendance","http_method":"PUT","short_description":"Mark the shift as absent or present","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager trainee rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>shift id which is being marked as absent</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manager_id","full_name":"manager_id","description":"\n<p>ID of the manager updating the shift</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_absent","full_name":"is_absent","description":"\n<p>Whether the employee is absent for the shift</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"absent_reason_id","full_name":"absent_reason_id","description":"\n<p>ID of the absent reason</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-time_clock_devices":{"doc_url":"/doc/1.0/time_clock_app-time_clock_devices","id":"time_clock_app-time_clock_devices","api_url":"/api","name":"Time_clock_app::Time_clock_devices","short_description":"Time Clock Device","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-time_clock_devices/cancel_registration","name":"cancel_registration","apis":[{"api_url":"/api/time_clock_app/businesses/:business_id/time_clock_devices/cancel_registration","http_method":"POST","short_description":"Cancel Time Clock Device Registration","deprecated":null}],"formats":["json"],"full_description":"\n<p>Reverts an unconfirmed time clock device entry to be an ‘empty’ device slot.</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Device ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-time_clock_devices/query_registration","name":"query_registration","apis":[{"api_url":"/api/time_clock_app/businesses/:business_id/time_clock_devices/query_registration","http_method":"GET","short_description":"Query Time Clock Device Registration","deprecated":null}],"formats":["json"],"full_description":"\n<p>Returns device registration info</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"device_key","full_name":"device_key","description":"\n<p>Device key</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"confirmation_code","full_name":"confirmation_code","description":"\n<p>Device key</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-time_clock_devices/confirm_registration","name":"confirm_registration","apis":[{"api_url":"/api/time_clock_app/businesses/:business_id/time_clock_devices/confirm_registration","http_method":"POST","short_description":"Confirm Time Clock Device Registration","deprecated":null}],"formats":["json"],"full_description":"\n<p>Confirms an unconfirmed time clock device entry.</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Device ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"os","full_name":"os","description":"\n<p>Device operating system</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"model","full_name":"model","description":"\n<p>Device model</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-time_clock_rating_reasons":{"doc_url":"/doc/1.0/time_clock_app-time_clock_rating_reasons","id":"time_clock_app-time_clock_rating_reasons","api_url":"/api","name":"Time_clock_app::Time_clock_rating_reasons","short_description":"Controller to get time clock rating reasons","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-time_clock_rating_reasons/index","name":"index","apis":[{"api_url":"/api/time_clock_app/time_clock_rating_reasons","http_method":"GET","short_description":"Get time clock rating reasons of a business","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-time_clocks":{"doc_url":"/doc/1.0/time_clock_app-time_clocks","id":"time_clock_app-time_clocks","api_url":"/api","name":"Time_clock_app::Time_clocks","short_description":"Controller to time clock","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-time_clocks/recent_per_employment","name":"recent_per_employment","apis":[{"api_url":"/api/time_clock_app/time_clocks/recent_per_employment","http_method":"POST","short_description":"Get latest time clocks of the schedule per employment given by employment ids, excluding deleted employments","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"employment_ids","full_name":"employment_ids","description":"\n<p>An array of employment IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-time_clocks/compliance_results","name":"compliance_results","apis":[{"api_url":"/api/time_clock_app/time_clocks/compliance_results","http_method":"POST","short_description":"Get compliance warnings for given time clock ids","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"time_clock_ids","full_name":"time_clock_ids","description":"\n<p>An array of time clock IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-time_clocks/punch_events","name":"punch_events","apis":[{"api_url":"/api/time_clock_app/time_clocks/punch_events","http_method":"POST","short_description":"Create one or many time clock punches","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"time_clock_id","full_name":"time_clock_id","description":"\n<p>Time Clock ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employment ID</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"check_without_saving","full_name":"check_without_saving","description":"\n<p>A flag for running rules without saving changes</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"events","full_name":"events","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"performed_by_id","full_name":"events[performed_by_id]","description":"\n<p>Id of Employment who performed this action</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"event_type","full_name":"events[event_type]","description":"\n<p>Type of event</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>clock_in</code>, <code>clock_out</code>, <code>planned_clock_out</code>, <code>break_start</code>, <code>break_end</code>, <code>clock_in_adjusted</code>, <code>clock_out_adjusted</code>, <code>break_start_adjusted</code>, <code>break_end_adjusted</code>, <code>deleted</code>, <code>employee_approved</code>, <code>manager_approved</code>, <code>employee_consented</code>, <code>rate_preference_index_selected</code>, <code>rate_preference_index_adjusted</code>, <code>role_rate_selected</code>, <code>role_rate_adjusted</code>, <code>attested_rest_breaks_taken</code>, <code>attested_rest_breaks_not_taken</code>, <code>attested_meal_breaks_taken</code>, <code>attested_meal_breaks_not_taken</code>, <code>break_start_attested</code>, <code>break_end_attested</code>, <code>stay_late_consented</code>, <code>stay_late_declined</code>, <code>scheduled_breaks_missed</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"punch_time","full_name":"events[punch_time]","description":"\n<p>Mandatory for all events except ‘deleted’</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"reasons","full_name":"events[reasons]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"punch_method","full_name":"events[punch_method]","description":"\n<p>Punch Method</p>\n","required":true,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>manual</code>, <code>biometrics</code>, <code>pin</code>, <code>system</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"punch_id","full_name":"events[punch_id]","description":"\n<p>Id of the punch, Mandatory for all events except ‘planned_clock_out’</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employee_initiated_change","full_name":"events[employee_initiated_change]","description":"\n<p>Indicates whether the deviation from schedule was employee initiated. (e.g employee voluntarily clock in early and won’t get premium pay) Mandatory for all events except ‘deleted’.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"break_type","full_name":"events[break_type]","description":"\n<p>break_type_code of a BreakType within the specified business [mandatory for (break_start, break_start_adjusted)]</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"paid_break","full_name":"events[paid_break]","description":"\n<p>Indicates whether the break is paid. Mandatory for (break_end, break_end_adjusted).</p>\n","required":false,"allow_nil":{"attributes":["paid_break"],"options":{"allow_nil":true,"in":[true,false]},"delimiter":[true,false]},"allow_blank":null,"validator":"must be one of <code>true</code>, <code>false</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_role_id","full_name":"events[business_role_id]","description":"\n<p>Id of business role [Needed for role_rate_selected, role_rate_adjusted. Can be null.]</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_preference_index","full_name":"events[rate_preference_index]","description":"\n<p>Preferred employment rate index. Default is 0</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"must be an integer, must be greater than or equal to 0","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"break_attestation_details","full_name":"events[break_attestation_details]","description":"\n<p>break attestation details</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"rest_break","full_name":"events[break_attestation_details][rest_break]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"number_of_breaks_taken","full_name":"events[break_attestation_details][rest_break][number_of_breaks_taken]","description":"\n<p># of breaks taken</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"number_of_breaks_offered","full_name":"events[break_attestation_details][rest_break][number_of_breaks_offered]","description":"\n<p># of breaks offered</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-time_clocks/submit_rating","name":"submit_rating","apis":[{"api_url":"/api/time_clock_app/time_clocks/submit_rating","http_method":"POST","short_description":"Submit time clock rating","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"time_clock_id","full_name":"time_clock_id","description":"\n<p>Time Clock ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rating","full_name":"rating","description":"\n<p>Time clock rating</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rating_reason_id","full_name":"rating_reason_id","description":"\n<p>Time Clock Rating Reason ID</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/time_clock_app-time_clocks/upload_time_clock_snapshot","name":"upload_time_clock_snapshot","apis":[{"api_url":"/api/time_clock_app/time_clocks/upload_time_clock_snapshot","http_method":"POST","short_description":"Save time clock snapshot","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[{"name":"snapshot","full_name":"snapshot","description":"\n<p>Time clock snapshot</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"time_clock_app-workflows":{"doc_url":"/doc/1.0/time_clock_app-workflows","id":"time_clock_app-workflows","api_url":"/api","name":"Time_clock_app::Workflows","short_description":"Workflow storage api for timeclock","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/time_clock_app-workflows/content","name":"content","apis":[{"api_url":"/api/time_clock_app/workflow","http_method":"GET","short_description":"Get workflow","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">Must</span> <span class=\"ruby-identifier\">be</span> <span class=\"ruby-identifier\">registered</span> <span class=\"ruby-identifier\">time</span> <span class=\"ruby-identifier\">clock</span> <span class=\"ruby-identifier\">device</span>\n</pre>\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-analytics-forecasts":{"doc_url":"/doc/1.0/admin-analytics-forecasts","id":"admin-analytics-forecasts","api_url":"/api","name":"Admin::Analytics::Forecasts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-analytics-forecasts/index","name":"index","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/schedules/:schedule_id/forecasts","http_method":"GET","short_description":"Get a list available forecasts for a schedule within a particular time range","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is exclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"admin-analytics-viewed_forecasts":{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts","id":"admin-analytics-viewed_forecasts","api_url":"/api","name":"Admin::Analytics::Viewed_forecasts","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/current","name":"current","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/schedules/:schedule_id/viewed_forecasts/current","http_method":"GET","short_description":"Get forecast data for a schedule within a particular time range","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager trainee rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is exclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"view_options","full_name":"view_options","description":"\n<p>options to control the returned forecast</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_time","full_name":"view_options[start_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"view_options[end_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_day","full_name":"view_options[by_day]","description":"\n<p>When true, aggregate forecast by day. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_day_parts","full_name":"view_options[include_day_parts]","description":"\n<p>When true, include day parts forecast. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/create","name":"create","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/schedules/:schedule_id/viewed_forecasts","http_method":"POST","short_description":"Create a viewed forecast within a particular time range of the schedule","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"forecast_id","full_name":"forecast_id","description":"\n<p>Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is exclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/set_forecast","name":"set_forecast","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/set_forecast","http_method":"POST","short_description":"Set viewed forecast to use a particular forecast","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the viewed forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"forecast_id","full_name":"forecast_id","description":"\n<p>Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"view_options","full_name":"view_options","description":"\n<p>options to control the returned forecast</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_time","full_name":"view_options[start_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"view_options[end_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_day","full_name":"view_options[by_day]","description":"\n<p>When true, aggregate forecast by day. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_day_parts","full_name":"view_options[include_day_parts]","description":"\n<p>When true, include day parts forecast. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/with_forecast","name":"with_forecast","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/schedules/:schedule_id/viewed_forecasts/with_forecast","http_method":"GET","short_description":"View a viewed forecast by choosing a particular forecast","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"forecast_id","full_name":"forecast_id","description":"\n<p>Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is exclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"view_options","full_name":"view_options","description":"\n<p>options to control the returned forecast</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_time","full_name":"view_options[start_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"view_options[end_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_day","full_name":"view_options[by_day]","description":"\n<p>When true, aggregate forecast by day. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_day_parts","full_name":"view_options[include_day_parts]","description":"\n<p>When true, include day parts forecast. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/previous_forecasts","name":"previous_forecasts","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/previous_forecasts","http_method":"GET","short_description":"Get a list of previously assigned forecasts","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/event_history","name":"event_history","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/event_history","http_method":"GET","short_description":"Get a history of all events for this viewed forecast","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/apply_latest_forecast","name":"apply_latest_forecast","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/apply_latest_forecast","http_method":"POST","short_description":"Set viewed forecast to use latest forecast","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"view_options","full_name":"view_options","description":"\n<p>options to control the returned forecast</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_time","full_name":"view_options[start_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"view_options[end_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_day","full_name":"view_options[by_day]","description":"\n<p>When true, aggregate forecast by day. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_day_parts","full_name":"view_options[include_day_parts]","description":"\n<p>When true, include day parts forecast. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/add_overrides","name":"add_overrides","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/add_overrides","http_method":"POST","short_description":"Add forecast overrides","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"overrides","full_name":"overrides","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"mode","full_name":"overrides[mode]","description":"\n<p>apply the override according to the source day actuals without modification, or by scaling the target day forecast such that the primary measure adds up to the sum of the source day primary measure</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>actuals</code>, <code>pattern</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"overrides[comment]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"source_date","full_name":"overrides[source_date]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"target_date","full_name":"overrides[target_date]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"view_options","full_name":"view_options","description":"\n<p>options to control the returned forecast</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_time","full_name":"view_options[start_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"view_options[end_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_day","full_name":"view_options[by_day]","description":"\n<p>When true, aggregate forecast by day. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_day_parts","full_name":"view_options[include_day_parts]","description":"\n<p>When true, include day parts forecast. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/remove_overrides","name":"remove_overrides","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/remove_overrides","http_method":"POST","short_description":"Remove forecast overrides","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"override_ids","full_name":"override_ids","description":"\n<p>IDs of Overrides to remove</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"view_options","full_name":"view_options","description":"\n<p>options to control the returned forecast</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_time","full_name":"view_options[start_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"view_options[end_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_day","full_name":"view_options[by_day]","description":"\n<p>When true, aggregate forecast by day. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_day_parts","full_name":"view_options[include_day_parts]","description":"\n<p>When true, include day parts forecast. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/add_adjustments","name":"add_adjustments","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/add_adjustments","http_method":"POST","short_description":"Add forecast adjustments","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"adjustments","full_name":"adjustments","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"amount","full_name":"adjustments[amount]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be numeric","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mode","full_name":"adjustments[mode]","description":"\n<p>apply the adjustment amount as a raw value, a percentage of the previous value, or a fixed absolute value</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>raw</code>, <code>percent</code>, <code>fixed</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"adjustments[comment]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_time","full_name":"adjustments[start_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"adjustments[end_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"forecast_type","full_name":"adjustments[forecast_type]","description":"\n<p>forecast type (i.e. sales, labour)</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"forecast_subtypes","full_name":"adjustments[forecast_subtypes]","description":"\n<p>a list of forecast subtypes to adjust</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"view_options","full_name":"view_options","description":"\n<p>options to control the returned forecast</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_time","full_name":"view_options[start_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"view_options[end_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_day","full_name":"view_options[by_day]","description":"\n<p>When true, aggregate forecast by day. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_day_parts","full_name":"view_options[include_day_parts]","description":"\n<p>When true, include day parts forecast. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/remove_adjustments","name":"remove_adjustments","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/remove_adjustments","http_method":"POST","short_description":"Remove forecast adjustments","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"adjustment_ids","full_name":"adjustment_ids","description":"\n<p>Adjustment ids to remove</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"view_options","full_name":"view_options","description":"\n<p>options to control the returned forecast</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"start_time","full_name":"view_options[start_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_time","full_name":"view_options[end_time]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"by_day","full_name":"view_options[by_day]","description":"\n<p>When true, aggregate forecast by day. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_day_parts","full_name":"view_options[include_day_parts]","description":"\n<p>When true, include day parts forecast. Default: false</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/submit_for_approval","name":"submit_for_approval","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/submit_for_approval","http_method":"POST","short_description":"Submit for approval","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"\n<p>Ask for approval comment</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/approve_submission","name":"approve_submission","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/approve_submission","http_method":"POST","short_description":"Approve submission","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin right by default to be able to manage the forecast adjustment approval.</p>\n\n<pre>Authorization will be dynamic based on forecastApprovalPermissionLevel and forecastApprovalSelfApprovalPermissionLevel\nwhen forecast requires approval is enabled</pre>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"\n<p>Approve comment</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-analytics-viewed_forecasts/cancel_submission","name":"cancel_submission","apis":[{"api_url":"/api/admin/analytics/businesses/:business_id/viewed_forecasts/:id/cancel_submission","http_method":"POST","short_description":"Cancel pending submission","deprecated":null}],"formats":null,"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule of the forecast</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Viewed Forecast ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"\n<p>Cancel submission comment</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"admin-mobile-schedules":{"doc_url":"/doc/1.0/admin-mobile-schedules","id":"admin-mobile-schedules","api_url":"/api","name":"Admin::Mobile::Schedules","short_description":"Employee schedules","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-mobile-schedules/show","name":"show","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/:id","http_method":"GET","short_description":"Get a specific schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Date+Parameters\" class=\"legacy-anchor\"></span>\n<h2 id=\"date-parameters\"><a href=\"#date-parameters\">Date Parameters</a></h2>\n\n<p>Date parameters are used to filter assignment total for schedule. Parameters start_date and end_date are interpreted as in the time zone of the schedule’s primary business location.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager trainee rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-schedules/hierarchy","name":"hierarchy","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/hierarchy","http_method":"GET","short_description":"Get hierarchy for schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager trainee rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-schedules/children","name":"children","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/:id/children","http_method":"GET","short_description":"Get children for schedule","deprecated":null}],"formats":["json"],"full_description":"\n<pre>== Security</pre>\n\n<p>Must have manager trainee rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-schedules/first_schedule","name":"first_schedule","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/first_schedule","http_method":"GET","short_description":"Get first schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager trainee rights for the business</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-schedules/aggregated_labour_hours_and_earnings","name":"aggregated_labour_hours_and_earnings","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/:id/aggregated_labour_hours_and_earnings","http_method":"GET","short_description":"Get labour hours and earnings on the schedule per day in the date range given","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Date+Parameters\" class=\"legacy-anchor\"></span>\n<h2 id=\"date-parameters\"><a href=\"#date-parameters\">Date Parameters</a></h2>\n\n<p>Parameters start_date and end_date are interpreted as in the time zone of the schedule’s primary business location.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager trainee rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-schedules/shift_status","name":"shift_status","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/:id/shift_status","http_method":"GET","short_description":"Get shift status for schedule in the date range given","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Date+Parameters\" class=\"legacy-anchor\"></span>\n<h2 id=\"date-parameters\"><a href=\"#date-parameters\">Date Parameters</a></h2>\n\n<p>Parameters start_date and end_date are interpreted as in the time zone of the schedule’s primary business location.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule-manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-schedules/shift_status_by_dates","name":"shift_status_by_dates","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/:id/shift_status_by_dates","http_method":"GET","short_description":"Get shift status for schedule in the date range given and return status grouped by dates","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Date+Parameters\" class=\"legacy-anchor\"></span>\n<h2 id=\"date-parameters\"><a href=\"#date-parameters\">Date Parameters</a></h2>\n\n<p>Parameters start_date and end_date are interpreted as in the time zone of the schedule’s primary business location.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift-manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-schedules/compliance_results","name":"compliance_results","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/:id/compliance_results","http_method":"POST","short_description":"Fetch compliance results for the schedule","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_ids","full_name":"shift_ids","description":"\n<p>Array of shift ids</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start time.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is exclusive of end time.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-mobile-shift_drops":{"doc_url":"/doc/1.0/admin-mobile-shift_drops","id":"admin-mobile-shift_drops","api_url":"/api","name":"Admin::Mobile::Shift_drops","short_description":"Shift Drop Requests","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-mobile-shift_drops/index","name":"index","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/:schedule_id/shift_drops","http_method":"GET","short_description":"Shift drop requests submitted for manager approval in a schedule","deprecated":null}],"formats":["json"],"full_description":"\n<p>The results will be restricted to the time range.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is exclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shift_drops/comments","name":"comments","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shift_drops/:id/comments","http_method":"GET","short_description":"Fetch shift drop request, response comments for a shift","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shift_drops/approve_drop","name":"approve_drop","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shift_drops/:id/approve_drop","http_method":"PUT","short_description":"Approve the drop request","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employment ID to accept the drop request</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_check","full_name":"compliance_warning_check","description":"\n<p>Whether to check the action causes new compliance warnings. Default = ‘do_not_check’.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>do_not_check</code>, <code>check_without_saving</code>, <code>check_and_save</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_severity","full_name":"compliance_warning_severity","description":"\n<p>If supplied compliance warnings with severity less than or equal to compliance_warning_severity will be filtered to perform compliance_warnings_check. Effective when ‘compliance_warnings_check’ is check_without_saving or check_and_save. If this value is ‘0’ no severity filtering is performed. Default: 0.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prevent_critical_errors","full_name":"prevent_critical_errors","description":"\n<p>If supplied and is false, severity 1 errors will not be blocking actions. Default is true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_employee_initiated","full_name":"shift_offer_employee_initiated","description":"\n<p>Whether the change is initiated by employee</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_manager_message","full_name":"shift_offer_manager_message","description":"\n<p>Any message to the employee while requesting for consent</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shift_drops/reject_drop","name":"reject_drop","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shift_drops/:id/reject_drop","http_method":"PUT","short_description":"Reject the drop request","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"comment","full_name":"comment","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-mobile-shift_swaps":{"doc_url":"/doc/1.0/admin-mobile-shift_swaps","id":"admin-mobile-shift_swaps","api_url":"/api","name":"Admin::Mobile::Shift_swaps","short_description":"To approve or reject a shift swap request","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-mobile-shift_swaps/index","name":"index","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/:schedule_id/shift_swaps","http_method":"GET","short_description":"Shift swap requests submitted for manager approval in a schedule","deprecated":null}],"formats":["json"],"full_description":"\n<p>The results will be restricted to the time range.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is exclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shift_swaps/show","name":"show","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shift_swaps/:id","http_method":"GET","short_description":"Get a specific shift swap","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for the shift’s schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift Swap Id</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shift_swaps/manager_response","name":"manager_response","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shift_swaps/:id/manager_response","http_method":"PUT","short_description":"Manager response to a pending approval shift swap request","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for the shift’s schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift Swap Id</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"response_status","full_name":"response_status","description":"\n<p>Approve or Reject the shift swap request</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>manager_approved</code>, <code>manager_rejected</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"manager_message","full_name":"manager_message","description":"\n<p>Message from the approving manager</p>\n","required":null,"allow_nil":null,"allow_blank":null,"validator":"must be string <= 500","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_check","full_name":"compliance_warning_check","description":"\n<p>Whether to check the action causes new compliance warnings. Default = ‘do_not_check’.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>do_not_check</code>, <code>check_without_saving</code>, <code>check_and_save</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_severity","full_name":"compliance_warning_severity","description":"\n<p>If supplied compliance warnings with severity less than or equal to compliance_warning_severity will be filtered to perform compliance_warnings_check. Effective when ‘compliance_warnings_check’ is check_without_saving or check_and_save. If this value is ‘0’ no severity filtering is performed. Default: 0.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prevent_critical_errors","full_name":"prevent_critical_errors","description":"\n<p>If supplied and is false, severity 1 errors will not be blocking actions. Default is true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_employee_initiated","full_name":"shift_offer_employee_initiated","description":"\n<p>Whether the change is initiated by employee</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_manager_message","full_name":"shift_offer_manager_message","description":"\n<p>Any message to the employee while requesting for consent</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-mobile-shifts":{"doc_url":"/doc/1.0/admin-mobile-shifts","id":"admin-mobile-shifts","api_url":"/api","name":"Admin::Mobile::Shifts","short_description":"Operations related to shifts in mobile management","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-mobile-shifts/index","name":"index","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/schedules/:schedule_id/shifts","http_method":"GET","short_description":"Get shifts of the schedule in the time range","deprecated":null}],"formats":["json"],"full_description":"\n<p>The results will be restricted to the time range.</p>\n\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights for the schedule</p>\n","errors":[],"params":[{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date_time","full_name":"start_date_time","description":"\n<p>Start time for time range. Range is inclusive of start.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date_time","full_name":"end_date_time","description":"\n<p>End time for time range. Range is exclusive of end.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shifts/show","name":"show","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shifts/:id","http_method":"GET","short_description":"Get a specific shift","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shifts/schedulable_employments","name":"schedulable_employments","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shifts/:id/schedulable_employments","http_method":"GET","short_description":"Get schedulable employments for this shift","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shifts/shift_employments","name":"shift_employments","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shifts/:id/shift_employments","http_method":"GET","short_description":"Employments of the shift","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shifts/update","name":"update","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shifts/:id","http_method":"PATCH","short_description":"Update the shift","deprecated":null},{"api_url":"/api/admin/mobile/businesses/:business_id/shifts/:id","http_method":"PUT","short_description":"Update the shift","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_office_location_id","full_name":"business_office_location_id","description":"\n<p>Business Office Location ID</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_start_time","full_name":"shift_start_time","description":"\n<p>The start time of the shift</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_end_time","full_name":"shift_end_time","description":"\n<p>The end time of the shift</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date & time in iso 8601 format","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_title","full_name":"shift_title","description":"\n<p>Title of the shift</p>\n","required":false,"allow_nil":{"attributes":["shift_title"],"options":{"allow_nil":true,"maximum":100}},"allow_blank":null,"validator":"must be string <= 100","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_description","full_name":"shift_description","description":"\n<p>Description of the shift</p>\n","required":false,"allow_nil":{"attributes":["shift_description"],"options":{"allow_nil":true,"maximum":500}},"allow_blank":null,"validator":"must be string <= 500","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"queued_employments","full_name":"queued_employments","description":"\n<p>An array of Employment IDs, defining which employees will be offered this shift and in which order</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"planned_breaks","full_name":"planned_breaks","description":"\n<p>An array of planned breaks for the shift</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"planned_roles","full_name":"planned_roles","description":"\n<p>An array of planned business roles for the shift (business_role_id and start_sec)</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"code","full_name":"code","description":"\n<p>3rd party unique ID for the shift</p>\n","required":false,"allow_nil":{"attributes":["code"],"options":{"allow_nil":true,"scope":"schedule_id"},"klass":"Shift"},"allow_blank":null,"validator":"must be string <= 50<br>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"published_status","full_name":"published_status","description":"\n<p>Publishable status of the shift.  Default is unpublished</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>unpublished</code>, <code>published</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_type","full_name":"shift_type","description":"\n<p>The shift type</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"must be one of <code>offer</code>, <code>offer_to_all</code>, <code>roster</code>, <code>time_off</code>, <code>meeting</code>, <code>open</code>","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"rate_preference_index","full_name":"rate_preference_index","description":"\n<p>Preferred employment rate index. Default is 0</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_check","full_name":"compliance_warning_check","description":"\n<p>Whether to check the action causes new compliance warnings. Default = ‘do_not_check’.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>do_not_check</code>, <code>check_without_saving</code>, <code>check_and_save</code>.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"compliance_warning_severity","full_name":"compliance_warning_severity","description":"\n<p>If supplied compliance warnings with severity less than or equal to compliance_warning_severity will be filtered to perform compliance_warnings_check. Effective when ‘compliance_warnings_check’ is check_without_saving or check_and_save. If this value is ‘0’ no severity filtering is performed. Default: 0.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"prevent_critical_errors","full_name":"prevent_critical_errors","description":"\n<p>If supplied and is false, severity 1 errors will not be blocking actions. Default is true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_employee_initiated","full_name":"shift_offer_employee_initiated","description":"\n<p>Whether the change is initiated by employee</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shift_offer_manager_message","full_name":"shift_offer_manager_message","description":"\n<p>Any message to the employee while requesting for consent</p>\n","required":false,"allow_nil":null,"allow_blank":null,"validator":"","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shifts/send_reminder","name":"send_reminder","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shifts/:id/send_reminder","http_method":"PUT","short_description":"Send shift reminder","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-mobile-shifts/cancel_pending_changes","name":"cancel_pending_changes","apis":[{"api_url":"/api/admin/mobile/businesses/:business_id/shifts/:id/cancel_pending_changes","http_method":"PUT","short_description":"Cancel changes pending consent from employee","deprecated":null}],"formats":["json"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule of the shift</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Shift ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-report-async_reports":{"doc_url":"/doc/1.0/admin-report-async_reports","id":"admin-report-async_reports","api_url":"/api","name":"Admin::Report::Async_reports","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-report-async_reports/content","name":"content","apis":[{"api_url":"/api/admin/report/businesses/:business_id/async_reports/:id/content","http_method":"GET","short_description":"retrieve report contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Async report ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID of the report.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"admin-report-businesses":{"doc_url":"/doc/1.0/admin-report-businesses","id":"admin-report-businesses","api_url":"/api","name":"Admin::Report::Businesses","short_description":"Business reports","full_description":"","version":"1.0","formats":["pdf"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-report-businesses/offer_swap_report","name":"offer_swap_report","apis":[{"api_url":"/api/admin/report/businesses/:id/offer_swap_report","http_method":"GET","short_description":"Get report of shift offers and shift swaps made in a given date range","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for business and requested schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"all_employees","full_name":"all_employees","description":"\n<p>Whether to report is includes all employees. Set as false for single employee and provide employment ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Store ID.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/leave_summary_report","name":"leave_summary_report","apis":[{"api_url":"/api/admin/report/businesses/:id/leave_summary_report","http_method":"POST","short_description":"Get leave summary report CSV for specified schedules","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/terminated_employees_report","name":"terminated_employees_report","apis":[{"api_url":"/api/admin/report/businesses/:id/terminated_employees_report","http_method":"POST","short_description":"Get terminated employees report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/t_and_a_timepunch_and_leave_report","name":"t_and_a_timepunch_and_leave_report","apis":[{"api_url":"/api/admin/report/businesses/:id/t_and_a_timepunch_and_leave_report","http_method":"POST","short_description":"Get T&A timepunch and leave CSV for specified schedules","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/minor_violations_report","name":"minor_violations_report","apis":[{"api_url":"/api/admin/report/businesses/:id/minor_violations_report","http_method":"POST","short_description":"Get minor violations report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/weekly_manager_hours_report","name":"weekly_manager_hours_report","apis":[{"api_url":"/api/admin/report/businesses/:id/weekly_manager_hours_report","http_method":"POST","short_description":"Get weekly manager hours (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for business week commencing in YYYY-MM-DD format</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/weekly_allowed_hours_report","name":"weekly_allowed_hours_report","apis":[{"api_url":"/api/admin/report/businesses/:id/weekly_allowed_hours_report","http_method":"POST","short_description":"Get weekly allowed hours (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for business week commencing in YYYY-MM-DD format</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>schedule id</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/crew_schedule_change_report","name":"crew_schedule_change_report","apis":[{"api_url":"/api/admin/report/businesses/:id/crew_schedule_change_report","http_method":"GET","short_description":"Get report of all the changes that happened to the originally published Crew Schedule","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n<p>Location ID for store.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/break_violations_report","name":"break_violations_report","apis":[{"api_url":"/api/admin/report/businesses/:id/break_violations_report","http_method":"POST","short_description":"Get break violations report CSV for specified schedules","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/schedule_overrides_report","name":"schedule_overrides_report","apis":[{"api_url":"/api/admin/report/businesses/:id/schedule_overrides_report","http_method":"POST","short_description":"Get schedule overrides report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/labour_analysis_summary_report","name":"labour_analysis_summary_report","apis":[{"api_url":"/api/admin/report/businesses/:id/labour_analysis_summary_report","http_method":"GET","short_description":"Get report of what happened in the schedule across all store or single store","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n<p>Location ID for store. Set to null to retrieve data for all stores.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for business week commencing in YYYY-MM-DD format</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"report_mode","full_name":"report_mode","description":"\n<p>A string indicating the breakdown type for the report (weekly for week summary and daily for day breakdown). The fallback mode is weekly</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/active_not_paid_report","name":"active_not_paid_report","apis":[{"api_url":"/api/admin/report/businesses/:id/active_not_paid_report","http_method":"POST","short_description":"Get active not paid report CSV and PDF for specified schedules","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/salary_reconciliation_report","name":"salary_reconciliation_report","apis":[{"api_url":"/api/admin/report/businesses/:id/salary_reconciliation_report","http_method":"POST","short_description":"Get report with the breakdown of Salary managers hours by store","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for business and all requested schedules</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>Filter the report to include only hours worked at given schedules.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/projected_and_actual_overtime_report","name":"projected_and_actual_overtime_report","apis":[{"api_url":"/api/admin/report/businesses/:id/projected_and_actual_overtime_report","http_method":"POST","short_description":"Get Projected vs Actual report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/biometric_consent_report","name":"biometric_consent_report","apis":[{"api_url":"/api/admin/report/businesses/:id/biometric_consent_report","http_method":"GET","short_description":"Get employment biometric response (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/break_waiver_report","name":"break_waiver_report","apis":[{"api_url":"/api/admin/report/businesses/:id/break_waiver_report","http_method":"GET","short_description":"Get break waiver report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have general manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/pay_period_variance_report","name":"pay_period_variance_report","apis":[{"api_url":"/api/admin/report/businesses/:id/pay_period_variance_report","http_method":"GET","short_description":"Get pay period va report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have general manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/total_store_percentage_of_sales_to_labour_budget","name":"total_store_percentage_of_sales_to_labour_budget","apis":[{"api_url":"/api/admin/report/businesses/:id/total_store_percentage_of_sales_to_labour_budget","http_method":"POST","short_description":"Get Total Store Sales To Labour Budget report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/employee_integration_rejection_report","name":"employee_integration_rejection_report","apis":[{"api_url":"/api/admin/report/businesses/:id/employee_integration_rejection_report","http_method":"GET","short_description":"Get employment integration rejection report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must be general manager or higher</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"resolved","full_name":"resolved","description":"\n<p>Resolved to filter by</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/outstanding_payment_report","name":"outstanding_payment_report","apis":[{"api_url":"/api/admin/report/businesses/:id/outstanding_payment_report","http_method":"GET","short_description":"Get outstanding payment report (PDF or CSV)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have general manager with pay rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_ids","full_name":"employment_ids","description":"\n<p>An array of employment IDs</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/manager_overtime_report","name":"manager_overtime_report","apis":[{"api_url":"/api/admin/report/businesses/:id/manager_overtime_report","http_method":"POST","short_description":"Get manager overtime report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/public_holiday_report","name":"public_holiday_report","apis":[{"api_url":"/api/admin/report/businesses/:id/public_holiday_report","http_method":"GET","short_description":"Get public holiday report (CSV)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/productive_overtime_report","name":"productive_overtime_report","apis":[{"api_url":"/api/admin/report/businesses/:id/productive_overtime_report","http_method":"POST","short_description":"Get productive overtime report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the business</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/open_shifts_report","name":"open_shifts_report","apis":[{"api_url":"/api/admin/report/businesses/:id/open_shifts_report","http_method":"POST","short_description":"Get open shifts report (CSV)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_ids","full_name":"schedule_ids","description":"\n<p>An array of schedule IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/compliance_dismissal_report","name":"compliance_dismissal_report","apis":[{"api_url":"/api/admin/report/businesses/:id/compliance_dismissal_report","http_method":"GET","short_description":"Get compliance dismissal report CSV","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID to filter by.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-businesses/time_clock_deactivation_report","name":"time_clock_deactivation_report","apis":[{"api_url":"/api/admin/report/businesses/:id/time_clock_deactivation_report","http_method":"GET","short_description":"Get time clock deactivation report CSV","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin rights</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"schedule_id","full_name":"schedule_id","description":"\n<p>Schedule ID to filter by.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"admin-report-schedules":{"doc_url":"/doc/1.0/admin-report-schedules","id":"admin-report-schedules","api_url":"/api","name":"Admin::Report::Schedules","short_description":"Schedule reports","full_description":"","version":"1.0","formats":["pdf"],"metadata":null,"methods":[{"doc_url":"/doc/1.0/admin-report-schedules/weekly_report","name":"weekly_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/weekly_report","http_method":"GET","short_description":"Get weekly schedule report PDF for the schedule","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for week in YYYY-MM-DD format. Report will include the 7 days starting from this date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/daily_report","name":"daily_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/daily_report","http_method":"GET","short_description":"Get daily schedule report PDF for the schedule","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>The date in YYYY-MM-DD format.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"num_days","full_name":"num_days","description":"\n<p>The number of days to print.  Default is 1 (the start date)</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/leave_report","name":"leave_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/leave_report","http_method":"GET","short_description":"Get schedule leave requests report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/t_and_a_manual_adjustment_compliance_report","name":"t_and_a_manual_adjustment_compliance_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/t_and_a_manual_adjustment_compliance_report","http_method":"GET","short_description":"Get T&A manual adjustment compliance report CSV for the schedule","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/time_punch_change_approvals_report","name":"time_punch_change_approvals_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/time_punch_change_approvals_report","http_method":"GET","short_description":"Get time punch change approval report CSV for the schedule","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/time_punch_summary_report","name":"time_punch_summary_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/time_punch_summary_report","http_method":"GET","short_description":"Get time punch summary report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_punch_auth","full_name":"include_punch_auth","description":"\n<p>Boolean to control the inclusion of punch authorization column</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_punch_initiator","full_name":"include_punch_initiator","description":"\n<p>Boolean to control the inclusion of punch initiator column</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/time_punch_summary_business_day_report","name":"time_punch_summary_business_day_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/time_punch_summary_business_day_report","http_method":"GET","short_description":"Get time punch summary business day report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have service manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range excludes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/employee_roster_report","name":"employee_roster_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/employee_roster_report","http_method":"POST","short_description":"Get employee roster report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employee_ids","full_name":"employee_ids","description":"\n<p>Array of selected employee IDs</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/projected_actuals_report","name":"projected_actuals_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/projected_actuals_report","http_method":"POST","short_description":"Get projected actuals report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/pay_period_daily_report","name":"pay_period_daily_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/pay_period_daily_report","http_method":"GET","short_description":"Get schedule pay period daily report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/work_pattern_availability_report","name":"work_pattern_availability_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/work_pattern_availability_report","http_method":"GET","short_description":"Get schedule work pattern availability report CSV","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/day_work_pattern_report","name":"day_work_pattern_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/day_work_pattern_report","http_method":"GET","short_description":"Get schedule day work pattern report CSV","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"day_of_week","full_name":"day_of_week","description":"\n<p>Lowercase day of week (e.g. monday)</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/labor_exception_report","name":"labor_exception_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/labor_exception_report","http_method":"GET","short_description":"Get schedule labor exception report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_compliance_detail_fields","full_name":"include_compliance_detail_fields","description":"\n<p>Boolean to control the inclusion of compliance column. Defaults to true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"\n<p>Array of columns to render in report. Must contain valid column names. Only valid when :type = pdf. Defaults to all columns</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"employee_name\", \"employee_geid\", \"payroll_id\", \"minor_age\", \"date\", \"scheduled_shift\", \"actual_shift\", \"break_type\", \"break_time_in\", \"break_time_out\", \"manager_authorized\", \"required_vs_optional\", \"paid_hours\", \"exception_details\", \"compliance_dollars\", \"compliance_hours\", \"dismissal_reason\", \"dismissal_manager\", \"dismissal_date_time\"]","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/labor_exception_aggregated_report","name":"labor_exception_aggregated_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/labor_exception_aggregated_report","http_method":"GET","short_description":"Get schedule labor exception at aggregated level report (CSV)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/break_audit_report","name":"break_audit_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/break_audit_report","http_method":"GET","short_description":"Get employee break audit report (CSV)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/time_punch_details_report","name":"time_punch_details_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/time_punch_details_report","http_method":"GET","short_description":"Get schedule time punch details report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have shift manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/labor_analysis_actuals_report","name":"labor_analysis_actuals_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/labor_analysis_actuals_report","http_method":"GET","short_description":"Get Labor Analysis Actuals report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"columns","full_name":"columns","description":"\n<p>Array of columns to render in report. Must contain valid column names. Only valid when :type = pdf. Defaults to all columns</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"sales_forecast\", \"sales_adjusted_forecast\", \"sales_actual\", \"sales_variance\", \"transactions_forecast\", \"transactions_adjusted_forecast\", \"transactions_actual\", \"transactions_variance\", \"punched_labor_percentage\", \"variable_roles_projected\", \"variable_roles_scheduled\", \"variable_roles_needed\", \"variable_roles_actual\", \"variable_roles_variance\", \"fixed_roles_projected\", \"fixed_roles_scheduled\", \"floor_roles_projected\", \"floor_roles_scheduled\", \"floor_roles_needed\", \"ideal_total_hours\", \"salaried_manager_hours\", \"actual_crew_hours\", \"all_hours_difference\", \"tpmh\"]","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/schedule_kpi_report","name":"schedule_kpi_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/schedule_kpi_report","http_method":"GET","short_description":"Get schedule KPI report CSV","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/schedule_daily_kpi_report","name":"schedule_daily_kpi_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/schedule_daily_kpi_report","http_method":"GET","short_description":"Get schedule daily KPI report CSV","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/detailed_schedule_change_report","name":"detailed_schedule_change_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/detailed_schedule_change_report","http_method":"GET","short_description":"Get detailed schedule change report CSV","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/attendance_report","name":"attendance_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/attendance_report","http_method":"GET","short_description":"Get attendance reliability report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have general manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"early_threshold_minutes","full_name":"early_threshold_minutes","description":"\n<p>Number of minutes prior to shift start time before which is considered early</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"late_threshold_minutes","full_name":"late_threshold_minutes","description":"\n<p>Number of minutes following shift start time after which is considered late</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/availability_report","name":"availability_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/availability_report","http_method":"GET","short_description":"Get schedule availability report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/worked_as_scheduled","name":"worked_as_scheduled","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/worked_as_scheduled","http_method":"POST","short_description":"Get worked as scheduled report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/schedule_creation_metrics_report","name":"schedule_creation_metrics_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/schedule_creation_metrics_report","http_method":"GET","short_description":"Get schedule creation metrics report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/shift_rating_report","name":"shift_rating_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/shift_rating_report","http_method":"GET","short_description":"Get Shift Ratings report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/shift_rating_summary_report","name":"shift_rating_summary_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/shift_rating_summary_report","http_method":"GET","short_description":"Get Shift Ratings Summary report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have group admin rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/unscheduled_report","name":"unscheduled_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/unscheduled_report","http_method":"GET","short_description":"Get unscheduled employment report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for business week commencing in YYYY-MM-DD format</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_mode","full_name":"employment_mode","description":"\n<p>Both / Manager/ Crew Only</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_shared","full_name":"include_shared","description":"\n<p>Filter to include shared employment</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/no_shows_report","name":"no_shows_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/no_shows_report","http_method":"POST","short_description":"Get no shows report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_id","full_name":"employment_id","description":"\n<p>Employee ID to filter by.</p>\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"day_of_week","full_name":"day_of_week","description":"\n<p>Lowercase day of week (e.g. monday)</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/weekly_labor_review_report","name":"weekly_labor_review_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/weekly_labor_review_report","http_method":"POST","short_description":"Get weekly labor review report (CSV or PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for business week commencing in YYYY-MM-DD format</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"type","full_name":"type","description":"\n<p>Type could be “pdf” or “csv”. Defaults to “csv”</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/pay_details_report","name":"pay_details_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/pay_details_report","http_method":"POST","short_description":"Get Pay Details Report (CSV)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager with pay rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n<p>Start date for date range in YYYY-MM-DD format.  Range includes start_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n<p>End date for date range in YYYY-MM-DD format.  Range includes end_date.</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a valid date of form 'YYYY-MM-DD'","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/doc/1.0/admin-report-schedules/planned_shifts_report","name":"planned_shifts_report","apis":[{"api_url":"/api/admin/report/businesses/:business_id/schedules/:id/planned_shifts_report","http_method":"POST","short_description":"Get Planned Shifts Report (PDF)","deprecated":null}],"formats":["pdf"],"full_description":"\n<span id=\"label-Security\" class=\"legacy-anchor\"></span>\n<h2 id=\"security\"><a href=\"#security\">Security</a></h2>\n\n<p>Must have schedule manager rights for the schedule</p>\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n<p>Schedule ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"business_id","full_name":"business_id","description":"\n<p>Business ID</p>\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"must be a UUID","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"async","full_name":"async","description":"\n<p>Generate report as a background async report rather than returning contents immediately.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"force_refresh","full_name":"force_refresh","description":"\n<p>Force full refresh of report, even if existing cached version available.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"notify_by_mail","full_name":"notify_by_mail","description":"\n<p>Send email notification when report is ready or fails. Only applies when async=true.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"employment_ids","full_name":"employment_ids","description":"\n<p>Array of employment IDs to include in report</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"must be an array of UUIDs","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_day_parts_table","full_name":"include_day_parts_table","description":"\n<p>Include day parts table in report. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_managers_table","full_name":"include_managers_table","description":"\n<p>Include managers table in report. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"include_roles_table","full_name":"include_roles_table","description":"\n<p>Include roles table in report. Defaults to false.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"show_as_military_time","full_name":"show_as_military_time","description":"\n<p>Display times in 24-hour format (military time) instead of 12-hour format with am/pm. If not provided, defaults to the business military_time setting.</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weeks","full_name":"weeks","description":"\n<p>Array of week objects with start_date, end_date, shift_ids, and planned_shift_ids</p>\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}