From 8764b5332e3ad9635d142a57e47d6e647a3e0ae7 Mon Sep 17 00:00:00 2001 From: Kam Date: Mon, 18 Jan 2016 22:30:34 +1000 Subject: [PATCH] Add sample Cheese Store API spec Separate Foundation CSS file Add responsive drawer layout Fix rendering bugs --- TODO.md | 3 + app/helpers/schemaRange.js | 2 + app/javascripts/main.js | 62 +- app/lib/common.js | 2 +- app/lib/config.js | 66 +- app/lib/preprocessor.js | 2 +- app/stylesheets/_drawer.scss | 80 + app/stylesheets/_foundation-includes.scss | 47 - app/stylesheets/_foundation-settings.scss | 4 +- app/stylesheets/_index.scss | 9 +- app/stylesheets/_layout.scss | 172 +- app/stylesheets/_utils.scss | 12 +- app/stylesheets/_variables.scss | 20 +- app/stylesheets/foundation.scss | 45 + app/stylesheets/spectacle-core.scss | 6 - app/stylesheets/spectacle.scss | 5 +- app/vendor/foundation/LICENSE | 22 + app/vendor/foundation/README.md | 51 + app/vendor/foundation/js/foundation.abide.js | 418 + .../foundation/js/foundation.accordion.js | 229 + .../foundation/js/foundation.accordionMenu.js | 262 + app/vendor/foundation/js/foundation.core.js | 378 + .../foundation/js/foundation.drilldown.js | 321 + .../foundation/js/foundation.dropdown.js | 390 + .../foundation/js/foundation.dropdownMenu.js | 391 + .../foundation/js/foundation.equalizer.js | 274 + .../foundation/js/foundation.interchange.js | 184 + .../foundation/js/foundation.magellan.js | 212 + .../foundation/js/foundation.offcanvas.js | 371 + app/vendor/foundation/js/foundation.orbit.js | 419 + .../js/foundation.responsiveMenu.js | 145 + .../js/foundation.responsiveToggle.js | 106 + app/vendor/foundation/js/foundation.reveal.js | 478 + app/vendor/foundation/js/foundation.slider.js | 484 + app/vendor/foundation/js/foundation.sticky.js | 436 + app/vendor/foundation/js/foundation.tabs.js | 306 + .../foundation/js/foundation.toggler.js | 147 + .../foundation/js/foundation.tooltip.js | 429 + .../foundation/js/foundation.util.box.js | 169 + .../foundation/js/foundation.util.keyboard.js | 115 + .../js/foundation.util.mediaQuery.js | 210 + .../foundation/js/foundation.util.motion.js | 89 + .../foundation/js/foundation.util.nest.js | 64 + .../js/foundation.util.timerAndImageLoader.js | 78 + .../foundation/js/foundation.util.touch.js | 339 + .../foundation/js/foundation.util.triggers.js | 222 + app/vendor/foundation/scss/_global.scss | 626 + .../scss/components/_accordion-menu.scss | 32 + .../scss/components/_accordion.scss | 113 + .../foundation/scss/components/_badge.scss | 55 + .../scss/components/_breadcrumbs.scss | 94 + .../scss/components/_button-group.scss | 130 + .../foundation/scss/components/_button.scss | 265 + .../foundation/scss/components/_callout.scss | 105 + .../scss/components/_close-button.scss | 61 + .../scss/components/_drilldown.scss | 75 + .../scss/components/_dropdown-menu.scss | 148 + .../foundation/scss/components/_dropdown.scss | 64 + .../scss/components/_flex-video.scss | 63 + .../foundation/scss/components/_float.scss | 27 + .../foundation/scss/components/_label.scss | 56 + .../scss/components/_media-object.scss | 74 + .../foundation/scss/components/_menu.scss | 209 + .../scss/components/_off-canvas.scss | 180 + .../foundation/scss/components/_orbit.scss | 193 + .../scss/components/_pagination.scss | 158 + .../scss/components/_progress-bar.scss | 83 + .../foundation/scss/components/_reveal.scss | 156 + .../foundation/scss/components/_slider.scss | 158 + .../foundation/scss/components/_sticky.scss | 38 + .../foundation/scss/components/_switch.scss | 232 + .../foundation/scss/components/_table.scss | 213 + .../foundation/scss/components/_tabs.scss | 170 + .../scss/components/_thumbnail.scss | 54 + .../scss/components/_title-bar.scss | 68 + .../foundation/scss/components/_tooltip.scss | 100 + .../foundation/scss/components/_top-bar.scss | 89 + .../scss/components/_visibility.scss | 131 + .../foundation/scss/forms/_checkbox.scss | 36 + app/vendor/foundation/scss/forms/_error.scss | 82 + .../foundation/scss/forms/_fieldset.scss | 53 + app/vendor/foundation/scss/forms/_forms.scss | 32 + .../foundation/scss/forms/_help-text.scss | 30 + .../foundation/scss/forms/_input-group.scss | 91 + app/vendor/foundation/scss/forms/_label.scss | 48 + app/vendor/foundation/scss/forms/_select.scss | 63 + app/vendor/foundation/scss/forms/_text.scss | 154 + app/vendor/foundation/scss/foundation.scss | 91 + app/vendor/foundation/scss/grid/_classes.scss | 153 + app/vendor/foundation/scss/grid/_column.scss | 124 + .../foundation/scss/grid/_flex-grid.scss | 281 + app/vendor/foundation/scss/grid/_grid.scss | 48 + app/vendor/foundation/scss/grid/_gutter.scss | 34 + app/vendor/foundation/scss/grid/_layout.scss | 33 + .../foundation/scss/grid/_position.scss | 72 + app/vendor/foundation/scss/grid/_row.scss | 97 + app/vendor/foundation/scss/grid/_size.scss | 24 + .../foundation/scss/settings/_settings.scss | 547 + .../scss/typography/_alignment.scss | 22 + .../foundation/scss/typography/_base.scss | 439 + .../foundation/scss/typography/_helpers.scss | 77 + .../foundation/scss/typography/_print.scss | 73 + .../scss/typography/_typography.scss | 28 + .../foundation/scss/util/_breakpoint.scss | 266 + app/vendor/foundation/scss/util/_color.scss | 41 + app/vendor/foundation/scss/util/_mixins.scss | 223 + .../foundation/scss/util/_selector.scss | 40 + app/vendor/foundation/scss/util/_unit.scss | 90 + app/vendor/foundation/scss/util/_util.scss | 15 + app/vendor/foundation/scss/util/_value.scss | 126 + app/views/main.hbs | 18 +- app/views/partials/layout/content.hbs | 1 + app/views/partials/layout/head.hbs | 6 +- app/views/partials/layout/nav.hbs | 8 +- app/views/partials/layout/page.hbs | 9 - app/views/partials/layout/topbar.hbs | 20 +- app/views/partials/swagger/introduction.hbs | 87 +- app/views/partials/swagger/operation.hbs | 6 +- app/views/partials/swagger/print-schema.hbs | 2 +- app/views/partials/swagger/tags.hbs | 6 +- bin/{cli.js => spectacle-cli.js} | 35 +- package.json | 11 +- public/index.html | 45499 +--------------- public/javascripts/spectacle.js | 430 +- public/javascripts/spectacle.min.js | 2 +- public/stylesheets/foundation.css | 3091 ++ public/stylesheets/foundation.min.css | 1 + public/stylesheets/spectacle.css | 4751 +- public/stylesheets/spectacle.min.css | 2 +- test/fixtures/cheese.json | 1024 + test/fixtures/petstore.json | 1224 +- 131 files changed, 25597 insertions(+), 46665 deletions(-) create mode 100644 TODO.md create mode 100644 app/stylesheets/_drawer.scss delete mode 100644 app/stylesheets/_foundation-includes.scss create mode 100644 app/stylesheets/foundation.scss delete mode 100644 app/stylesheets/spectacle-core.scss create mode 100644 app/vendor/foundation/LICENSE create mode 100644 app/vendor/foundation/README.md create mode 100644 app/vendor/foundation/js/foundation.abide.js create mode 100644 app/vendor/foundation/js/foundation.accordion.js create mode 100644 app/vendor/foundation/js/foundation.accordionMenu.js create mode 100644 app/vendor/foundation/js/foundation.core.js create mode 100644 app/vendor/foundation/js/foundation.drilldown.js create mode 100644 app/vendor/foundation/js/foundation.dropdown.js create mode 100644 app/vendor/foundation/js/foundation.dropdownMenu.js create mode 100644 app/vendor/foundation/js/foundation.equalizer.js create mode 100644 app/vendor/foundation/js/foundation.interchange.js create mode 100644 app/vendor/foundation/js/foundation.magellan.js create mode 100644 app/vendor/foundation/js/foundation.offcanvas.js create mode 100644 app/vendor/foundation/js/foundation.orbit.js create mode 100644 app/vendor/foundation/js/foundation.responsiveMenu.js create mode 100644 app/vendor/foundation/js/foundation.responsiveToggle.js create mode 100644 app/vendor/foundation/js/foundation.reveal.js create mode 100644 app/vendor/foundation/js/foundation.slider.js create mode 100644 app/vendor/foundation/js/foundation.sticky.js create mode 100644 app/vendor/foundation/js/foundation.tabs.js create mode 100644 app/vendor/foundation/js/foundation.toggler.js create mode 100644 app/vendor/foundation/js/foundation.tooltip.js create mode 100644 app/vendor/foundation/js/foundation.util.box.js create mode 100644 app/vendor/foundation/js/foundation.util.keyboard.js create mode 100644 app/vendor/foundation/js/foundation.util.mediaQuery.js create mode 100644 app/vendor/foundation/js/foundation.util.motion.js create mode 100644 app/vendor/foundation/js/foundation.util.nest.js create mode 100644 app/vendor/foundation/js/foundation.util.timerAndImageLoader.js create mode 100644 app/vendor/foundation/js/foundation.util.touch.js create mode 100644 app/vendor/foundation/js/foundation.util.triggers.js create mode 100644 app/vendor/foundation/scss/_global.scss create mode 100644 app/vendor/foundation/scss/components/_accordion-menu.scss create mode 100644 app/vendor/foundation/scss/components/_accordion.scss create mode 100644 app/vendor/foundation/scss/components/_badge.scss create mode 100644 app/vendor/foundation/scss/components/_breadcrumbs.scss create mode 100644 app/vendor/foundation/scss/components/_button-group.scss create mode 100644 app/vendor/foundation/scss/components/_button.scss create mode 100644 app/vendor/foundation/scss/components/_callout.scss create mode 100644 app/vendor/foundation/scss/components/_close-button.scss create mode 100644 app/vendor/foundation/scss/components/_drilldown.scss create mode 100644 app/vendor/foundation/scss/components/_dropdown-menu.scss create mode 100644 app/vendor/foundation/scss/components/_dropdown.scss create mode 100644 app/vendor/foundation/scss/components/_flex-video.scss create mode 100644 app/vendor/foundation/scss/components/_float.scss create mode 100644 app/vendor/foundation/scss/components/_label.scss create mode 100644 app/vendor/foundation/scss/components/_media-object.scss create mode 100644 app/vendor/foundation/scss/components/_menu.scss create mode 100644 app/vendor/foundation/scss/components/_off-canvas.scss create mode 100644 app/vendor/foundation/scss/components/_orbit.scss create mode 100644 app/vendor/foundation/scss/components/_pagination.scss create mode 100644 app/vendor/foundation/scss/components/_progress-bar.scss create mode 100644 app/vendor/foundation/scss/components/_reveal.scss create mode 100644 app/vendor/foundation/scss/components/_slider.scss create mode 100644 app/vendor/foundation/scss/components/_sticky.scss create mode 100644 app/vendor/foundation/scss/components/_switch.scss create mode 100644 app/vendor/foundation/scss/components/_table.scss create mode 100644 app/vendor/foundation/scss/components/_tabs.scss create mode 100644 app/vendor/foundation/scss/components/_thumbnail.scss create mode 100644 app/vendor/foundation/scss/components/_title-bar.scss create mode 100644 app/vendor/foundation/scss/components/_tooltip.scss create mode 100644 app/vendor/foundation/scss/components/_top-bar.scss create mode 100644 app/vendor/foundation/scss/components/_visibility.scss create mode 100644 app/vendor/foundation/scss/forms/_checkbox.scss create mode 100644 app/vendor/foundation/scss/forms/_error.scss create mode 100644 app/vendor/foundation/scss/forms/_fieldset.scss create mode 100644 app/vendor/foundation/scss/forms/_forms.scss create mode 100644 app/vendor/foundation/scss/forms/_help-text.scss create mode 100644 app/vendor/foundation/scss/forms/_input-group.scss create mode 100644 app/vendor/foundation/scss/forms/_label.scss create mode 100644 app/vendor/foundation/scss/forms/_select.scss create mode 100644 app/vendor/foundation/scss/forms/_text.scss create mode 100644 app/vendor/foundation/scss/foundation.scss create mode 100644 app/vendor/foundation/scss/grid/_classes.scss create mode 100644 app/vendor/foundation/scss/grid/_column.scss create mode 100644 app/vendor/foundation/scss/grid/_flex-grid.scss create mode 100644 app/vendor/foundation/scss/grid/_grid.scss create mode 100644 app/vendor/foundation/scss/grid/_gutter.scss create mode 100644 app/vendor/foundation/scss/grid/_layout.scss create mode 100644 app/vendor/foundation/scss/grid/_position.scss create mode 100644 app/vendor/foundation/scss/grid/_row.scss create mode 100644 app/vendor/foundation/scss/grid/_size.scss create mode 100644 app/vendor/foundation/scss/settings/_settings.scss create mode 100644 app/vendor/foundation/scss/typography/_alignment.scss create mode 100644 app/vendor/foundation/scss/typography/_base.scss create mode 100644 app/vendor/foundation/scss/typography/_helpers.scss create mode 100644 app/vendor/foundation/scss/typography/_print.scss create mode 100644 app/vendor/foundation/scss/typography/_typography.scss create mode 100644 app/vendor/foundation/scss/util/_breakpoint.scss create mode 100644 app/vendor/foundation/scss/util/_color.scss create mode 100644 app/vendor/foundation/scss/util/_mixins.scss create mode 100644 app/vendor/foundation/scss/util/_selector.scss create mode 100644 app/vendor/foundation/scss/util/_unit.scss create mode 100644 app/vendor/foundation/scss/util/_util.scss create mode 100644 app/vendor/foundation/scss/util/_value.scss rename bin/{cli.js => spectacle-cli.js} (73%) create mode 100644 public/stylesheets/foundation.css create mode 100644 public/stylesheets/foundation.min.css create mode 100644 test/fixtures/cheese.json diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..7b1c8ed --- /dev/null +++ b/TODO.md @@ -0,0 +1,3 @@ +Enable custom OpenAPI spec extensions for rendering examples +Copy spec to target directory and link +Implement company logo diff --git a/app/helpers/schemaRange.js b/app/helpers/schemaRange.js index 815fe1b..3be003b 100644 --- a/app/helpers/schemaRange.js +++ b/app/helpers/schemaRange.js @@ -1,3 +1,5 @@ +var util = require("util"); + /** * * @param range a json-schema object with minimum, maximum, exclusiveMinimum, exclusiveMaximum diff --git a/app/javascripts/main.js b/app/javascripts/main.js index dbb2322..f4b3f23 100644 --- a/app/javascripts/main.js +++ b/app/javascripts/main.js @@ -1,16 +1,52 @@ $(function() { - var $sidebar = $('#sidebar'); - var $nav = $sidebar.find('nav'); - var traverse = new Traverse($nav, { - threshold: 10, - barOffset: $sidebar.position().top - }); + // $(document).foundation(); - $nav.on('update.traverse', function(event, element) { - $nav.find('section').removeClass('expand'); - var $section = element.parents('section:first'); - if ($section.length) { - $section.addClass('expand'); - } - }); + var $sidebar = $('#sidebar'); + if ($sidebar.length) { + var $docs = $('#docs'); + var $nav = $sidebar.find('nav'); + + // + // Setup sidebar navigation + var traverse = new Traverse($nav, { + threshold: 10, + barOffset: $sidebar.position().top + }); + + $nav.on('update.traverse', function(event, element) { + $nav.find('section').removeClass('expand'); + var $section = element.parents('section:first'); + if ($section.length) { + $section.addClass('expand'); + } + }); + + // + // Bind the drawer layout + var $drawerLayout = $('.drawer-layout'), + $drawer = $drawerLayout.find('.drawer'), + closeDrawer = function() { + $drawer.removeClass('slide-right slide-left'); + $drawer.find('.drawer-overlay').remove(); + $drawerLayout.removeClass('drawer-open drawer-slide-left-large drawer-slide-right-large'); + return false; + }; + + // Drawer open buttons + $drawerLayout.find('[data-drawer-slide]').click(function(e) { + var $this = $(this), + direction = $this.data('drawer-slide'); + $drawerLayout.addClass('drawer-open'); + $drawer.addClass('slide-' + direction); + + var $overlay = $('') + $drawer.append($overlay); + $overlay.click(closeDrawer); + + return false; + }); + + // Drawer close buttons + $drawerLayout.find('[data-drawer-close]').click(closeDrawer); + } }); diff --git a/app/lib/common.js b/app/lib/common.js index 38569ae..340da4a 100644 --- a/app/lib/common.js +++ b/app/lib/common.js @@ -45,7 +45,7 @@ var common = { // Add an extra CRLR before the code so the postprocessor can determine // the correct line indent for the 
 tag.
-      var $ = cheerio.load(marked("```json\r\n\r\n" + schemaString + "\n```"));
+      var $ = cheerio.load(marked("```json\r\n" + schemaString + "\n```"));
       var definitions = $('span:not(:has(span)):contains("#/definitions/")');
       definitions.each(function(index, item) {
           var ref = $(item).html();
diff --git a/app/lib/config.js b/app/lib/config.js
index 1723830..ed78226 100644
--- a/app/lib/config.js
+++ b/app/lib/config.js
@@ -1,19 +1,34 @@
+var path = require('path');
+
 module.exports = function(grunt, options, spec) {
   return {
 
       // Compile SCSS source files into the cache directory
       compass: {
-          dist: {
+          scss: {
               options: {
-                  sassDir: options.appDir + '/stylesheets',
+                  specify: options.appDir + '/stylesheets/spectacle.scss',
+                  sassDir: path.resolve(options.appDir + '/stylesheets'),
                   cssDir: options.cacheDir + '/stylesheets',
                   environment: 'development',
-                  // outputStyle: 'compressed',
                   importPath: [
-                      'node_modules/foundation-sites/scss'
+                      options.appDir + '/vendor',
+                      options.appDir + '/vendor/foundation/scss'
                   ]
               }
-          }
+          },
+          foundation_scss: {
+              options: {
+                  specify: path.resolve(options.appDir + '/stylesheets/foundation.scss'),
+                  sassDir: path.resolve(options.appDir + '/stylesheets'),
+                  cssDir: options.cacheDir + '/stylesheets',
+                  environment: 'development',
+                  importPath: [
+                      options.appDir + '/vendor',
+                      options.appDir + '/vendor/foundation/scss'
+                  ]
+              }
+          },
       },
 
       concat: {
@@ -26,17 +41,39 @@ module.exports = function(grunt, options, spec) {
 
           // Concentrate compiled CSS files into the traget directory
           css: {
-              src: [options.cacheDir + '/stylesheets/*.css'],
+              src: [options.cacheDir + '/stylesheets/spectacle.css'],
               dest: options.targetDir + '/stylesheets/spectacle.css',
+          },
+
+          // // Concentrate required Foundation JS files into the traget directory
+          // foundation_js: {
+          //     src: [
+          //         options.appDir + '/vendor/foundation/js/foundation.core.js',
+          //         options.appDir + '/vendor/foundation/js/foundation.util.mediaQuery.js',
+          //         options.appDir + '/vendor/foundation/js/foundation.util.triggers.js',
+          //         options.appDir + '/vendor/foundation/js/foundation.util.motion.js',
+          //         options.appDir + '/vendor/foundation/js/foundation.offcanvas.js'
+          //     ],
+          //     dest: options.targetDir + '/javascripts/foundation.js',
+          // },
+
+          // Concentrate compiled Foundation CSS files into the traget directory
+          foundation_css: {
+              src: [options.cacheDir + '/stylesheets/foundation.css'],
+              dest: options.targetDir + '/stylesheets/foundation.css',
           }
       },
 
       // Minify compiled JS files in the traget directory
       uglify: {
-          build: {
+          js: {
               src: options.targetDir + '/javascripts/spectacle.js',
               dest: options.targetDir + '/javascripts/spectacle.min.js'
           }
+          // foundation_js: {
+          //     src: options.targetDir + '/javascripts/foundation.js',
+          //     dest: options.targetDir + '/javascripts/foundation.min.js'
+          // }
       },
 
       // Minify compiled CSS files in the traget directory
@@ -77,7 +114,7 @@ module.exports = function(grunt, options, spec) {
                   hostname: '*',
                   port: options.port,
                   base: options.targetDir,
-                  livereload: true
+                  // livereload: true
               }
           }
       },
@@ -85,23 +122,28 @@ module.exports = function(grunt, options, spec) {
       // Watch the filesystem and regenerate docs if sources change
       watch: {
           options: {
-              livereload: true
+              // livereload: true,
+              spawn: false
           },
+          // options: {
+          //     livereload: true
+          // },
           js: {
               files: [options.appDir + '/javascripts/**/*.js'],
-              // tasks: ['javascripts']
+              tasks: ['javascripts']
           },
           css: {
               files: [options.appDir + '/stylesheets/**/*.scss'],
-              // tasks: ['stylesheets']
+              tasks: ['stylesheets']
           },
           templates: {
               files: [
+                options.specFile,
                 options.appDir + '/views/**/*.hbs',
                 options.appDir + '/helpers/**/*.js',
                 options.appDir + '/lib/**/*.js'
               ],
-              // tasks: ['templates']
+              tasks: ['templates']
           }
       }
   }
diff --git a/app/lib/preprocessor.js b/app/lib/preprocessor.js
index f261b73..a729bfe 100644
--- a/app/lib/preprocessor.js
+++ b/app/lib/preprocessor.js
@@ -54,7 +54,7 @@ module.exports = function(swaggerJson) {
             return true
           })
         // Show body section, if either a body-parameter or a consumes-property is present.
-        operation._show_requst_body_section = operation._request_body || operation.consumes
+        operation._show_requst_body_section = !!operation._request_body //|| operation.consumes
       })
     })
     // If there are multiple tags, we show the tag-based summary
diff --git a/app/stylesheets/_drawer.scss b/app/stylesheets/_drawer.scss
new file mode 100644
index 0000000..a209248
--- /dev/null
+++ b/app/stylesheets/_drawer.scss
@@ -0,0 +1,80 @@
+//
+//= Drawer layout
+//
+
+.drawer-layout {
+  .drawer {
+    box-shadow: 0 0 10px rgba($black, 0.5);
+    transition: transform $default-transition-length ease;
+    backface-visibility: hidden;
+
+    &.slide-left {
+      transform: translateX(-250px);
+    }
+    &.slide-right {
+      transform: translateX(250px);
+    }
+    .drawer-overlay {
+      position: absolute;
+      top: 0;
+      left: 0;
+      right: 0;
+      bottom: 0;
+      background-color: rgba($white, 0.25);
+    }
+
+    @include breakpoint(large) {
+      &.slide-left {
+        transform: none;
+        margin-left: -250px;
+      }
+      &.slide-right {
+        transform: none;
+        margin-left: 250px;
+      }
+      .drawer-overlay {
+        display: none;
+      }
+    }
+  }
+
+  @include breakpoint(large) {
+    &.drawer-slide-left-large {
+      .drawer {
+        margin-left: -250px;
+      }
+      .floating-menu-icon {
+        opacity: 0;
+      }
+    }
+    &.drawer-slide-right-large {
+      .drawer {
+        margin-left: 250px;
+      }
+      .floating-menu-icon {
+        opacity: 0;
+      }
+    }
+  }
+
+  &.drawer-open {
+    .floating-menu-icon {
+      opacity: 0;
+    }
+  }
+
+  .floating-menu-icon {
+    position: fixed;
+    top: 0.75rem;
+    right: 0.75rem;
+    background-color: rgba($black, 0.75);
+    padding: 0.65rem;
+    z-index: 1;
+    border-radius: 5px;
+    transition: opacity $default-transition-length linear;
+
+    .hamburger {
+      @include hamburger($color: $white, $color-hover: $medium-gray);
+    }
+  }
+}
diff --git a/app/stylesheets/_foundation-includes.scss b/app/stylesheets/_foundation-includes.scss
deleted file mode 100644
index ec4c119..0000000
--- a/app/stylesheets/_foundation-includes.scss
+++ /dev/null
@@ -1,47 +0,0 @@
-//
-//= Include Foundation components
-
-@import 'foundation';
-
-// TODO: Conditionally include `foundation-global-styles`.
-// It's better if we don't have ANY global includes.
-@include foundation-global-styles;
-
-#spectacle {
-
-  @include foundation-grid;
-  //@include foundation-flex-grid;
-  @include foundation-typography;
-  @include foundation-button;
-  @include foundation-forms;
-  @include foundation-visibility-classes;
-  @include foundation-float-classes;
-  // @include foundation-accordion;
-  // @include foundation-accordion-menu;
-  // @include foundation-badge;
-  // @include foundation-breadcrumbs;
-  // @include foundation-button-group;
-  // @include foundation-callout;
-  // @include foundation-close-button;
-  // @include foundation-drilldown-menu;
-  // @include foundation-dropdown;
-  // @include foundation-dropdown-menu;
-  // @include foundation-flex-video;
-  @include foundation-label;
-  // @include foundation-media-object;
-  @include foundation-menu;
-  // @include foundation-off-canvas;
-  // @include foundation-orbit;
-  // @include foundation-pagination;
-  // @include foundation-progress-bar;
-  // @include foundation-slider;
-  // @include foundation-sticky;
-  // @include foundation-reveal;
-  // @include foundation-switch;
-  @include foundation-table;
-  // @include foundation-tabs;
-  // @include foundation-thumbnail;
-  // @include foundation-title-bar;
-  // @include foundation-tooltip;
-  @include foundation-top-bar;
-}
diff --git a/app/stylesheets/_foundation-settings.scss b/app/stylesheets/_foundation-settings.scss
index 4a68a07..4dc130d 100644
--- a/app/stylesheets/_foundation-settings.scss
+++ b/app/stylesheets/_foundation-settings.scss
@@ -519,9 +519,9 @@ $thumbnail-radius: $global-radius;
 // 33. Title Bar
 // -------------
 
-$titlebar-background: $black;
+$titlebar-background: scale-color($black, $lightness: -10%);
 $titlebar-color: $white;
-$titlebar-padding: 0.5rem;
+$titlebar-padding: 0.75rem 1.25rem; // 0.5rem
 $titlebar-text-font-weight: bold;
 $titlebar-icon-color: $white;
 $titlebar-icon-color-hover: $medium-gray;
diff --git a/app/stylesheets/_index.scss b/app/stylesheets/_index.scss
index 6f0052d..75da8a7 100644
--- a/app/stylesheets/_index.scss
+++ b/app/stylesheets/_index.scss
@@ -2,15 +2,12 @@
 //= Main includes
 //
 
+// Scope everything inside #spectacle ...
 #spectacle {
-
-  // Include highlight.js style
-  @import 'monokai';
-
-  // Include Spectacle layout
   @import 'variables';
   @import 'utils';
   @import 'schema';
   @import 'layout';
-
+  @import 'drawer';
+  @import 'monokai';
 }
diff --git a/app/stylesheets/_layout.scss b/app/stylesheets/_layout.scss
index a25902c..c6b17f5 100644
--- a/app/stylesheets/_layout.scss
+++ b/app/stylesheets/_layout.scss
@@ -13,65 +13,67 @@
   margin: 0 !important;
 }
 
+button:focus {
+  outline: none;
+}
+
 .default-label {
-  @include small-label('secondary');
+  @include small-label($secondary-color);
 }
 
 //
 // Topbar layout
 
-.top-bar {
-  padding: 0.5rem;
-  height: $topbar-height;
-  color: $white;
-
-  // Make it fixed
-  position: fixed;
-  left: 0;
-  right: 0;
-  top: 0;
-  z-index: 1;
-}
+// .top-bar {
+//   padding: 0.5rem;
+//   height: $topbar-height;
+//   color: $white;
+//
+//   // Make it fixed
+//   position: fixed;
+//   left: 0;
+//   right: 0;
+//   top: 0;
+//   z-index: 1;
+// }
+//
 
 #logo {
-  span {
-    opacity: 0.5;
-    margin-left: 5px;
-  }
 }
 
-//
-// Page layout
-
-#page {
-  margin-top: $topbar-height;
-}
+// Include the Foundation grid (the only required component)
+@include foundation-grid();
 
 //
 // Sidebar layout
 
 #sidebar {
-  padding-top: 1rem;
-  padding-left: 1rem;
+  padding-top: 1.5rem;
+  padding-left: 1.5rem;
   padding-right: 1rem;
   padding-bottom: 2rem;
   border-right: 1px solid #eee;
-  background-color: #f6f6f6 !important;
+  background-color: #f6f6f6;
   height: 100vh;
-  //height: 100%;
-  overflow: scroll;
+  overflow: auto;
+  position: fixed;
+  bottom: 0;
+  left: 0;
+  top: 0;
+  width: $drawer-size;
 
   h5 {
-    margin: 1.25rem 0 0.5rem;
+    margin: 1.5rem 0 0.75rem;
     text-transform: uppercase;
     color: $medium-gray;
+    color: $accent-color;
     font-size: 0.9rem;
   }
 
   a {
     display: block;
-    font-size: 0.95rem;
-    margin: 0 0 0.175rem;
+    // font-size: 0.95rem;
+    margin: 0 0 0.25rem;
     color: scale-color($black, $lightness: 15%);
     white-space: nowrap;
     overflow: hidden;
@@ -79,9 +81,9 @@
     text-overflow: ellipsis;
 
     &.active {
-      // color: $primary-color;
-      color: $accent-color;
-      font-weight: bold;
+      color: $accent-color; //$primary-color;
+      color: $primary-color;
+      // font-weight: bold;
     }
   }
 
@@ -102,23 +104,19 @@
       }
     }
   }
-}
 
-@media screen and (min-width: $medium-width) { // medium and up
-  #sidebar {
-    position: fixed;
-    bottom: 0;
-    left: 0;
-    right: 0;
-    top: $topbar-height;
+  .close-button {
+    opacity: 0.5;
   }
 }
 
+
 //
 // Documentation layout
 
 .doc-content {
   @extend .large-6;
+  // @include grid-column(6, $column-padding);
   padding-left: $column-padding !important;
   padding-right: $column-padding !important;
 }
@@ -131,27 +129,31 @@
 }
 
 #docs {
+  background: $white;
   overflow: hidden;
+  position: relative;
 
   .example-box {
     display: none;
   }
-  @media screen and (min-width: $large-width) { // medium and up
+
+  @include breakpoint(large) {
     .example-box {
       // width: 50%;
       display: block;
-      background-color: #2E2F28;
-      background-color: #23241f;
+      // background-color: #2E2F28;
+      background-color: $black;
       position: absolute;
       right: 0;
       top: 0;
       bottom: 0;
-      z-index: -1;
     }
   }
 }
 
 article {
+  position: relative;
+
   .no-description {
     color: $dark-gray;
   }
@@ -173,15 +175,10 @@ article {
     margin-bottom: 0;
   }
 
-  #introduction {
-    padding-top: 2rem; // 30px
+  .tag-description {
+    // margin-bottom: 0 !important;
   }
 
-  // > h1:first-child {
-  //   margin-top: 0;
-  //   margin-bottom: 2.5rem;
-  // }
-
   //
   // Titles
 
@@ -193,6 +190,7 @@ article {
     padding-right: $column-padding;
     border-top: 1px solid #e8e8e8;
     border-bottom: 1px solid #e2e2e2;
+    background-color: #f6f6f6;
     // border-top: 1px solid #ddd;
     // border-bottom: 1px solid #ccc;
     // background-image: url('data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgi…pZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIGZpbGw9InVybCgjZ3JhZCkiIC8+PC9zdmc+IA==');
@@ -201,7 +199,24 @@ article {
     // background-image: -moz-linear-gradient(top, #fff, #f9f9f9);
     // background-image: -webkit-linear-gradient(top, #fff, #f9f9f9);
     // background-image: linear-gradient(to bottom, #fff, #f9f9f9);
-    background-color: #f6f6f6 !important;
+  }
+
+  h1.doc-title {
+    @extend .doc-content;
+    margin: 0;
+    padding-top: 2.15rem;
+    padding-bottom: 0;
+    font-weight: bold;
+    background: transparent;
+    border: none;
+    color: scale-color($black, $lightness: 20%);
+
+    span {
+      display: none;
+      opacity: 0.65;
+      margin-left: 5px;
+      font-weight: normal;
+    }
   }
 
   h2 {
@@ -226,11 +241,15 @@ article {
     @extend .doc-content;
   }
 
-  h1+.panel > h2, h1+span+.panel > h2, h1+span+span+.panel > h2 {
+  h1+.panel > h2 {
     margin-top: 0;
     border-top: none;
   }
 
+  h1+.tag-description+.panel > h2 {
+    margin-top: 2rem;
+  }
+
   h1+.panel h3 {
     margin-top: 1rem;
   }
@@ -271,20 +290,24 @@ article {
 
     .prop-name {
       @extend .columns;
-      @extend .small-4;
-      @extend .text-right;
+      @extend .small-5;
+      // @extend .text-right;
+      text-align: right;
       padding-right: 0.85rem !important;
-      word-break: break-all;
+      word-break: break-word;
     }
     .prop-value {
       @extend .columns;
-      @extend .small-8;
+      @extend .small-7;
       padding-left: 0.85rem !important;
       word-wrap: break-word;
     }
 
     &.prop-inner {
-      @extend small;
+      // @extend small;
+      padding-top: 0.5em;
+      padding-bottom: 0.5em;
+      font-size: $small-font-size;
 
       .prop-name {
         color: $dark-gray;
@@ -298,7 +321,7 @@ article {
   .doc-row {
     @extend .row;
     @extend .collapse;
-    margin: 30px 0 20px;
+    margin: 2rem 0 20px;
   }
 
   .doc-copy {
@@ -333,13 +356,13 @@ article {
         //color: $dark-gray;
       }
     }
-  }
 
-  @media screen and (max-width: $large-width) { // medium and lower
-    .doc-examples:not(:empty) {
-      margin-top: 1.5rem;
-      padding-top: 1.5rem;
-      padding-bottom: 0.5rem;
+    @include breakpoint(medium down) {
+      &:not(:empty) {
+        margin-top: 1.5rem;
+        padding-top: 1.5rem;
+        padding-bottom: 0.5rem;
+      }
     }
   }
 
@@ -347,7 +370,8 @@ article {
   // Powered by link
 
   .powered-by {
-    @extend small;
+    // @extend small;
+    font-size: $small-font-size;
     color: $medium-gray;
 
     span {
@@ -365,7 +389,9 @@ article {
       text-align: right;
       right: 0;
     }
-    @media screen and (min-width: $large-width) { // large and up
+
+    @include breakpoint(large) {
+    // @media screen and (min-width: $large-width) { // large and up
       .operation-tags {
         right: 50%;
       }
@@ -378,18 +404,18 @@ article {
 
 //
 // Code highlighting
-//
 
 .hljs {
-  padding: 0;
+  padding: 0 !important;
+  margin-bottom: 1.5rem;
 
   pre {
     line-height: 1.25;
-    padding: 0.15rem 2rem;
+    padding: 1.5rem 2rem;
 
     border-radius: 5px;
     box-shadow: 0 0 200px rgba(0, 0, 0, 0.33) inset;
-    margin-bottom: 1.5rem;
+    margin: 0;
     border-top: 1px solid #000;
     border-bottom: 1px solid #404040;
 
diff --git a/app/stylesheets/_utils.scss b/app/stylesheets/_utils.scss
index 6309e36..29d6d41 100644
--- a/app/stylesheets/_utils.scss
+++ b/app/stylesheets/_utils.scss
@@ -7,7 +7,7 @@
   &:before {
     content: $title;
     display: block;
-    @extend h6;
+    // @extend h6;
     margin-bottom: 0.5em;
     color: $accent-color;
     text-transform: uppercase;
@@ -15,17 +15,19 @@
   }
 }
 
-@mixin small-label($style:'alert') {
+@mixin small-label($color: $alert-color) {
   @include label();
-  @extend .label.#{$style};
+  // @extend .label.#{$style};
+  background: $color;
+  color: foreground($color);
   font-size: 0.75rem;
   border-radius: 4px;
   padding: 3px 6px;
 }
 
-@mixin named-label($name, $style:'alert') {
+@mixin named-label($name, $color: $alert-color) {
   &:before {
-    @include small-label($style);
+    @include small-label($color);
     content: $name;
   }
 }
diff --git a/app/stylesheets/_variables.scss b/app/stylesheets/_variables.scss
index 232056f..15dad7f 100644
--- a/app/stylesheets/_variables.scss
+++ b/app/stylesheets/_variables.scss
@@ -2,23 +2,29 @@
 //= Layout variables
 //
 
-// The height of the top bar
-$topbar-height: 50px !default;
+// Width of the off-canvas menu.
+$drawer-size: 250px !default;
+
+// Length of animation.
+$default-transition-length: 0.5s !default;
 
 // The width of the column padding
 $column-padding: 2.25rem !default;
 
-// The accent color to use for nav highlights and section headings
+// The accent color to use for section headings
 $accent-color: #f68b1f !default;
 
 // The dark backgorund color behind code examples
 $dark-background-color: $black !default;
 
-// Medium device width (from Foundation)
-$medium-width: 40em !default;
+// The height of the top bar
+// $topbar-height: 50px !default;
 
-// Large device width (from Foundation)
-$large-width: 64em !default;
+// // Medium device width (from Foundation)
+// $medium-width: 40em !default;
+//
+// // Large device width (from Foundation)
+// $large-width: 64em !default;
 
 //
 // JSON schema labels
diff --git a/app/stylesheets/foundation.scss b/app/stylesheets/foundation.scss
new file mode 100644
index 0000000..5379eba
--- /dev/null
+++ b/app/stylesheets/foundation.scss
@@ -0,0 +1,45 @@
+//
+//= Foundation
+//
+
+@import 'foundation-settings';
+@import 'foundation/scss/foundation';
+
+// Include required components to build
+
+@include foundation-global-styles;
+@include foundation-grid;
+//@include foundation-flex-grid;
+@include foundation-typography;
+@include foundation-button;
+@include foundation-forms;
+@include foundation-visibility-classes;
+@include foundation-float-classes;
+// @include foundation-accordion;
+// @include foundation-accordion-menu;
+// @include foundation-badge;
+// @include foundation-breadcrumbs;
+// @include foundation-button-group;
+// @include foundation-callout;
+@include foundation-close-button;
+// @include foundation-drilldown-menu;
+// @include foundation-dropdown;
+// @include foundation-dropdown-menu;
+// @include foundation-flex-video;
+@include foundation-label;
+// @include foundation-media-object;
+// @include foundation-menu;
+// @include foundation-off-canvas;
+// @include foundation-orbit;
+// @include foundation-pagination;
+// @include foundation-progress-bar;
+// @include foundation-slider;
+// @include foundation-sticky;
+// @include foundation-reveal;
+// @include foundation-switch;
+@include foundation-table;
+// @include foundation-tabs;
+// @include foundation-thumbnail;
+// @include foundation-title-bar;
+// @include foundation-tooltip;
+// @include foundation-top-bar;
diff --git a/app/stylesheets/spectacle-core.scss b/app/stylesheets/spectacle-core.scss
deleted file mode 100644
index b68cf57..0000000
--- a/app/stylesheets/spectacle-core.scss
+++ /dev/null
@@ -1,6 +0,0 @@
-//
-//= Spectacle core
-//
-
-// Include just the Spectacle core without Foundation
-@import 'index';
diff --git a/app/stylesheets/spectacle.scss b/app/stylesheets/spectacle.scss
index 16fbb1b..8227432 100644
--- a/app/stylesheets/spectacle.scss
+++ b/app/stylesheets/spectacle.scss
@@ -2,10 +2,9 @@
 //= Spectacle
 //
 
-// Include Foundation
-// TODO: Don't include foundation if already included
+// Include Foundation components and utilities (but don't build anything)
 @import 'foundation-settings';
-@import 'foundation-includes';
+@import 'foundation/scss/foundation';
 
 // Include Spectacle
 @import 'index';
diff --git a/app/vendor/foundation/LICENSE b/app/vendor/foundation/LICENSE
new file mode 100644
index 0000000..1e12290
--- /dev/null
+++ b/app/vendor/foundation/LICENSE
@@ -0,0 +1,22 @@
+Copyright (c) 2013-2015 ZURB, inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/app/vendor/foundation/README.md b/app/vendor/foundation/README.md
new file mode 100644
index 0000000..1e5f4f6
--- /dev/null
+++ b/app/vendor/foundation/README.md
@@ -0,0 +1,51 @@
+# [Foundation for Sites](http://foundation.zurb.com) (v6.1)
+
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/zurb/foundation-sites?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
+Foundation is the most advanced responsive front-end framework in the world. Quickly go from prototype to production, building sites or apps that work on any kind of device with Foundation. Includes layout constructs, like a fully customizable, responsive grid, commonly used JavaScript plugins, and full A11Y support.
+
+## Requirements
+
+Requires NodeJS to be installed on your machine. Works with 0.10, 0.12, and 4.1! **Note that parts of our build process will break with NPM 3, due to the changes in how packages are installed.**
+
+The Sass is compiled using libsass, which requires the GCC to be installed on your machine. Windows users can install it through [MinGW](http://www.mingw.org/), and Mac users can install it through the [Xcode Command-line Tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/).
+
+## Setup
+
+To get going with Foundation you can:
+
+
+  * [Install Yeti Launch](http://foundation.zurb.com/develop/yeti-launch.html): Seriously though, check it out!
+  * [Install the CLI](https://www.npmjs.com/package/foundation-cli): `npm install -g foundation-cli`
+  * [Download the latest release](http://foundation.zurb.com/sites/download.html)
+  * [Install with Bower](http://bower.io): `bower install foundation-sites`
+  * [Install with npm](http://npmjs.com): `npm install foundation-sites`
+  * [Install with Atmosphere for Meteor](https://atmospherejs.com): `meteor add zurb:foundation-sites`
+  * [Install with Composer](https://getcomposer.org/): `php composer.phar require zurb/foundation`
+
+## Documentation
+
+Foundation uses [Gulp](http://gulpjs.com/) and [SuperCollider](https://www.npmjs.com/package/supercollider) to generate its [documentation pages](http://foundation.zurb.com/sites/docs). Documentation can also be run from your local computer:
+
+### View documentation locally
+
+You'll want to clone the Foundation repo first and install all the dependencies. You can do this using the following commands:
+
+```
+git clone git@github.com:zurb/foundation-sites.git
+cd foundation-sites
+npm install
+```
+
+Then just run `npm start` and the documentation will be compiled. It will also launch an instance of [BrowserSync](http://www.browsersync.io/) and open a tab in your default browser.
+The file structure:
+
+```
+foundation/
+├── dist/
+│   └── ...
+├── docs/
+│   └── ...
+```
+
+Copyright (c) 2015 ZURB, inc.
diff --git a/app/vendor/foundation/js/foundation.abide.js b/app/vendor/foundation/js/foundation.abide.js
new file mode 100644
index 0000000..d5794a3
--- /dev/null
+++ b/app/vendor/foundation/js/foundation.abide.js
@@ -0,0 +1,418 @@
+!function(Foundation, $) {
+  'use strict';
+
+  /**
+   * Creates a new instance of Abide.
+   * @class
+   * @fires Abide#init
+   * @param {Object} element - jQuery object to add the trigger to.
+   * @param {Object} options - Overrides to the default plugin settings.
+   */
+  function Abide(element, options) {
+    this.$element = element;
+    this.options  = $.extend({}, Abide.defaults, this.$element.data(), options);
+
+    this._init();
+
+    Foundation.registerPlugin(this, 'Abide');
+  }
+
+  /**
+   * Default settings for plugin
+   */
+  Abide.defaults = {
+    /**
+     * The default event to validate inputs. Checkboxes and radios validate immediately.
+     * Remove or change this value for manual validation.
+     * @option
+     * @example 'fieldChange'
+     */
+    validateOn: 'fieldChange',
+    /**
+     * Class to be applied to input labels on failed validation.
+     * @option
+     * @example 'is-invalid-label'
+     */
+    labelErrorClass: 'is-invalid-label',
+    /**
+     * Class to be applied to inputs on failed validation.
+     * @option
+     * @example 'is-invalid-input'
+     */
+    inputErrorClass: 'is-invalid-input',
+    /**
+     * Class selector to use to target Form Errors for show/hide.
+     * @option
+     * @example '.form-error'
+     */
+    formErrorSelector: '.form-error',
+    /**
+     * Class added to Form Errors on failed validation.
+     * @option
+     * @example 'is-visible'
+     */
+    formErrorClass: 'is-visible',
+    /**
+     * Set to true to validate text inputs on any value change.
+     * @option
+     * @example false
+     */
+    liveValidate: false,
+
+    patterns: {
+      alpha : /^[a-zA-Z]+$/,
+      alpha_numeric : /^[a-zA-Z0-9]+$/,
+      integer : /^[-+]?\d+$/,
+      number : /^[-+]?\d*(?:[\.\,]\d+)?$/,
+
+      // amex, visa, diners
+      card : /^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$/,
+      cvv : /^([0-9]){3,4}$/,
+
+      // http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
+      email : /^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+$/,
+
+      url : /^(https?|ftp|file|ssh):\/\/(((([a-zA-Z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:)*@)?(((\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]))|((([a-zA-Z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-zA-Z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-zA-Z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-zA-Z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-zA-Z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-zA-Z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-zA-Z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-zA-Z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.?)(:\d*)?)(\/((([a-zA-Z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)+(\/(([a-zA-Z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)*)*)?)?(\?((([a-zA-Z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|[\uE000-\uF8FF]|\/|\?)*)?(\#((([a-zA-Z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|\/|\?)*)?$/,
+      // abc.de
+      domain : /^([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,8}$/,
+
+      datetime : /^([0-2][0-9]{3})\-([0-1][0-9])\-([0-3][0-9])T([0-5][0-9])\:([0-5][0-9])\:([0-5][0-9])(Z|([\-\+]([0-1][0-9])\:00))$/,
+      // YYYY-MM-DD
+      date : /(?:19|20)[0-9]{2}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-9])|(?:(?!02)(?:0[1-9]|1[0-2])-(?:30))|(?:(?:0[13578]|1[02])-31))$/,
+      // HH:MM:SS
+      time : /^(0[0-9]|1[0-9]|2[0-3])(:[0-5][0-9]){2}$/,
+      dateISO : /^\d{4}[\/\-]\d{1,2}[\/\-]\d{1,2}$/,
+      // MM/DD/YYYY
+      month_day_year : /^(0[1-9]|1[012])[- \/.](0[1-9]|[12][0-9]|3[01])[- \/.]\d{4}$/,
+      // DD/MM/YYYY
+      day_month_year : /^(0[1-9]|[12][0-9]|3[01])[- \/.](0[1-9]|1[012])[- \/.]\d{4}$/,
+
+      // #FFF or #FFFFFF
+      color : /^#?([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$/
+    },
+    /**
+     * Optional validation functions to be used. `equalTo` being the only default included function.
+     * Functions should return only a boolean if the input is valid or not. Functions are given the following arguments:
+     * el : The jQuery element to validate.
+     * required : Boolean value of the required attribute be present or not.
+     * parent : The direct parent of the input.
+     * @option
+     */
+    validators: {
+      equalTo: function (el, required, parent) {
+        return $('#' + el.attr('data-equalto')).val() === el.val();
+      }
+    }
+  };
+
+
+  /**
+   * Initializes the Abide plugin and calls functions to get Abide functioning on load.
+   * @private
+   */
+  Abide.prototype._init = function(){
+    this.$inputs = this.$element.find('input, textarea, select').not('[data-abide-ignore]');
+
+    this._events();
+  };
+
+  /**
+   * Initializes events for Abide.
+   * @private
+   */
+  Abide.prototype._events = function() {
+    var _this = this;
+
+    this.$element.off('.abide')
+        .on('reset.zf.abide', function(e){
+          _this.resetForm();
+        })
+        .on('submit.zf.abide', function(e){
+          return _this.validateForm();
+        });
+
+    if(this.options.validateOn === 'fieldChange'){
+        this.$inputs.off('change.zf.abide')
+            .on('change.zf.abide', function(e){
+              _this.validateInput($(this));
+            });
+    }
+
+    if(this.options.liveValidate){
+      this.$inputs.off('input.zf.abide')
+          .on('input.zf.abide', function(e){
+            _this.validateInput($(this));
+          });
+    }
+  },
+  /**
+   * Calls necessary functions to update Abide upon DOM change
+   * @private
+   */
+  Abide.prototype._reflow = function() {
+    this._init();
+  };
+  /**
+   * Checks whether or not a form element has the required attribute and if it's checked or not
+   * @param {Object} element - jQuery object to check for required attribute
+   * @returns {Boolean} Boolean value depends on whether or not attribute is checked or empty
+   */
+  Abide.prototype.requiredCheck = function($el) {
+    if(!$el.attr('required')) return true;
+    var isGood = true;
+    switch ($el[0].type) {
+
+      case 'checkbox':
+      case 'radio':
+        isGood = $el[0].checked;
+        break;
+
+      case 'select':
+      case 'select-one':
+      case 'select-multiple':
+        var opt = $el.find('option:selected');
+        if(!opt.length || !opt.val()) isGood = false;
+        break;
+
+      default:
+        if(!$el.val() || !$el.val().length) isGood = false;
+    }
+    return isGood;
+  };
+  /**
+   * Based on $el, get the first element with selector in this order:
+   * 1. The element's direct sibling('s).
+   * 3. The element's parent's children.
+   *
+   * This allows for multiple form errors per input, though if none are found, no form errors will be shown.
+   *
+   * @param {Object} $el - jQuery object to use as reference to find the form error selector.
+   * @returns {Object} jQuery object with the selector.
+   */
+  Abide.prototype.findFormError = function($el){
+    var $error = $el.siblings(this.options.formErrorSelector)
+    if(!$error.length){
+      $error = $el.parent().find(this.options.formErrorSelector);
+    }
+    return $error;
+  };
+  /**
+   * Get the first element in this order:
+   * 2. The
+ + +
+
Response Example (404 Not Found)
+ 
{
+  "code": "integer(int32)",
+  "message": "string",
+  "type": "string"
+}
+
+
+
+ + +
+
+
+ + + + + + + + + + + + + +
api_key +
+
- -
- - - -
- - -
- Employees - Employer +
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- -
-
-
-
employer_id
- -
-
- -

(no description)

-
+
+ + +
+ Cheese
-
-
type
-
string - + + -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - +

+
Update a cheese
+

-
+
+
+
+ POST + /cheeses/{cheeseId} +
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
-
-
-
-
-

PayApp Payroll System

- -
-
-
-
API Endpoint
-
- 

-https://api.mytommy.com/api/v1
-
-
- - -
Response Content-Types: - application/json -
- -
Schemes: - http, https -
- -
Version: - 1.0.0 -
-
-
-
- - -

Authentication

- -
-
-
-

- basicAuth - -

-
-
-
-
description
-
- HTTP Basic Authentication. Works over `HTTP` and `HTTPS` -
-
-
- - -
-
-
-
-
-
-

- api_key - -

-
-
-
-
name
-
-
- api_key -
-
-
-
-
in
-
-
- header -
-
-
- - -
-
-
-
-
-
-

- petstore_auth - -

-
-
-
-
authorizationUrl
-
-
- http://swagger.io/api/oauth/dialog -
-
-
-
-
flow
-
-
- implicit -
-
-
-
-
scopes
-
-
- [object Object] -
-
-
- - -
-
-
-

User

- -
- - -
- User -
- - - -

-
List of Accounts including Employer(s)
-

- -
-
-
- GET - /user/accounts -
-
-
- -
-
-
-

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

- -
-
-
- -
-
- -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Accounts - -
- -
-
-

An array of accounts

- -
+
+
+
+

Updates a cheese in the Store with form data.

+ +
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
+
+ +
+
+ + +
+
+
+
cheeseId
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer (int64) + +
-
+
+
+
in
+
path
+
+
+
+
name
+
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
formData
+
+
+
+
status
+
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
formData
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
405 Method Not Allowed
+
+
+

Invalid input

+ +
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
cheesy_auth + write:cheeses + , read:cheeses +
+
+
+
-
-
Response Example (200 OK)
- 

-[
+                      
+                      

+                          
+                            
+                            

+                                Cheese
+                            

+                            
+                          
+                      
+                        

+                            
Deletes a cheese

+                        

+                      
+                          

+                            

+                              

+                                DELETE
+                                /cheeses/{cheeseId}
+                              

+                            

+                          

+                      
+                      
+                        

+                          

+                      
+                            
+                              

+                                  

+                                    

+                                      
api_key

+                                    

+                                    

+                                      
+                                        
(no description)

+                                    

+                                  

+                                  

+                                    
type

+                                    
string
+                            
+                            
+                            

+                                  

+                                  

+                                    
in

+                                    
header

+                                  

+                                  

+                                    

+                                      
cheeseId

+                                        
+                                    

+                                    

+                                      
+                                        
(no description)

+                                    

+                                  

+                                  

+                                    
type

+                                    
integer  (int64)
+                            
+                            
+                            

+                                  

+                                  

+                                    
in

+                                    
path

+                                  

+                              

+                          

+                      
+                          

+                        

+                      
+                        
+                          

+                            

+                              

+                        
+                                  

+                                    

+                                      
400 Bad Request

+                                        
  
+                            Error
+                          
+                        

+                                        
+                                    

+                                    

+                                      
Invalid ID supplied

+                        
+                                    

+                                  

+                                  

+                                    

+                                      
404 Not Found

+                                        
  
+                            Error
+                          
+                        

+                                        
+                                    

+                                    

+                                      
Cheese not found

+                        
+                                    

+                                  

+                              

+                            

+                            
        

+                                  
Response Example (400 Bad Request)

+                                    
{
+  "code": "integer(int32)",
+  "message": "string",
+  "type": "string"
+}
+

+                                  

+                                

+                                      

+                                  
Response Example (404 Not Found)

+                                    
{
+  "code": "integer(int32)",
+  "message": "string",
+  "type": "string"
+}
+

+                                  

+                                

+                              

+                          

+                          

+                            

+                              

+                                  
+                                      
+                                      
+                                          
+                                          
+                                      
+                                      
+                                      
+                                              
+                                                  
+                                                  
+                                              
+                                      
+                                  
cheesy_auth
+                                                          write:cheeses
+                                                          , read:cheeses
+                                                  

+                              

+                            

+                          

+                      

+                      
+                      

+                          
+                            
+                            

+                                Cheese
+                            

+                            
+                          
+                      
+                        

+                            
Finds cheeses by status

+                        

+                      
+                          

+                            

+                              

+                                GET
+                                /cheeses/findByStatus
+                              

+                            

+                          

+                      
+                          

+                            

+                              

+                                
Multiple status values can be provided with comma separated strings.

+                      
+                              

+                            

+                          

+                      
+                        

+                          

+                      
+                            
+                              

+                                  

+                                    

+                                      
status

+                                        
+                                    

+                                    

+                                      
+                                        
(no description)

+                                    

+                                  

+                            

+                                      
format

+                                      
multiple parameters (status=aaa&status=bbb)

+                                    
      

+                                    
type

+                                    
string[]
+                            
+                            
+                            

+                                  

+                                  

+                                    
in

+                                    
query

+                                  

+                              

+                          

+                      
+                          

+                        

+                      
+                        
+                          

+                            

+                              

+                        
+                                  

+                                    

+                                      
200 OK

+                                        
  
+                            Cheese
+                          
+                        

+                                        
+                                    

+                                    

+                                      
Successful operation

+                        
+                                    

+                                  

+                                  

+                                    

+                                      
400 Bad Request

+                                        
  
+                            Error
+                          
+                        

+                                        
+                                    

+                                    

+                                      
Invalid status value

+                        
+                                    

+                                  

+                              

+                            

+                            
        

+                                  
Response Example (200 OK)

+                                    
[
   {
-    "account_type": "string",
-    "acount_id": "integer",
-    "display_name": "string",
-    "icon_url": "string"
+    "category": {
+      "$ref": "#/definitions/Category"
+    },
+    "id": "integer(int64)",
+    "name": "string",
+    "photoUrls": "array",
+    "status": "string",
+    "tags": "array"
   }
 ]
-                            

-                            

-                          

-                                

-                            
Response Example (default )

-                              

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-                            

-                            

-                          

-                        

-                    

-                

-                
-                

-                    
-                      
-                      

-                          User
-                      

-                      
-                    
-                
-                  

-                      
Update User Data

-                  

-                
-                    

-                      

-                        

-                          PUT
-                          /user
-                        

-                      

-                    

-                
-                    

-                      

-                        

-                          
This updates individual or group of user's records
-                Pages 3_AccountEmployerProfile

-                
-                        

-                      

-                    

-                
-                  

-                    

-                        
-                        

-                              

-                                

-                                  

-                                      
-                                        UserProfile
-                                      
+
-
-
- -

accepts any users data to be updated.

- - -
-
- - - -
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
+
+
+
Response Example (400 Bad Request)
+ 
{
   "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
+  "message": "string",
+  "type": "string"
 }
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
api_key -
-
-
-
- - -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user/password -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- - -
-
-
-
new_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
-
old_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User password updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
- GET - /user/login -
-

- - - -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username/password supplied

- -
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
basicAuth -
-
-
-
-
- -
- - -
- User -
- - - -

-
Accept Employer
-

- -
-
-
- GET - /employee/accept-employer/{employer_id} -
-
-
- -
-
-
-

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) - 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
response
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

User's accepted

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid email/password supplied

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
logout user
-

- -
-
-
- GET - /user/logout -
-
-
- -
-
-
-

Logs out current logged in user session - *Page 3_Account (part3)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
-

Employer

- -
- - -
- Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /employer/{employer_id} -
-
-
- -
-
-
-

Employer profile. - *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerOwnProfile - -
- -
-
-

Profile information for an employer

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employer -
- - - -

-
Update Employer Data
-

- -
-
-
- PUT - /employer/{employer_id} -
-
-
- -
-
-
-

This updates individual or group of employer's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - EmployerOwnProfile - +
-
-
- -

Unique employer identifier to be used for fetching specific employer profile data.

- - -
+
- - - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employer update success

- -
+
+
+
+ + + + + + + + + + + + + +
cheesy_auth + write:cheeses + , read:cheeses +
+
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
+
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
- - - -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- -
-
-
-
employer_id
- -
-
- -

(no description)

-
+
+ + +
+ Cheese
-
-
type
-
string - + + -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - +

+
Upload a cheese image
+

-
+
+
+
+ POST + /cheeses/{cheeseId}/uploadImage +
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- +
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
- -

Role

- -
- - -
- Role -
- - - -

-
Employee Role List
-

- -
-
-
- GET - /employee/roles/{employee_id} -
-
-
- - -
-
- +
+
-
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Role - -
- -
-
-

Employee role list

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role
-

- -
-
-
- POST - /employee/role -
-
-
- - -
-
- -
-
-
-
- - Role - + +
+
+
+
cheeseId
+ +
+
+ +

(no description)

+
-
-
- -

accepts role page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
+
+
type
+
integer (int64) + +
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Details
-

- -
-
-
- GET - /employee/role/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleDetails - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "first_shift": "string",
-  "last_shift": "string",
-  "payroll_variations": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation Details
-

- -
-
-
- GET - /employee/role/variation/{employee_role_variation_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_variation_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role variation details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role Variation
-

- -
-
-
- POST - /employee/role/variation -
-
-
- - -
-
- -
-
-
-
- - RoleVariation -
-
-
- -

accepts variation page data to be added.

+
+
in
+
path
+
+
+
+
additionalMetadata
+
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
formData
+
+
+
+
file
+
+
+ +

(no description)

+
+
+
+
type
+
file + + +
+
+
+
in
+
formData
+
+
+
+ +
+
+ - +
+
+
+ +
+
+
200 OK
+
+ Cheese + +
+ +
+
+

Successful operation

+ +
+
+
+
+
+
Response Example (200 OK)
+ 
{
+  "category": {
+    "$ref": "#/definitions/Category"
+  },
+  "id": "integer(int64)",
+  "name": "string",
+  "photoUrls": "array",
+  "status": "string",
+  "tags": "array"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
cheesy_auth + write:cheeses + , read:cheeses +
+
+
+
+
+

Store

+
+
+

Store methods provide access to cheese store orders.

+ +
+
+ +
+ + +
+ Store +
+ + + +

+
Return cheese inventories by status
+

+ +
+
+
+ GET + /store/inventory +
+
+
+ +
+
+
+

Returns a map of status codes to quantities

+ +
+
+
+ +
+
+ + +
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ +
+
+

Successful operation

+ +
+
+
+
+
+
Response Example (200 OK)
+ 
{
+  "additionalProperties": {
+    "format": "int32",
+    "type": "integer"
+  },
+  "type": "object"
+}
+
+
+
+
+
+
+
+
+ + + + + + + + + + + + + +
api_key +
+
+
+
+
+ +
+ + +
+ Store +
+ + + +

+
Place a cheese order
+

+ +
+
+
+ POST + /store/order +
+
+
+ +
+
+
+

Place an order to purchase cheese from the store.

+ +
+
+
+ +
+
+ +
+
+
+
+ + Order + +
+
+
+ +

Order to place for purchasing the cheese.

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 
{
+  "cheeseId": "integer(int64)",
+  "complete": "boolean",
+  "id": "integer(int64)",
+  "quantity": "integer(int32)",
+  "shipDate": "string(date-time)",
+  "status": "string"
+}
+
-
- - + +
+
-
-
-
-
employee_id
- -
-
- -

(no description)

-
+ +
+
+
+ +
+
+
200 OK
+
+ Order + +
+ +
+
+

Successful operation

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid Order

+ +
+
+
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
+                            
        

+                                  
Response Example (200 OK)

+                                    
{
+  "cheeseId": "integer(int64)",
+  "complete": "boolean",
+  "id": "integer(int64)",
+  "quantity": "integer(int32)",
+  "shipDate": "string(date-time)",
+  "status": "string"
 }
-                          

+
+
+
+
- - - - -
-
-
- -
-
-
200 OK
-
-
-

Employee role variation added

- -
+ +
+ + +
+ Store
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
+ + + +

+
Find purchase order by ID
+

+ +
+
+
+ GET + /store/order/{orderId} +
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
+
+ +
+
+
+

For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions

+ +
+
+
+ +
+
+ + +
+
+
+
orderId
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer (int64) + , { x ∈ ℤ | 1 ≤ x ≤ 10 } + +
+
+
+
in
+
path
+
+
+
+ +
+
+ + +
+
+
+ +
+
+
200 OK
+
+ Order + +
+ +
+
+

Successful operation

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid ID supplied

+ +
+
+
+
+
404 Not Found
+
+
+

Order not found

+ +
+
+
+
+
+
Response Example (200 OK)
+ 
{
+  "cheeseId": "integer(int64)",
+  "complete": "boolean",
+  "id": "integer(int64)",
+  "quantity": "integer(int32)",
+  "shipDate": "string(date-time)",
+  "status": "string"
 }
-
+ +
+
+
+
+
+ +
+ + +
+ Store
- + + + +

+
Delete purchase order by ID
+

+ +
+
+
+ DELETE + /store/order/{orderId} +
+
+
+ +
+
+
+

For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors

+ +
+
+
+ +
+
+ + +
+
+
+
orderId
+ +
+
+ +

(no description)

+
+
+
+
type
+
integer (int64) + , { x ∈ ℤ | x ≥ 1 } + +
+
+
+
in
+
path
+
+
+
+ +
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation List
-

- -
-
-
- GET - /employee/role/variations/{employee_role_id} -
-
-
- - -
-
- -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
+ +
+
+
+ +
+
+
400 Bad Request
+
+
+

Invalid ID supplied

+ +
+
+
+
+
404 Not Found
+
+
+

Order not found

+ +
+
+
-
-
type
-
integer - +
+
+
+

Customer

+
+
+

Customer methods contain operations relating to customer accounts.

+ +
+
-
+
+ + +
+ Customer
-
-
in
-
path
+ + + +

+
Create customer account
+

+ +
+
+
+ POST + /customer +
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role details

- -
+
+ +
+
+
+

This can only be done by the logged in customer.

+ +
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
+
+ +
+
+ +
+
+
+
+ + Customer + +
+
+
+ +

Created customer object

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 
{
+  "customerStatus": "integer(int32)",
+  "email": "string",
+  "firstName": "string",
+  "id": "integer(int64)",
+  "lastName": "string",
+  "password": "string",
+  "phone": "string",
+  "username": "string"
 }
-
+ +
+
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-

Bank

- -
- - -
- Bank -
- - - -

-
List All User Bank
-

- -
-
-
- GET - /user/bank -
-
-
- - -
-
- -
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Banks List

- -
+ +
+
+
+ +
+
+
default
+
+
+

Successful operation

+ +
+
+
-
+
+
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
- - -
- - -
- Bank -
- - - -

-
Get User Bank
-

- -
-
-
- GET - /user/bank/{user_bank_id} -
-
-
- - -
-
- -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
+
+ + +
+ Customer
-
-
type
-
string - + + -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Bank Details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
List All Bank
-

- -
-
-
- GET - /bank -
-
-
- - -
-
- +

+
Create multiple customers
+

-
- -
-
- - -
-
-
- -
-
-
default
-
- Bank - -
- -
-
-

Banks List

- -
+
+
+
+ POST + /customer/createMultiple +
-
-
-
-
Response Example (default )
- 

-{
-  "bank_description": "string",
-  "bank_fullname": "string",
-  "bank_iconurl": "string",
-  "bank_id": "integer",
-  "bank_name": "string",
-  "bank_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Add User Bank Allotment
-

- -
-
-
- POST -
-
-
-
-
-
-
-

PayApp Payroll System

- -
-
-
-
API Endpoint
-
- 

-https://api.mytommy.com/api/v1
-
-
- - -
Response Content-Types: - application/json -
- -
Schemes: - http, https -
- -
Version: - 1.0.0 -
-
-
-
- - -

Authentication

- -
-
-
-

- basicAuth - -

-
-
-
-
description
-
- HTTP Basic Authentication. Works over `HTTP` and `HTTPS` -
-
-
- - -
-
-
-
-
-
-

- api_key - -

-
-
-
-
name
-
-
- api_key -
-
-
-
-
in
-
-
- header -
-
-
- - -
-
-
-
-
-
-

- petstore_auth - -

-
-
-
-
authorizationUrl
-
-
- http://swagger.io/api/oauth/dialog -
-
-
-
-
flow
-
-
- implicit -
-
-
-
-
scopes
-
-
- [object Object] -
-
-
- - -
-
-
-

User

- -
- - -
- User -
- - - -

-
List of Accounts including Employer(s)
-

- -
-
-
- GET - /user/accounts -
-
-
- -
-
-
-

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

- -
-
-
- -
-
- -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Accounts - -
- -
-
-

An array of accounts

- -
+
+
+
+

Create a list of customers from the given input array.

+ +
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-[
+
+ +
+
+ +
+
+
+
+ + Customer + +
+
+
+ +

List of created customer objects

+ + +
+
+
+ + +
+ +
+
+
Request Example
+ 
[
   {
-    "account_type": "string",
-    "acount_id": "integer",
-    "display_name": "string",
-    "icon_url": "string"
+    "customerStatus": "integer(int32)",
+    "email": "string",
+    "firstName": "string",
+    "id": "integer(int64)",
+    "lastName": "string",
+    "password": "string",
+    "phone": "string",
+    "username": "string"
   }
 ]
-
+ +
+
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
+ -
-
-
-
- - UserProfile - +
+
+
+ +
+
+
default
+
+
+

Successful operation

+ +
-
-
- -

accepts any users data to be updated.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
+
+
+
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
api_key -
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user/password -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
new_password
- -
-
- -

(no description)

-
+
+ + +
+ Customer
-
-
type
-
string - + + -
-
-
-
in
-
query
-
-
-
-
old_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - +

+
Customer login
+

-
+
+
+
+ POST + /customer/login +
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User password updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
- GET - /user/login -
-

- - - -
-
- +
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username/password supplied

- -
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
basicAuth -
-
-
-
-
- -
- - -
- User -
- - - -

-
Accept Employer
-

- -
-
-
- GET - /employee/accept-employer/{employer_id} -
-
-
- -
-
-
-

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) - 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

- -
-
-
- -
-
- +
+
+
+

Log a customer into the system and create a new user session.

-
-
-
-
employer_id
- -
-
- -

(no description)

-
+
-
-
type
-
string - +
-
-
-
-
in
-
path
-
-
-
-
response
- -
-
- -

(no description)

-
-
-
-
type
-
string - +
+
-
-
-
-
in
-
query
-
- -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

User's accepted

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid email/password supplied

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
logout user
-

- -
-
-
- GET - /user/logout -
-
-
- -
-
-
-

Logs out current logged in user session - *Page 3_Account (part3)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
-

Employer

- -
- - -
- Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /employer/{employer_id} -
-
-
- -
-
-
-

Employer profile. - *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerOwnProfile - -
- -
-
-

Profile information for an employer

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employer -
- - - -

-
Update Employer Data
-

- -
-
-
- PUT - /employer/{employer_id} -
-
-
- -
-
-
-

This updates individual or group of employer's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - EmployerOwnProfile - + +
+
+
+
username
+ +
+
+ +

(no description)

+
-
-
- -

Unique employer identifier to be used for fetching specific employer profile data.

- - -
-
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
+
+
type
+
string + +
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employer update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Role

- -
- - -
- Role -
- - - -

-
Employee Role List
-

- -
-
-
- GET - /employee/roles/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Role - -
- -
-
-

Employee role list

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role
-

- -
-
-
- POST - /employee/role -
-
-
- - -
-
- -
-
-
-
- - Role -
-
-
- -

accepts role page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Details
-

- -
-
-
- GET - /employee/role/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleDetails - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "first_shift": "string",
-  "last_shift": "string",
-  "payroll_variations": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation Details
-

- -
-
-
- GET - /employee/role/variation/{employee_role_variation_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_variation_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role variation details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role Variation
-

- -
-
-
- POST - /employee/role/variation -
-
-
- - -
-
- -
-
-
-
- - RoleVariation - +
+
in
+
query
-
-
- -

accepts variation page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role variation added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation List
-

- -
-
-
- GET - /employee/role/variations/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Bank

- -
- - -
- Bank -
- - - -

-
List All User Bank
-

- -
-
-
- GET - /user/bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Get User Bank
-

- -
-
-
- GET - /user/bank/{user_bank_id} -
-
-
- - -
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Bank Details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
List All Bank
-

- -
-
-
- GET - /bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- Bank - -
- -
-
-

Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_description": "string",
-  "bank_fullname": "string",
-  "bank_iconurl": "string",
-  "bank_id": "integer",
-  "bank_name": "string",
-  "bank_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Add User Bank Allotment
-

- -
-
-
- POST - /user/bank/allotment/{user_bank_id} -
-
-
- - -
-
- -
-
-
-
- - BankAllotment - +
+
+
password
+ +
+
+ +

(no description)

+
-
-
- -

accepts user bank allotment data to be added.

- - -
-
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
+
+
type
+
string + +
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "pay_type": "string",
-  "user_bank_allotment_fixed": "string",
-  "user_bank_allotment_id": "integer",
-  "user_bank_allotment_percent": "string",
-  "user_bank_id": "integer"
-}
-
+
+
+
in
+
query
+
+
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Bank Allotment successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
+ +
-
-
-

SuperFund

- -
- - -
- SuperFund -
- - - -

-
List All Superfund
-

- -
-
-
- GET - /superfund -
-
-
- - -
-
- -
- -
-
- - -
-
-
- -
-
-
default
-
- SuperFund - -
- -
-
-

SuportFund List

- -
+ +
+
+
+ +
+
+
200 OK
+
+ +
+
+

Successful operation

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username/password supplied

+ +
+
+
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_description": "string",
-  "superfund_id": "integer",
-  "superfund_name": "string"
+                            
        

+                                  
Response Example (200 OK)

+                                    
{
+  "type": "string"
 }
-                            

+
+
+
+
+
+
+ +
+ + +
+ Customer
- + + + +

+
Customer logout
+

+ +
+
+
+ GET + /customer/logout +
+
+
+ +
+
+
+

Log the currently the authenticated customer out of the system and end the user session.

+ +
+
+
+ +
+
+ + +
+ +
-
-
- -
- - -
- SuperFund -
- - - -

-
List All User SuperFund
-

- -
-
-
- GET - /user/superfund -
-
-
- - -
-
- -
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

List User superfund

- -
+ +
+
+
+ +
+
+
default
+
+
+

Successful operation

+ +
+
+
-
+
+
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
+ +
+ + +
+ Customer
-
+ + + +

+
Get customer by username
+

+ +
+
+
+ GET + /customer/{username} +
+
+
+ +
+
+
+

Get customer by their customer username.

+ +
+
+
+ +
+
+ + +
+
+
+
username
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
-
-
- -
- - -
- SuperFund -
- - - -

-
GetUser SuperFund Details
-

- -
-
-
- GET - /user/superfund/{user_supperfund_id} -
-
-
- - -
-
- -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

User superfund details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
+ +
+
+
+ +
+
+
200 OK
+
+ Customer +
-
-
- -
- - -
- SuperFund -
- - - -

-
List All Employer with SuperFund
-

- -
-
-
- GET - /user/superfund/employer/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
+ +
+
+

Successful operation

+ +
+
+
+
+
400 Bad Request
+
+
+

Invalid username supplied

+ +
+
+
+
+
404 Not Found
+
+
+

Customer not found

+ +
+
+
-
-
type
-
string - - -
-
-
-
in
-
path
-
- -
- -
-
- - -
-
-
- -
-
-
default
-
- UserEmployerSuperFund - -
- -
-
-

List Employer with superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "employer_id": "integer",
-  "employer_name": "string",
-  "user_employer_superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_status": "string"
+                            
        

+                                  
Response Example (200 OK)

+                                    
{
+  "customerStatus": "integer(int32)",
+  "email": "string",
+  "firstName": "string",
+  "id": "integer(int64)",
+  "lastName": "string",
+  "password": "string",
+  "phone": "string",
+  "username": "string"
 }
-                            

+
+
+
+
+
+
+ +
+ + +
+ Customer +
+ + + +

+
Update customer
+

+ +
+
+
+ PUT + /customer/{username} +
+
+
+ +
+
+
+

This can only be done by the logged in customer.

+ +
+
+
+ +
+
+ +
+
+
+
+ + Customer + +
+
+
+ +

Customer object to be updated.

+ + +
+
+
+ + +
+
+
+
username
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + + +
+
+
+
in
+
path
+
+
+
+ +
+
+
Request Example
+ 
{
+  "customerStatus": "integer(int32)",
+  "email": "string",
+  "firstName": "string",
+  "id": "integer(int64)",
+  "lastName": "string",
+  "password": "string",
+  "phone": "string",
+  "username": "string"
+}
+
+
+
-
-
-
- -
- - -
- SuperFund -
- - - -

-
Remove User Employer SupportFund
-

- -
-
-
- POST - /user/superfund/employer/remove/{user_supperfund_id} -
-
-
- - -
-
- -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
+ +
+
+
+ +
+
+
400 Bad Request
+
+
+

Invalid customer supplied

+ +
+
+
+
+
404 Not Found
+
+
+

Customer not found

+ +
+
+
-
-
type
-
string - +
+
+
-
+
+ + +
+ Customer
-
-
in
-
path
-
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - + + -
+

+
Delete customer
+

+ +
+
+
+ DELETE + /customer/{username} +
-
-
in
-
query
+
+ +
+
+
+

Datate a customer by their username.

+ +
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Employer SuperFund successfully remove

- -
+
+ +
+
+ + +
+
+
+
username
+ +
+
+ +

(no description)

+
+
+
+
type
+
string + +
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
+
+
+
in
+
path
+
+
+
+ +
+ + +
+
+
+ +
+
+
400 Bad Request
+
+
+

Invalid username supplied

+ +
+
+
+
+
404 Not Found
+
+
+

Customer not found

+ +
+
+
+
+
+
+
+ + +

Schema definitions

+ +
+

+ Category: + object + + + +

+
+
+ +
+
+
+ id: + integer (int64) + + +
+
+ name: + string + + +
+
+
+
+
+
+

+ Cheese: + object + + + +

+
+
+ +
+
+
+ id: + object + + +
+
+ category: + + Category + + + + +
+
+ name: + object + + + +
+
+ photoUrls: + object + + + +
+
+ tags: + object + + +
+
+ status: + object + + +
+
+
+
+
+
+
+

+ Customer: + object + + + +

+
+
+ +
+
+
+ id: + object + + +
+
+ username: + object + + +
+
+ firstName: + object + + +
+
+ lastName: + object + + +
+
+ email: + object + + +
+
+ password: + object + + +
+
+ phone: + object + + +
+
+ customerStatus: + object + + +
+
+
+
+
+
+
+

+ Error: + object + + + +

+
+
+ +
+
+
+ code: + object + + +
+
+ type: + object + + +
+
+ message: + object + + +
+
+
+
+
+
+
+

+ Order: + object + + + +

+
+
+ +
+
+
+ id: + object + + +
+
+ cheeseId: + object + + +
+
+ quantity: + object + + +
+
+ shipDate: + object + + +
+
+ status: + object + + +
+
+ complete: + object + + +
+
+
+
+
+
+
+

+ Tag: + object + + + +

+
+
+ +
+
+
+ id: + integer (int64) + + +
+
+ name: + string + + +
+
+
+
+
+
+ +
+
+ Documentation by Spectacle
-

Payroll

- -
- - -
- Payroll -
- - - -

-
List all Pay approval options
-

- -
-
-
- GET - /pay-approval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollApprovalOptions - -
- -
-
-

Pay Approval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_approval_id": "string",
-  "payroll_approval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay interval options
-

- -
-
-
- GET - /pay-interval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollIntervalOptions - -
- -
-
-

Pay Interval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_interval_id": "string",
-  "payroll_interval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay release options
-

- -
-
-
- GET - /pay-release-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollReleaseOptions - -
- -
-
-

Pay Interval Release List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_release_id": "string",
-  "payroll_release_name": "string"
-}
-
-
-
-
-
-
-

Entity

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
-

Tax

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Reporting

- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Employees

- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees -
- - - -

-
Employer Empl

-
-
-
-
-
-
-

PayApp Payroll System

- +
+
-
-
-
API Endpoint
-
- 

-https://api.mytommy.com/api/v1
-
-
- - -
Response Content-Types: - application/json -
- -
Schemes: - http, https -
- -
Version: - 1.0.0 -
-
-
-
- - -

Authentication

- -
-
-
-

- basicAuth - -

-
-
-
-
description
-
-
- HTTP Basic Authentication. Works over `HTTP` and `HTTPS` -
-
-
- - -
-
-
-
-
-
-

- api_key - -

-
-
-
-
name
-
-
- api_key -
-
-
-
-
in
-
-
- header -
-
-
- - -
-
-
-
-
-
-

- petstore_auth - -

-
-
-
-
authorizationUrl
-
-
- http://swagger.io/api/oauth/dialog -
-
-
-
-
flow
-
-
- implicit -
-
-
-
-
scopes
-
-
- [object Object] -
-
-
- - -
-
-
-

User

- -
- - -
- User -
- - - -

-
List of Accounts including Employer(s)
-

- -
-
-
- GET - /user/accounts -
-
-
- -
-
-
-

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Accounts - -
- -
-
-

An array of accounts

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-[
-  {
-    "account_type": "string",
-    "acount_id": "integer",
-    "display_name": "string",
-    "icon_url": "string"
-  }
-]
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - UserProfile - -
-
-
- -

accepts any users data to be updated.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
api_key -
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user/password -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- - -
-
-
-
new_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
-
old_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User password updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
- GET - /user/login -
-

- - - -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username/password supplied

- -
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
basicAuth -
-
-
-
-
- -
- - -
- User -
- - - -

-
Accept Employer
-

- -
-
-
- GET - /employee/accept-employer/{employer_id} -
-
-
- -
-
-
-

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) - 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
response
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

User's accepted

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid email/password supplied

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
logout user
-

- -
-
-
- GET - /user/logout -
-
-
- -
-
-
-

Logs out current logged in user session - *Page 3_Account (part3)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
-

Employer

- -
- - -
- Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /employer/{employer_id} -
-
-
- -
-
-
-

Employer profile. - *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerOwnProfile - -
- -
-
-

Profile information for an employer

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employer -
- - - -

-
Update Employer Data
-

- -
-
-
- PUT - /employer/{employer_id} -
-
-
- -
-
-
-

This updates individual or group of employer's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - EmployerOwnProfile - -
-
-
- -

Unique employer identifier to be used for fetching specific employer profile data.

- - -
-
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employer update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Role

- -
- - -
- Role -
- - - -

-
Employee Role List
-

- -
-
-
- GET - /employee/roles/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Role - -
- -
-
-

Employee role list

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role
-

- -
-
-
- POST - /employee/role -
-
-
- - -
-
- -
-
-
-
- - Role - -
-
-
- -

accepts role page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Details
-

- -
-
-
- GET - /employee/role/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleDetails - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "first_shift": "string",
-  "last_shift": "string",
-  "payroll_variations": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation Details
-

- -
-
-
- GET - /employee/role/variation/{employee_role_variation_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_variation_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role variation details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role Variation
-

- -
-
-
- POST - /employee/role/variation -
-
-
- - -
-
- -
-
-
-
- - RoleVariation - -
-
-
- -

accepts variation page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role variation added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation List
-

- -
-
-
- GET - /employee/role/variations/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Bank

- -
- - -
- Bank -
- - - -

-
List All User Bank
-

- -
-
-
- GET - /user/bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Get User Bank
-

- -
-
-
- GET - /user/bank/{user_bank_id} -
-
-
- - -
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Bank Details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
List All Bank
-

- -
-
-
- GET - /bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- Bank - -
- -
-
-

Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_description": "string",
-  "bank_fullname": "string",
-  "bank_iconurl": "string",
-  "bank_id": "integer",
-  "bank_name": "string",
-  "bank_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Add User Bank Allotment
-

- -
-
-
- POST - /user/bank/allotment/{user_bank_id} -
-
-
- - -
-
- -
-
-
-
- - BankAllotment - -
-
-
- -

accepts user bank allotment data to be added.

- - -
-
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "pay_type": "string",
-  "user_bank_allotment_fixed": "string",
-  "user_bank_allotment_id": "integer",
-  "user_bank_allotment_percent": "string",
-  "user_bank_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Bank Allotment successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

SuperFund

- -
- - -
- SuperFund -
- - - -

-
List All Superfund
-

- -
-
-
- GET - /superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- SuperFund - -
- -
-
-

SuportFund List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_description": "string",
-  "superfund_id": "integer",
-  "superfund_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All User SuperFund
-

- -
-
-
- GET - /user/superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

List User superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
GetUser SuperFund Details
-

- -
-
-
- GET - /user/superfund/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

User superfund details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All Employer with SuperFund
-

- -
-
-
- GET - /user/superfund/employer/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserEmployerSuperFund - -
- -
-
-

List Employer with superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "employer_id": "integer",
-  "employer_name": "string",
-  "user_employer_superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
Remove User Employer SupportFund
-

- -
-
-
- POST - /user/superfund/employer/remove/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Employer SuperFund successfully remove

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Payroll

- -
- - -
- Payroll -
- - - -

-
List all Pay approval options
-

- -
-
-
- GET - /pay-approval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollApprovalOptions - -
- -
-
-

Pay Approval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_approval_id": "string",
-  "payroll_approval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay interval options
-

- -
-
-
- GET - /pay-interval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollIntervalOptions - -
- -
-
-

Pay Interval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_interval_id": "string",
-  "payroll_interval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay release options
-

- -
-
-
- GET - /pay-release-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollReleaseOptions - -
- -
-
-

Pay Interval Release List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_release_id": "string",
-  "payroll_release_name": "string"
-}
-
-
-
-
-
-
-

Entity

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
-

Tax

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Reporting

- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Employees

- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees -
- - - -

-
Employer Employee List
-

- -
-
-
- GET - /employer/employees -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Employee

- -
- - -
- Employee -
- - - -

-
Employee Profile
-

- -
-
-
- GET - /employee/{employee_id} -
-
-
- -
-
-
-

E_Employee-Profile (part1)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

employee profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Availability
-

- -
-
-
- GET - /employee/unavailability/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Unavailability - -
- -
-
-

employee unavailability within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Shifts
-

- -
-
-
- GET - /employee/shift/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Shifts (calendar view – clicked) - E_Employee-Profile_Shifts (List View)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployeeShifts - -
- -
-
-

employee shifts within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employer_id": "integer",
-  "employer_shift_assigned_id": "integer",
-  "end_date": "object",
-  "location_id": "integer",
-  "note": "string",
-  "role_id": "integer",
-  "start_date": "object"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Unavailability

- -
- - -
- Unavailability -
- - - -

-
Add Employee Unavailability
-

- -
-
-
- POST - /employee/unavailability -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- -
-
-
-
- - Unavailability - -
-
-
- -

accepts unavailability form data.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability added successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Unavailability -
- - - -

-
Delete Employee Unavailability
-

- -
-
-
- DELETE - /employee/unavailability/{employee_unavailability_id} -
-
-
- -
-
-
-

E_Employee-Profile_Availability_Edit (Delete confirmation)

- -
-
-
- -
-
- - -
-
-
-
employee_unavailability_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability deleted successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Shift

- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerShiftsMonth - -
- -
-
-

employer shifts count within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "count": "integer",
-  "date": "object",
-  "employer_shift_id": "integer",
-  "publish": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
-
-
-
-

PayApp Payroll System

- -
-
-
-
API Endpoint
-
- 

-https://api.mytommy.com/api/v1
-
-
- - -
Response Content-Types: - application/json -
- -
Schemes: - http, https -
- -
Version: - 1.0.0 -
-
-
-
- - -

Authentication

- -
-
-
-

- basicAuth - -

-
-
-
-
description
-
-
- HTTP Basic Authentication. Works over `HTTP` and `HTTPS` -
-
-
- - -
-
-
-
-
-
-

- api_key - -

-
-
-
-
name
-
-
- api_key -
-
-
-
-
in
-
-
- header -
-
-
- - -
-
-
-
-
-
-

- petstore_auth - -

-
-
-
-
authorizationUrl
-
-
- http://swagger.io/api/oauth/dialog -
-
-
-
-
flow
-
-
- implicit -
-
-
-
-
scopes
-
-
- [object Object] -
-
-
- - -
-
-
-

User

- -
- - -
- User -
- - - -

-
List of Accounts including Employer(s)
-

- -
-
-
- GET - /user/accounts -
-
-
- -
-
-
-

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Accounts - -
- -
-
-

An array of accounts

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-[
-  {
-    "account_type": "string",
-    "acount_id": "integer",
-    "display_name": "string",
-    "icon_url": "string"
-  }
-]
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - UserProfile - -
-
-
- -

accepts any users data to be updated.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
api_key -
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user/password -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- - -
-
-
-
new_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
-
old_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User password updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
- GET - /user/login -
-

- - - -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username/password supplied

- -
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
basicAuth -
-
-
-
-
- -
- - -
- User -
- - - -

-
Accept Employer
-

- -
-
-
- GET - /employee/accept-employer/{employer_id} -
-
-
- -
-
-
-

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) - 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
response
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

User's accepted

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid email/password supplied

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
logout user
-

- -
-
-
- GET - /user/logout -
-
-
- -
-
-
-

Logs out current logged in user session - *Page 3_Account (part3)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
-

Employer

- -
- - -
- Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /employer/{employer_id} -
-
-
- -
-
-
-

Employer profile. - *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerOwnProfile - -
- -
-
-

Profile information for an employer

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employer -
- - - -

-
Update Employer Data
-

- -
-
-
- PUT - /employer/{employer_id} -
-
-
- -
-
-
-

This updates individual or group of employer's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - EmployerOwnProfile - -
-
-
- -

Unique employer identifier to be used for fetching specific employer profile data.

- - -
-
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employer update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Role

- -
- - -
- Role -
- - - -

-
Employee Role List
-

- -
-
-
- GET - /employee/roles/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Role - -
- -
-
-

Employee role list

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role
-

- -
-
-
- POST - /employee/role -
-
-
- - -
-
- -
-
-
-
- - Role - -
-
-
- -

accepts role page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Details
-

- -
-
-
- GET - /employee/role/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleDetails - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "first_shift": "string",
-  "last_shift": "string",
-  "payroll_variations": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation Details
-

- -
-
-
- GET - /employee/role/variation/{employee_role_variation_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_variation_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role variation details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role Variation
-

- -
-
-
- POST - /employee/role/variation -
-
-
- - -
-
- -
-
-
-
- - RoleVariation - -
-
-
- -

accepts variation page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role variation added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation List
-

- -
-
-
- GET - /employee/role/variations/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Bank

- -
- - -
- Bank -
- - - -

-
List All User Bank
-

- -
-
-
- GET - /user/bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Get User Bank
-

- -
-
-
- GET - /user/bank/{user_bank_id} -
-
-
- - -
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Bank Details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
List All Bank
-

- -
-
-
- GET - /bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- Bank - -
- -
-
-

Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_description": "string",
-  "bank_fullname": "string",
-  "bank_iconurl": "string",
-  "bank_id": "integer",
-  "bank_name": "string",
-  "bank_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Add User Bank Allotment
-

- -
-
-
- POST - /user/bank/allotment/{user_bank_id} -
-
-
- - -
-
- -
-
-
-
- - BankAllotment - -
-
-
- -

accepts user bank allotment data to be added.

- - -
-
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "pay_type": "string",
-  "user_bank_allotment_fixed": "string",
-  "user_bank_allotment_id": "integer",
-  "user_bank_allotment_percent": "string",
-  "user_bank_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Bank Allotment successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

SuperFund

- -
- - -
- SuperFund -
- - - -

-
List All Superfund
-

- -
-
-
- GET - /superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- SuperFund - -
- -
-
-

SuportFund List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_description": "string",
-  "superfund_id": "integer",
-  "superfund_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All User SuperFund
-

- -
-
-
- GET - /user/superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

List User superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
GetUser SuperFund Details
-

- -
-
-
- GET - /user/superfund/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

User superfund details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All Employer with SuperFund
-

- -
-
-
- GET - /user/superfund/employer/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserEmployerSuperFund - -
- -
-
-

List Employer with superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "employer_id": "integer",
-  "employer_name": "string",
-  "user_employer_superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
Remove User Employer SupportFund
-

- -
-
-
- POST - /user/superfund/employer/remove/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Employer SuperFund successfully remove

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Payroll

- -
- - -
- Payroll -
- - - -

-
List all Pay approval options
-

- -
-
-
- GET - /pay-approval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollApprovalOptions - -
- -
-
-

Pay Approval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_approval_id": "string",
-  "payroll_approval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay interval options
-

- -
-
-
- GET - /pay-interval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollIntervalOptions - -
- -
-
-

Pay Interval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_interval_id": "string",
-  "payroll_interval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay release options
-

- -
-
-
- GET - /pay-release-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollReleaseOptions - -
- -
-
-

Pay Interval Release List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_release_id": "string",
-  "payroll_release_name": "string"
-}
-
-
-
-
-
-
-

Entity

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
-

Tax

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Reporting

- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Employees

- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees -
- - - -

-
Employer Employee List
-

- -
-
-
- GET - /employer/employees -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Employee

- -
- - -
- Employee -
- - - -

-
Employee Profile
-

- -
-
-
- GET - /employee/{employee_id} -
-
-
- -
-
-
-

E_Employee-Profile (part1)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

employee profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Availability
-

- -
-
-
- GET - /employee/unavailability/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Unavailability - -
- -
-
-

employee unavailability within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Shifts
-

- -
-
-
- GET - /employee/shift/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Shifts (calendar view – clicked) - E_Employee-Profile_Shifts (List View)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployeeShifts - -
- -
-
-

employee shifts within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employer_id": "integer",
-  "employer_shift_assigned_id": "integer",
-  "end_date": "object",
-  "location_id": "integer",
-  "note": "string",
-  "role_id": "integer",
-  "start_date": "object"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Unavailability

- -
- - -
- Unavailability -
- - - -

-
Add Employee Unavailability
-

- -
-
-
- POST - /employee/unavailability -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- -
-
-
-
- - Unavailability - -
-
-
- -

accepts unavailability form data.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability added successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Unavailability -
- - - -

-
Delete Employee Unavailability
-

- -
-
-
- DELETE - /employee/unavailability/{employee_unavailability_id} -
-
-
- -
-
-
-

E_Employee-Profile_Availability_Edit (Delete confirmation)

- -
-
-
- -
-
- - -
-
-
-
employee_unavailability_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability deleted successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Shift

- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerShiftsMonth - -
- -
-
-

employer shifts count within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "count": "integer",
-  "date": "object",
-  "employer_shift_id": "integer",
-  "publish": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerShifts - -
- -
-
-

employer shifts count within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Publish Employer Shifts
-

- -
-
-
- PUT - /shift/publish -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift published

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employer Shift Update
-

- -
-
-
- PUT - /shift/{employer_shift_id} -
-
-
- - -
-
- -
-
-
-
- - EmployerShifts - -
-
-
- -

accepts shift form data.

- - -
-
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift details updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Add Employer Shift
-

- -
-
-
- POST - /shift -
-
-
- - -
-
- -
-
-
-
- - EmployerShifts - -
-
-
- -

accepts shift form data.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employee Shift
-

- -
-
-
- GET - /employee/shift/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployeeShift - -
- -
-
-

shift added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employer_shift_assigned_id": "integer",
-  "role_name": "string",
-  "shift_current_time": "string",
-  "shift_status": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
List Employees Scheduled on this Shift
-

- -
-
-
- GET - /shift/scheduled/{employer_shift_id} -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

list of employees

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Add employee on shift
-

- -
-
-
- POST - /shift/add/employee/{employer_shift_id} -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

add employee to shift

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Remove employee on shift
-

- -
-
-
- DELETE - /shift/employee/{employer_shift_assigned_id}/ -
-
-
- - -
-
- - -
-
-
-
employer_shift_assigned_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

employee removed

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Industry

- -
- - -
- Industry -
- - - -

-
List all industries
-

- -
-
-
- GET - /industry -
-
-
- -
-
-
-

fetch industries, used in select/list - *Page 3_Account_EmployerProfile (Industry select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Industries - -
- -
-
-

Industry Lists

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "industry_code": "string",
-  "industry_description": "string",
-  "industry_id": "string",
-  "industry_name": "string"
-}
-
-
-
-
-
-
-

Documents

- -
- - -
- Documents -
- - - -

-
Add new document
-

- -
-
-
- POST - /documents -
-
-
- - -
-
- -
-
-
-
- - Documents - -
-
-
- -

accepts document data to be added.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Document successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Edit document
-

- -
-
-
- PUT - /documents/{document_id} -
-
-
- - -
-
- -
-
-
-
- - Documents - -
-
-
- -

accepts document data to be edited.

- - -
-
-
- - -
-
-
-
document_id
-
-
-
-
-
-
-
-

PayApp Payroll System

- -
-
-
-
API Endpoint
-
- 

-https://api.mytommy.com/api/v1
-
-
- - -
Response Content-Types: - application/json -
- -
Schemes: - http, https -
- -
Version: - 1.0.0 -
-
-
-
- - -

Authentication

- -
-
-
-

- basicAuth - -

-
-
-
-
description
-
-
- HTTP Basic Authentication. Works over `HTTP` and `HTTPS` -
-
-
- - -
-
-
-
-
-
-

- api_key - -

-
-
-
-
name
-
-
- api_key -
-
-
-
-
in
-
-
- header -
-
-
- - -
-
-
-
-
-
-

- petstore_auth - -

-
-
-
-
authorizationUrl
-
-
- http://swagger.io/api/oauth/dialog -
-
-
-
-
flow
-
-
- implicit -
-
-
-
-
scopes
-
-
- [object Object] -
-
-
- - -
-
-
-

User

- -
- - -
- User -
- - - -

-
List of Accounts including Employer(s)
-

- -
-
-
- GET - /user/accounts -
-
-
- -
-
-
-

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Accounts - -
- -
-
-

An array of accounts

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-[
-  {
-    "account_type": "string",
-    "acount_id": "integer",
-    "display_name": "string",
-    "icon_url": "string"
-  }
-]
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - UserProfile - -
-
-
- -

accepts any users data to be updated.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
api_key -
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user/password -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- - -
-
-
-
new_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
-
old_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User password updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
- GET - /user/login -
-

- - - -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username/password supplied

- -
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
basicAuth -
-
-
-
-
- -
- - -
- User -
- - - -

-
Accept Employer
-

- -
-
-
- GET - /employee/accept-employer/{employer_id} -
-
-
- -
-
-
-

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) - 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
response
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

User's accepted

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid email/password supplied

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
logout user
-

- -
-
-
- GET - /user/logout -
-
-
- -
-
-
-

Logs out current logged in user session - *Page 3_Account (part3)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
-

Employer

- -
- - -
- Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /employer/{employer_id} -
-
-
- -
-
-
-

Employer profile. - *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerOwnProfile - -
- -
-
-

Profile information for an employer

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employer -
- - - -

-
Update Employer Data
-

- -
-
-
- PUT - /employer/{employer_id} -
-
-
- -
-
-
-

This updates individual or group of employer's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - EmployerOwnProfile - -
-
-
- -

Unique employer identifier to be used for fetching specific employer profile data.

- - -
-
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employer update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Role

- -
- - -
- Role -
- - - -

-
Employee Role List
-

- -
-
-
- GET - /employee/roles/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Role - -
- -
-
-

Employee role list

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role
-

- -
-
-
- POST - /employee/role -
-
-
- - -
-
- -
-
-
-
- - Role - -
-
-
- -

accepts role page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Details
-

- -
-
-
- GET - /employee/role/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleDetails - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "first_shift": "string",
-  "last_shift": "string",
-  "payroll_variations": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation Details
-

- -
-
-
- GET - /employee/role/variation/{employee_role_variation_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_variation_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role variation details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role Variation
-

- -
-
-
- POST - /employee/role/variation -
-
-
- - -
-
- -
-
-
-
- - RoleVariation - -
-
-
- -

accepts variation page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role variation added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation List
-

- -
-
-
- GET - /employee/role/variations/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Bank

- -
- - -
- Bank -
- - - -

-
List All User Bank
-

- -
-
-
- GET - /user/bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Get User Bank
-

- -
-
-
- GET - /user/bank/{user_bank_id} -
-
-
- - -
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Bank Details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
List All Bank
-

- -
-
-
- GET - /bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- Bank - -
- -
-
-

Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_description": "string",
-  "bank_fullname": "string",
-  "bank_iconurl": "string",
-  "bank_id": "integer",
-  "bank_name": "string",
-  "bank_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Add User Bank Allotment
-

- -
-
-
- POST - /user/bank/allotment/{user_bank_id} -
-
-
- - -
-
- -
-
-
-
- - BankAllotment - -
-
-
- -

accepts user bank allotment data to be added.

- - -
-
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "pay_type": "string",
-  "user_bank_allotment_fixed": "string",
-  "user_bank_allotment_id": "integer",
-  "user_bank_allotment_percent": "string",
-  "user_bank_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Bank Allotment successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

SuperFund

- -
- - -
- SuperFund -
- - - -

-
List All Superfund
-

- -
-
-
- GET - /superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- SuperFund - -
- -
-
-

SuportFund List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_description": "string",
-  "superfund_id": "integer",
-  "superfund_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All User SuperFund
-

- -
-
-
- GET - /user/superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

List User superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
GetUser SuperFund Details
-

- -
-
-
- GET - /user/superfund/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

User superfund details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All Employer with SuperFund
-

- -
-
-
- GET - /user/superfund/employer/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserEmployerSuperFund - -
- -
-
-

List Employer with superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "employer_id": "integer",
-  "employer_name": "string",
-  "user_employer_superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
Remove User Employer SupportFund
-

- -
-
-
- POST - /user/superfund/employer/remove/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Employer SuperFund successfully remove

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Payroll

- -
- - -
- Payroll -
- - - -

-
List all Pay approval options
-

- -
-
-
- GET - /pay-approval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollApprovalOptions - -
- -
-
-

Pay Approval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_approval_id": "string",
-  "payroll_approval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay interval options
-

- -
-
-
- GET - /pay-interval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollIntervalOptions - -
- -
-
-

Pay Interval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_interval_id": "string",
-  "payroll_interval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay release options
-

- -
-
-
- GET - /pay-release-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollReleaseOptions - -
- -
-
-

Pay Interval Release List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_release_id": "string",
-  "payroll_release_name": "string"
-}
-
-
-
-
-
-
-

Entity

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
-

Tax

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Reporting

- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Employees

- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees -
- - - -

-
Employer Employee List
-

- -
-
-
- GET - /employer/employees -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Employee

- -
- - -
- Employee -
- - - -

-
Employee Profile
-

- -
-
-
- GET - /employee/{employee_id} -
-
-
- -
-
-
-

E_Employee-Profile (part1)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

employee profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Availability
-

- -
-
-
- GET - /employee/unavailability/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Unavailability - -
- -
-
-

employee unavailability within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Shifts
-

- -
-
-
- GET - /employee/shift/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Shifts (calendar view – clicked) - E_Employee-Profile_Shifts (List View)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployeeShifts - -
- -
-
-

employee shifts within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employer_id": "integer",
-  "employer_shift_assigned_id": "integer",
-  "end_date": "object",
-  "location_id": "integer",
-  "note": "string",
-  "role_id": "integer",
-  "start_date": "object"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Unavailability

- -
- - -
- Unavailability -
- - - -

-
Add Employee Unavailability
-

- -
-
-
- POST - /employee/unavailability -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- -
-
-
-
- - Unavailability - -
-
-
- -

accepts unavailability form data.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability added successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Unavailability -
- - - -

-
Delete Employee Unavailability
-

- -
-
-
- DELETE - /employee/unavailability/{employee_unavailability_id} -
-
-
- -
-
-
-

E_Employee-Profile_Availability_Edit (Delete confirmation)

- -
-
-
- -
-
- - -
-
-
-
employee_unavailability_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability deleted successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Shift

- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerShiftsMonth - -
- -
-
-

employer shifts count within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "count": "integer",
-  "date": "object",
-  "employer_shift_id": "integer",
-  "publish": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerShifts - -
- -
-
-

employer shifts count within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Publish Employer Shifts
-

- -
-
-
- PUT - /shift/publish -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift published

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employer Shift Update
-

- -
-
-
- PUT - /shift/{employer_shift_id} -
-
-
- - -
-
- -
-
-
-
- - EmployerShifts - -
-
-
- -

accepts shift form data.

- - -
-
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift details updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Add Employer Shift
-

- -
-
-
- POST - /shift -
-
-
- - -
-
- -
-
-
-
- - EmployerShifts - -
-
-
- -

accepts shift form data.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employee Shift
-

- -
-
-
- GET - /employee/shift/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployeeShift - -
- -
-
-

shift added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employer_shift_assigned_id": "integer",
-  "role_name": "string",
-  "shift_current_time": "string",
-  "shift_status": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
List Employees Scheduled on this Shift
-

- -
-
-
- GET - /shift/scheduled/{employer_shift_id} -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

list of employees

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Add employee on shift
-

- -
-
-
- POST - /shift/add/employee/{employer_shift_id} -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

add employee to shift

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Remove employee on shift
-

- -
-
-
- DELETE - /shift/employee/{employer_shift_assigned_id}/ -
-
-
- - -
-
- - -
-
-
-
employer_shift_assigned_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

employee removed

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Industry

- -
- - -
- Industry -
- - - -

-
List all industries
-

- -
-
-
- GET - /industry -
-
-
- -
-
-
-

fetch industries, used in select/list - *Page 3_Account_EmployerProfile (Industry select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Industries - -
- -
-
-

Industry Lists

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "industry_code": "string",
-  "industry_description": "string",
-  "industry_id": "string",
-  "industry_name": "string"
-}
-
-
-
-
-
-
-

Documents

- -
- - -
- Documents -
- - - -

-
Add new document
-

- -
-
-
- POST - /documents -
-
-
- - -
-
- -
-
-
-
- - Documents - -
-
-
- -

accepts document data to be added.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Document successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Edit document
-

- -
-
-
- PUT - /documents/{document_id} -
-
-
- - -
-
- -
-
-
-
- - Documents - -
-
-
- -

accepts document data to be edited.

- - -
-
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-[
-  {
-    "user_document_expiry": "string",
-    "user_document_id": "integer",
-    "user_document_issuer": "string",
-    "user_document_name": "string"
-  }
-]
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
- Documents - -
- -
-
-

Document successfully updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
List document page
-

- -
-
-
- GET - /document-pages/{document_id} -
-
-
- - -
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- DocumentPages - -
- -
-
-

Document Page List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "user_document_id": "string",
-  "user_document_page_id": "integer",
-  "user_document_page_url": "string",
-  "user_document_sort": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
List document shared
-

- -
-
-
- GET - /document/shared -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- DocumentShared - -
- -
-
-

Document Page List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "employer_id": "string",
-  "user_document_id": "integer",
-  "user_document_share_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Remove employer to document share
-

- -
-
-
- DELETE - /document/share/{document_id} -
-
-
- - -
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Document unshared successful

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
List all employee's documents
-

- -
-
-
- GET - /employee/documents/shared/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Documents - -
- -
-
-

Employee document lists

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Employee's document Details
-

- -
-
-
- GET - /employee/document/shared/{document_id} -
-
-
- - -
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Documents - -
- -
-
-

Employee document details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Locations

- -
- - -
- Locations -
- - - -

-
Employee's list of locations
-

- -
-
-
- POST - /employee/locations/{employee_id} -
-
-
- - -
-
- -
-
-
-
- - Locations - -
-
-
- -

accepts locations page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_location_id": "integer",
-  "employee_location_name": "string",
-  "location_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee location added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Locations -
- - - -

-
remove location from employee
-

- -
-
-
- DELETE - /employee/location/{employee_location_id} -
-
-
- - -
-
- - -
-
-
-
employee_location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Successfully remove employees locations

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Notes

- -
- - -
- Notes -
- - - -

-
Add Employee's notes
-

- -
-
-
- POST - /employee/notes/{employee_id} -
-
-
- - -
-
- -
-
-
-
- - Note - -
-
-
- -

accepts noted page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_notes": "string",
-  "employee_notes_id": "integer",
-  "employer_shift_id": "integer",
-  "location_id": "integer",
-  "to_user_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee notes added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Notes -
- - - -

-
Delte employee's note
-

- -
-
-
- DELETE - /employee/note/{employee_notes_id} -
-
-
- - -
-
- - -
-
-
-
employee_notes_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee note deleted

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- - -

Schema definitions

- -
-

- Accounts: - object - - - -

-
-
- -
-
-
- acount_id: - object - - -
-
- display_name: - object - - -
-
- icon_url: - object - - -
-
- account_type: - object - - -
-
-
-
-
-
-
-

- Bank: - object - - - -

-
-
- -
-
-
- bank_id: - object - - -
-
- bank_status: - object - - -
-
- bank_name: - object - - -
-
- bank_fullname: - object - - -
-
- bank_description: - object - - -
-
- bank_iconurl: - object - - -
-
-
-
-
-
-
-

- BankAllotment: - object - - - -

-
-
- -
-
-
- user_bank_allotment_id: - object - - -
-
- user_bank_id: - object - - -
-
- employer_id: - object - - -
-
- user_bank_allotment_percent: - object - - -
-
-
-
-
-
-
-
-

PayApp Payroll System

- -
-
-
-
API Endpoint
-
- 

-https://api.mytommy.com/api/v1
-
-
- - -
Response Content-Types: - application/json -
- -
Schemes: - http, https -
- -
Version: - 1.0.0 -
-
-
-
- - -

Authentication

- -
-
-
-

- basicAuth - -

-
-
-
-
description
-
-
- HTTP Basic Authentication. Works over `HTTP` and `HTTPS` -
-
-
- - -
-
-
-
-
-
-

- api_key - -

-
-
-
-
name
-
-
- api_key -
-
-
-
-
in
-
-
- header -
-
-
- - -
-
-
-
-
-
-

- petstore_auth - -

-
-
-
-
authorizationUrl
-
-
- http://swagger.io/api/oauth/dialog -
-
-
-
-
flow
-
-
- implicit -
-
-
-
-
scopes
-
-
- [object Object] -
-
-
- - -
-
-
-

User

- -
- - -
- User -
- - - -

-
List of Accounts including Employer(s)
-

- -
-
-
- GET - /user/accounts -
-
-
- -
-
-
-

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Accounts - -
- -
-
-

An array of accounts

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-[
-  {
-    "account_type": "string",
-    "acount_id": "integer",
-    "display_name": "string",
-    "icon_url": "string"
-  }
-]
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - UserProfile - -
-
-
- -

accepts any users data to be updated.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
api_key -
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user/password -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- - -
-
-
-
new_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
-
old_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User password updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
- GET - /user/login -
-

- - - -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username/password supplied

- -
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
basicAuth -
-
-
-
-
- -
- - -
- User -
- - - -

-
Accept Employer
-

- -
-
-
- GET - /employee/accept-employer/{employer_id} -
-
-
- -
-
-
-

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) - 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
response
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

User's accepted

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid email/password supplied

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
logout user
-

- -
-
-
- GET - /user/logout -
-
-
- -
-
-
-

Logs out current logged in user session - *Page 3_Account (part3)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
-

Employer

- -
- - -
- Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /employer/{employer_id} -
-
-
- -
-
-
-

Employer profile. - *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerOwnProfile - -
- -
-
-

Profile information for an employer

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employer -
- - - -

-
Update Employer Data
-

- -
-
-
- PUT - /employer/{employer_id} -
-
-
- -
-
-
-

This updates individual or group of employer's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - EmployerOwnProfile - -
-
-
- -

Unique employer identifier to be used for fetching specific employer profile data.

- - -
-
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employer update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Role

- -
- - -
- Role -
- - - -

-
Employee Role List
-

- -
-
-
- GET - /employee/roles/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Role - -
- -
-
-

Employee role list

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role
-

- -
-
-
- POST - /employee/role -
-
-
- - -
-
- -
-
-
-
- - Role - -
-
-
- -

accepts role page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Details
-

- -
-
-
- GET - /employee/role/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleDetails - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "first_shift": "string",
-  "last_shift": "string",
-  "payroll_variations": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation Details
-

- -
-
-
- GET - /employee/role/variation/{employee_role_variation_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_variation_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role variation details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role Variation
-

- -
-
-
- POST - /employee/role/variation -
-
-
- - -
-
- -
-
-
-
- - RoleVariation - -
-
-
- -

accepts variation page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role variation added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation List
-

- -
-
-
- GET - /employee/role/variations/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Bank

- -
- - -
- Bank -
- - - -

-
List All User Bank
-

- -
-
-
- GET - /user/bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Get User Bank
-

- -
-
-
- GET - /user/bank/{user_bank_id} -
-
-
- - -
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Bank Details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
List All Bank
-

- -
-
-
- GET - /bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- Bank - -
- -
-
-

Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_description": "string",
-  "bank_fullname": "string",
-  "bank_iconurl": "string",
-  "bank_id": "integer",
-  "bank_name": "string",
-  "bank_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Add User Bank Allotment
-

- -
-
-
- POST - /user/bank/allotment/{user_bank_id} -
-
-
- - -
-
- -
-
-
-
- - BankAllotment - -
-
-
- -

accepts user bank allotment data to be added.

- - -
-
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "pay_type": "string",
-  "user_bank_allotment_fixed": "string",
-  "user_bank_allotment_id": "integer",
-  "user_bank_allotment_percent": "string",
-  "user_bank_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Bank Allotment successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

SuperFund

- -
- - -
- SuperFund -
- - - -

-
List All Superfund
-

- -
-
-
- GET - /superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- SuperFund - -
- -
-
-

SuportFund List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_description": "string",
-  "superfund_id": "integer",
-  "superfund_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All User SuperFund
-

- -
-
-
- GET - /user/superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

List User superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
GetUser SuperFund Details
-

- -
-
-
- GET - /user/superfund/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

User superfund details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All Employer with SuperFund
-

- -
-
-
- GET - /user/superfund/employer/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserEmployerSuperFund - -
- -
-
-

List Employer with superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "employer_id": "integer",
-  "employer_name": "string",
-  "user_employer_superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
Remove User Employer SupportFund
-

- -
-
-
- POST - /user/superfund/employer/remove/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Employer SuperFund successfully remove

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Payroll

- -
- - -
- Payroll -
- - - -

-
List all Pay approval options
-

- -
-
-
- GET - /pay-approval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollApprovalOptions - -
- -
-
-

Pay Approval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_approval_id": "string",
-  "payroll_approval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay interval options
-

- -
-
-
- GET - /pay-interval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollIntervalOptions - -
- -
-
-

Pay Interval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_interval_id": "string",
-  "payroll_interval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay release options
-

- -
-
-
- GET - /pay-release-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollReleaseOptions - -
- -
-
-

Pay Interval Release List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_release_id": "string",
-  "payroll_release_name": "string"
-}
-
-
-
-
-
-
-

Entity

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
-

Tax

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Reporting

- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Employees

- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees -
- - - -

-
Employer Employee List
-

- -
-
-
- GET - /employer/employees -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Employee

- -
- - -
- Employee -
- - - -

-
Employee Profile
-

- -
-
-
- GET - /employee/{employee_id} -
-
-
- -
-
-
-

E_Employee-Profile (part1)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

employee profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Availability
-

- -
-
-
- GET - /employee/unavailability/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Unavailability - -
- -
-
-

employee unavailability within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Shifts
-

- -
-
-
- GET - /employee/shift/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Shifts (calendar view – clicked) - E_Employee-Profile_Shifts (List View)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployeeShifts - -
- -
-
-

employee shifts within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employer_id": "integer",
-  "employer_shift_assigned_id": "integer",
-  "end_date": "object",
-  "location_id": "integer",
-  "note": "string",
-  "role_id": "integer",
-  "start_date": "object"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Unavailability

- -
- - -
- Unavailability -
- - - -

-
Add Employee Unavailability
-

- -
-
-
- POST - /employee/unavailability -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- -
-
-
-
- - Unavailability - -
-
-
- -

accepts unavailability form data.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability added successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Unavailability -
- - - -

-
Delete Employee Unavailability
-

- -
-
-
- DELETE - /employee/unavailability/{employee_unavailability_id} -
-
-
- -
-
-
-

E_Employee-Profile_Availability_Edit (Delete confirmation)

- -
-
-
- -
-
- - -
-
-
-
employee_unavailability_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability deleted successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Shift

- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerShiftsMonth - -
- -
-
-

employer shifts count within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "count": "integer",
-  "date": "object",
-  "employer_shift_id": "integer",
-  "publish": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerShifts - -
- -
-
-

employer shifts count within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Publish Employer Shifts
-

- -
-
-
- PUT - /shift/publish -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift published

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employer Shift Update
-

- -
-
-
- PUT - /shift/{employer_shift_id} -
-
-
- - -
-
- -
-
-
-
- - EmployerShifts - -
-
-
- -

accepts shift form data.

- - -
-
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift details updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Add Employer Shift
-

- -
-
-
- POST - /shift -
-
-
- - -
-
- -
-
-
-
- - EmployerShifts - -
-
-
- -

accepts shift form data.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employee Shift
-

- -
-
-
- GET - /employee/shift/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployeeShift - -
- -
-
-

shift added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employer_shift_assigned_id": "integer",
-  "role_name": "string",
-  "shift_current_time": "string",
-  "shift_status": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
List Employees Scheduled on this Shift
-

- -
-
-
- GET - /shift/scheduled/{employer_shift_id} -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

list of employees

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Add employee on shift
-

- -
-
-
- POST - /shift/add/employee/{employer_shift_id} -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

add employee to shift

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Remove employee on shift
-

- -
-
-
- DELETE - /shift/employee/{employer_shift_assigned_id}/ -
-
-
- - -
-
- - -
-
-
-
employer_shift_assigned_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

employee removed

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Industry

- -
- - -
- Industry -
- - - -

-
List all industries
-

- -
-
-
- GET - /industry -
-
-
- -
-
-
-

fetch industries, used in select/list - *Page 3_Account_EmployerProfile (Industry select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Industries - -
- -
-
-

Industry Lists

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "industry_code": "string",
-  "industry_description": "string",
-  "industry_id": "string",
-  "industry_name": "string"
-}
-
-
-
-
-
-
-

Documents

- -
- - -
- Documents -
- - - -

-
Add new document
-

- -
-
-
- POST - /documents -
-
-
- - -
-
- -
-
-
-
- - Documents - -
-
-
- -

accepts document data to be added.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Document successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Edit document
-

- -
-
-
- PUT - /documents/{document_id} -
-
-
- - -
-
- -
-
-
-
- - Documents - -
-
-
- -

accepts document data to be edited.

- - -
-
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-[
-  {
-    "user_document_expiry": "string",
-    "user_document_id": "integer",
-    "user_document_issuer": "string",
-    "user_document_name": "string"
-  }
-]
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
- Documents - -
- -
-
-

Document successfully updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
List document page
-

- -
-
-
- GET - /document-pages/{document_id} -
-
-
- - -
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- DocumentPages - -
- -
-
-

Document Page List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "user_document_id": "string",
-  "user_document_page_id": "integer",
-  "user_document_page_url": "string",
-  "user_document_sort": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
List document shared
-

- -
-
-
- GET - /document/shared -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- DocumentShared - -
- -
-
-

Document Page List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "employer_id": "string",
-  "user_document_id": "integer",
-  "user_document_share_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Remove employer to document share
-

- -
-
-
- DELETE - /document/share/{document_id} -
-
-
- - -
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Document unshared successful

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
List all employee's documents
-

- -
-
-
- GET - /employee/documents/shared/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Documents - -
- -
-
-

Employee document lists

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Employee's document Details
-

- -
-
-
- GET - /employee/document/shared/{document_id} -
-
-
- - -
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Documents - -
- -
-
-

Employee document details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Locations

- -
- - -
- Locations -
- - - -

-
Employee's list of locations
-

- -
-
-
- POST - /employee/locations/{employee_id} -
-
-
- - -
-
- -
-
-
-
- - Locations - -
-
-
- -

accepts locations page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_location_id": "integer",
-  "employee_location_name": "string",
-  "location_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee location added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Locations -
- - - -

-
remove location from employee
-

- -
-
-
- DELETE - /employee/location/{employee_location_id} -
-
-
- - -
-
- - -
-
-
-
employee_location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Successfully remove employees locations

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Notes

- -
- - -
- Notes -
- - - -

-
Add Employee's notes
-

- -
-
-
- POST - /employee/notes/{employee_id} -
-
-
- - -
-
- -
-
-
-
- - Note - -
-
-
- -

accepts noted page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_notes": "string",
-  "employee_notes_id": "integer",
-  "employer_shift_id": "integer",
-  "location_id": "integer",
-  "to_user_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee notes added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Notes -
- - - -

-
Delte employee's note
-

- -
-
-
- DELETE - /employee/note/{employee_notes_id} -
-
-
- - -
-
- - -
-
-
-
employee_notes_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee note deleted

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- - -

Schema definitions

- -
-

- Accounts: - object - - - -

-
-
- -
-
-
- acount_id: - object - - -
-
- display_name: - object - - -
-
- icon_url: - object - - -
-
- account_type: - object - - -
-
-
-
-
-
-
-

- Bank: - object - - - -

-
-
- -
-
-
- bank_id: - object - - -
-
- bank_status: - object - - -
-
- bank_name: - object - - -
-
- bank_fullname: - object - - -
-
- bank_description: - object - - -
-
- bank_iconurl: - object - - -
-
-
-
-
-
-
-

- BankAllotment: - object - - - -

-
-
- -
-
-
- user_bank_allotment_id: - object - - -
-
- user_bank_id: - object - - -
-
- employer_id: - object - - -
-
- user_bank_allotment_percent: - object - - -
-
- user_bank_allotment_fixed: - object - - -
-
- pay_type: - object - - -
-
-
-
-
-
-
-

- DocumentPages: - object - - - -

-
-
- -
-
-
- user_document_page_id: - object - - -
-
- user_document_page_url: - object - - -
-
- user_document_sort: - object - - -
-
- user_document_id: - object - - -
-
-
-
-
-
-
-

- Documents: - object - - - -

-
-
- -
-
-
- user_document_id: - object - - -
-
- user_document_name: - object - - -
-
- user_document_issuer: - object - - -
-
- user_document_expiry: - object - - -
-
-
-
-
-
-
-

- DocumentShared: - object - - - -

-
-
- -
-
-
- user_document_share_id: - object - - -
-
- user_document_id: - object - - -
-
- employer_id: - object - - -
-
-
-
-
-
-
-

- EmployeeShift: - object - - - -

-
-
- -
-
-
- user_id: - object - - -
-
- employer_shift_assigned_id: - object - - -
-
- role_name: - object - - -
-
- shift_current_time: - object - - -
-
- user_name_last: - object - - -
-
- user_name_first: - object - - -
-
- user_email: - object - - -
-
- user_iconurl: - object - - -
-
- user_phone: - object - - -
-
- shift_status: - object - - -
-
-
-
-
-
-
-

- EmployeeShifts: - object - - - -

-
-
- -
-
-
- employer_shift_assigned_id: - object - - -
-
- employer_id: - object - - -
-
- employee_id: - object - - -
-
- location_id: - object - - -
-
- role_id: - object - - -
-
- start_date: - object - - -
-
- end_date: - object - - -
-
- note: - object - - -
-
-
-
-
-
-
-

- EmployerAddress: - object - - - -

-
-
- -
-
-
- employer_address_line1: - string - - -
-
-

Employer current address line one

- -
-
- employer_address_line2: - string - - -
-
-

Employer current address line two

- -
-
- employer_address_city: - string - - -
-
-

Employer current city

- -
-
- employer_postcode: - string - - -
-
-

Employer current postcode

- -
-
- employer_state: - string - - -
-
-

Employer current state/province

- -
-
- country_id: - string - - -
-
-

Employer current country

- -
-
-
-
-
-
-
-

- EmployerOwnProfile: - object - - - -

-
-
- -
-
-
- employer_id: - object - - -
-
- employer_business_name: - object - - -
-
- employer_iconurl: - object - - -
-
- user_name_last: - object - - -
-
- user_name_first: - object - - -
-
- employer_email: - object - - -
-
- employer_phone: - object - - -
-
- industry_id: - object - - -
-
- employer_abn: - object - - -
-
- employer_acn: - object - - -
-
- employer_contact_email: - object - - -
-
- employer_contact_name: - object - - -
-
- payroll_interval_id: - object - - -
-
- payroll_approval_id: - object - - -
-
- payroll_release_id: - object - - -
-
- tax_entity_id: - object - - -
-
- tax_reporting_id: - object - - -
-
- employer_tax_gst: - object - - -
-
- employer_tax_payrolltax: - object - - -
-
- address: - object - - -
-
-
-
-
-
-
-

- EmployerShifts: - object - - - -

-
-
- -
-
-
- employer_shift_id: - object - - -
-
- employer_id: - object - - -
-
- location_id: - object - - -
-
- role_id: - object - - -
-
- employer_shift_time_start: - object - - -
-
- employer_shift_time_end: - object - - -
-
- employer_shift_repeat: - object - - -
-
- notes: - object - - -
-
-
-
-
-
-
-

- EmployerShiftsMonth: - object - - - -

-
-
- -
-
-
- employer_shift_id: - object - - -
-
- date: - object - - -
-
- count: - object - - -
-
- publish: - object - - -
-
-
-
-
-
-
-

- Error: - object - - - -

-
-
- -
-
-
- code: - object - - -
-
- message: - object - - -
-
- fields: - object - - -
-
-
-
-
-
-
-

- Industries: - object - - - -

-
-
- -
-
-
- industry_id: - object - - -
-
- industry_name: - object - - -
-
- industry_code: - object - - -
-
- industry_description: - object - - -
-
-
-
-
-
-
-

- Locations: - object - - - -

-
-
- -
-
-
- location_id: - object - - -
-
- employee_location_id: - object - - -
-
- employee_location_name: - object - - -
-
-
-
-
-
-
-

- Note: - object - - - -

-
-
- -
-
-
- employee_notes_id: - object - - -
-
- employee_id: - object - - -
-
- to_user_id: - object - - -
-
- location_id: - object - - -
-
- employer_shift_id: - object - - -
-
- employee_notes: - object - - -
-
-
-
-
-
-
-

- PayrollApprovalOptions: - object - - - -

-
-
- -
-
-
- payroll_approval_id: - object - - -
-
- payroll_approval_name: - object - - -
-
-
-
-
-
-
-

- PayrollIntervalOptions: - object - - - -

-
-
- -
-
-
- payroll_interval_id: - object - - -
-
- payroll_interval_name: - object - - -
-
-
-
-
-
-
-

- PayrollReleaseOptions: - object - - - -

-
-
- -
-
-
- payroll_release_id: - object - - -
-
- payroll_release_name: - object - - -
-
-
-
-
-
-
-

- Role: - object - - - -

-
-
- -
-
-
- employee_role_id: - object - - -
-
- employee_id: - object - - -
-
- role_id: - object - - -
-
-
-
-
-
-
-

- RoleDetails: - object - - - -

-
-
- -
-
-
- employee_role_id: - object - - -
-
- employee_id: - object - - -
-
- last_shift: - object - - -
-
- first_shift: - object - - -
-
- payroll_variations: - object - - -
-
-
-
-
-
-
-

- RoleVariation: - object - - - -

-
-
- -
-
-
- employee_role_variations_id: - object - - -
-
- employee_role_id: - object - - -
-
- variations_type: - object - - -
-
- variations_value: - object - - -
-
-
-
-
-
-
-

- SuperFund: - object - - - -

-
-
- -
-
-
- superfund_id: - object - - -
-
- superfund_name: - object - - -
-
- superfund_description: - object - - -
-
-
-
-
-
-
-

- TaxEntityTypeOptions: - object - - - -

-
-
- -
-
-
- tax_entity_id: - object - - -
-
- tax_entity_name: - object - - -
-
-
-
-
-
-
-

- TaxReportingOptions: - object - - - -

-
-
- -
-
-
- entity_type_id: - object - - -
-
- entity_type_name: - object - - -
-
-
-
-
-
-
-

- Unavailability: - object - - - -

-
-
- -
-
-
- employee_unavailability_id: - object - - -
-
- employee_unavailability_date_start: - object - - -
-
- employee_unavailability_date_endv: - object - - -
-
- employee_id: - object - - -
-
- notes: - object - - -
-
- employee_unavailability_special_day: - object - - -
-
- employee_unavailability_fullday: - object - - -
-
-
-
-
-
-
-
-

PayApp Payroll System

- -
-
-
-
API Endpoint
-
- 

-https://api.mytommy.com/api/v1
-
-
- - -
Response Content-Types: - application/json -
- -
Schemes: - http, https -
- -
Version: - 1.0.0 -
-
-
-
- - -

Authentication

- -
-
-
-

- basicAuth - -

-
-
-
-
description
-
-
- HTTP Basic Authentication. Works over `HTTP` and `HTTPS` -
-
-
- - -
-
-
-
-
-
-

- api_key - -

-
-
-
-
name
-
-
- api_key -
-
-
-
-
in
-
-
- header -
-
-
- - -
-
-
-
-
-
-

- petstore_auth - -

-
-
-
-
authorizationUrl
-
-
- http://swagger.io/api/oauth/dialog -
-
-
-
-
flow
-
-
- implicit -
-
-
-
-
scopes
-
-
- [object Object] -
-
-
- - -
-
-
-

User

- -
- - -
- User -
- - - -

-
List of Accounts including Employer(s)
-

- -
-
-
- GET - /user/accounts -
-
-
- -
-
-
-

Returns different accounts with its type (user, own employer, other employer) *Page 3_Account (part1)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Accounts - -
- -
-
-

An array of accounts

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-[
-  {
-    "account_type": "string",
-    "acount_id": "integer",
-    "display_name": "string",
-    "icon_url": "string"
-  }
-]
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - UserProfile - -
-
-
- -

accepts any users data to be updated.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
api_key -
-
-
-
-
- -
- - -
- User -
- - - -

-
Update User Data
-

- -
-
-
- PUT - /user/password -
-
-
- -
-
-
-

This updates individual or group of user's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- - -
-
-
-
new_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
-
old_password
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User password updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
- GET - /user/login -
-

- - - -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Will send Authenticated if authentication is succesful, otherwise it will send Unauthorized

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid username/password supplied

- -
-
-
-
-
-
-
-
-
- - - - - - - - - - - - - -
basicAuth -
-
-
-
-
- -
- - -
- User -
- - - -

-
Accept Employer
-

- -
-
-
- GET - /employee/accept-employer/{employer_id} -
-
-
- -
-
-
-

4_Messages_ChatWindow_EmploymentOffer_Reject(confirm) - 4_Messages_ChatWindow_EmploymentOffer_Accept(confirm)

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
response
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

User's accepted

- -
-
-
-
-
400 Bad Request
-
-
-

Invalid email/password supplied

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- User -
- - - -

-
logout user
-

- -
-
-
- GET - /user/logout -
-
-
- -
-
-
-

Logs out current logged in user session - *Page 3_Account (part3)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
-
-

successful operation

- -
-
-
-
-
-
-
-

Employer

- -
- - -
- Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /employer/{employer_id} -
-
-
- -
-
-
-

Employer profile. - *Pages 3_Account_EmployerProfile p1, 3_Account_EmployerProfile p2

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerOwnProfile - -
- -
-
-

Profile information for an employer

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employer -
- - - -

-
Update Employer Data
-

- -
-
-
- PUT - /employer/{employer_id} -
-
-
- -
-
-
-

This updates individual or group of employer's records - Pages 3_AccountEmployerProfile

- -
-
-
- -
-
- -
-
-
-
- - EmployerOwnProfile - -
-
-
- -

Unique employer identifier to be used for fetching specific employer profile data.

- - -
-
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "address": "array",
-  "employer_abn": "string",
-  "employer_acn": "string",
-  "employer_business_name": "string",
-  "employer_contact_email": "string",
-  "employer_contact_name": "string",
-  "employer_email": "string",
-  "employer_iconurl": "string",
-  "employer_id": "integer",
-  "employer_phone": "string",
-  "employer_tax_gst": "integer",
-  "employer_tax_payrolltax": "integer",
-  "industry_id": "string",
-  "payroll_approval_id": "integer",
-  "payroll_interval_id": "integer",
-  "payroll_release_id": "integer",
-  "tax_entity_id": "integer",
-  "tax_reporting_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employer update success

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Role

- -
- - -
- Role -
- - - -

-
Employee Role List
-

- -
-
-
- GET - /employee/roles/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Role - -
- -
-
-

Employee role list

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role
-

- -
-
-
- POST - /employee/role -
-
-
- - -
-
- -
-
-
-
- - Role - -
-
-
- -

accepts role page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Details
-

- -
-
-
- GET - /employee/role/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleDetails - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_role_id": "integer",
-  "first_shift": "string",
-  "last_shift": "string",
-  "payroll_variations": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation Details
-

- -
-
-
- GET - /employee/role/variation/{employee_role_variation_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_variation_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role variation details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Add Employee Role Variation
-

- -
-
-
- POST - /employee/role/variation -
-
-
- - -
-
- -
-
-
-
- - RoleVariation - -
-
-
- -

accepts variation page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee role variation added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Role -
- - - -

-
Get Employee Role Variation List
-

- -
-
-
- GET - /employee/role/variations/{employee_role_id} -
-
-
- - -
-
- - -
-
-
-
employee_role_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- RoleVariation - -
- -
-
-

Employee role details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_role_id": "integer",
-  "employee_role_variations_id": "integer",
-  "variations_type": "string",
-  "variations_value": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Bank

- -
- - -
- Bank -
- - - -

-
List All User Bank
-

- -
-
-
- GET - /user/bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Get User Bank
-

- -
-
-
- GET - /user/bank/{user_bank_id} -
-
-
- - -
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserBank - -
- -
-
-

User Bank Details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_id": "integer",
-  "created_at": "string",
-  "user_bank_bsb": "string",
-  "user_bank_id": "integer",
-  "user_bank_name": "string",
-  "user_bank_number": "string",
-  "user_bank_status": "string",
-  "user_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
List All Bank
-

- -
-
-
- GET - /bank -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- Bank - -
- -
-
-

Banks List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "bank_description": "string",
-  "bank_fullname": "string",
-  "bank_iconurl": "string",
-  "bank_id": "integer",
-  "bank_name": "string",
-  "bank_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- Bank -
- - - -

-
Add User Bank Allotment
-

- -
-
-
- POST - /user/bank/allotment/{user_bank_id} -
-
-
- - -
-
- -
-
-
-
- - BankAllotment - -
-
-
- -

accepts user bank allotment data to be added.

- - -
-
-
- - -
-
-
-
user_bank_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "pay_type": "string",
-  "user_bank_allotment_fixed": "string",
-  "user_bank_allotment_id": "integer",
-  "user_bank_allotment_percent": "string",
-  "user_bank_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Bank Allotment successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

SuperFund

- -
- - -
- SuperFund -
- - - -

-
List All Superfund
-

- -
-
-
- GET - /superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- SuperFund - -
- -
-
-

SuportFund List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_description": "string",
-  "superfund_id": "integer",
-  "superfund_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All User SuperFund
-

- -
-
-
- GET - /user/superfund -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

List User superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
GetUser SuperFund Details
-

- -
-
-
- GET - /user/superfund/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserSuperFund - -
- -
-
-

User superfund details

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_number": "string",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
List All Employer with SuperFund
-

- -
-
-
- GET - /user/superfund/employer/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- UserEmployerSuperFund - -
- -
-
-

List Employer with superfund

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "employer_id": "integer",
-  "employer_name": "string",
-  "user_employer_superfund_id": "integer",
-  "user_superfund_id": "integer",
-  "user_superfund_status": "string"
-}
-
-
-
-
-
-
- -
- - -
- SuperFund -
- - - -

-
Remove User Employer SupportFund
-

- -
-
-
- POST - /user/superfund/employer/remove/{user_supperfund_id} -
-
-
- - -
-
- - -
-
-
-
user_supperfund_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

User Employer SuperFund successfully remove

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Payroll

- -
- - -
- Payroll -
- - - -

-
List all Pay approval options
-

- -
-
-
- GET - /pay-approval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Approval Day Frequency select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollApprovalOptions - -
- -
-
-

Pay Approval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_approval_id": "string",
-  "payroll_approval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay interval options
-

- -
-
-
- GET - /pay-interval-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollIntervalOptions - -
- -
-
-

Pay Interval Options List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_interval_id": "string",
-  "payroll_interval_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Payroll -
- - - -

-
List all Pay release options
-

- -
-
-
- GET - /pay-release-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_PayRun (Interval select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- PayrollReleaseOptions - -
- -
-
-

Pay Interval Release List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "payroll_release_id": "string",
-  "payroll_release_name": "string"
-}
-
-
-
-
-
-
-

Entity

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
-

Tax

- -
- - -
- Entity - Tax -
- - - -

-
List all Tax entity Type
-

- -
-
-
- GET - /tax-entity-type-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Entity Type Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxEntityTypeOptions - -
- -
-
-

Tax Entity Type List

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "tax_entity_id": "string",
-  "tax_entity_name": "string"
-}
-
-
-
-
-
-
- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Reporting

- -
- - -
- Reporting - Tax -
- - - -

-
List all Tax Reporting Option
-

- -
-
-
- GET - /tax-reporting-options -
-
-
- -
-
-
-

used in select/list - *Page 3_Account_EmployerProfile_Tax (Reporting Period Select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- TaxReportingOptions - -
- -
-
-

Tax Reporting Option

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "entity_type_id": "string",
-  "entity_type_name": "string"
-}
-
-
-
-
-
-
-

Employees

- -
- - -
- Employees - Employer -
- - - -

-
Employer Employee List by Location
-

- -
-
-
- GET - /employer/employees/listbylocation/{employer_id}/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees -
- - - -

-
Employer Employee List
-

- -
-
-
- GET - /employer/employees -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employees - Employer -
- - - -

-
Employer Own Profile
-

- -
-
-
- GET - /user/employer/employee-profile/{location_id} -
-
-
- -
-
-
-

List all employees under the employer's location

- -
-
-
- -
-
- - -
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

List of employees profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Employee

- -
- - -
- Employee -
- - - -

-
Employee Profile
-

- -
-
-
- GET - /employee/{employee_id} -
-
-
- -
-
-
-

E_Employee-Profile (part1)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

employee profile

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Availability
-

- -
-
-
- GET - /employee/unavailability/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Unavailability - -
- -
-
-

employee unavailability within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Employee -
- - - -

-
Employee Profile Shifts
-

- -
-
-
- GET - /employee/shift/{employee_id}/{date_start}/{date_end} -
-
-
- -
-
-
-

E_Employee-Profile_Shifts (calendar view – clicked) - E_Employee-Profile_Shifts (List View)

- -
-
-
- -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployeeShifts - -
- -
-
-

employee shifts within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employee_id": "integer",
-  "employer_id": "integer",
-  "employer_shift_assigned_id": "integer",
-  "end_date": "object",
-  "location_id": "integer",
-  "note": "string",
-  "role_id": "integer",
-  "start_date": "object"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Unavailability

- -
- - -
- Unavailability -
- - - -

-
Add Employee Unavailability
-

- -
-
-
- POST - /employee/unavailability -
-
-
- -
-
-
-

E_Employee-Profile_Availability (Calendar View - date clicked)

- -
-
-
- -
-
- -
-
-
-
- - Unavailability - -
-
-
- -

accepts unavailability form data.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_unavailability_date_endv": "string",
-  "employee_unavailability_date_start": "string",
-  "employee_unavailability_fullday": "boolean",
-  "employee_unavailability_id": "integer",
-  "employee_unavailability_special_day": "string",
-  "notes": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability added successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Unavailability -
- - - -

-
Delete Employee Unavailability
-

- -
-
-
- DELETE - /employee/unavailability/{employee_unavailability_id} -
-
-
- -
-
-
-

E_Employee-Profile_Availability_Edit (Delete confirmation)

- -
-
-
- -
-
- - -
-
-
-
employee_unavailability_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Unavailability deleted successfully

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Shift

- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/calendar/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerShiftsMonth - -
- -
-
-

employer shifts count within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "count": "integer",
-  "date": "object",
-  "employer_shift_id": "integer",
-  "publish": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employe Shifts
-

- -
-
-
- GET - /employer/shiftbylocation/list/{employer_id}/{location_id}/{date_start}/{date_end} -
-
-
- - -
-
- - -
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
date_start
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
date_end
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployerShifts - -
- -
-
-

employer shifts count within the current selecte date range

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Publish Employer Shifts
-

- -
-
-
- PUT - /shift/publish -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift published

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employer Shift Update
-

- -
-
-
- PUT - /shift/{employer_shift_id} -
-
-
- - -
-
- -
-
-
-
- - EmployerShifts - -
-
-
- -

accepts shift form data.

- - -
-
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift details updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Add Employer Shift
-

- -
-
-
- POST - /shift -
-
-
- - -
-
- -
-
-
-
- - EmployerShifts - -
-
-
- -

accepts shift form data.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "employer_id": "integer",
-  "employer_shift_id": "integer",
-  "employer_shift_repeat": "boolean",
-  "employer_shift_time_end": "string",
-  "employer_shift_time_start": "string",
-  "location_id": "integer",
-  "notes": "string",
-  "role_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

shift added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Employee Shift
-

- -
-
-
- GET - /employee/shift/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- EmployeeShift - -
- -
-
-

shift added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "employer_shift_assigned_id": "integer",
-  "role_name": "string",
-  "shift_current_time": "string",
-  "shift_status": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
List Employees Scheduled on this Shift
-

- -
-
-
- GET - /shift/scheduled/{employer_shift_id} -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- UserProfile - -
- -
-
-

list of employees

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "address": "array",
-  "user_dob": "string",
-  "user_email": "string",
-  "user_iconurl": "string",
-  "user_id": "integer",
-  "user_name_first": "string",
-  "user_name_last": "string",
-  "user_phone": "string",
-  "user_status": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Add employee on shift
-

- -
-
-
- POST - /shift/add/employee/{employer_shift_id} -
-
-
- - -
-
- - -
-
-
-
employer_shift_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

add employee to shift

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Shift -
- - - -

-
Remove employee on shift
-

- -
-
-
- DELETE - /shift/employee/{employer_shift_assigned_id}/ -
-
-
- - -
-
- - -
-
-
-
employer_shift_assigned_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

employee removed

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Industry

- -
- - -
- Industry -
- - - -

-
List all industries
-

- -
-
-
- GET - /industry -
-
-
- -
-
-
-

fetch industries, used in select/list - *Page 3_Account_EmployerProfile (Industry select)

- -
-
-
- -
-
- - -
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Industries - -
- -
-
-

Industry Lists

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "industry_code": "string",
-  "industry_description": "string",
-  "industry_id": "string",
-  "industry_name": "string"
-}
-
-
-
-
-
-
-

Documents

- -
- - -
- Documents -
- - - -

-
Add new document
-

- -
-
-
- POST - /documents -
-
-
- - -
-
- -
-
-
-
- - Documents - -
-
-
- -

accepts document data to be added.

- - -
-
-
- - -
- -
-
-
Request Example
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Document successfully added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Edit document
-

- -
-
-
- PUT - /documents/{document_id} -
-
-
- - -
-
- -
-
-
-
- - Documents - -
-
-
- -

accepts document data to be edited.

- - -
-
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-[
-  {
-    "user_document_expiry": "string",
-    "user_document_id": "integer",
-    "user_document_issuer": "string",
-    "user_document_name": "string"
-  }
-]
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
- Documents - -
- -
-
-

Document successfully updated

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
List document page
-

- -
-
-
- GET - /document-pages/{document_id} -
-
-
- - -
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
default
-
- DocumentPages - -
- -
-
-

Document Page List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "user_document_id": "string",
-  "user_document_page_id": "integer",
-  "user_document_page_url": "string",
-  "user_document_sort": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
List document shared
-

- -
-
-
- GET - /document/shared -
-
-
- - -
-
- - -
- -
-
- - -
-
-
- -
-
-
default
-
- DocumentShared - -
- -
-
-

Document Page List

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "employer_id": "string",
-  "user_document_id": "integer",
-  "user_document_share_id": "integer"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Remove employer to document share
-

- -
-
-
- DELETE - /document/share/{document_id} -
-
-
- - -
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
-
employer_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
query
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Document unshared successful

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
List all employee's documents
-

- -
-
-
- GET - /employee/documents/shared/{employee_id} -
-
-
- - -
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Documents - -
- -
-
-

Employee document lists

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Documents -
- - - -

-
Employee's document Details
-

- -
-
-
- GET - /employee/document/shared/{document_id} -
-
-
- - -
-
- - -
-
-
-
document_id
- -
-
- -

(no description)

-
-
-
-
type
-
string - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
- Documents - -
- -
-
-

Employee document details

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (200 OK)
- 

-{
-  "user_document_expiry": "string",
-  "user_document_id": "integer",
-  "user_document_issuer": "string",
-  "user_document_name": "string"
-}
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Locations

- -
- - -
- Locations -
- - - -

-
Employee's list of locations
-

- -
-
-
- POST - /employee/locations/{employee_id} -
-
-
- - -
-
- -
-
-
-
- - Locations - -
-
-
- -

accepts locations page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_location_id": "integer",
-  "employee_location_name": "string",
-  "location_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee location added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Locations -
- - - -

-
remove location from employee
-

- -
-
-
- DELETE - /employee/location/{employee_location_id} -
-
-
- - -
-
- - -
-
-
-
employee_location_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Successfully remove employees locations

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
-

Notes

- -
- - -
- Notes -
- - - -

-
Add Employee's notes
-

- -
-
-
- POST - /employee/notes/{employee_id} -
-
-
- - -
-
- -
-
-
-
- - Note - -
-
-
- -

accepts noted page data to be added.

- - -
-
-
- - -
-
-
-
employee_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
-
Request Example
- 

-{
-  "employee_id": "integer",
-  "employee_notes": "string",
-  "employee_notes_id": "integer",
-  "employer_shift_id": "integer",
-  "location_id": "integer",
-  "to_user_id": "integer"
-}
-
-
-
-
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee notes added

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- -
- - -
- Notes -
- - - -

-
Delte employee's note
-

- -
-
-
- DELETE - /employee/note/{employee_notes_id} -
-
-
- - -
-
- - -
-
-
-
employee_notes_id
- -
-
- -

(no description)

-
-
-
-
type
-
integer - - -
-
-
-
in
-
path
-
-
-
- -
-
- - -
-
-
- -
-
-
200 OK
-
-
-

Employee note deleted

- -
-
-
-
-
default
-
- Error - -
- -
-
-

Unexpected error

- -
-
-
-
-
-
Response Example (default )
- 

-{
-  "code": "integer(int32)",
-  "fields": "string",
-  "message": "string"
-}
-
-
-
-
-
-
- - -

Schema definitions

- -
-

- Accounts: - object - - - -

-
-
- -
-
-
- acount_id: - object - - -
-
- display_name: - object - - -
-
- icon_url: - object - - -
-
- account_type: - object - - -
-
-
-
-
-
-
-

- Bank: - object - - - -

-
-
- -
-
-
- bank_id: - object - - -
-
- bank_status: - object - - -
-
- bank_name: - object - - -
-
- bank_fullname: - object - - -
-
- bank_description: - object - - -
-
- bank_iconurl: - object - - -
-
-
-
-
-
-
-

- BankAllotment: - object - - - -

-
-
- -
-
-
- user_bank_allotment_id: - object - - -
-
- user_bank_id: - object - - -
-
- employer_id: - object - - -
-
- user_bank_allotment_percent: - object - - -
-
- user_bank_allotment_fixed: - object - - -
-
- pay_type: - object - - -
-
-
-
-
-
-
-

- DocumentPages: - object - - - -

-
-
- -
-
-
- user_document_page_id: - object - - -
-
- user_document_page_url: - object - - -
-
- user_document_sort: - object - - -
-
- user_document_id: - object - - -
-
-
-
-
-
-
-

- Documents: - object - - - -

-
-
- -
-
-
- user_document_id: - object - - -
-
- user_document_name: - object - - -
-
- user_document_issuer: - object - - -
-
- user_document_expiry: - object - - -
-
-
-
-
-
-
-

- DocumentShared: - object - - - -

-
-
- -
-
-
- user_document_share_id: - object - - -
-
- user_document_id: - object - - -
-
- employer_id: - object - - -
-
-
-
-
-
-
-

- EmployeeShift: - object - - - -

-
-
- -
-
-
- user_id: - object - - -
-
- employer_shift_assigned_id: - object - - -
-
- role_name: - object - - -
-
- shift_current_time: - object - - -
-
- user_name_last: - object - - -
-
- user_name_first: - object - - -
-
- user_email: - object - - -
-
- user_iconurl: - object - - -
-
- user_phone: - object - - -
-
- shift_status: - object - - -
-
-
-
-
-
-
-

- EmployeeShifts: - object - - - -

-
-
- -
-
-
- employer_shift_assigned_id: - object - - -
-
- employer_id: - object - - -
-
- employee_id: - object - - -
-
- location_id: - object - - -
-
- role_id: - object - - -
-
- start_date: - object - - -
-
- end_date: - object - - -
-
- note: - object - - -
-
-
-
-
-
-
-

- EmployerAddress: - object - - - -

-
-
- -
-
-
- employer_address_line1: - string - - -
-
-

Employer current address line one

- -
-
- employer_address_line2: - string - - -
-
-

Employer current address line two

- -
-
- employer_address_city: - string - - -
-
-

Employer current city

- -
-
- employer_postcode: - string - - -
-
-

Employer current postcode

- -
-
- employer_state: - string - - -
-
-

Employer current state/province

- -
-
- country_id: - string - - -
-
-

Employer current country

- -
-
-
-
-
-
-
-

- EmployerOwnProfile: - object - - - -

-
-
- -
-
-
- employer_id: - object - - -
-
- employer_business_name: - object - - -
-
- employer_iconurl: - object - - -
-
- user_name_last: - object - - -
-
- user_name_first: - object - - -
-
- employer_email: - object - - -
-
- employer_phone: - object - - -
-
- industry_id: - object - - -
-
- employer_abn: - object - - -
-
- employer_acn: - object - - -
-
- employer_contact_email: - object - - -
-
- employer_contact_name: - object - - -
-
- payroll_interval_id: - object - - -
-
- payroll_approval_id: - object - - -
-
- payroll_release_id: - object - - -
-
- tax_entity_id: - object - - -
-
- tax_reporting_id: - object - - -
-
- employer_tax_gst: - object - - -
-
- employer_tax_payrolltax: - object - - -
-
- address: - object - - -
-
-
-
-
-
-
-

- EmployerShifts: - object - - - -

-
-
- -
-
-
- employer_shift_id: - object - - -
-
- employer_id: - object - - -
-
- location_id: - object - - -
-
- role_id: - object - - -
-
- employer_shift_time_start: - object - - -
-
- employer_shift_time_end: - object - - -
-
- employer_shift_repeat: - object - - -
-
- notes: - object - - -
-
-
-
-
-
-
-

- EmployerShiftsMonth: - object - - - -

-
-
- -
-
-
- employer_shift_id: - object - - -
-
- date: - object - - -
-
- count: - object - - -
-
- publish: - object - - -
-
-
-
-
-
-
-

- Error: - object - - - -

-
-
- -
-
-
- code: - object - - -
-
- message: - object - - -
-
- fields: - object - - -
-
-
-
-
-
-
-

- Industries: - object - - - -

-
-
- -
-
-
- industry_id: - object - - -
-
- industry_name: - object - - -
-
- industry_code: - object - - -
-
- industry_description: - object - - -
-
-
-
-
-
-
-

- Locations: - object - - - -

-
-
- -
-
-
- location_id: - object - - -
-
- employee_location_id: - object - - -
-
- employee_location_name: - object - - -
-
-
-
-
-
-
-

- Note: - object - - - -

-
-
- -
-
-
- employee_notes_id: - object - - -
-
- employee_id: - object - - -
-
- to_user_id: - object - - -
-
- location_id: - object - - -
-
- employer_shift_id: - object - - -
-
- employee_notes: - object - - -
-
-
-
-
-
-
-

- PayrollApprovalOptions: - object - - - -

-
-
- -
-
-
- payroll_approval_id: - object - - -
-
- payroll_approval_name: - object - - -
-
-
-
-
-
-
-

- PayrollIntervalOptions: - object - - - -

-
-
- -
-
-
- payroll_interval_id: - object - - -
-
- payroll_interval_name: - object - - -
-
-
-
-
-
-
-

- PayrollReleaseOptions: - object - - - -

-
-
- -
-
-
- payroll_release_id: - object - - -
-
- payroll_release_name: - object - - -
-
-
-
-
-
-
-

- Role: - object - - - -

-
-
- -
-
-
- employee_role_id: - object - - -
-
- employee_id: - object - - -
-
- role_id: - object - - -
-
-
-
-
-
-
-

- RoleDetails: - object - - - -

-
-
- -
-
-
- employee_role_id: - object - - -
-
- employee_id: - object - - -
-
- last_shift: - object - - -
-
- first_shift: - object - - -
-
- payroll_variations: - object - - -
-
-
-
-
-
-
-

- RoleVariation: - object - - - -

-
-
- -
-
-
- employee_role_variations_id: - object - - -
-
- employee_role_id: - object - - -
-
- variations_type: - object - - -
-
- variations_value: - object - - -
-
-
-
-
-
-
-

- SuperFund: - object - - - -

-
-
- -
-
-
- superfund_id: - object - - -
-
- superfund_name: - object - - -
-
- superfund_description: - object - - -
-
-
-
-
-
-
-

- TaxEntityTypeOptions: - object - - - -

-
-
- -
-
-
- tax_entity_id: - object - - -
-
- tax_entity_name: - object - - -
-
-
-
-
-
-
-

- TaxReportingOptions: - object - - - -

-
-
- -
-
-
- entity_type_id: - object - - -
-
- entity_type_name: - object - - -
-
-
-
-
-
-
-

- Unavailability: - object - - - -

-
-
- -
-
-
- employee_unavailability_id: - object - - -
-
- employee_unavailability_date_start: - object - - -
-
- employee_unavailability_date_endv: - object - - -
-
- employee_id: - object - - -
-
- notes: - object - - -
-
- employee_unavailability_special_day: - object - - -
-
- employee_unavailability_fullday: - object - - -
-
-
-
-
-
-
-

- UserAddress: - object - - - -

-
-
- -
-
-
- user_address_line1: - string - - -
-
-

User current address line one

- -
-
- user_address_line2: - string - - -
-
-

User current address line two

- -
-
- user_address_city: - string - - -
-
-

User current city

- -
-
- user_postcode: - string - - -
-
-

User current postcode

- -
-
- user_state: - string - - -
-
-

User current state/province

- -
-
- country_id: - string - - -
-
-

User current country

- -
-
-
-
-
-
-
-

- UserBank: - object - - - -

-
-
- -
-
-
- user_bank_id: - object - - -
-
- bank_id: - object - - -
-
- user_id: - object - - -
-
- user_bank_status: - object - - -
-
- user_bank_name: - object - - -
-
- user_bank_bsb: - object - - -
-
- user_bank_number: - object - - -
-
- created_at: - object - - -
-
-
-
-
-
-
-

- UserEmployerSuperFund: - object - - - -

-
-
- -
-
-
- user_employer_superfund_id: - object - - -
-
- user_superfund_id: - object - - -
-
- employer_id: - object - - -
-
- employer_name: - object - - -
-
- user_superfund_status: - object - - -
-
-
-
-
-
-
-

- UserProfile: - object - - - -

-
-
- -
-
-
- user_id: - object - - -
-
- user_name_last: - object - - -
-
- user_name_first: - object - - -
-
- user_email: - object - - -
-
- user_dob: - object - - -
-
- user_iconurl: - object - - -
-
- user_status: - object - - -
-
- user_phone: - object - - -
-
- address: - object - - -
-
-
-
-
-
-
-

- UserSuperFund: - object - - - -

-
-
- -
-
-
- user_superfund_id: - object - - -
-
- superfund_id: - object - - -
-
- user_superfund_number: - object - - -
-
- user_superfund_status: - object - - -
-
-
-
-
-
- -
-
- Documentation by Spectacle -
-
-
- -
-
+ + diff --git a/public/javascripts/spectacle.js b/public/javascripts/spectacle.js index cce4f87..d8dd102 100644 --- a/public/javascripts/spectacle.js +++ b/public/javascripts/spectacle.js @@ -1,18 +1,426 @@ -$(function() { - var $sidebar = $('#sidebar'); - var $nav = $sidebar.find('nav'); - var traverse = new Traverse($nav, { - threshold: 10, - barOffset: $sidebar.position().top +/** + * SlidingCanvas module. + * @module foundation.offcanvas + * @requires foundation.util.triggers + * @requires foundation.util.motion + */ +// !function($, Foundation) { +// +// 'use strict'; + +/** + * Creates a new instance of an off-canvas wrapper. + * @class + * @fires SlidingCanvas#init + * @param {Object} element - jQuery object to initialize. + * @param {Object} options - Overrides to the default plugin settings. + */ +function SlidingCanvas(element, options) { + this.$element = element; + this.options = $.extend({}, SlidingCanvas.defaults, this.$element.data(), options); + this.$lastTrigger = $(); + + this._init(); + this._events(); + + // Foundation.registerPlugin(this, 'SlidingCanvas'); +} + +SlidingCanvas.defaults = { + /** + * Allow the user to click outside of the menu to close it. + * @option + * @example true + */ + closeOnClick: true, + /** + * Amount of time in ms the open and close transition requires. If none selected, pulls from body style. + * @option + * @example 500 + */ + transitionTime: 0, + /** + * Direction the offcanvas opens from. Determines class applied to body. + * @option + * @example left + */ + position: 'left', + /** + * Force the page to scroll to top on open. + */ + forceTop: true, + /** + * Allow the offcanvas to be sticky while open. Does nothing if Sass option `$maincontent-prevent-scroll === true`. + * Performance in Safari OSX/iOS is not great. + */ + // isSticky: false, + /** + * Allow the offcanvas to remain open for certain breakpoints. Can be used with `isSticky`. + * @option + * @example false + */ + isRevealed: false, + /** + * Breakpoint at which to reveal. JS will use a RegExp to target standard classes, if changing classnames, pass your class @`revealClass`. + * @option + * @example reveal-for-large + */ + revealOn: null, + /** + * Force focus to the offcanvas on open. If true, will focus the opening trigger on close. + * @option + * @example true + */ + autoFocus: true, + /** + * Class used to force an offcanvas to remain open. Foundation defaults for this are `reveal-for-large` & `reveal-for-medium`. + * @option + * TODO improve the regex testing for this. + * @example reveal-for-large + */ + revealClass: 'reveal-for-', + /** + * Triggers optional focus trapping when opening an offcanvas. Sets tabindex of [data-off-canvas-content] to -1 for accessibility purposes. + * @option + * @example true + */ + trapFocus: false +}; + +/** + * Initializes the off-canvas wrapper by adding the exit overlay (if needed). + * @function + * @private + */ +SlidingCanvas.prototype._init = function() { + var id = this.$element.attr('id'); + + this.$element.attr('aria-hidden', 'true'); + + // Find triggers that affect this element and add aria-expanded to them + $(document) + .find('[data-open="'+id+'"], [data-close="'+id+'"], [data-toggle="'+id+'"]') + .attr('aria-expanded', 'false') + .attr('aria-controls', id); + + // Add a close trigger over the body if necessary + if (this.options.closeOnClick){ + if($('.js-off-canvas-exit').length){ + this.$exiter = $('.js-off-canvas-exit'); + }else{ + var exiter = document.createElement('div'); + exiter.setAttribute('class', 'js-off-canvas-exit'); + $('[data-off-canvas-content]').append(exiter); + + this.$exiter = $(exiter); + } + } + + this.options.isRevealed = this.options.isRevealed || new RegExp(this.options.revealClass, 'g').test(this.$element[0].className); + + if(this.options.isRevealed){ + this.options.revealOn = this.options.revealOn || this.$element[0].className.match(/(reveal-for-medium|reveal-for-large)/g)[0].split('-')[2]; + this._setMQChecker(); + } + if(!this.options.transitionTime){ + this.options.transitionTime = parseFloat(window.getComputedStyle($('[data-off-canvas-wrapper]')[0]).transitionDuration) * 1000; + } +}; + +/** + * Adds event handlers to the off-canvas wrapper and the exit overlay. + * @function + * @private + */ +SlidingCanvas.prototype._events = function() { + this.$element.off('.zf.trigger .zf.offcanvas').on({ + 'open.zf.trigger': this.open.bind(this), + 'close.zf.trigger': this.close.bind(this), + 'toggle.zf.trigger': this.toggle.bind(this), + 'keydown.zf.offcanvas': this._handleKeyboard.bind(this) }); - $nav.on('update.traverse', function(event, element) { - $nav.find('section').removeClass('expand'); - var $section = element.parents('section:first'); - if ($section.length) { - $section.addClass('expand'); + if (this.$exiter.length) { + var _this = this; + this.$exiter.on({'click.zf.offcanvas': this.close.bind(this)}); + } +}; +/** + * Applies event listener for elements that will reveal at certain breakpoints. + * @private + */ +SlidingCanvas.prototype._setMQChecker = function(){ + var _this = this; + + // $(window).on('changed.zf.mediaquery', function(){ + // if(Foundation.MediaQuery.atLeast(_this.options.revealOn)){ + // _this.reveal(true); + // }else{ + // _this.reveal(false); + // } + // }).one('load.zf.offcanvas', function(){ + // if(Foundation.MediaQuery.atLeast(_this.options.revealOn)){ + // _this.reveal(true); + // } + // }); +}; +/** + * Handles the revealing/hiding the off-canvas at breakpoints, not the same as open. + * @param {Boolean} isRevealed - true if element should be revealed. + * @function + */ +SlidingCanvas.prototype.reveal = function(isRevealed){ + var $closer = this.$element.find('[data-close]'); + if(isRevealed){ + this.close(); + this.isRevealed = true; + // if(!this.options.forceTop){ + // var scrollPos = parseInt(window.pageYOffset); + // this.$element[0].style.transform = 'translate(0,' + scrollPos + 'px)'; + // } + // if(this.options.isSticky){ this._stick(); } + this.$element.off('open.zf.trigger toggle.zf.trigger'); + if($closer.length){ $closer.hide(); } + }else{ + this.isRevealed = false; + // if(this.options.isSticky || !this.options.forceTop){ + // this.$element[0].style.transform = ''; + // $(window).off('scroll.zf.offcanvas'); + // } + this.$element.on({ + 'open.zf.trigger': this.open.bind(this), + 'toggle.zf.trigger': this.toggle.bind(this) + }); + if($closer.length){ + $closer.show(); + } + } +}; + +/** + * Opens the off-canvas menu. + * @function + * @param {Object} event - Event object passed from listener. + * @param {jQuery} trigger - element that triggered the off-canvas to open. + * @fires SlidingCanvas#opened + */ +SlidingCanvas.prototype.open = function(event, trigger) { + if (this.$element.hasClass('is-open') || this.isRevealed){ return; } + var _this = this, + $body = $(document.body); + // $('body').scrollTop(0); + // window.pageYOffset = 0; + + // if(!this.options.forceTop){ + // var scrollPos = parseInt(window.pageYOffset); + // this.$element[0].style.transform = 'translate(0,' + scrollPos + 'px)'; + // if(this.$exiter.length){ + // this.$exiter[0].style.transform = 'translate(0,' + scrollPos + 'px)'; + // } + // } + /** + * Fires when the off-canvas menu opens. + * @event SlidingCanvas#opened + */ + Foundation.Move(this.options.transitionTime, this.$element, function(){ + $('[data-off-canvas-wrapper]').addClass('is-off-canvas-open is-open-'+ _this.options.position); + + _this.$element + .addClass('is-open') + + // if(_this.options.isSticky){ + // _this._stick(); + // } + }); + this.$element.attr('aria-hidden', 'false') + .trigger('opened.zf.offcanvas'); + + + if(trigger){ + this.$lastTrigger = trigger.attr('aria-expanded', 'true'); + } + if(this.options.autoFocus){ + this.$element.one('finished.zf.animate', function(){ + _this.$element.find('a, button').eq(0).focus(); + }); + } + if(this.options.trapFocus){ + $('[data-off-canvas-content]').attr('tabindex', '-1'); + this._trapFocus(); + } +}; +/** + * Traps focus within the offcanvas on open. + * @private + */ +SlidingCanvas.prototype._trapFocus = function(){ + var focusable = Foundation.Keyboard.findFocusable(this.$element), + first = focusable.eq(0), + last = focusable.eq(-1); + + focusable.off('.zf.offcanvas').on('keydown.zf.offcanvas', function(e){ + if(e.which === 9 || e.keycode === 9){ + if(e.target === last[0] && !e.shiftKey){ + e.preventDefault(); + first.focus(); + } + if(e.target === first[0] && e.shiftKey){ + e.preventDefault(); + last.focus(); + } } }); +}; +/** + * Allows the offcanvas to appear sticky utilizing translate properties. + * @private + */ +// SlidingCanvas.prototype._stick = function(){ +// var elStyle = this.$element[0].style; +// +// if(this.options.closeOnClick){ +// var exitStyle = this.$exiter[0].style; +// } +// +// $(window).on('scroll.zf.offcanvas', function(e){ +// console.log(e); +// var pageY = window.pageYOffset; +// elStyle.transform = 'translate(0,' + pageY + 'px)'; +// if(exitStyle !== undefined){ exitStyle.transform = 'translate(0,' + pageY + 'px)'; } +// }); +// // this.$element.trigger('stuck.zf.offcanvas'); +// }; +/** + * Closes the off-canvas menu. + * @function + * @param {Function} cb - optional cb to fire after closure. + * @fires SlidingCanvas#closed + */ +SlidingCanvas.prototype.close = function(cb) { + if(!this.$element.hasClass('is-open') || this.isRevealed){ return; } + + var _this = this; + + // Foundation.Move(this.options.transitionTime, this.$element, function(){ + $('[data-off-canvas-wrapper]').removeClass('is-off-canvas-open is-open-' + _this.options.position); + _this.$element.removeClass('is-open'); + // Foundation._reflow(); + // }); + this.$element.attr('aria-hidden', 'true') + /** + * Fires when the off-canvas menu opens. + * @event SlidingCanvas#closed + */ + .trigger('closed.zf.offcanvas'); + // if(_this.options.isSticky || !_this.options.forceTop){ + // setTimeout(function(){ + // _this.$element[0].style.transform = ''; + // $(window).off('scroll.zf.offcanvas'); + // }, this.options.transitionTime); + // } + + this.$lastTrigger.attr('aria-expanded', 'false'); + if(this.options.trapFocus){ + $('[data-off-canvas-content]').removeAttr('tabindex'); + } + +}; + +/** + * Toggles the off-canvas menu open or closed. + * @function + * @param {Object} event - Event object passed from listener. + * @param {jQuery} trigger - element that triggered the off-canvas to open. + */ +SlidingCanvas.prototype.toggle = function(event, trigger) { + if (this.$element.hasClass('is-open')) { + this.close(event, trigger); + } + else { + this.open(event, trigger); + } +}; + +/** + * Handles keyboard input when detected. When the escape key is pressed, the off-canvas menu closes, and focus is restored to the element that opened the menu. + * @function + * @private + */ +SlidingCanvas.prototype._handleKeyboard = function(event) { + if (event.which !== 27) return; + + event.stopPropagation(); + event.preventDefault(); + this.close(); + this.$lastTrigger.focus(); +}; +/** + * Destroys the offcanvas plugin. + * @function + */ +SlidingCanvas.prototype.destroy = function(){ + this.close(); + this.$element.off('.zf.trigger .zf.offcanvas'); + this.$exiter.off('.zf.offcanvas'); + + // Foundation.unregisterPlugin(this); +}; + +// Foundation.plugin(SlidingCanvas, 'SlidingCanvas'); + +// }(jQuery, Foundation); + +$(function() { + // $(document).foundation(); + + var $sidebar = $('#sidebar'); + if ($sidebar.length) { + var $docs = $('#docs'); + var $nav = $sidebar.find('nav'); + + // + // Setup sidebar navigation + var traverse = new Traverse($nav, { + threshold: 10, + barOffset: $sidebar.position().top + }); + + $nav.on('update.traverse', function(event, element) { + $nav.find('section').removeClass('expand'); + var $section = element.parents('section:first'); + if ($section.length) { + $section.addClass('expand'); + } + }); + + // + // Bind the drawer layout + var $drawerLayout = $('.drawer-layout'), + $drawer = $drawerLayout.find('.drawer'), + closeDrawer = function() { + $drawer.removeClass('slide-right slide-left'); + $drawer.find('.drawer-overlay').remove(); + $drawerLayout.removeClass('drawer-open drawer-slide-left-large drawer-slide-right-large'); + return false; + }; + + // Drawer open buttons + $drawerLayout.find('[data-drawer-slide]').click(function(e) { + var $this = $(this), + direction = $this.data('drawer-slide'); + $drawerLayout.addClass('drawer-open'); + $drawer.addClass('slide-' + direction); + + var $overlay = $('') + $drawer.append($overlay); + $overlay.click(closeDrawer); + + return false; + }); + + // Drawer close buttons + $drawerLayout.find('[data-drawer-close]').click(closeDrawer); + } }); /** diff --git a/public/javascripts/spectacle.min.js b/public/javascripts/spectacle.min.js index 27405e3..e1d6f9e 100644 --- a/public/javascripts/spectacle.min.js +++ b/public/javascripts/spectacle.min.js @@ -1 +1 @@ -function Traverse(a,b){this.$element=a,this.options=$.extend({},Traverse.defaults,this.$element.data(),b),this._init()}$(function(){var a=$("#sidebar"),b=a.find("nav");new Traverse(b,{threshold:10,barOffset:a.position().top});b.on("update.traverse",function(a,c){b.find("section").removeClass("expand");var d=c.parents("section:first");d.length&&d.addClass("expand")})}),Traverse.defaults={animationDuration:500,animationEasing:"linear",threshold:50,activeClass:"active",deepLinking:!1,barOffset:0},Traverse.prototype._init=function(){var a=this.$element[0].id;this.$targets=$("[data-traverse-target]"),this.$links=this.$element.find("a"),this.$element.attr({"data-resize":a,"data-scroll":a,id:a}),this.$active=$(),this.scrollPos=parseInt(window.pageYOffset,10),this._events()},Traverse.prototype.calcPoints=function(){var a=this,b=document.body,c=document.documentElement;this.points=[],this.winHeight=Math.round(Math.max(window.innerHeight,c.clientHeight)),this.docHeight=Math.round(Math.max(b.scrollHeight,b.offsetHeight,c.clientHeight,c.scrollHeight,c.offsetHeight)),this.$targets.each(function(){var b=$(this),c=b.offset().top;b.targetPoint=c,a.points.push(c)})},Traverse.prototype._events=function(){var a=this,b=$("html, body"),c={duration:a.options.animationDuration,easing:a.options.animationEasing};$(window).one("load",function(){a.calcPoints(),a._updateActive(),$(this).resize(function(b){a.reflow()}).scroll(function(b){a._updateActive()})}),this.$element.on("click",'a[href^="#"]',function(d){d.preventDefault();var e=this.getAttribute("href"),f=$(e).offset().top-a.options.barOffset;b.stop(!0).animate({scrollTop:f},c)})},Traverse.prototype.reflow=function(){this.calcPoints(),this._updateActive()},Traverse.prototype._updateActive=function(){var a,b=parseInt(window.pageYOffset,10);if(b+this.winHeight===this.docHeight)a=this.points.length-1;else if(b');return d.append(g),g.click(e),!1}),c.find("[data-drawer-close]").click(e)}}),Traverse.defaults={animationDuration:500,animationEasing:"linear",threshold:50,activeClass:"active",deepLinking:!1,barOffset:0},Traverse.prototype._init=function(){var a=this.$element[0].id;this.$targets=$("[data-traverse-target]"),this.$links=this.$element.find("a"),this.$element.attr({"data-resize":a,"data-scroll":a,id:a}),this.$active=$(),this.scrollPos=parseInt(window.pageYOffset,10),this._events()},Traverse.prototype.calcPoints=function(){var a=this,b=document.body,c=document.documentElement;this.points=[],this.winHeight=Math.round(Math.max(window.innerHeight,c.clientHeight)),this.docHeight=Math.round(Math.max(b.scrollHeight,b.offsetHeight,c.clientHeight,c.scrollHeight,c.offsetHeight)),this.$targets.each(function(){var b=$(this),c=b.offset().top;b.targetPoint=c,a.points.push(c)})},Traverse.prototype._events=function(){var a=this,b=$("html, body"),c={duration:a.options.animationDuration,easing:a.options.animationEasing};$(window).one("load",function(){a.calcPoints(),a._updateActive(),$(this).resize(function(b){a.reflow()}).scroll(function(b){a._updateActive()})}),this.$element.on("click",'a[href^="#"]',function(d){d.preventDefault();var e=this.getAttribute("href"),f=$(e).offset().top-a.options.barOffset;b.stop(!0).animate({scrollTop:f},c)})},Traverse.prototype.reflow=function(){this.calcPoints(),this._updateActive()},Traverse.prototype._updateActive=function(){var a,b=parseInt(window.pageYOffset,10);if(b+this.winHeight===this.docHeight)a=this.points.length-1;else if(b