Humanity HVII Public API

Humanity Public API Developer Hub

Welcome to the Humanity Public API Developer Hub. You'll find comprehensive guides and documentation to help you start working with Humanity Public API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started
Suggest Edits

api.config

 

Returns all all config properties used in Humanity for date, time, display, and error codes.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

DOCUMENTATION

GET
Retrieves all config properties used in Humanity for date, time, display, and error codes.
Level 5 is required (all users can fetch this module)

--

Parameters
Type
Description

all (accepted)

enum[0,1]

Display all languages
0 : Display visible languages
1 : Display all languages

Example request:

    {
       "module":"api.config",
       "method":"GET",
       "request":{
         "all":0,
         "token": xxxxxxx
       }
    }

Example response:

{
  "status": 1,
  "data": {
    "today": {
      "id": 2961,
      "month": 6,
      "day": 7,
      "wday": 3,
      "year": 2017,
      "weekday": "Wed",
      "mname": "Jun",
      "week": 23,
      "dayid": 4,
      "timeid": 1,
      "timeid_exact": 1,
      "formatted": "Jun 7, 2017",
      "iso8601": "2017-06-07T00:00:00+0300",
      "time": "12:00am",
      "timestamp": 1496782800,
      "hours": 0,
      "minutes": 0,
      "seconds": 0,
      "date": "2017-06-07 00:00:00",
      "day_of_year": "157",
      "week_adjusted": 23,
      "sp_wday": 4
    },
    "days": {
      "1": "Sun",
      "2": "Mon",
      "3": "Tue",
      "4": "Wed",
      "5": "Thu",
      "6": "Fri",
      "7": "Sat"
    },
    "fdays": {
      "1": "Sunday",
      "2": "Monday",
      "3": "Tuesday",
      "4": "Wednesday",
      "5": "Thursday",
      "6": "Friday",
      "7": "Saturday"
    },
    "months": {
      "1": "Jan",
      "2": "Feb",
      "3": "Mar",
      "4": "Apr",
      "5": "May",
      "6": "Jun",
      "7": "Jul",
      "8": "Aug",
      "9": "Sep",
      "10": "Oct",
      "11": "Nov",
      "12": "Dec"
    },
    "fmonths": {
      "1": "January",
      "2": "February",
      "3": "March",
      "4": "April",
      "5": "May",
      "6": "June",
      "7": "July",
      "8": "August",
      "9": "September",
      "10": "October",
      "11": "November",
      "12": "December"
    },
    "time": {
      "1": "12 am",
      "2": "12:15 am",
      "3": "12:30 am",
      "4": "12:45 am",
      "5": "1 am",
      "6": "1:15 am",
      "7": "1:30 am",
      "8": "1:45 am",
      "9": "2 am",
      "10": "2:15 am",
      "11": "2:30 am",
      "12": "2:45 am",
      "13": "3 am",
      "14": "3:15 am",
      "15": "3:30 am",
      "16": "3:45 am",
      "17": "4 am",
      "18": "4:15 am",
      "19": "4:30 am",
      "20": "4:45 am",
      "21": "5 am",
      "22": "5:15 am",
      "23": "5:30 am",
      "24": "5:45 am",
      "25": "6 am",
      "26": "6:15 am",
      "27": "6:30 am",
      "28": "6:45 am",
      "29": "7 am",
      "30": "7:15 am",
      "31": "7:30 am",
      "32": "7:45 am",
      "33": "8 am",
      "34": "8:15 am",
      "35": "8:30 am",
      "36": "8:45 am",
      "37": "9 am",
      "38": "9:15 am",
      "39": "9:30 am",
      "40": "9:45 am",
      "41": "10 am",
      "42": "10:15 am",
      "43": "10:30 am",
      "44": "10:45 am",
      "45": "11 am",
      "46": "11:15 am",
      "47": "11:30 am",
      "48": "11:45 am",
      "49": "12 pm",
      "50": "12:15 pm",
      "51": "12:30 pm",
      "52": "12:45 pm",
      "53": "1 pm",
      "54": "1:15 pm",
      "55": "1:30 pm",
      "56": "1:45 pm",
      "57": "2 pm",
      "58": "2:15 pm",
      "59": "2:30 pm",
      "60": "2:45 pm",
      "61": "3 pm",
      "62": "3:15 pm",
      "63": "3:30 pm",
      "64": "3:45 pm",
      "65": "4 pm",
      "66": "4:15 pm",
      "67": "4:30 pm",
      "68": "4:45 pm",
      "69": "5 pm",
      "70": "5:15 pm",
      "71": "5:30 pm",
      "72": "5:45 pm",
      "73": "6 pm",
      "74": "6:15 pm",
      "75": "6:30 pm",
      "76": "6:45 pm",
      "77": "7 pm",
      "78": "7:15 pm",
      "79": "7:30 pm",
      "80": "7:45 pm",
      "81": "8 pm",
      "82": "8:15 pm",
      "83": "8:30 pm",
      "84": "8:45 pm",
      "85": "9 pm",
      "86": "9:15 pm",
      "87": "9:30 pm",
      "88": "9:45 pm",
      "89": "10 pm",
      "90": "10:15 pm",
      "91": "10:30 pm",
      "92": "10:45 pm",
      "93": "11 pm",
      "94": "11:15 pm",
      "95": "11:30 pm",
      "96": "11:45 pm",
      "97": "midnight"
    },
    "time24h": {
      "1": "00:00",
      "2": "00:15",
      "3": "00:30",
      "4": "00:45",
      "5": "01:00",
      "6": "01:15",
      "7": "01:30",
      "8": "01:45",
      "9": "02:00",
      "10": "02:15",
      "11": "02:30",
      "12": "02:45",
      "13": "03:00",
      "14": "03:15",
      "15": "03:30",
      "16": "03:45",
      "17": "04:00",
      "18": "04:15",
      "19": "04:30",
      "20": "04:45",
      "21": "05:00",
      "22": "05:15",
      "23": "05:30",
      "24": "05:45",
      "25": "06:00",
      "26": "06:15",
      "27": "06:30",
      "28": "06:45",
      "29": "07:00",
      "30": "07:15",
      "31": "07:30",
      "32": "07:45",
      "33": "08:00",
      "34": "08:15",
      "35": "08:30",
      "36": "08:45",
      "37": "09:00",
      "38": "09:15",
      "39": "09:30",
      "40": "09:45",
      "41": "10:00",
      "42": "10:15",
      "43": "10:30",
      "44": "10:45",
      "45": "11:00",
      "46": "11:15",
      "47": "11:30",
      "48": "11:45",
      "49": "12:00",
      "50": "12:15",
      "51": "12:30",
      "52": "12:45",
      "53": "13:00",
      "54": "13:15",
      "55": "13:30",
      "56": "13:45",
      "57": "14:00",
      "58": "14:15",
      "59": "14:30",
      "60": "14:45",
      "61": "15:00",
      "62": "15:15",
      "63": "15:30",
      "64": "15:45",
      "65": "16:00",
      "66": "16:15",
      "67": "16:30",
      "68": "16:45",
      "69": "17:00",
      "70": "17:15",
      "71": "17:30",
      "72": "17:45",
      "73": "18:00",
      "74": "18:15",
      "75": "18:30",
      "76": "18:45",
      "77": "19:00",
      "78": "19:15",
      "79": "19:30",
      "80": "19:45",
      "81": "20:00",
      "82": "20:15",
      "83": "20:30",
      "84": "20:45",
      "85": "21:00",
      "86": "21:15",
      "87": "21:30",
      "88": "21:45",
      "89": "22:00",
      "90": "22:15",
      "91": "22:30",
      "92": "22:45",
      "93": "23:00",
      "94": "23:15",
      "95": "23:30",
      "96": "23:45",
      "97": "24:00"
    },
    "colorsets": {
      "1": [
        "00A464",
        "63E6BE",
        "1E1E1E"
      ],
      "2": [
        "035800",
        "82C91E",
        "FFFFFF"
      ],
      "3": [
        "E5922D",
        "FFE8CC",
        "1E1E1E"
      ],
      "4": [
        "960000",
        "FD7E14",
        "FFFFFF"
      ],
      "5": [
        "1E0000",
        "A61E4D",
        "FFFFFF"
      ],
      "6": [
        "4F25C7",
        "B197FC",
        "1E1E1E"
      ],
      "7": [
        "008FA7",
        "66D9E8",
        "1E1E1E"
      ],
      "8": [
        "010B16",
        "0B7285",
        "FFFFFF"
      ],
      "9": [
        "67AC00",
        "C0EB75",
        "1E1E1E"
      ],
      "10": [
        "E6B300",
        "FFF59D",
        "1E1E1E"
      ],
      "11": [
        "00334C",
        "15AABF",
        "FFFFFF"
      ],
      "12": [
        "868E96",
        "CED4DA",
        "1E1E1E"
      ],
      "13": [
        "000036",
        "5F3DC4",
        "FFFFFF"
      ],
      "14": [
        "CC6700",
        "FFC078",
        "1E1E1E"
      ],
      "15": [
        "95D31F",
        "E9FAC8",
        "1E1E1E"
      ],
      "16": [
        "050016",
        "862E9C",
        "FFFFFF"
      ],
      "17": [
        "14C5D3",
        "C5F6FA",
        "1E1E1E"
      ],
      "18": [
        "004307",
        "12B886",
        "FFFFFF"
      ],
      "19": [
        "FF7BAF",
        "FFDEEB",
        "1E1E1E"
      ],
      "20": [
        "CCAC00",
        "FFEB3B",
        "1E1E1E"
      ],
      "21": [
        "966A00",
        "FDD835",
        "1E1E1E"
      ],
      "22": [
        "470000",
        "D9480F",
        "FFFFFF"
      ],
      "23": [
        "000039",
        "364FC7",
        "FFFFFF"
      ],
      "24": [
        "000089",
        "7950F2",
        "FFFFFF"
      ],
      "25": [
        "A228BF",
        "E599F7",
        "1E1E1E"
      ],
      "26": [
        "00008D",
        "4C6EF5",
        "FFFFFF"
      ],
      "27": [
        "040505",
        "495057",
        "FFFFFF"
      ],
      "28": [
        "1C3FCC",
        "91A7FF",
        "1E1E1E"
      ],
      "29": [
        "4B006D",
        "BE4BDB",
        "FFFFFF"
      ],
      "30": [
        "0DD393",
        "C3FAE8",
        "1E1E1E"
      ],
      "31": [
        "623300",
        "FBC02D",
        "1E1E1E"
      ],
      "32": [
        "C43768",
        "FAA2C1",
        "1E1E1E"
      ],
      "33": [
        "011912",
        "087F5B",
        "FFFFFF"
      ],
      "34": [
        "343A40",
        "868E96",
        "FFFFFF"
      ],
      "35": [
        "7B0000",
        "E64980",
        "FFFFFF"
      ],
      "36": [
        "002900",
        "5C940D",
        "FFFFFF"
      ],
      "37": [
        "CF67EB",
        "F3D9FA",
        "1E1E1E"
      ],
      "38": [
        "976FFF",
        "E5DBFF",
        "1E1E1E"
      ],
      "39": [
        "6F93FF",
        "DBE4FF",
        "1E1E1E"
      ],
      "40": [
        "ADB5BD",
        "E9ECEF",
        "1E1E1E"
      ]
    },
    "newcolorsets": {
      "1": [
        "00A464",
        "63E6BE",
        "1E1E1E"
      ],
      "2": [
        "035800",
        "82C91E",
        "FFFFFF"
      ],
      "3": [
        "E5922D",
        "FFE8CC",
        "1E1E1E"
      ],
      "4": [
        "960000",
        "FD7E14",
        "FFFFFF"
      ],
      "5": [
        "1E0000",
        "A61E4D",
        "FFFFFF"
      ],
      "6": [
        "4F25C7",
        "B197FC",
        "1E1E1E"
      ],
      "7": [
        "008FA7",
        "66D9E8",
        "1E1E1E"
      ],
      "8": [
        "010B16",
        "0B7285",
        "FFFFFF"
      ],
      "9": [
        "67AC00",
        "C0EB75",
        "1E1E1E"
      ],
      "10": [
        "E6B300",
        "FFF59D",
        "1E1E1E"
      ],
      "11": [
        "00334C",
        "15AABF",
        "FFFFFF"
      ],
      "12": [
        "868E96",
        "CED4DA",
        "1E1E1E"
      ],
      "13": [
        "000036",
        "5F3DC4",
        "FFFFFF"
      ],
      "14": [
        "CC6700",
        "FFC078",
        "1E1E1E"
      ],
      "15": [
        "95D31F",
        "E9FAC8",
        "1E1E1E"
      ],
      "16": [
        "050016",
        "862E9C",
        "FFFFFF"
      ],
      "17": [
        "14C5D3",
        "C5F6FA",
        "1E1E1E"
      ],
      "18": [
        "004307",
        "12B886",
        "FFFFFF"
      ],
      "19": [
        "FF7BAF",
        "FFDEEB",
        "1E1E1E"
      ],
      "20": [
        "CCAC00",
        "FFEB3B",
        "1E1E1E"
      ],
      "21": [
        "966A00",
        "FDD835",
        "1E1E1E"
      ],
      "22": [
        "470000",
        "D9480F",
        "FFFFFF"
      ],
      "23": [
        "000039",
        "364FC7",
        "FFFFFF"
      ],
      "24": [
        "000089",
        "7950F2",
        "FFFFFF"
      ],
      "25": [
        "A228BF",
        "E599F7",
        "1E1E1E"
      ],
      "26": [
        "00008D",
        "4C6EF5",
        "FFFFFF"
      ],
      "27": [
        "040505",
        "495057",
        "FFFFFF"
      ],
      "28": [
        "1C3FCC",
        "91A7FF",
        "1E1E1E"
      ],
      "29": [
        "4B006D",
        "BE4BDB",
        "FFFFFF"
      ],
      "30": [
        "0DD393",
        "C3FAE8",
        "1E1E1E"
      ],
      "31": [
        "623300",
        "FBC02D",
        "1E1E1E"
      ],
      "32": [
        "C43768",
        "FAA2C1",
        "1E1E1E"
      ],
      "33": [
        "011912",
        "087F5B",
        "FFFFFF"
      ],
      "34": [
        "343A40",
        "868E96",
        "FFFFFF"
      ],
      "35": [
        "7B0000",
        "E64980",
        "FFFFFF"
      ],
      "36": [
        "002900",
        "5C940D",
        "FFFFFF"
      ],
      "37": [
        "CF67EB",
        "F3D9FA",
        "1E1E1E"
      ],
      "38": [
        "976FFF",
        "E5DBFF",
        "1E1E1E"
      ],
      "39": [
        "6F93FF",
        "DBE4FF",
        "1E1E1E"
      ],
      "40": [
        "ADB5BD",
        "E9ECEF",
        "1E1E1E"
      ]
    },
    "errorcodes": {
      "1": [
        "Success",
        ""
      ],
      "2": [
        "Invalid API key",
        "App must be granted a valid key by Humanity"
      ],
      "3": [
        "Invalid token key",
        "Please re-authenticate"
      ],
      "4": [
        "Invalid Method",
        "No Method with that name exists in our API"
      ],
      "5": [
        "Invalid Module",
        "No Module with that name exists in our API"
      ],
      "6": [
        "Invalid Action",
        "No Action with that name exists in our API"
      ],
      "7": [
        "Authentication Failed",
        "You do not have permissions to access the service"
      ],
      "8": [
        "Missing parameters",
        "Your request is missing a required parameter"
      ],
      "9": [
        "Invalid parameters",
        "Your request has an invalid parameter type"
      ],
      "10": [
        "Extra parameters",
        "Your request has an extra/unallowed parameter type"
      ],
      "12": [
        "Create Failed",
        "Your CREATE request failed"
      ],
      "13": [
        "Update Failed",
        "Your UPDATE request failed"
      ],
      "14": [
        "Delete Failed",
        "Your DELETE request failed"
      ],
      "15": [
        "Get Failed",
        "Your GET request failed"
      ],
      "20": [
        "Incorrect Permissions",
        "You don't have the proper permissions to access this"
      ],
      "90": [
        "Suspended API key",
        "Access for your account has been suspended, please contact Humanity"
      ],
      "91": [
        "Throttle exceeded",
        "You have exceeded the max allowed requests. Try again later."
      ],
      "98": [
        "Bad API Paramaters",
        "Invalid POST request. See Manual."
      ],
      "99": [
        "Service Offline",
        "This service is temporarily offline. Try again later."
      ],
      "-3": [
        "Flagged API Key",
        "Pemanently Banned"
      ],
      "-2": [
        "Flagged API Key",
        "Too Many invalid access attempts - contact us"
      ],
      "-1": [
        "Flagged API Key",
        "Temporarily Disabled - contact us"
      ]
    },
"languages": {
      "sq_AL": {
        "code": "sq_AL",
        "name": "Albanian",
        "local_name": "Shqip",
        "machine": "1",
        "short_code": "sq",
        "crawl": "1"
      },
      "en_US": {
        "code": "en_US",
        "name": "American English",
        "local_name": "American English",
        "machine": "0",
        "short_code": "en",
        "crawl": "1"
      },
      "ar_SY": {
        "code": "ar_SY",
        "name": "Arabic",
        "local_name": "العربية",
        "machine": "1",
        "short_code": "ar",
        "crawl": "1"
      },
      "be_BY": {
        "code": "be_BY",
        "name": "Belarusian",
        "local_name": "Беларуская мова",
        "machine": "1",
        "short_code": "be",
        "crawl": "1"
      },
      "bg_BG": {
        "code": "bg_BG",
        "name": "Bulgarian",
        "local_name": "Български",
        "machine": "1",
        "short_code": "bg",
        "crawl": "1"
      },
      "ca_AD": {
        "code": "ca_AD",
        "name": "Catalan",
        "local_name": "Català",
        "machine": "1",
        "short_code": "ca",
        "crawl": "1"
      },
      "zh_CN": {
        "code": "zh_CN",
        "name": "Chinese Simplified",
        "local_name": "繁体字",
        "machine": "1",
        "short_code": "zh-CN",
        "crawl": "1"
      },
      "zh_TW": {
        "code": "zh_TW",
        "name": "Chinese Traditional",
        "local_name": "繁體字",
        "machine": "1",
        "short_code": "zh-TW",
        "crawl": "1"
      },
      "hr_HR": {
        "code": "hr_HR",
        "name": "Croatian",
        "local_name": "Hrvatski",
        "machine": "1",
        "short_code": "hr",
        "crawl": "1"
      },
      "cs_CZ": {
        "code": "cs_CZ",
        "name": "Czech",
        "local_name": "Čeština",
        "machine": "1",
        "short_code": "cs",
        "crawl": "1"
      },
      "da_DK": {
        "code": "da_DK",
        "name": "Danish",
        "local_name": "Dansk",
        "machine": "1",
        "short_code": "da",
        "crawl": "1"
      },
      "nl_NL": {
        "code": "nl_NL",
        "name": "Dutch",
        "local_name": "Nederlands",
        "machine": "1",
        "short_code": "nl",
        "crawl": "1"
      },
      "et_EE": {
        "code": "et_EE",
        "name": "Estonian",
        "local_name": "Eesti keel",
        "machine": "1",
        "short_code": "et",
        "crawl": "1"
      },
      "tl_PH": {
        "code": "tl_PH",
        "name": "Filipino",
        "local_name": "Filipino",
        "machine": "1",
        "short_code": "tl",
        "crawl": "1"
      },
      "fi_FI": {
        "code": "fi_FI",
        "name": "Finnish",
        "local_name": "Suomi",
        "machine": "1",
        "short_code": "fi",
        "crawl": "1"
      },
      "fr_FR": {
        "code": "fr_FR",
        "name": "French (Canadian)",
        "local_name": "Français Canadien",
        "machine": "0",
        "short_code": "fr",
        "crawl": "1"
      },
      "ka_GE": {
        "code": "ka_GE",
        "name": "Georgian",
        "local_name": "ქართული",
        "machine": "1",
        "short_code": "ka",
        "crawl": "1"
      },
      "de_DE": {
        "code": "de_DE",
        "name": "German",
        "local_name": "Deutsch",
        "machine": "1",
        "short_code": "de",
        "crawl": "1"
      },
      "iw_IL": {
        "code": "iw_IL",
        "name": "Hebrew",
        "local_name": "עברית",
        "machine": "1",
        "short_code": "iw",
        "crawl": "1"
      },
      "hu_HU": {
        "code": "hu_HU",
        "name": "Hungarian",
        "local_name": "Magyar",
        "machine": "1",
        "short_code": "hu",
        "crawl": "1"
      },
      "is_IS": {
        "code": "is_IS",
        "name": "Icelandic",
        "local_name": "Íslenska",
        "machine": "1",
        "short_code": "is",
        "crawl": "1"
      },
      "ga_IE": {
        "code": "ga_IE",
        "name": "Irish",
        "local_name": "Gaeilge",
        "machine": "1",
        "short_code": "ga",
        "crawl": "1"
      },
      "it_IT": {
        "code": "it_IT",
        "name": "Italian",
        "local_name": "Italiano",
        "machine": "1",
        "short_code": "it",
        "crawl": "1"
      },
      "ja_JP": {
        "code": "ja_JP",
        "name": "Japanese",
        "local_name": "日本語",
        "machine": "1",
        "short_code": "ja",
        "crawl": "1"
      },
      "ko_KR": {
        "code": "ko_KR",
        "name": "Korean",
        "local_name": "韓國語",
        "machine": "1",
        "short_code": "ko",
        "crawl": "1"
      },
      "lv_LV": {
        "code": "lv_LV",
        "name": "Latvian",
        "local_name": "Latviešu valoda",
        "machine": "1",
        "short_code": "lv",
        "crawl": "1"
      },
      "lt_LT": {
        "code": "lt_LT",
        "name": "Lithuanian",
        "local_name": "Lietuvių kalba",
        "machine": "1",
        "short_code": "lt",
        "crawl": "1"
      },
      "mk_MK": {
        "code": "mk_MK",
        "name": "Macedonian",
        "local_name": "Македонски",
        "machine": "1",
        "short_code": "mk",
        "crawl": "1"
      },
      "ms_MY": {
        "code": "ms_MY",
        "name": "Malay",
        "local_name": "Bahasa melayu",
        "machine": "1",
        "short_code": "ms",
        "crawl": "1"
      },
      "mt_MT": {
        "code": "mt_MT",
        "name": "Maltese",
        "local_name": "Malti",
        "machine": "1",
        "short_code": "mt",
        "crawl": "1"
      },
      "nb_NO": {
        "code": "nb_NO",
        "name": "Norwegian",
        "local_name": "Norsk",
        "machine": "1",
        "short_code": "no",
        "crawl": "1"
      },
      "pl_PL": {
        "code": "pl_PL",
        "name": "Polish",
        "local_name": "Polski",
        "machine": "1",
        "short_code": "pl",
        "crawl": "1"
      },
      "pt_PT": {
        "code": "pt_PT",
        "name": "Portuguese",
        "local_name": "Português",
        "machine": "1",
        "short_code": "pt",
        "crawl": "1"
      },
      "pt_BR": {
        "code": "pt_BR",
        "name": "Portuguese (Brazil)",
        "local_name": "Português",
        "machine": "1",
        "short_code": "pt-BR",
        "crawl": "1"
      },
      "ro_RO": {
        "code": "ro_RO",
        "name": "Romanian",
        "local_name": "Român",
        "machine": "1",
        "short_code": "ro",
        "crawl": "1"
      },
      "ru_RU": {
        "code": "ru_RU",
        "name": "Russian",
        "local_name": "Русский",
        "machine": "1",
        "short_code": "ru",
        "crawl": "1"
      },
      "sr_RS": {
        "code": "sr_RS",
        "name": "Serbian",
        "local_name": "Српски",
        "machine": "1",
        "short_code": "sr",
        "crawl": "1"
      },
      "sk_SK": {
        "code": "sk_SK",
        "name": "Slovak",
        "local_name": "Slovenčina",
        "machine": "1",
        "short_code": "sk",
        "crawl": "1"
      },
      "sl_SI": {
        "code": "sl_SI",
        "name": "Slovenian",
        "local_name": "Slovenščina",
        "machine": "1",
        "short_code": "sl",
        "crawl": "1"
      },
      "es_ES": {
        "code": "es_ES",
        "name": "Spanish",
        "local_name": "Español",
        "machine": "0",
        "short_code": "es",
        "crawl": "1"
      },
      "sv_SE": {
        "code": "sv_SE",
        "name": "Swedish",
        "local_name": "Svenska",
        "machine": "1",
        "short_code": "sv",
        "crawl": "1"
      },
      "th_TH": {
        "code": "th_TH",
        "name": "Thai",
        "local_name": "ภาษาไทย",
        "machine": "1",
        "short_code": "th",
        "crawl": "1"
      },
      "tr_TR": {
        "code": "tr_TR",
        "name": "Turkish",
        "local_name": "Türkçe",
        "machine": "1",
        "short_code": "tr",
        "crawl": "1"
      },
      "uk_UA": {
        "code": "uk_UA",
        "name": "Ukrainian",
        "local_name": "Українська",
        "machine": "1",
        "short_code": "uk",
        "crawl": "1"
      },
      "vi_VN": {
        "code": "vi_VN",
        "name": "Vietnamese",
        "local_name": "Tiếng việt",
        "machine": "1",
        "short_code": "vi",
        "crawl": "1"
      },
      "cy_GB": {
        "code": "cy_GB",
        "name": "Welsh",
        "local_name": "Cymraeg",
        "machine": "1",
        "short_code": "cy",
        "crawl": "1"
      }
    },
"timezones": {
      "1": {
        "timezone_id": "1",
        "name": "Africa/Abidjan",
        "name_formatted": "(UTC) Africa/Abidjan",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "2": {
        "timezone_id": "2",
        "name": "Africa/Accra",
        "name_formatted": "(UTC) Africa/Accra",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "3": {
        "timezone_id": "3",
        "name": "Africa/Addis_Ababa",
        "name_formatted": "(UTC +03:00) Africa/Addis Ababa",
        "offset": "+3:00",
        "seconds": "10800",
        "hours": "3",
        "default": "0"
      },
      "4": {
        "timezone_id": "4",
        "name": "Africa/Algiers",
        "name_formatted": "(UTC +01:00) Africa/Algiers",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "5": {
        "timezone_id": "5",
        "name": "Africa/Asmara",
        "name_formatted": "(UTC +03:00) Africa/Asmara",
        "offset": "+3:00",
        "seconds": "10800",
        "hours": "3",
        "default": "0"
      },
      "6": {
        "timezone_id": "6",
        "name": "Africa/Bamako",
        "name_formatted": "(UTC) Africa/Bamako",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "7": {
        "timezone_id": "7",
        "name": "Africa/Bangui",
        "name_formatted": "(UTC +01:00) Africa/Bangui",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "8": {
        "timezone_id": "8",
        "name": "Africa/Banjul",
        "name_formatted": "(UTC) Africa/Banjul",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "9": {
        "timezone_id": "9",
        "name": "Africa/Bissau",
        "name_formatted": "(UTC) Africa/Bissau",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "10": {
        "timezone_id": "10",
        "name": "Africa/Blantyre",
        "name_formatted": "(UTC +02:00) Africa/Blantyre",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "11": {
        "timezone_id": "11",
        "name": "Africa/Brazzaville",
        "name_formatted": "(UTC +01:00) Africa/Brazzaville",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "12": {
        "timezone_id": "12",
        "name": "Africa/Bujumbura",
        "name_formatted": "(UTC +02:00) Africa/Bujumbura",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "13": {
        "timezone_id": "13",
        "name": "Africa/Cairo",
        "name_formatted": "(UTC +02:00) Africa/Cairo",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "14": {
        "timezone_id": "14",
        "name": "Africa/Casablanca",
        "name_formatted": "(UTC) Africa/Casablanca",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "15": {
        "timezone_id": "15",
        "name": "Africa/Ceuta",
        "name_formatted": "(UTC +01:00) Africa/Ceuta",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "16": {
        "timezone_id": "16",
        "name": "Africa/Conakry",
        "name_formatted": "(UTC) Africa/Conakry",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "17": {
        "timezone_id": "17",
        "name": "Africa/Dakar",
        "name_formatted": "(UTC) Africa/Dakar",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "18": {
        "timezone_id": "18",
        "name": "Africa/Dar_es_Salaam",
        "name_formatted": "(UTC +03:00) Africa/Dar es Salaam",
        "offset": "+3:00",
        "seconds": "10800",
        "hours": "3",
        "default": "0"
      },
      "19": {
        "timezone_id": "19",
        "name": "Africa/Djibouti",
        "name_formatted": "(UTC +03:00) Africa/Djibouti",
        "offset": "+3:00",
        "seconds": "10800",
        "hours": "3",
        "default": "0"
      },
      "20": {
        "timezone_id": "20",
        "name": "Africa/Douala",
        "name_formatted": "(UTC +01:00) Africa/Douala",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "21": {
        "timezone_id": "21",
        "name": "Africa/El_Aaiun",
        "name_formatted": "(UTC) Africa/El Aaiun",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "22": {
        "timezone_id": "22",
        "name": "Africa/Freetown",
        "name_formatted": "(UTC) Africa/Freetown",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "23": {
        "timezone_id": "23",
        "name": "Africa/Gaborone",
        "name_formatted": "(UTC +02:00) Africa/Gaborone",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "24": {
        "timezone_id": "24",
        "name": "Africa/Harare",
        "name_formatted": "(UTC +02:00) Africa/Harare",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "25": {
        "timezone_id": "25",
        "name": "Africa/Johannesburg",
        "name_formatted": "(UTC +02:00) Africa/Johannesburg",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "26": {
        "timezone_id": "26",
        "name": "Africa/Juba",
        "name_formatted": "(UTC +03:00) Africa/Juba",
        "offset": "+3:00",
        "seconds": "10800",
        "hours": "3",
        "default": "0"
      },
      "27": {
        "timezone_id": "27",
        "name": "Africa/Kampala",
        "name_formatted": "(UTC +03:00) Africa/Kampala",
        "offset": "+3:00",
        "seconds": "10800",
        "hours": "3",
        "default": "0"
      },
      "28": {
        "timezone_id": "28",
        "name": "Africa/Khartoum",
        "name_formatted": "(UTC +03:00) Africa/Khartoum",
        "offset": "+3:00",
        "seconds": "10800",
        "hours": "3",
        "default": "0"
      },
      "29": {
        "timezone_id": "29",
        "name": "Africa/Kigali",
        "name_formatted": "(UTC +02:00) Africa/Kigali",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "30": {
        "timezone_id": "30",
        "name": "Africa/Kinshasa",
        "name_formatted": "(UTC +01:00) Africa/Kinshasa",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "31": {
        "timezone_id": "31",
        "name": "Africa/Lagos",
        "name_formatted": "(UTC +01:00) Africa/Lagos",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "32": {
        "timezone_id": "32",
        "name": "Africa/Libreville",
        "name_formatted": "(UTC +01:00) Africa/Libreville",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "33": {
        "timezone_id": "33",
        "name": "Africa/Lome",
        "name_formatted": "(UTC) Africa/Lome",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "34": {
        "timezone_id": "34",
        "name": "Africa/Luanda",
        "name_formatted": "(UTC +01:00) Africa/Luanda",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "35": {
        "timezone_id": "35",
        "name": "Africa/Lubumbashi",
        "name_formatted": "(UTC +02:00) Africa/Lubumbashi",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "36": {
        "timezone_id": "36",
        "name": "Africa/Lusaka",
        "name_formatted": "(UTC +02:00) Africa/Lusaka",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "37": {
        "timezone_id": "37",
        "name": "Africa/Malabo",
        "name_formatted": "(UTC +01:00) Africa/Malabo",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "38": {
        "timezone_id": "38",
        "name": "Africa/Maputo",
        "name_formatted": "(UTC +02:00) Africa/Maputo",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "39": {
        "timezone_id": "39",
        "name": "Africa/Maseru",
        "name_formatted": "(UTC +02:00) Africa/Maseru",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "40": {
        "timezone_id": "40",
        "name": "Africa/Mbabane",
        "name_formatted": "(UTC +02:00) Africa/Mbabane",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "41": {
        "timezone_id": "41",
        "name": "Africa/Mogadishu",
        "name_formatted": "(UTC +03:00) Africa/Mogadishu",
        "offset": "+3:00",
        "seconds": "10800",
        "hours": "3",
        "default": "0"
      },
      "42": {
        "timezone_id": "42",
        "name": "Africa/Monrovia",
        "name_formatted": "(UTC) Africa/Monrovia",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "43": {
        "timezone_id": "43",
        "name": "Africa/Nairobi",
        "name_formatted": "(UTC +03:00) Africa/Nairobi",
        "offset": "+3:00",
        "seconds": "10800",
        "hours": "3",
        "default": "0"
      },
      "44": {
        "timezone_id": "44",
        "name": "Africa/Ndjamena",
        "name_formatted": "(UTC +01:00) Africa/Ndjamena",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "45": {
        "timezone_id": "45",
        "name": "Africa/Niamey",
        "name_formatted": "(UTC +01:00) Africa/Niamey",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "46": {
        "timezone_id": "46",
        "name": "Africa/Nouakchott",
        "name_formatted": "(UTC) Africa/Nouakchott",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "47": {
        "timezone_id": "47",
        "name": "Africa/Ouagadougou",
        "name_formatted": "(UTC) Africa/Ouagadougou",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "48": {
        "timezone_id": "48",
        "name": "Africa/Porto-Novo",
        "name_formatted": "(UTC +01:00) Africa/Porto-Novo",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "49": {
        "timezone_id": "49",
        "name": "Africa/Sao_Tome",
        "name_formatted": "(UTC) Africa/Sao Tome",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "50": {
        "timezone_id": "50",
        "name": "Africa/Tripoli",
        "name_formatted": "(UTC +02:00) Africa/Tripoli",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "51": {
        "timezone_id": "51",
        "name": "Africa/Tunis",
        "name_formatted": "(UTC +01:00) Africa/Tunis",
        "offset": "+1:00",
        "seconds": "3600",
        "hours": "1",
        "default": "0"
      },
      "52": {
        "timezone_id": "52",
        "name": "Africa/Windhoek",
        "name_formatted": "(UTC +02:00) Africa/Windhoek",
        "offset": "+2:00",
        "seconds": "7200",
        "hours": "2",
        "default": "0"
      },
      "53": {
        "timezone_id": "53",
        "name": "America/Adak",
        "name_formatted": "(UTC -10:00) America/Adak",
        "offset": "-10:00",
        "seconds": "-36000",
        "hours": "-10",
        "default": "0"
      },
      "54": {
        "timezone_id": "54",
        "name": "America/Anchorage",
        "name_formatted": "(UTC -09:00) America/Anchorage",
        "offset": "-9:00",
        "seconds": "-32400",
        "hours": "-9",
        "default": "0"
      },
      "55": {
        "timezone_id": "55",
        "name": "America/Anguilla",
        "name_formatted": "(UTC -04:00) America/Anguilla",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "56": {
        "timezone_id": "56",
        "name": "America/Antigua",
        "name_formatted": "(UTC -04:00) America/Antigua",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "57": {
        "timezone_id": "57",
        "name": "America/Araguaina",
        "name_formatted": "(UTC -03:00) America/Araguaina",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "58": {
        "timezone_id": "58",
        "name": "America/Argentina/Buenos_Aires",
        "name_formatted": "(UTC -03:00) America/Argentina/Buenos Aires",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "59": {
        "timezone_id": "59",
        "name": "America/Argentina/Catamarca",
        "name_formatted": "(UTC -03:00) America/Argentina/Catamarca",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "60": {
        "timezone_id": "60",
        "name": "America/Argentina/Cordoba",
        "name_formatted": "(UTC -03:00) America/Argentina/Cordoba",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "61": {
        "timezone_id": "61",
        "name": "America/Argentina/Jujuy",
        "name_formatted": "(UTC -03:00) America/Argentina/Jujuy",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "62": {
        "timezone_id": "62",
        "name": "America/Argentina/La_Rioja",
        "name_formatted": "(UTC -03:00) America/Argentina/La Rioja",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "63": {
        "timezone_id": "63",
        "name": "America/Argentina/Mendoza",
        "name_formatted": "(UTC -03:00) America/Argentina/Mendoza",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "64": {
        "timezone_id": "64",
        "name": "America/Argentina/Rio_Gallegos",
        "name_formatted": "(UTC -03:00) America/Argentina/Rio Gallegos",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "65": {
        "timezone_id": "65",
        "name": "America/Argentina/Salta",
        "name_formatted": "(UTC -03:00) America/Argentina/Salta",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "66": {
        "timezone_id": "66",
        "name": "America/Argentina/San_Juan",
        "name_formatted": "(UTC -03:00) America/Argentina/San Juan",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "67": {
        "timezone_id": "67",
        "name": "America/Argentina/San_Luis",
        "name_formatted": "(UTC -03:00) America/Argentina/San Luis",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "68": {
        "timezone_id": "68",
        "name": "America/Argentina/Tucuman",
        "name_formatted": "(UTC -03:00) America/Argentina/Tucuman",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "69": {
        "timezone_id": "69",
        "name": "America/Argentina/Ushuaia",
        "name_formatted": "(UTC -03:00) America/Argentina/Ushuaia",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "70": {
        "timezone_id": "70",
        "name": "America/Aruba",
        "name_formatted": "(UTC -04:00) America/Aruba",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "71": {
        "timezone_id": "71",
        "name": "America/Asuncion",
        "name_formatted": "(UTC -03:00) America/Asuncion",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "72": {
        "timezone_id": "72",
        "name": "America/Atikokan",
        "name_formatted": "(UTC -05:00) America/Atikokan",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "73": {
        "timezone_id": "73",
        "name": "America/Bahia",
        "name_formatted": "(UTC -03:00) America/Bahia",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "74": {
        "timezone_id": "74",
        "name": "America/Bahia_Banderas",
        "name_formatted": "(UTC -06:00) America/Bahia Banderas",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "75": {
        "timezone_id": "75",
        "name": "America/Barbados",
        "name_formatted": "(UTC -04:00) America/Barbados",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "76": {
        "timezone_id": "76",
        "name": "America/Belem",
        "name_formatted": "(UTC -03:00) America/Belem",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "77": {
        "timezone_id": "77",
        "name": "America/Belize",
        "name_formatted": "(UTC -06:00) America/Belize",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "78": {
        "timezone_id": "78",
        "name": "America/Blanc-Sablon",
        "name_formatted": "(UTC -04:00) America/Blanc-Sablon",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "79": {
        "timezone_id": "79",
        "name": "America/Boa_Vista",
        "name_formatted": "(UTC -04:00) America/Boa Vista",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "80": {
        "timezone_id": "80",
        "name": "America/Bogota",
        "name_formatted": "(UTC -05:00) America/Bogota",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "81": {
        "timezone_id": "81",
        "name": "America/Boise",
        "name_formatted": "(UTC -07:00) America/Boise",
        "offset": "-7:00",
        "seconds": "-25200",
        "hours": "-7",
        "default": "0"
      },
      "82": {
        "timezone_id": "82",
        "name": "America/Cambridge_Bay",
        "name_formatted": "(UTC -07:00) America/Cambridge Bay",
        "offset": "-7:00",
        "seconds": "-25200",
        "hours": "-7",
        "default": "0"
      },
      "83": {
        "timezone_id": "83",
        "name": "America/Campo_Grande",
        "name_formatted": "(UTC -04:00) America/Campo Grande",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "84": {
        "timezone_id": "84",
        "name": "America/Cancun",
        "name_formatted": "(UTC -06:00) America/Cancun",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "85": {
        "timezone_id": "85",
        "name": "America/Caracas",
        "name_formatted": "(UTC -04:30) America/Caracas",
        "offset": "-4:30",
        "seconds": "-16200",
        "hours": "-4",
        "default": "0"
      },
      "86": {
        "timezone_id": "86",
        "name": "America/Cayenne",
        "name_formatted": "(UTC -03:00) America/Cayenne",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "87": {
        "timezone_id": "87",
        "name": "America/Cayman",
        "name_formatted": "(UTC -05:00) America/Cayman",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "88": {
        "timezone_id": "88",
        "name": "America/Chicago",
        "name_formatted": "(UTC -06:00) America/Chicago",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "89": {
        "timezone_id": "89",
        "name": "America/Chihuahua",
        "name_formatted": "(UTC -07:00) America/Chihuahua",
        "offset": "-7:00",
        "seconds": "-25200",
        "hours": "-7",
        "default": "0"
      },
      "90": {
        "timezone_id": "90",
        "name": "America/Costa_Rica",
        "name_formatted": "(UTC -06:00) America/Costa Rica",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "91": {
        "timezone_id": "91",
        "name": "America/Cuiaba",
        "name_formatted": "(UTC -04:00) America/Cuiaba",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "92": {
        "timezone_id": "92",
        "name": "America/Curacao",
        "name_formatted": "(UTC -04:00) America/Curacao",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "93": {
        "timezone_id": "93",
        "name": "America/Danmarkshavn",
        "name_formatted": "(UTC) America/Danmarkshavn",
        "offset": "+0:00",
        "seconds": "0",
        "hours": "0",
        "default": "0"
      },
      "94": {
        "timezone_id": "94",
        "name": "America/Dawson",
        "name_formatted": "(UTC -08:00) America/Dawson",
        "offset": "-8:00",
        "seconds": "-28800",
        "hours": "-8",
        "default": "0"
      },
      "95": {
        "timezone_id": "95",
        "name": "America/Dawson_Creek",
        "name_formatted": "(UTC -07:00) America/Dawson Creek",
        "offset": "-7:00",
        "seconds": "-25200",
        "hours": "-7",
        "default": "0"
      },
      "96": {
        "timezone_id": "96",
        "name": "America/Denver",
        "name_formatted": "(UTC -07:00) America/Denver",
        "offset": "-7:00",
        "seconds": "-25200",
        "hours": "-7",
        "default": "0"
      },
      "97": {
        "timezone_id": "97",
        "name": "America/Detroit",
        "name_formatted": "(UTC -05:00) America/Detroit",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "98": {
        "timezone_id": "98",
        "name": "America/Dominica",
        "name_formatted": "(UTC -04:00) America/Dominica",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "99": {
        "timezone_id": "99",
        "name": "America/Edmonton",
        "name_formatted": "(UTC -07:00) America/Edmonton",
        "offset": "-7:00",
        "seconds": "-25200",
        "hours": "-7",
        "default": "0"
      },
      "100": {
        "timezone_id": "100",
        "name": "America/Eirunepe",
        "name_formatted": "(UTC -04:00) America/Eirunepe",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "101": {
        "timezone_id": "101",
        "name": "America/El_Salvador",
        "name_formatted": "(UTC -06:00) America/El Salvador",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "102": {
        "timezone_id": "102",
        "name": "America/Fortaleza",
        "name_formatted": "(UTC -03:00) America/Fortaleza",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "103": {
        "timezone_id": "103",
        "name": "America/Glace_Bay",
        "name_formatted": "(UTC -04:00) America/Glace Bay",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "104": {
        "timezone_id": "104",
        "name": "America/Godthab",
        "name_formatted": "(UTC -03:00) America/Godthab",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "105": {
        "timezone_id": "105",
        "name": "America/Goose_Bay",
        "name_formatted": "(UTC -04:00) America/Goose Bay",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "106": {
        "timezone_id": "106",
        "name": "America/Grand_Turk",
        "name_formatted": "(UTC -05:00) America/Grand Turk",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "107": {
        "timezone_id": "107",
        "name": "America/Grenada",
        "name_formatted": "(UTC -04:00) America/Grenada",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "108": {
        "timezone_id": "108",
        "name": "America/Guadeloupe",
        "name_formatted": "(UTC -04:00) America/Guadeloupe",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "109": {
        "timezone_id": "109",
        "name": "America/Guatemala",
        "name_formatted": "(UTC -06:00) America/Guatemala",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "110": {
        "timezone_id": "110",
        "name": "America/Guayaquil",
        "name_formatted": "(UTC -05:00) America/Guayaquil",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "111": {
        "timezone_id": "111",
        "name": "America/Guyana",
        "name_formatted": "(UTC -04:00) America/Guyana",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "112": {
        "timezone_id": "112",
        "name": "America/Halifax",
        "name_formatted": "(UTC -04:00) America/Halifax",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "113": {
        "timezone_id": "113",
        "name": "America/Havana",
        "name_formatted": "(UTC -05:00) America/Havana",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "114": {
        "timezone_id": "114",
        "name": "America/Hermosillo",
        "name_formatted": "(UTC -07:00) America/Hermosillo",
        "offset": "-7:00",
        "seconds": "-25200",
        "hours": "-7",
        "default": "0"
      },
      "115": {
        "timezone_id": "115",
        "name": "America/Indiana/Indianapolis",
        "name_formatted": "(UTC -05:00) America/Indiana/Indianapolis",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "116": {
        "timezone_id": "116",
        "name": "America/Indiana/Knox",
        "name_formatted": "(UTC -06:00) America/Indiana/Knox",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "117": {
        "timezone_id": "117",
        "name": "America/Indiana/Marengo",
        "name_formatted": "(UTC -05:00) America/Indiana/Marengo",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "118": {
        "timezone_id": "118",
        "name": "America/Indiana/Petersburg",
        "name_formatted": "(UTC -05:00) America/Indiana/Petersburg",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "119": {
        "timezone_id": "119",
        "name": "America/Indiana/Tell_City",
        "name_formatted": "(UTC -06:00) America/Indiana/Tell City",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "120": {
        "timezone_id": "120",
        "name": "America/Indiana/Vevay",
        "name_formatted": "(UTC -05:00) America/Indiana/Vevay",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "121": {
        "timezone_id": "121",
        "name": "America/Indiana/Vincennes",
        "name_formatted": "(UTC -05:00) America/Indiana/Vincennes",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "122": {
        "timezone_id": "122",
        "name": "America/Indiana/Winamac",
        "name_formatted": "(UTC -05:00) America/Indiana/Winamac",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "123": {
        "timezone_id": "123",
        "name": "America/Inuvik",
        "name_formatted": "(UTC -07:00) America/Inuvik",
        "offset": "-7:00",
        "seconds": "-25200",
        "hours": "-7",
        "default": "0"
      },
      "124": {
        "timezone_id": "124",
        "name": "America/Iqaluit",
        "name_formatted": "(UTC -05:00) America/Iqaluit",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "125": {
        "timezone_id": "125",
        "name": "America/Jamaica",
        "name_formatted": "(UTC -05:00) America/Jamaica",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "126": {
        "timezone_id": "126",
        "name": "America/Juneau",
        "name_formatted": "(UTC -09:00) America/Juneau",
        "offset": "-9:00",
        "seconds": "-32400",
        "hours": "-9",
        "default": "0"
      },
      "127": {
        "timezone_id": "127",
        "name": "America/Kentucky/Louisville",
        "name_formatted": "(UTC -05:00) America/Kentucky/Louisville",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "128": {
        "timezone_id": "128",
        "name": "America/Kentucky/Monticello",
        "name_formatted": "(UTC -05:00) America/Kentucky/Monticello",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "129": {
        "timezone_id": "129",
        "name": "America/Kralendijk",
        "name_formatted": "(UTC -04:00) America/Kralendijk",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "130": {
        "timezone_id": "130",
        "name": "America/La_Paz",
        "name_formatted": "(UTC -04:00) America/La Paz",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "131": {
        "timezone_id": "131",
        "name": "America/Lima",
        "name_formatted": "(UTC -05:00) America/Lima",
        "offset": "-5:00",
        "seconds": "-18000",
        "hours": "-5",
        "default": "0"
      },
      "132": {
        "timezone_id": "132",
        "name": "America/Los_Angeles",
        "name_formatted": "(UTC -08:00) America/Los Angeles",
        "offset": "-8:00",
        "seconds": "-28800",
        "hours": "-8",
        "default": "0"
      },
      "133": {
        "timezone_id": "133",
        "name": "America/Lower_Princes",
        "name_formatted": "(UTC -04:00) America/Lower Princes",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      },
      "134": {
        "timezone_id": "134",
        "name": "America/Maceio",
        "name_formatted": "(UTC -03:00) America/Maceio",
        "offset": "-3:00",
        "seconds": "-10800",
        "hours": "-3",
        "default": "0"
      },
      "135": {
        "timezone_id": "135",
        "name": "America/Managua",
        "name_formatted": "(UTC -06:00) America/Managua",
        "offset": "-6:00",
        "seconds": "-21600",
        "hours": "-6",
        "default": "0"
      },
      "136": {
        "timezone_id": "136",
        "name": "America/Manaus",
        "name_formatted": "(UTC -04:00) America/Manaus",
        "offset": "-4:00",
        "seconds": "-14400",
        "hours": "-4",
        "default": "0"
      }
  ...
     }
  },
  "token": "xxxxxxx"
}
Suggest Edits

api.methods

 

Returns a list of all methods supported by the Humanitu API and their support variables and variable types.

SUPPORTED METHODS:

GET

Parameters
Type
Description

Parameters aren't required to fetch this method

DOCUMENTATION

GET
Retrieves a list of all methods supported by the Humanity API and their support variables and variable types.
Level 5 is required (all users can fetch this module)

--

Example Request:

  {
       "module":"api.methods",
       "method":"GET",
       "request":{
 
       }
    }

Example Response:

 {
       "status":1,
          "data":{
             "api":{
                "methods":{
                   "description":"Returns a list of all methods supported by the
                    Humanity API and their support variables and variable types.",
                   "GET":{
                      "perms":{
                         "module":"",
                         "level":""
                      },
                      "variables":{
                         "accepted":[
 
                         ]
                      }
                   }
                },
         "config":{
            "description":"Returns all all config properties used in 
             Humanity for date, time, display, and error codes.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":""
               },
               "variables":{
                  "accepted":{
                     "all":"int"
                  }
               }
            }
         },
         "vtoken":{
            "description":"Verifies a Humanity Token",
            "GET":{
               "perms":{
                  "module":"",
                  "level":""
               },
               "variables":{
                  "required":[
                     "token"
                  ],
                  "accepted":[
 
                  ]
               }
            }
         }
      },
 
     // ...
 
      "messaging":{
         "messages":{
            "description":"Retrieve\/Delete\/Add to the business message wall.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "mode":[
                        "to",
                        "from"
                     ]
                  }
               }
            }
         },
         "message":{
            "description":"Retrieve\/Delete\/Send individual messages.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "0":"subject",
                     "1":"message",
                     "to":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "read":[
                        "1",
                        "0"
                     ]
                  }
               }
            }
         },
         "shift":{
            "description":"Send a message to all staff on a shift.",
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "0":"subject",
                     "1":"message",
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "wall":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
                     "post"
                  ],
                  "accepted":{
                     "id":"int",
                     "0":"title",
                     "sticky":[
                        "0"
                     ]
                  }
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int",
                     "delete":[
                        "message",
                        "comment"
                     ]
                  },
                  "accepted":[
 
                  ]
               }
            }
         }
      },
      "reports":{
         "schedule":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date",
                     "type":[
                        "schedule_summary",
                        "shift_confirmed",
                        "crib_sheet",
                        "shift_exchanges",
                        "open_shifts",
                        "position_summary"
                     ]
                  },
                  "accepted":{
                     "location":"int",
                     "schedule":"int",
                     "0":"employee",
                     "skill":"int",
                     "with_statuses":"int",
                     "options":"int"
                  }
               }
            }
         },
         "budget":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "timesheets":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date",
                     "location":"int",
                     "schedule":"int",
                     "0":"employee",
                     "skill":"int",
                     "type":[
                        "timesheets_summary",
                        "timesheets_attendance"
                     ]
                  },
                  "accepted":{
                     "deductbreaks":"int"
                  }
               }
            }
         },
         "employee":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date",
                     "location":"int",
                     "schedule":"int",
                     "0":"employee",
                     "skill":"int",
                     "type":[
                        "attendance",
                        "vacations",
                        "availability",
                        "unavailability"
                     ]
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "custom":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "0":"fields",
                     "start_date":"date",
                     "end_date":"date",
                     "type":[
                        "timesheets",
                        "confirmedtimesheets",
                        "shifts",
                        "confirmedshifts"
                     ]
                  },
                  "accepted":{
                     "schedule":"int",
                     "0":"employee",
                     "skill":"int",
                     "deduct_breaks":[
                        0,
                        1
                     ]
                  }
               }
            }
         }
      },
      "payroll":{
         "report":{
            "description":"Run Payroll Specific Reports on schedule \/ time sheet data.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "type":[
                        "scheduledhours",
                        "confirmedhours",
                        "timesheets"
                     ]
                  },
                  "accepted":{
                     "start_date":"date",
                     "end_date":"date",
                     "location":"int",
                     "schedule":"int",
                     "0":"employee",
                     "skill":"int",
                     "deduct_breaks":[
                        "0",
                        "1"
                     ],
                     "group_results":[
                        "0",
                        "1",
                        "2"
                     ],
                     "show_empty":[
                        "0",
                        "1"
                     ]
                  }
               }
            }
         },
         "ratecards":{
            "description":"Returns a list of payroll rate cards.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":[
 
                  ]
               }
            }
         },
         "ratecard":{
            "description":"Returns a payroll rate card.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":[
                     "name"
                  ],
                  "accepted":{
                     "stack_overtime":[
                        "0",
                        "1"
                     ]
                  }
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "def":[
                        "0",
                        "1"
                     ]
                  }
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "0":"name",
                     "def":[
                        "0",
                        "1"
                     ],
                     "1":"rates",
                     "2":"overtime",
                     "day_limit":[
                        "CREATE",
                        "UPDATE",
                        "DELETE"
                     ],
                     "day_limit_id":"int",
                     "day_limit_minimum":"int",
                     "day_limit_rate":"int",
                     "stack_overtime":[
                        "0",
                        "1"
                     ]
                  }
               }
            }
         }
      },
      "schedule":{
         "schedules":{
            "description":"Returns a list of all schedules.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "perms":[
                        "1"
                     ]
                  }
               }
            }
         },
         "schedule":{
            "description":"Management of individual schedules.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":[
                     "name"
                  ],
                  "accepted":{
                     "active":[
                        "1",
                        "-1"
                     ],
                     "start_time":"time",
                     "end_time":"time",
                     "color":"int",
                     "location":"int"
                  }
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "active":[
                        "1",
                        "-1"
                     ],
                     "0":"name",
                     "start_time":"time",
                     "end_time":"time",
                     "color":"int",
                     "location":"int"
                  }
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "shifts":{
            "description":"Returns a list of shifts.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "start_date":"date",
                     "end_date":"date",
                     "mode":[
                        "overview",
                        "location",
                        "schedule",
                        "incomplete",
                        "employees",
                        "employee",
                        "open",
                        "openapproval",
                        "confirm",
                        "onnow"
                     ],
                     "0":"schedule",
                     "location":"int",
                     "1":"employees",
                     "detailed":"int",
                     "budget":[
                        "0",
                        "1"
                     ]
                  }
               }
            }
         },
         "shift":{
            "description":"Management of individual shifts.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "detailed":"int"
                  }
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "start_time":"time",
                     "end_time":"time",
                     "start_date":"date",
                     "end_date":"date"
                  },
                  "accepted":{
                     "schedule":"int",
                     "type":"int",
                     "needed":"int",
                     "0":"notes",
                     "1":"title",
                     "2":"confirmed",
                     "location":"int"
                  }
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "0":"schedule",
                     "type":"int",
                     "needed":"int",
                     "start_time":"time",
                     "end_time":"time",
                     "start_date":"date",
                     "end_date":"date",
                     "1":"notes",
                     "2":"title",
                     "confirmed":"int",
                     "3":"add",
                     "remove":"int",
                     "4":"detailed",
                     "5":"location",
                     "force":[
                        "0",
                        "1"
                     ],
                     "repeat":"int",
                     "repeat_until":"date",
                     "repeat_staff":[
                        "",
                        "0",
                        "1",
                        "2"
                     ],
                     "update_series":[
                        "1",
                        "2",
                        "3"
                     ],
                     "update_staff":[
                        "0",
                        "1"
                     ],
                     "update_time":[
                        "0",
                        "1"
                     ],
                     "update_type":[
                        "0",
                        "1"
                     ],
                     "update_notes":[
                        "0",
                        "1"
                     ],
                     "update_schedule":[
                        "0",
                        "1"
                     ],
                     "copy_to":"date",
                     "restore":[
                        "0",
                        "1"
                     ]
                  }
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "rule":[
                        "all",
                        "following"
                     ]
                  }
               }
            }
         },
         "shiftapprove":{
            "description":"Management of individual shifts.",
            "GET":{
               "perms":{
                  "module":"shift",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"shift",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  }
               }
            },
            "UPDATE":{
               "variables":{
                  "accepted":{
                     "employee":"int",
                     "absent":[
                        "0",
                        "1"
                     ],
                     "start_time":"time",
                     "end_time":"time"
                  },
                  "required":{
                     "id":"int"
                  }
               },
               "perms":{
                  "module":"shift",
                  "level":3
               }
            },
            "DELETE":{
               "perms":{
                  "module":"shift",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "trades":{
            "description":"Returns a list of trades.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "mode":[
                        "manage",
                        "requested"
                     ]
                  }
               }
            }
         },
         "trade":{
            "description":"Management of individual trades.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "shift":"int",
                     "0":"tradewith",
                     "1":"reason"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "trade":"int",
                     "action":[
                        "activate",
                        "deactivate",
                        "cancel",
                        "accept",
                        "reject"
                     ]
                  },
                  "accepted":{
                     "user":"int"
                  }
               }
            }
         },
         "vacations":{
            "description":"Returns a list of vacations.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "start_date":"date",
                     "end_date":"date",
                     "mode":[
                        "manage",
                        "requested",
                        "upcoming"
                     ]
                  }
               }
            }
         },
         "vacation":{
            "description":"Individual vacation management.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date"
                  },
                  "accepted":{
                     "employee":"int",
                     "0":"comments",
                     "start_time":"time",
                     "end_time":"time",
                     "1":"notes",
                     "2":"status"
                  }
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "start_date":"date",
                     "end_date":"date",
                     "start_time":"time",
                     "end_time":"time",
                     "0":"comments",
                     "1":"notes",
                     "status":[
                        "0",
                        "1",
                        "-1",
                        "-2"
                     ]
                  }
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "conflicts":{
            "description":"Returns a list of schedule conficts.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "start_date":"date",
                     "end_date":"date",
                     "0":"mode",
                     "1":"schedule"
                  }
               }
            }
         },
         "copy":{
            "description":"Copy a schedule between two timelines",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "from_start":"date",
                     "from_end":"date",
                     "to_start":"date",
                     "to_end":"date"
                  },
                  "accepted":{
                     "0":"schedule",
                     "1":"mode",
                     "with_staff":[
                        "0",
                        "1",
                        "2"
                     ]
                  }
               }
            }
         },
         "clear":{
            "description":"Clear the Schedule",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "start_date":"date",
                     "end_date":"date",
                     "schedule":"int",
                     "0":"shifts",
                     "restore":[
                        "0",
                        "1"
                     ],
                     "restoredate":"timestamp"
                  }
               }
            }
         },
         "restore":{
            "description":"View History of schedule clears",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "start_date":"date",
                     "end_date":"date",
                     "0":"schedule",
                     "detailed":[
                        "0",
                        "1"
                     ],
                     "timestamp":"timestamp"
                  }
               }
            }
         },
         "wizard":{
            "description":"Auto-Generated a schedule using the wizard schedule wizard.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":4
               },
               "variables":{
                  "required":{
                     "from_start":"date",
                     "from_end":"date",
                     "to_start":"date",
                     "to_end":"date"
                  },
                  "accepted":{
                     "0":"schedule",
                     "1":"mode",
                     "rule":[
                        "1",
                        "2",
                        "3"
                     ],
                     "clear":[
                        0,
                        1
                     ],
                     "force":[
                        0,
                        1
                     ],
                     "2":"shifts"
                  }
               }
            }
         },
         "fill":{
            "description":"Fill Shifts using the Schedule wizard.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":4
               },
               "variables":{
                  "required":[
                     "shifts"
                  ],
                  "accepted":{
                     "fill_count":"int",
                     "fill_slots":[
                        0,
                        1
                     ]
                  }
               }
            }
         },
         "publish":{
            "description":"Publish Shifts",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
                     "shifts"
                  ],
                  "accepted":{
                     "schedule":"int",
                     "notify":[
                        "",
                        "0",
                        "1",
                        "2"
                     ],
                     "0":"message",
                     "start_date":"date",
                     "end_date":"date"
                  }
               }
            }
         },
         "requests":{
            "description":"Returns a list of requests.",
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int",
                     "type":[
                        "openshifts"
                     ],
                     "mode":[
                        "approve",
                        "reject"
                     ]
                  },
                  "accepted":[
 
                  ]
               }
            }
         }
      },
      "timeclock":{
         "timeclocks":{
            "description":"Returns a list of all Time Clocks.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "start_date":"date",
                     "end_date":"date",
                     "schedule":"int",
                     "employee":"int",
                     "status":[
                        "approved",
                        "unapproved"
                     ]
                  }
               }
            }
         },
         "timeclock":{
            "description":"Management of individual Clock Times.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "schedule":"int",
                     "employee":"int",
                     "start_time":"time"
                  },
                  "accepted":{
                     "end_date":"date",
                     "end_time":"time",
                     "0":"notes"
                  }
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "start_date":"date",
                     "end_date":"date",
                     "schedule":"int",
                     "employee":"int",
                     "start_time":"time",
                     "end_time":"time",
                     "0":"notes",
                     "approved":[
                        "0",
                        "1"
                     ]
                  }
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":4
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "clockin":{
            "description":"Clock In Employee (Default: Authenticated User)",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "employee":"int"
                  }
               }
            }
         },
         "clockout":{
            "description":"Clock Out Employee (Default: Authenticated User)",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "schedule":"int",
                     "0":"notes",
                     "employee":"int"
                  }
               }
            }
         },
         "status":{
            "description":"Get Clock Status of Employee (Default: Authenticated User).
             Returns 'in' or 'out'",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "employee":"int",
                     "details":[
                        "1"
                     ]
                  }
               }
            }
         },
         "manage":{
            "description":"Manage individual clock time or csv id's of clock times",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "0":"id",
                     "action":[
                        "approve",
                        "unapprove",
                        "reject",
                        "delete"
                     ]
                  },
                  "accepted":[
                     "comment"
                  ]
               }
            }
         },
         "screenshot":{
            "description":"Upload a screenshot for authenticated user",
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
                     "filedata"
                  ],
                  "accepted":{
                     "width":"int",
                     "height":"int",
                     "filesize":"int",
                     "timeclock":"int",
                     "0":"ip"
                  }
               }
            }
         }
      },
      "staff":{
         "login":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":""
               },
               "variables":{
                  "required":[
                     "username",
                     "password"
                  ],
                  "accepted":{
                     "remember":[
                        "1"
                     ]
                  }
               }
            }
         },
         "logout":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ]
               }
            }
         },
         "employees":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":[
                     "schedule"
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":[
 
                  ]
               }
            }
         },
         "employee":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "id":"int",
                     "0":"eid"
                  }
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":[
                     "name"
                  ],
                  "accepted":{
                     "0":"eid",
                     "status":[
                        "0",
                        "1",
                        "-1",
                        "-2"
                     ],
                     "group":[
                        "2",
                        "3",
                        "4",
                        "5"
                     ],
                     "email":"email",
                     "1":"nick_name",
                     "birth_day":"int",
                     "birth_month":"int",
                     "cell_phone":"phone",
                     "wage":"int",
                     "home_phone":"phone",
                     "2":"address",
                     "3":"city",
                     "4":"state",
                     "5":"zip",
                     "6":"notes",
                     "smsgateway":"int",
                     "password":[
                        "min",
                        6
                     ],
                     "username":[
                        "min",
                        3
                     ],
                     "send_activation":[
                        "1"
                     ],
                     "7":"facebook",
                     "8":"google"
                  }
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "0":"eid",
                     "status":[
                        "0",
                        "1",
                        "-1",
                        "-2"
                     ],
                     "group":[
                        "2",
                        "3",
                        "4",
                        "5"
                     ],
                     "1":"name",
                     "email":"email",
                     "2":"nick_name",
                     "birth_day":"int",
                     "birth_month":"int",
                     "cell_phone":"phone",
                     "wage":"int",
                     "home_phone":"phone",
                     "3":"address",
                     "4":"city",
                     "5":"state",
                     "6":"zip",
                     "7":"notes",
                     "smsgateway":"int",
                     "password":[
                        "min",
                        6
                     ],
                     "username":[
                        "min",
                        3
                     ],
                     "addschedule":"int",
                     "removeschedule":"int",
                     "addskill":"int",
                     "removeskill":"int",
                     "send_activation":[
                        "1"
                     ],
                     "8":"language"
                  }
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":3
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "skills":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":[
 
                  ]
               }
            }
         },
         "skill":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
                     "name"
                  ],
                  "accepted":[
 
                  ]
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int",
                     "0":"name"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "ping":{
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "to":"int",
                     "0":"message"
                  },
                  "accepted":[
 
                  ]
               }
            }
         }
      },
      "location":{
         "locations":{
            "description":"Returns a list of Locations.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":[
 
                  ]
               }
            }
         },
         "location":{
            "description":"Management of individual Location.",
            "GET":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "0":"name",
                     "type":[
                        "1",
                        "2"
                     ]
                  },
                  "accepted":[
                     "country",
                     "address",
                     "lat",
                     "lon"
                  ]
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":5
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            }
         }
      },
      "training":{
         "progress":{
            "description":"Returns a list of users and their completion
             status of training modules",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"5"
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "user_id":"int"
                  }
               }
            }
         },
         "sections":{
            "description":"Returns a list of all training sections 
            (parent group categories)",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"5"
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":[
 
                  ]
               }
            }
         },
         "section":{
            "description":"Manage an individual training section (parent group category)",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"5"
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "id":"int",
                     "0":"title"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":[
                     "title"
                  ],
                  "accepted":[
 
                  ]
               }
            }
         },
         "modules":{
            "description":"Returns a list of all training modules",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"5"
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "section":"int",
                     "detailed":[
                        "0",
                        "1"
                     ]
                  }
               }
            }
         },
         "module":{
            "description":"Manage an individual training module",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"5"
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "store":"int"
                  }
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":{
                     "0":"title",
                     "section":"int",
                     "child_edit":"int",
                     "tutorial":"int",
                     "mintime":"int",
                     "1":"contents",
                     "2":"video",
                     "addgroup":"int",
                     "removegroup":"int",
                     "add_group":"int",
                     "remove_group":"int",
                     "add_skill":"int",
                     "remove_skill":"int",
                     "add_user_training":"int",
                     "remove_user_training":"int",
                     "addlocation":"int",
                     "removelocation":"int",
                     "reset":"int"
                  }
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":[
                     "title"
                  ],
                  "accepted":{
                     "section":"int",
                     "tutorial":"int",
                     "mintime":"int",
                     "0":"contents",
                     "1":"video"
                  }
               }
            }
         },
         "complete":{
            "description":"Mark this training module as complete by authenticated user",
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":"5"
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            }
         }
      },
      "group":{
         "accounts":{
            "description":"Group Account Management - Returns a list of all 
             accounts in the Group",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "detailed":[
                        "0",
                        "1"
                     ]
                  }
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":[
                     "accounts"
                  ],
                  "accepted":{
                     "clone_positions":[
                        "0",
                        "1"
                     ],
                     "clone_settings":[
                        "0",
                        "1"
                     ],
                     "clone_training":[
                        "0",
                        "1"
                     ]
                  }
               }
            }
         },
         "account":{
            "description":"Group Account Management - Manage individual group account",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
                     "name"
                  ]
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":{
                     "name":[
                        "min",
                        3
                     ],
                     "administrator":[
                        "min",
                        3
                     ],
                     "password":[
                        "min",
                        6
                     ],
                     "email":"email",
                     "domain":[
                        "min",
                        3
                     ],
                     "clone":"int",
                     "clone_positions":[
                        "0",
                        "1"
                     ],
                     "clone_settings":[
                        "0",
                        "1"
                     ],
                     "clone_training":[
                        "0",
                        "1"
                     ]
                  }
               }
            }
         }
      },
      "sales":{
         "budgets":{
            "description":"Returns all budget settings for a given time period",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "budget":{
            "description":"Manage individual budget setting",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date",
                     "location":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "UPDATE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date",
                     "location":"int"
                  },
                  "accepted":{
                     "hours":"int",
                     "dollars":"int"
                  }
               }
            },
            "DELETE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date",
                     "location":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":"3"
               },
               "variables":{
                  "required":{
                     "start_date":"date",
                     "end_date":"date",
                     "location":"int"
                  },
                  "accepted":{
                     "hours":"int",
                     "dollars":"int"
                  }
               }
            }
         }
      },
      "language":{
         "suggestion":{
            "description":"Gets or creates one new suggestion",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"",
                  "private":1
               },
               "variables":{
                  "required":{
                     "suggestion_id":"int"
                  },
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5,
                  "private":1
               },
               "variables":{
                  "required":{
                     "original_id":"int",
                     "0":"language_id",
                     "1":"suggestion"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "suggestions":{
            "description":"Gets one or more suggestions based on original id passed",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"",
                  "private":1
               },
               "variables":{
                  "required":[
                     "original_id"
                  ],
                  "accepted":[
                     "code"
                  ]
               }
            }
         },
         "vote":{
            "description":"Vote module gets,creates or deletes votes of specific user.
            (mode can be: vote_up or vote_down)",
            "GET":{
               "perms":{
                  "module":"",
                  "level":"",
                  "private":1
               },
               "variables":{
                  "required":[
                     "lang_suggestion_id"
                  ],
                  "accepted":[
 
                  ]
               }
            },
            "CREATE":{
               "perms":{
                  "module":"",
                  "level":5,
                  "private":1
               },
               "variables":{
                  "required":{
                     "lang_suggestion_id":"int",
                     "0":"mode"
                  },
                  "accepted":[
 
                  ]
               }
            }
         },
         "user":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":5,
                  "private":1
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":[
 
                  ]
               }
            }
         },
         "originals":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":"",
                  "private":1
               },
               "variables":{
                  "required":[
                     "code"
                  ],
                  "accepted":[
                     "filters",
                     "orig_id"
                  ]
               }
            }
         },
         "filters":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":"",
                  "private":1
               },
               "variables":{
                  "required":[
 
                  ],
                  "accepted":[
 
                  ]
               }
            }
         },
         "search":{
            "GET":{
               "perms":{
                  "module":"",
                  "level":"",
                  "private":1
               },
               "variables":{
                  "required":[
                     "query",
                     "code"
                  ],
                  "accepted":[
 
                  ]
               }
            }
         }
      }
          },
          "token":null
 }
Suggest Edits

admin.backups

 

Returns a list of all Backups uploaded into Humanity.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

DOCUMENTATION

GET
Retrieves a list of all Backups uploaded into Humanity.
Display limit is 50.
Level 5 is required (all users can fetch this module)

--

Example Request:

      {
         "module":"admin.backups",
         "method":"GET",
         "request":{
 
         }
      }

Example Response:

      {
         "status":1,
         "data":[
            {
               "id":"445",
               "name":"",
               "description":"",
               "filename":"backup",
               "date":"1339674939",
               "file_size":"128",
               "num_downloads":"0",
               "filetype":"mime",
               "extension":"backup",
               "url":"http://www.humanity.com/api/file/445.5dsafd0e28418",
               "secureurl":"http:\/\/www.humanity.com\/app\/admin
                \/file.php?fid=NDQ43g1"
            }
         ],
         "token":"xxxxxxx"
      }
Suggest Edits

admin.backup

 

Allows for retrieving and setting details on any given backup file.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Backup file id

DELETE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

File id

CREATE

Parameters
Type
Decription

token (required)

Valid token

filename (required)

varchar

File name

filedata (required)

varchar

File data

filelength (required)

integer

File length

mimetype (Required)

varchar

Describes the type of data which is being sent

name (accepted)

varchar

Name

description (accepted)

varchar

Description

DOCUMENTATION

GET
Retrieving details of any given backup file.
Level 5 is required (all users can fetch this module)

--

Example Request:

    {
       "module":"admin.backup",
       "method":"GET",
       "request":{
              "id":"445"
       }
    }

Example Response:

    {
       "status":1,
       "data":{
          "id":"445",
          "name":"",
          "description":"",
          "filename":"backup",
          "date":"1339674939",
          "file_size":"128",
          "num_downloads":"0",
          "filetype":"mime",
          "extension":"backup",
          "url":"http:\/\/www.humanity.com\/api\/file\/445.53718",
          "secureurl":"http:\/\/www.humanity.com\/app\/admin\/file.php?fid=NDQ1"
       },
       "token":"xxxxxxx"
    }

CREATE
Creates new backup file and backup file details.
Level 5 is required (all users can fetch this module)

--

Example Request:

    {
       "module":"admin.backup",
       "method":"CREATE",
       "request":{
          "filename":"File",
          "filelength":"128",
          "mimetype":"type",
          "filedata":"data"
       }
    }

Example Response:

    {
       "status":1,
       "data":"",
       "token":"xxxxxxx"
    }

DELETE
Deletes any given backup file and backup file details.
Level 5 is required (all users can fetch this module)

--

Example Request:

   {
       "module":"admin.backup",
       "method":"DELETE",
       "request":{
          "id":"545"
       }
    }

Example Response:

    {
       "status":1,
       "data":"",
       "token":"xxxxxxx"
    }
Suggest Edits

admin.business

 

Retrieves business details

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

valid token

DOCUMENTATION

GET
Retrieves a business details.
Level 5 is required (all users can fetch this module)

--

Example Request:

     {
        "module":"admin.business",
        "method":"GET",
        "request":{
 
        }
     }

Example Response:

 {  
    "status":1,
    "data":{  
        "id":"553",
        "franchise":"553",
        "status":"1",
        "agent":"43232423",
        "hunter":null,
        "level":"1",
        "price":"1",
        "timezone":"-05:00,1",
        "created":"1265595316",
        "deleted":"0",
        "created_day":"300",
        "name":"Test",
        "domain":"domain",
        "nemployees":"74",
        "logo":"0",
        "address":"Address 15",
        "country":"227",
        "state":"AZ",
        "phone_number":"888-432-1233",
        "fax_number":"281-321-1231",
        "user":"12313",
        "start_day":"1",
        "end_day":"7",
        "start_time":"0",
        "end_time":"0",
        "24hr":"0",
        "overtime":"40",
        "industry":"6",
        "pref_admin_past_edit":"0",
        "pref_book_days_off":"1",
        "pref_book_days_off_adv":"30",
        "pref_book_days_off_max":"10",
        "pref_confirm_trade_before":"1",
        "pref_confirm_trade_after":"1",
        "pref_sms":"1",
        "pref_email":"1",
        "pref_email_force":"0",
        "pref_pm":"1",
        "pref_visible_staff":"1",
        "pref_visible_staff_details":"1",
        "pref_visible_coworkers":"1",
        "pref_trade_shifts":"1",
        "pref_coworkers_contacts":"0",
        "pref_future_avail":"1",
        "pref_weekly_avail":"1",
        "pref_visible_overview":"0",
        "pref_visible_own":"1",
        "pref_timeout":"0",
        "pref_message_wall_on":"1",
        "pref_message_wall_emp":"0",
        "pref_message_wall_comments":"1",
        "pref_message_wall_uploads":"0",
        "pref_on_now":"0",
        "pref_shift_confirm":"1",
        "pref_shift_drop":"0",
        "pref_shift_autoconfirm":"0",
        "pref_timeclock":"1",
        "pref_tc_terminal_lock":"0",
        "pref_tc_round_to":"-1",
        "pref_tc_round_to_in":"-1",
        "pref_tc_round_to_out":"-1",
        "pref_tc_clock_in_timeframe":"-1",
        "pref_tc_autoclockout":"0",
        "pref_tc_webcam":"0",
        "pref_tc_empl_import":"0",
        "pref_tc_empl_addtime":"1",
        "pref_tc_require_pos":"0",
        "pref_tc_require_notes":"0",
        "pref_24hr":"0",
        "pref_date":"M j, Y",
        "pref_startday":"1",
        "pref_currency":"1",
        "pref_viewadvance":"-1",
        "pref_mintimebshifts":"0",
        "pref_draft":"1",
        "pref_reports":"1",
        "pref_edit_profile":"1",
        "pref_login_google":"1",
        "pref_login_facebook":"1",
        "pref_login_splogo":"1",
        "pref_login_twitter":"1",
        "pref_scosting":"3",
        "pref_training":"1",
        "settings":"{\"payroll\":{\"company_code\":\"5\",\"batch_id\":\"9\", 
     \"fixed_batch_id\":1,\"regular_hour_code\":\"R\",\"special_hour_code\":\"08 
    \",\"overtime_hour_code\":\"02\",\"company_name\":\"Test\",\"company_created_time 
    \":\"1329996350\",\"export_provider\":\"5\"},\"login\":{\"ssl\":null}}",
        "notes":"",
        "created_by":"0",
        "new_employee_note":"",
        "personal_welcome_sent":"1",
        "ical":"asdmi2is929sda9dsa0dsad9sad0as0das0",
        "trial":"90",
        "nonprofit":"0",
        "paid_until":"0",
        "groupbilling":"1",
        "setup":"0",
        "aw_keyword":"",
        "affiliate":"",
        "saml_enabled":"1",
        "saml_allow_login":"0",
        "saml_login_url":"https:\/\/app.onelogin.com\/saml\/signon\/35439",
        "saml_logout_url":"http:\/\/www.humanity.com?saml_logout=true",
        "saml_certificate":"-----CERTIFICAT-----",
        "saml_fingerprint":"xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx",
        "timezone_id":"80",
        "language":"en_US",
        "daily_overtime":"9",
        "pref_min_disregard":"0",
        "max_days_row":"4",
        "pref_same_day_trades":"1",
        "pref_tc_screenshot":"0",
        "group_platform_settings":"{\"Scheduler\":\"4\",\"Supervisor\":\"3 
    \",\"color_customization\":\"1\",\"color_nav\":\"#0A0A0A\",\"color_nav_text\":\"#ffffff 
    \",\"color_nav_left\":\"#F7F7F7\",\"color_nav_left_text\":\"#3F3F3F\",\"color_nav_left_act 
    \":\"#D6D6D9\",\"color_nav_left_act_text\":\"#3F3F3F\",\"color_links\":\"#99131E 
    \",\"color_headings\":\"#D12F19\",\"master_logo\":\"1\",\"disallow_logo\":\"1\",\"Manager 
    \":\"2\",\"Employee\":\"5\"}"
        },
        "token":"xxxxxxx"
}
Suggest Edits

admin.details

 

Returns the details for the organization of the currently logged in user.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

token (required)

UPDATE

Parameters
Type
Description

token (Required)

Valid token

name (accepted)

varchar

Name

address (accepted)

varchar

Address

phone (accepted)

phone

Phone

fax (accepted)

phone

Fax

DOCUMENTATION

GET
Returns the details for the organization of the currently logged in user.
Level 5 is required (all users can fetch this module)

--

Example Request:

    {
       "module":"admin.details",
       "method":"GET",
       "request":{
 
       }
   }

Example Response:

    {
       "status":1,
       "data":{
              "name":"Master",
              "address":"Belgrade, Serbia",
              "phone":"855-876-1176",
              "fax":"567-456-8765"
           },
       "token":"xxxxxxx"
    }

UPDATE
Updates the details for the organization of the currently logged in user.
Level 2 is required.

Example Request:

    {
       "module":"admin.details",
       "method":"UPDATE",
       "request":{
              "address":"Company address 1",
              "phone":"381-326-4214",
              "fax":"567-456-8765"
       }
    }

Example Response:

    {
       "status":1,
       "data":{
              "name":"Master",
              "address":"Company address 1",
              "phone":"381-326-4214",
              "fax":"567-456-8765"
       },
       "token":"xxxxxxx"
    }
Suggest Edits

admin.files

 

Returns a list of all files uploaded into Humanity.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

training (accepted)

integer

Training id

employee (accepted)

integer

Employee id

DOCUMENTATION

GET

Retrieves a list of all files uploaded into Humanity.
If training id is forwarded trough parameter "training" the module retrieves the Training Files.
If employee id is forwarded trough parameter "employee" the module retrieves Employee Files.
If no parameters are forwarded module retrieves Admin Files.
Display limit is 50.

Level 5 is required.

Example Request:

    {
       "module":"admin.files",
       "method":"GET",
       "request":{
 
       }
    }    

Example Response:

{
       "status":1,
       "data":[
          {
             "id":"444",
             "name":"",
             "description":"",
             "filename":"payroll_export.csv",
             "date":"1339516067",
             "file_size":"239",
             "num_downloads":"0",
             "filetype":"application\/octet-stream",
             "extension":"csv",
             "url":"http:\/\/www.humanity.com\/api\/file\/444.j4k32k32k",
             "secureurl":"http:\/\/www.humanity.com\/app\/admin\/file.php?fid=ggfd"
          }
       ],
       "token":"xxxxxxx"
    }
Suggest Edits

admin.file

 

Allows for retrieving and setting details on any given file.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

File id

content

enum (1, 0)

UPDATE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

File id

name (accepted)

varchar

Name

description (accepted)

varchar

Description

pref_employee_files

enum (1, 0)

positions (accepted)

varchar

Position assignments

Array of position ids (eg. "234345,545673,765270")

groups (accepted)

varchar

Group assignments

Array of group ids (eg. "2,5,6")

users (accepted)

varchar

User assignments

Array of user ids (eg. "927945,759206,3865478"

DELETE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

File id

homework (accepted)

varchar

Homework id

CREATE

token (required)

Valid token

filename (required)

varchar

File name

filedata (required)

varchar

File data

filelength (required)

varchar

File length

mimetype (required)

varchar

Mime type

name (accepted)

varchar

Name

description (accepted)

varchar

Description

training (accepted)

integer

Training id

employee (acepted)

integer

Employees id

positions (accepted)

varchar

Position assignments

Array of position ids (eg. "234345,545673,765270")

groups (accepted)

varchar

Group assignments

Array of group ids (eg. "2,5,6")

users (accepted)

varchar

User assignments

Array of user ids (eg. "927945,759206,3865478")

DOCUMENTATION

GET
Retrieving details of any given file.
Level 5 is required (all users can fetch this module)

--

Example Request:

    {
       "module":"admin.file",
       "method":"GET",
       "request":{
              "id":"159"
           }
    }

Example Response:

    {
       "status":1,
       "data":{
          "id":"159",
          "name":"",
          "description":"",
          "filename":"payroll_export.csv",
          "date":"1339516067",
          "file_size":"239",
          "num_downloads":"0",
          "filetype":"application\/octet-stream",
          "extension":"csv",
          "url":"http:\/\/www.humanity.com\/api\/file\/444.sadas334gfd",
          "secureurl":"http:\/\/www.dev.humanity.com\/app\/admin\/file.php?fid=ddff"
       },
       "token":"xxxxxxx"
    }

CREATE
Uploads and creates details for any given file.
Level 3 is required.

--

Example Request:

       {  
            "module":"admin.file",
            "method":"CREATE",
            "request":{  
                    "name":"name",
                    "description":"description",
                    "employee":"154",
                    "mimetype":"image/jpeg",
                    "data":"{//byte array}",
                    "filelength":"{//byte array length}",
                    "positions":"234345,545673,765270",
                    "groups":"2,5,6",
                    "users":"927945,759206,3865478"
              }
          }

Example Response:

    {
       "status":1,
       "data":{
              "id":"224",
              "name":"name",
              "description":"description",
              "filename":"payroll_export22.csv",
              "date":"1339516067",
              "file_size":"632",
              "num_downloads":"0",
              "filetype":"application\/octet-stream",
              "extension":"csv",
              "url":"http:\/\/www.humanity.com\/api\/file\/444.suiuh43fef",
              "secureurl":"http:\/\/www.humanity.com\/app\/admin\/file.php?fid=drtyu"
           },
           "token":"xxxxxxx"
    }

UPDATE
Updates details of any given file uploaded.
Level 5 is required (all users can fetch this module)

--

Example Request:

    {
       "module":"admin.file",
       "method":"UPDATE",
       "request":{
              "name":"second name",
              "description":"description",
              "training":"training",
              "employee":"154",
              "positions": "234345,545673,765270",
              "groups": "2,5,6",
              "users": "927945,759206,3865478"
       }
    }

Example Response:

    {
       "status":1,
       "data":{
              "id":"224",
              "name":"second name",
              "description":"description",
              "filename":"payroll_export22.csv",
              "date":"1339516067",
              "file_size":"632",
              "num_downloads":"0",
              "filetype":"application\/octet-stream",
              "extension":"csv",
              "url":"http:\/\/www.documentapi-s.dev.humanity.com\/api\/file\/444.suiuh43fef",
              "secureurl":"http:\/\/www.humanity.com\/app\/admin\/file.php?fid=drtyu"
           },
       "token":"xxxxxxx"
    }

--

DELETE
Deletes any given file and file details.
Level 3 is required.

--

Example Request:

    {
       "module":"admin.file",
       "method":"DELETE",
       "request":{
              "id":"224"
       }
    }

Example Response:


    {
       "status":1,
       "data":"",
       "token":"xxxxxxx"
    }
Suggest Edits

admin.group_perms

 

Retrieves business details

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

user (accepted)

integer

User id

UPDATE

Parameters
Type
Description

token (required)

Valid token

group_perms (required)

varchar

perm[0]: user id (integer) perm[1]: Can add accounts (integer/boolean)
//0(false): Can not add accounts
//1(true) : Can add accounts
perm[2]: Can write (integer/boolean)
//0(false): Can not write
//1(true) : Can write
perm[3]: Can read (integer/boolean)
//0(false): Can not read
//1(true) : Can read
perm[4]: Can access all accounts (integer/boolean)
//0(false): Can not access all accounts
//1(true) : Can access all accounts

DOCUMENTATION

GET
Retrieves an employees group perms.
If you specify id, retrieve selected employees perms.
Level 5 is required (all users can fetch this module)

--

Example Request:

     {
        "module":"admin.group_perms",
        "method":"GET",
        "request":{
                "user":"15553"
        }
     }

Example Response:

    {
        "status":1,
        "data":{
           "user":"15553",
           "read":"1",
           "write":"1",
           "can_add_account":"1",
           "can_access_account":"1",
           "updated":"2012-06-02 11:46:44",
           "id":"15553",
           "name":"John Smith"
        },
        "token":"xxxxxxx"
     }

UPDATE
Updates an employees group perms.
Level 5 is required (all users can fetch this module)

--

Example Request:

     {
        "module":"admin.group_perms",
        "method":"GET",
        "request":{
           "group_perms":"15553,0,0,0,0,5112,0,0,0,0"
           //In this example we updated two employees perms
        }
     }

Example Response:

    {
        "status":1,
        "data":true,
        "token":"xxxxxxx"
     }
Suggest Edits

admin.nrequests

 

Returns a count of all requests.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

valid token

DOCUMENTATION

GET

Retrieves a count of all requests. Available shifts, vacations needing approving, shifts needing approving, shifts pickups needing approval, shift trades needding approval before or after, and shifts available to pickup.
Level 3 is required.

--

Example Request:

    {
        "module":"admin.nrequest",
        "method":"GET",
        "request":{
 
        }
     }

Example Response:

     {
        "status":1,
        "data":{
           "total":354,
           "vacation":4,
           "shift_available":107,
           "shift_approval":349,
           "shift_request_waiting":0,
           "trade_approval":1
        },
        "token":"xxxxxxx"
     }
Suggest Edits

admin.settings

 

Returns a list of all modules, methods and their support variables and types.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

UPDATE

Parameters
Type
Description

token (Required)

token (Required)

admin_past_edit (accepted)

enum (0, 1)

Edit admin settings

0: Can not edit admin settings
1: Can edit admin settings

book_days_off (accepted)

enum (0, 1)

Book days off

0: Can not book day off
1: Can book day off

book_days_off_adv (accepted)

enum (0, 1)

Confirm trade before

0: Manager do not have to confirm shift trades before requests are sent to other employees
1: Manager have to confirm shift trades before requests are sent to other employees

confirm_trade_after (accepted)

enum (0, 1)

Confirm trade after

0: Manager do not have to confirm shift trades after requests are sent to other employees
1: Manager do not have to confirm shift trades after requests are sent to other employees

sms (accepted)

enum (0, 1)

Sms notification

0: Sms notification disabled
1: Sms notification enabled

email (accepted)

enum (0, 1)

Email notification

0: Email notification disabled
1: Email notification enabled

pm (accepted)

enum (0, 1)

Private message

0: Employees can not send private messages
1: Employees can send private messages

visible_staff (accepted)

enum (0, 1)

Visible staff

0: Employees can not see visible staff
1: Employees can see visible staff

visible_staff_details (accepted)

enum (0, 1)

Visible staff details

0: Employees can not see visible staff details
1: Employees can see visible staff details

visible_coworkers (accepted)

enum (0, 1)

Visible coworkers

0: Employees can not see visible coworkers
1: Employees can see visible coworkers

trade_shifts (accepted)

enum (0, 1)

Trade shifts

0: Employees can not trade shifts
1: Employees can trade shifts

coworkers_contacts (accepted)

enum (0, 1)

Future availability

0: Employees can not set future availability
1: Employees can set future availability

weekly_avail (accepted)

enum (0, 1)

Visible overview

0: Not allowed to view all schedules
1: Allowed to view all schedules

visible_own (accepted)

enum (0, 1)

Visible own

0: Employees can not view own staff
1: Employees can view own staff

message_wall_on (accepted)

enum (0, 1)

Message wall employees

0: Only managers can post messages
1: Employees can post messages

message_wall_emp (accepted)

enum (0, 1)

Message wall employees

0: Only managers can post messages
1: Employees can post messages

message_wall_comments (accepted)

enum (0, 1)

Message wall comments

0: Staff can not leave comments
1: Staff can leave comments

on_now (accepted)

enum (0, 1)

On now

0: Employees can not view "Who's on now"
1: Employees can view "Who's on now"

shift_confirm (accepted)

enum (0, 1)

Shift confirm

0: Can not confirm shifts
1: Can confirm shift

timeclock (accepted)

enum (0, 1)

Timeclock

0: Time Clock Module is disabled.
1: Time Clock Module is enabled

tc_terminal_lock (accepted)

enum (0, 1)

Timeclock terminal lock

0: Do not lock time-clocking to specified locations
1: Lock time-clocking to specified locations

tc_round_to (accepted)

integer

Round time clock totals to nearest

tc_clock_in_timeframe (accepted)

integer

Round ClockIn times up to the nearest

tc_autoclockout (accepted)

enum (0, 1)

Timeclock auto clock out

0: Autoclockout disabled
1: Autoclockout enabled

tc_webcam (accepted)

enum (0, 1)

Timeclock webcam

0: Employees do not have to use webcam when they clock in & out
1: Employees have to use webcam when they clock in & out

overtime (accepted)

integer

Daily overtime - max number of hours

pref_availability_timeframe (accepted)

integer

AvailabilityChangeRequests are effective (integer)

0 – Immediatly
1 – after one day
2 – after two days
7 – after one week

pref_alt_w_overtime_calc (accepted)

enum (0, 1)

Alternative weekly overtime calculation.
Using this mode will only put regular hours into weekly overtime quota.
Daily overtime will not be included

pref_birthday (accepted)

enum (0, 1)

Enable/Disable Birthday Notifications

pref_birthday_card (accepted)

enum (0, 1)

Enable/Disable happy birthday card

pref_birthday_reminder (accepted)

enum (0, 1)

Birthday reminder

pref_allow_req_acc (accepted)

enum (0, 1)

Users can request account
Allow this option to let new employees request account directly from company's login page.

security_question (accepted)

varchar

Security question for user who make account request

security_answer (accepted)

varchar

Security answer for user who make account request

DOCUMENTATION

GET
Retrieves a list of all admin current settings.
Level 5 is required

--

Example Request:

    {
       "method":"GET",
       "module":"admin.settings",
        "request":{
 
           }
    }

Example Response:

{  
    "status":1,
    "data":{  
        "admin_past_edit":"0",
        "edit_profile":"1",
        "reports":"1",
        "book_days_off":"1",
        "book_days_off_adv":"30",
        "book_days_off_max":"10",
        "confirm_trade_before":"1",
        "confirm_trade_after":"1",
        "sms":"1",
        "email":"1",
        "pm":"1",
        "visible_staff":"1",
        "visible_staff_details":"1",
        "visible_coworkers":"1",
        "trade_shifts":"1",
        "coworkers_contacts":"0",
        "future_avail":"1",
        "weekly_avail":"1",
        "visible_overview":"0",
        "visible_own":"1",
        "timeout":"0",
        "message_wall_on":"1",
        "message_wall_emp":"0",
        "message_wall_comments":"1",
        "message_wall_uploads":"0",
        "on_now":"0",
        "shift_confirm":"1",
        "shift_drop":"0",
        "shift_autoconfirm":"0",
        "timeclock":"1",
        "tc_terminal_lock":"0",
        "tc_round_to":"60",
        "tc_round_to_in":"-1",
        "tc_round_to_out":"-1",
        "tc_clock_in_timeframe":"-1",
        "tc_autoclockout":"0",
        "tc_webcam":"0",
        "tc_empl_import":"1",
        "tc_empl_addtime":"1",
        "24hr":"0",
        "draft":"1",
        "date":"M j, Y",
        "startday":"1",
        "currency":"1",
        "viewadvance":"-1",
        "login_splogo":"1",
        "scosting":"3",
        "start_day":"1",
        "end_day":"7",
        "start_time":"0",
        "end_time":"0",
        "overtime":"40",
        "timezone":"-05:00,1"
    },
    "token":"xxxxxxx"
    }

UPDATE
Updates admin settings.
Level 2 is required.

Example Request:

     {  
        "module":"admin.settings",
        "method":"UPDATE",
        "request":{  
                  "admin_past_edit":"0",
                  "book_days_off":"1",
                  "book_days_off_adv":"3",
                  "confirm_trade_before":"1",
                  "confirm_trade_after":"0",
             "sms":"1"
         }
     }

Example Response:


      {  
           "status":1,
            "data":{  
           "admin_past_edit":"0",
           "edit_profile":"1",
           "reports":"1",
           "book_days_off":"1",
           "book_days_off_adv":"3",
           "book_days_off_max":"10",
           "confirm_trade_before":"1",
           "confirm_trade_after":"0",
           "sms":"1",
           "email":"1",
           "pm":"1",
           "visible_staff":"1",
           "visible_staff_details":"1",
           "visible_coworkers":"1",
           "trade_shifts":"1",
           "coworkers_contacts":"0",
           "future_avail":"1",
           "weekly_avail":"1",
           "visible_overview":"0",
           "visible_own":"1",
           "timeout":"0",
           "message_wall_on":"1",
           "message_wall_emp":"0",
           "message_wall_comments":"1",
           "message_wall_uploads":"0",
           "on_now":"0",
           "shift_confirm":"1",
           "shift_drop":"0",
           "shift_autoconfirm":"0",
           "timeclock":"1",
           "tc_terminal_lock":"0",
           "tc_round_to":"60",
           "tc_round_to_in":"-1",
           "tc_round_to_out":"-1",
           "tc_clock_in_timeframe":"-1",
           "tc_autoclockout":"0",
           "tc_webcam":"0",
           "tc_empl_import":"1",
           "tc_empl_addtime":"1",
           "24hr":"0",
           "draft":"1",
           "date":"M j, Y",
           "startday":"1",
           "currency":"1",
           "viewadvance":"-1",
           "login_splogo":"1",
           "scosting":"3",
           "start_day":"1",
           "end_day":"7",
           "start_time":"0",
           "end_time":"0",
           "overtime":"40",
           "timezone":"-05:00,1",
           "availability_timeframe":"0",
           "alt_w_overtime_calc":"0",
           "birthday":"1",
           "birthday_card":"1",
           "allow_req_acc":"0",
           "security_question":"",
           "security_answer":""
       },
       "token":"xxxxxxx"
   }
Suggest Edits

availability.available

 

Returns Availability for a user on a given day

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Date

user (accepted)

integer

User id

approved (accepted)

enum (0, 1)

Filter unapproved or approved availability

0: Unapproved
1: Approved

DOCUMENTATION

GET
Returns Availability for a user on a given day.
Level 5 is required (all users can fetch this module)

--

Example Request:

{
   "method":"GET",
   "module":"availability.available",
   "request":{
      "start_date":"May 1, 2017",
      "user":2097936
   }
}

Example Response:

{
    "status": 1,
    "data": {
        "type": "weekly",
        "availability": {
            "1": {
                "flag": "2",
                "approved": null
            },
            "2": {
                "flag": "2",
                "approved": null
            },
            "3": {
                "flag": "2",
                "approved": null
            },
            "4": {
                "flag": "2",
                "approved": null
            },
            "5": {
                "flag": "2",
                "approved": null
            },
            "6": {
                "flag": "2",
                "approved": null
            },
            "7": {
                "flag": "2",
                "approved": null
            },
            "8": {
                "flag": "2",
                "approved": null
            },
            "9": {
                "flag": "2",
                "approved": null
            },
            "10": {
                "flag": "2",
                "approved": null
            },
            "11": {
                "flag": "2",
                "approved": null
            },
            "12": {
                "flag": "2",
                "approved": null
            },
            "13": {
                "flag": "2",
                "approved": null
            },
            "14": {
                "flag": "2",
                "approved": null
            },
            "15": {
                "flag": "2",
                "approved": null
            },
            "16": {
                "flag": "2",
                "approved": null
            },
            "17": {
                "flag": "2",
                "approved": null
            },
            "18": {
                "flag": "2",
                "approved": null
            },
            "19": {
                "flag": "2",
                "approved": null
            },
            "20": {
                "flag": "2",
                "approved": null
            },
            "21": {
                "flag": "2",
                "approved": null
            },
            "22": {
                "flag": "2",
                "approved": null
            },
            "23": {
                "flag": "2",
                "approved": null
            },
            "24": {
                "flag": "2",
                "approved": null
            },
            "25": {
                "flag": "2",
                "approved": null
            },
            "26": {
                "flag": "2",
                "approved": null
            },
            "27": {
                "flag": "2",
                "approved": null
            },
            "28": {
                "flag": "2",
                "approved": null
            },
            "29": {
                "flag": "2",
                "approved": null
            },
            "30": {
                "flag": "2",
                "approved": null
            },
            "31": {
                "flag": "2",
                "approved": null
            },
            "32": {
                "flag": "2",
                "approved": null
            },
            "33": {
                "flag": "2",
                "approved": null
            },
            "34": {
                "flag": "2",
                "approved": null
            },
            "35": {
                "flag": "2",
                "approved": null
            },
            "36": {
                "flag": "2",
                "approved": null
            },
            "37": {
                "flag": "2",
                "approved": null
            },
            "38": {
                "flag": "2",
                "approved": null
            },
            "39": {
                "flag": "2",
                "approved": null
            },
            "40": {
                "flag": "2",
                "approved": null
            },
            "41": {
                "flag": "2",
                "approved": null
            },
            "42": {
                "flag": "2",
                "approved": null
            },
            "43": {
                "flag": "2",
                "approved": null
            },
            "44": {
                "flag": "2",
                "approved": null
            },
            "45": {
                "flag": "2",
                "approved": null
            },
            "46": {
                "flag": "2",
                "approved": null
            },
            "47": {
                "flag": "2",
                "approved": null
            },
            "48": {
                "flag": "2",
                "approved": null
            },
            "49": {
                "flag": "2",
                "approved": null
            },
            "50": {
                "flag": "2",
                "approved": null
            },
            "51": {
                "flag": "2",
                "approved": null
            },
            "52": {
                "flag": "2",
                "approved": null
            },
            "53": {
                "flag": "2",
                "approved": null
            },
            "54": {
                "flag": "2",
                "approved": null
            },
            "55": {
                "flag": "2",
                "approved": null
            },
            "56": {
                "flag": "2",
                "approved": null
            },
            "57": {
                "flag": "2",
                "approved": null
            },
            "58": {
                "flag": "2",
                "approved": null
            },
            "59": {
                "flag": "2",
                "approved": null
            },
            "60": {
                "flag": "2",
                "approved": null
            },
            "61": {
                "flag": "2",
                "approved": null
            },
            "62": {
                "flag": "2",
                "approved": null
            },
            "63": {
                "flag": "2",
                "approved": null
            },
            "64": {
                "flag": "2",
                "approved": null
            },
            "65": {
                "flag": "2",
                "approved": null
            },
            "66": {
                "flag": "2",
                "approved": null
            },
            "67": {
                "flag": "2",
                "approved": null
            },
            "68": {
                "flag": "2",
                "approved": null
            },
            "69": {
                "flag": "2",
                "approved": null
            },
            "70": {
                "flag": "2",
                "approved": null
            },
            "71": {
                "flag": "2",
                "approved": null
            },
            "72": {
                "flag": "2",
                "approved": null
            },
            "73": {
                "flag": "2",
                "approved": null
            },
            "74": {
                "flag": "2",
                "approved": null
            },
            "75": {
                "flag": "2",
                "approved": null
            },
            "76": {
                "flag": "2",
                "approved": null
            },
            "77": {
                "flag": "2",
                "approved": null
            },
            "78": {
                "flag": "2",
                "approved": null
            },
            "79": {
                "flag": "2",
                "approved": null
            },
            "80": {
                "flag": "2",
                "approved": null
            },
            "81": {
                "flag": "2",
                "approved": null
            },
            "82": {
                "flag": "2",
                "approved": null
            },
            "83": {
                "flag": "2",
                "approved": null
            },
            "84": {
                "flag": "2",
                "approved": null
            },
            "85": {
                "flag": "2",
                "approved": null
            },
            "86": {
                "flag": "2",
                "approved": null
            },
            "87": {
                "flag": "2",
                "approved": null
            },
            "88": {
                "flag": "2",
                "approved": null
            },
            "89": {
                "flag": "2",
                "approved": null
            },
            "90": {
                "flag": "2",
                "approved": null
            },
            "91": {
                "flag": "2",
                "approved": null
            },
            "92": {
                "flag": "2",
                "approved": null
            },
            "93": {
                "flag": "2",
                "approved": null
            },
            "94": {
                "flag": "2",
                "approved": null
            },
            "95": {
                "flag": "2",
                "approved": null
            },
            "96": {
                "flag": "2",
                "approved": null
            }
        },
        "date": {
            "id": 2924,
            "month": 5,
            "day": 1,
            "year": 2017,
            "weekday": "Mon"
        }
    },
    "token": "xxxxxxxxx"
}
Suggest Edits

availability.approve

 

Request employee availability approval

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

type (required)

enum (future, weekly)

future: Future availability
weekly: Weekly availability

user (accepted)

integer

User id

UPDATE

Parameters
Type
Description

token (required)

Valid token

user (required)

integer

User id

type (required)

enum (future, weekly)

future: Future availability
weekly: Weekly availability

action (required)

enum (approve, reject)

approve: Approve availability
reject: Reject availability

start_time (accepted)

time

Start time

end_time (accepted)

time

End time

day (accepted)

enum (1, 2, 3, 4, 5, 6, 7)

1: Sunday
2: Monday
3: Tuesday
4: Wednesday
5: Thursday
6: Friday
7: Saturday

start_date (accepted)

date

Start date

id (accepted)

integer

CREATE

Parameters
Type
Description

token (required)

Valid token

comment (accepted)

varchar

Comment

user (accepted)

integer

User id

DOCUMENTATION

GET
Request employee availability approval.
Level 3 is required.

--

Example Request:

{
   "method":"GET",
   "module":"availability.approve",
   "request":{
      "type":"future"
   }
}

Example Response:

{
    "status": 1,
    "data": [
        {
            "id": "4271810",
            "user": "2165774",
            "day_timestamp": {
                "id": 3112,
                "month": 11,
                "day": 5,
                "wday": 0,
                "year": 2017,
                "weekday": "Sun",
                "mname": "Nov",
                "week": 44,
                "dayid": 1,
                "timeid": 1,
                "timeid_exact": 1,
                "formatted": "Nov 5, 2017",
                "iso8601": "2017-11-05T00:00:00+0100",
                "time": "12:00am",
                "timestamp": 1509836400,
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "date": "2017-11-05 00:00:00",
                "day_of_year": "308",
                "week_adjusted": 44,
                "sp_wday": 1
            },
            "date": "1488459034",
            "name": "Brus Vejn",
            "day": 3112
        },
        {
            "id": "4271813",
            "user": "2165774",
            "day_timestamp": {
                "id": 3113,
                "month": 11,
                "day": 6,
                "wday": 1,
                "year": 2017,
                "weekday": "Mon",
                "mname": "Nov",
                "week": 45,
                "dayid": 2,
                "timeid": 1,
                "timeid_exact": 1,
                "formatted": "Nov 6, 2017",
                "iso8601": "2017-11-06T00:00:00+0100",
                "time": "12:00am",
                "timestamp": 1509922800,
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "date": "2017-11-06 00:00:00",
                "day_of_year": "309",
                "week_adjusted": 45,
                "sp_wday": 2
            },
            "date": "1488459076",
            "name": "Brus Vejn",
            "day": 3113
        },
        {
            "id": "4271818",
            "user": "2165774",
            "day_timestamp": {
                "id": 3114,
                "month": 11,
                "day": 7,
                "wday": 2,
                "year": 2017,
                "weekday": "Tue",
                "mname": "Nov",
                "week": 45,
                "dayid": 3,
                "timeid": 1,
                "timeid_exact": 1,
                "formatted": "Nov 7, 2017",
                "iso8601": "2017-11-07T00:00:00+0100",
                "time": "12:00am",
                "timestamp": 1510009200,
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "date": "2017-11-07 00:00:00",
                "day_of_year": "310",
                "week_adjusted": 45,
                "sp_wday": 3
            },
            "date": "1488459189",
            "name": "Brus Vejn",
            "day": 3114
        },
        {
            "id": "4670828",
            "user": "2097936",
            "day_timestamp": {
                "id": 2984,
                "month": 6,
                "day": 30,
                "wday": 5,
                "year": 2017,
                "weekday": "Fri",
                "mname": "Jun",
                "week": 26,
                "dayid": 6,
                "timeid": 1,
                "timeid_exact": 1,
                "formatted": "Jun 30, 2017",
                "iso8601": "2017-06-30T00:00:00+0200",
                "time": "12:00am",
                "timestamp": 1498773600,
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "date": "2017-06-30 00:00:00",
                "day_of_year": "180",
                "week_adjusted": 26,
                "sp_wday": 6
            },
            "date": "1497270877",
            "name": "Jelena Pavlovic",
            "day": 2984
        },
        {
            "id": "4670836",
            "user": "2097936",
            "day_timestamp": {
                "id": 3011,
                "month": 7,
                "day": 27,
                "wday": 4,
                "year": 2017,
                "weekday": "Thu",
                "mname": "Jul",
                "week": 30,
                "dayid": 5,
                "timeid": 29,
                "timeid_exact": 29,
                "formatted": "Jul 27, 2017",
                "iso8601": "2017-07-27T07:00:00+0200",
                "time": "7:00am",
                "timestamp": 1501131600,
                "hours": 7,
                "minutes": 0,
                "seconds": 0,
                "date": "2017-07-27 07:00:00",
                "day_of_year": "207",
                "week_adjusted": 30,
                "sp_wday": 5
            },
            "date": "1497270986",
            "name": "Jelena Pavlovic",
            "day": 3011
        }
    ],
    "token": "xxxxxxx"
}

CREATE
Create future availability that needs approval.
Level 5 is required (all users can fetch this module)

--

Example Request:

{
   "method":"CREATE",
   "module":"availability.approve",
   "request":{
      "user":52,
      "start_date":"27-07-2017"
   }
}

Example Response:

{
   "status":1,
   "data":"Approval Request Sent",
   "token":"xxxxxxx"
}

UPDATE
Update future availability.
Level 3 is required.

--

Example Request:

{
   "method":"UPDATE",
   "module":"availability.approve",
   "request":{
      "user":52,
      "type":"future",
      "action":"approve"
   }
}

Example Response:

{
   "status":1,
   "data":"Availability Approved",
   "token":"xxxxxxx"
}
Suggest Edits

availability.future

 

Returns Future Availability for a given day time period

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

user (accepted)

integer

User id

approved (accepted)

enum (0, 1)

0: Unapproved
1: Approved

start_date (accepted)

date

Start date

end_date (accepted)

date

End date

CREATE

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Start date

user (accepted)

integer

User id

UPDATE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

flag (required)

enum (1, 2, 3)

1: Unavailable,
2: Available,
3: Wants to work

times (required)

enum (Array)

[\“Nov 21, 2017 00:00\“,\“Nov 21, 2017 01:00\“]

time_type (accepted)

time_type

DELETE

Parameters
Type
Description

token (required)

Valid token

user (accepted)

integer

User id

start_date (required)

date

Start date

DOCUMENTATION

GET
Returns Future Availability for a given day time period.
Level 5 is required (all users can fetch this module)

--

Example Request:

{
   "method":"GET",
   "module":"availability.future",
   "request":{
      "user":2097936
   }
}

Example Response:

{
    "status": 1,
    "data": {
        "4670828": {
            "date": {
                "id": 2983,
                "month": 6,
                "day": 29,
                "wday": 4,
                "year": 2017,
                "weekday": "Thu",
                "mname": "Jun",
                "week": 26,
                "dayid": 5,
                "timeid": 69,
                "timeid_exact": 69,
                "formatted": "Jun 29, 2017",
                "iso8601": "2017-06-29T17:00:00-0500",
                "time": "5:00pm",
                "timestamp": 1498773600,
                "hours": 17,
                "minutes": 0,
                "seconds": 0,
                "date": "2017-06-29 17:00:00",
                "day_of_year": "179",
                "week_adjusted": 26,
                "sp_wday": 5
            },
            "availability": [],
            "approved": "0",
            "approved_by": "0",
            "times": "-"
        }
    },
    "token": "xxxxxxx"
}

CREATE
Create Future Availability for a given date.
Level 5 is required (all users can fetch this module)

--

Example Request:

{
   "method":"CREATE",
   "module":"availability.future",
   "request":{
      "user":2097936,
      "start_date":"27-07-2017"
   }
}

Example Response:

{
    "status": 1,
    "data": 4670836,
    "token": "xxxxxxx"
}

UPDATE
Update Future Availability for a given date and time.
Level 5 is required (all users can fetch this module)

--

Example Request:

{
   "method":"UPDATE",
   "module":"availability.future",
   "request":{
      "user":2097936,
      "flag":1,
      "times":[\“Nov 21, 2017 00:00\,\“Nov 21, 2017 01:00\]
   }
}
                

Example Response:

{
   "status":1,
   "data":"Availability Updated",
   "token":"xxxxxxx"
}

DELETE
Deletes Future Availability for a given date.
Level 5 is required (all users can fetch this module)

--

Example Request:

{
   "method":"DELETE",
   "module":"availability.future",
   "request":{
      "user":52,
      "start_date":1185,
   }
}

Example Response:

{
   "status":1,
   "data":"Future Availability Date Removed",
   "token":"xxxxxxx"
}
Suggest Edits

availability.weekly

 

Returns Weekly Availability for a user

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

user (accepted)

integer

User id

approved (accepted)

integer

Filter unapproved or approved availability
0: Unapproved
1: Approved

day (accepted)

enum (1, 2, 3, 4, 5, 6, 7)

1: Sunday
2: Monday
3: Tuesday
4: Wednesday
5: Thursday
6: Friday
7: Saturday

timeframe (accepted)

min length 1

Timeframe

UPDATE

Parameters
Type
Description

token (required)

Valid token

flag (required)

enum (1, 2, 3)

1: Unavailable
2: Available
3: Changed

user (accepted)

integer

User id

day (accepted)

enum (1, 2, 3, 4, 5, 6, 7)

1: Sunday
2: Monday
3: Tuesday
4: Wednesday
5: Thursday
6: Friday
7: Saturday

start_time (accepted)

time

Start time

end_time (accepted)

time

End time

intervals (accepted)

enum (Array)

Availability interval,
json {"date_id":["start_time_id", "end_time_id"]}
Parameters "start_time_id" and "end_time_id" can take values from 1 to 96 (24 hours splitted into 15 min intervals)

DELETE

Parameters
Type
Description

token (required)

Valid token

start_time (required)

time

Start time

end_time (required)

time

End time

user (accepted)

integer

User id

DOCUMENTATION

GET
Returns Weekly Availability for a user.
Level 5 is required (all users can fetch this module)

--

Example Request:

{
   "method":"GET",
   "module":"availability.weekly",
   "request":{
      "user":2097936,
      "day":1
   }
}

Example Response:

{
    "status": 1,
    "data": {
        "1": {
            "1": {
                "flag": "2",
                "approved": null
            },
            "2": {
                "flag": "2",
                "approved": null
            },
            "3": {
                "flag": "2",
                "approved": null
            },
            "4": {
                "flag": "2",
                "approved": null
            },
            "5": {
                "flag": "2",
                "approved": null
            },
            "6": {
                "flag": "2",
                "approved": null
            },
            "7": {
                "flag": "2",
                "approved": null
            },
            "8": {
                "flag": "2",
                "approved": null
            },
            "9": {
                "flag": "2",
                "approved": null
            },
            "10": {
                "flag": "2",
                "approved": null
            },
            "11": {
                "flag": "2",
                "approved": null
            },
            "12": {
                "flag": "2",
                "approved": null
            },
            "13": {
                "flag": "2",
                "approved": null
            },
            "14": {
                "flag": "2",
                "approved": null
            },
            "15": {
                "flag": "2",
                "approved": null
            },
            "16": {
                "flag": "2",
                "approved": null
            },
            "17": {
                "flag": "2",
                "approved": null
            },
            "18": {
                "flag": "2",
                "approved": null
            },
            "19": {
                "flag": "2",
                "approved": null
            },
            "20": {
                "flag": "2",
                "approved": null
            },
            "21": {
                "flag": "2",
                "approved": null
            },
            "22": {
                "flag": "2",
                "approved": null
            },
            "23": {
                "flag": "2",
                "approved": null
            },
            "24": {
                "flag": "2",
                "approved": null
            },
            "25": {
                "flag": "2",
                "approved": null
            },
            "26": {
                "flag": "2",
                "approved": null
            },
            "27": {
                "flag": "2",
                "approved": null
            },
            "28": {
                "flag": "2",
                "approved": null
            },
            "29": {
                "flag": "2",
                "approved": null
            },
            "30": {
                "flag": "2",
                "approved": null
            },
            "31": {
                "flag": "2",
                "approved": null
            },
            "32": {
                "flag": "2",
                "approved": null
            },
            "33": {
                "flag": "2",
                "approved": null
            },
            "34": {
                "flag": "2",
                "approved": null
            },
            "35": {
                "flag": "2",
                "approved": null
            },
            "36": {
                "flag": "2",
                "approved": null
            },
            "37": {
                "flag": "2",
                "approved": null
            },
            "38": {
                "flag": "2",
                "approved": null
            },
            "39": {
                "flag": "2",
                "approved": null
            },
            "40": {
                "flag": "2",
                "approved": null
            },
            "41": {
                "flag": "2",
                "approved": null
            },
            "42": {
                "flag": "2",
                "approved": null
            },
            "43": {
                "flag": "2",
                "approved": null
            },
            "44": {
                "flag": "2",
                "approved": null
            },
            "45": {
                "flag": "2",
                "approved": null
            },
            "46": {
                "flag": "2",
                "approved": null
            },
            "47": {
                "flag": "2",
                "approved": null
            },
            "48": {
                "flag": "2",
                "approved": null
            },
            "49": {
                "flag": "2",
                "approved": null
            },
            "50": {
                "flag": "2",
                "approved": null
            },
            "51": {
                "flag": "2",
                "approved": null
            },
            "52": {
                "flag": "2",
                "approved": null
            },
            "53": {
                "flag": "2",
                "approved": null
            },
            "54": {
                "flag": "2",
                "approved": null
            },
            "55": {
                "flag": "2",
                "approved": null
            },
            "56": {
                "flag": "2",
                "approved": null
            },
            "57": {
                "flag": "2",
                "approved": null
            },
            "58": {
                "flag": "2",
                "approved": null
            },
            "59": {
                "flag": "2",
                "approved": null
            },
            "60": {
                "flag": "2",
                "approved": null
            },
            "61": {
                "flag": "2",
                "approved": null
            },
            "62": {
                "flag": "2",
                "approved": null
            },
            "63": {
                "flag": "2",
                "approved": null
            },
            "64": {
                "flag": "2",
                "approved": null
            },
            "65": {
                "flag": "2",
                "approved": null
            },
            "66": {
                "flag": "2",
                "approved": null
            },
            "67": {
                "flag": "2",
                "approved": null
            },
            "68": {
                "flag": "2",
                "approved": null
            },
            "69": {
                "flag": "2",
                "approved": null
            },
            "70": {
                "flag": "2",
                "approved": null
            },
            "71": {
                "flag": "2",
                "approved": null
            },
            "72": {
                "flag": "2",
                "approved": null
            },
            "73": {
                "flag": "2",
                "approved": null
            },
            "74": {
                "flag": "2",
                "approved": null
            },
            "75": {
                "flag": "2",
                "approved": null
            },
            "76": {
                "flag": "2",
                "approved": null
            },
            "77": {
                "flag": "2",
                "approved": null
            },
            "78": {
                "flag": "2",
                "approved": null
            },
            "79": {
                "flag": "2",
                "approved": null
            },
            "80": {
                "flag": "2",
                "approved": null
            },
            "81": {
                "flag": "2",
                "approved": null
            },
            "82": {
                "flag": "2",
                "approved": null
            },
            "83": {
                "flag": "2",
                "approved": null
            },
            "84": {
                "flag": "2",
                "approved": null
            },
            "85": {
                "flag": "2",
                "approved": null
            },
            "86": {
                "flag": "2",
                "approved": null
            },
            "87": {
                "flag": "2",
                "approved": null
            },
            "88": {
                "flag": "2",
                "approved": null
            },
            "89": {
                "flag": "2",
                "approved": null
            },
            "90": {
                "flag": "2",
                "approved": null
            },
            "91": {
                "flag": "2",
                "approved": null
            },
            "92": {
                "flag": "2",
                "approved": null
            },
            "93": {
                "flag": "2",
                "approved": null
            },
            "94": {
                "flag": "2",
                "approved": null
            },
            "95": {
                "flag": "2",
                "approved": null
            },
            "96": {
                "flag": "2",
                "approved": null
            },
            "id": 1,
            "day": "Sun"
        }
    },
    "token": "xxxxxxxx"
}

UPDATE
Updates Weekly Availability for a user.
Level 5 is required

--

Example Request:

{
   "method":"UPDATE",
   "module":"availability.weekly",
   "request":{
       "flag":"1",
       "user":"xxxxxx",
       "intervals": {"1":["1","7"],"2":["8","12"]}
   }
}

Example Response:

{
   "status":1,
   "data":"Availability Updated",
   "token":"xxxxxxx"
}

DELETE
Deletes Weekly Availability for a user.
Level 5 is required (all users can fetch this module)

--

Example Request:

{
   "method":"DELETE",
   "module":"availability.weekly",
   "request":{
      "start_time":1,
      "end_time":5,
   }
}

Example Response:

{
   "status":1,
   "data":"Availability Updated",
   "token":"xxxxxxx"
}
Suggest Edits

dashboard.notifications

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

DOCUMENTATION

GET
Returns a list of notifications.
Level 5 is required (all users can fetch this module)

--
Example Request:

{
   "module":"dashboard.notifications",
   "method":"GET",
   "request":{
   }
}

Example Response:

{
    "status": 1,
    "data": {
        "used_old_inbox": false,
        "new_conversation_messages": 0,
        "new_training": 1,
        "email": true,
        "avatar": true,
        "email_confirmation": true,
        "vacation_approval": "2",
        "shifts_approval": true,
        "trades_approval_before_after": "1",
        "weekly_avail_requests": "1",
        "future_avail_requests": "5",
        "logo": true,
        "missing_assigments": "15",
        "timeclock_notify": "101"
    },
    "token": "xxxxxxx"
}
Suggest Edits

dashboard.onnow

 

Returns a list of currently clocked employees and employees who are late for work.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

lateforwork (accepted)

varchar

Late for work

DOCUMENTATION

GET
Returns a list of currently clocked employees and employees who are late for work.
Level 5 is required

--

Example Request:

{
   "module":"dashboard.onnow",
   "method":"GET",
   "request":{
   }
}

Example Response:

{
    "status": 1,
    "data": [
        {
            "employee_id": "2119304",
            "employee_eid": "",
            "employee_name": "Will Smith",
            "employee_avatar": "0",
            "employee_avatar_url": null,
            "schedule_id": "1068295",
            "schedule_name": "Waiter",
            "schedule_color": "17",
            "timeclock_id": null,
            "clockin_time": null,
            "shift_id": "337613678",
            "shift_start": {
                "id": 2966,
                "month": 6,
                "day": 12,
                "wday": 1,
                "year": 2017,
                "weekday": "Mon",
                "mname": "Jun",
                "week": 24,
                "dayid": 2,
                "timeid": 73,
                "timeid_exact": 73,
                "formatted": "Jun 12, 2017",
                "iso8601": "2017-06-12T18:00:00+0200",
                "time": "6:00pm",
                "timestamp": 1497283200,
                "hours": 18,
                "minutes": 0,
                "seconds": 0,
                "date": "Jun 12, 2017",
                "day_of_year": "162",
                "week_adjusted": 24,
                "sp_wday": 2,
                "date_timestamp": "2017-06-12 18:00:00"
            },
            "shift_end": {
                "id": 2966,
                "month": 6,
                "day": 12,
                "wday": 1,
                "year": 2017,
                "weekday": "Mon",
                "mname": "Jun",
                "week": 24,
                "dayid": 2,
                "timeid": 77,
                "timeid_exact": 77,
                "formatted": "Jun 12, 2017",
                "iso8601": "2017-06-12T19:00:00+0200",
                "time": "7:00pm",
                "timestamp": 1497286800,
                "hours": 19,
                "minutes": 0,
                "seconds": 0,
                "date": "Jun 12, 2017",
                "day_of_year": "162",
                "week_adjusted": 24,
                "sp_wday": 2,
                "date_timestamp": "2017-06-12 19:00:00"
            },
            "is_on_break": null,
            "break": [],
            "lateDuration": "3m"
        }
    ],
    "token": "xxxxxxx"
}
Suggest Edits

group.accounts

 

Group Account Management - Returns a list of all accounts in the Group

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

detailed (accepted)

enum (0, 1)

0: Not detailed
1: Detailed

detailed_staff (accepted)

enum (0, 1)

0: Not detailed
1: Detailed

CREATE

Parameters
Type
Description

token (required)

Valid token

accounts (required)

varchar

Accounts

clone_positions (accepted)

enum (0,1)

Clone position
0: Do not clone positions
1: Clone positions

clone_settings (accepted)

enum (0,1)

Clone settings
0: Do not clone settings
1: Clone settings

clone_training (accepted)

enum (0,1)

Clone trainining
0: Do not clone training
1: Clone training

DOCUMENTATION

GET
Group Account Management - Returns a list of all accounts in the Group.
Level 3 is required

--

Example Request:

{
   "method":"GET",
   "module":"group.accounts",
   "request":{
      "detailed":1
   }
}

Example Response:

{
   "status":1,
   "data":[
      {
         "id":"11",
         "name":"Master",
         "domain":"domain",
         "created":"1265595316",
         "language":"en_US",
         "settings":{
            "admin_past_edit":"0",
            "book_days_off":"1",
            "book_days_off_adv":"30",
            "book_days_off_max":"10",
            "confirm_trade_before":"1",
            "confirm_trade_after":"1",
            "sms":"1",
            "email":"1",
            "pm":"1",
            "visible_staff":"1",
            "visible_staff_details":"1",
            "visible_coworkers":"1",
            "trade_shifts":"1",
            "coworkers_contacts":"0",
            "future_avail":"1",
            "weekly_avail":"1",
            "visible_overview":"0",
            "visible_own":"1",
            "timeout":"0",
            "message_wall_on":"1",
            "message_wall_emp":"0",
            "message_wall_comments":"1",
            "message_wall_uploads":"0",
            "on_now":"0",
            "shift_confirm":"1",
            "shift_drop":"0",
            "shift_autoconfirm":"0",
            "timeclock":"1",
            "tc_terminal_lock":"0",
            "tc_round_to":"10",
            "tc_round_to_in":"-1",
            "tc_round_to_out":"-1",
            "tc_clock_in_timeframe":"-1",
            "tc_autoclockout":"0",
            "tc_webcam":"0",
            "tc_empl_import":"1",
            "tc_empl_addtime":"1",
            "24hr":"0",
            "draft":"1",
            "date":"M j, Y",
            "startday":"2",
            "currency":"4",
            "viewadvance":"-1",
            "login_splogo":"1",
            "scosting":"3",
            "start_day":"1",
            "end_day":"7",
            "start_time":"0",
            "end_time":"0",
            "overtime":"40",
            "timezone":"-05:00,1"
         },
         "admin":{
            "id":"556",
            "name":"Marc Smith",
            "email":"marc@humanity.com"
         },
         "staff":[
            {
               "id":"5226",
               "name":"Zidane"
            },
            {
               "id":"22367",
               "name":"Alan Ford"
            }
         ],
         "locations":{
            "0":"None",
            "294":"Budget",
            "318":"Budget Testing",
            "37":"Business Team.",
            "436":"serbia",
            "3":"Support Team"
         },
         "positions":[
            {
               "id":"32408",
               "name":"Admin\/meetings",
               "l_name":null,
               "l_id":null
            }
         ]
      }
   ],
   "token":"xxxxxxx"
}

CREATE
Group Account Management - Creates a list of accounts in the Group.
Level 3 is required

--

Example Request:

{
   "method":"CREATE",
   "module":"group.accounts",
   "request":{
       "accounts":"New child account"
 
   }
}

Example Response:

{
   "status":1,
   "data":[
      {
         "details":{
            "id":"56",
            "settings":{
               "admin_past_edit":"0",
               "book_days_off":"1",
               "book_days_off_adv":"1",
               "book_days_off_max":"11",
               "confirm_trade_before":"1",
               "confirm_trade_after":"1",
               "sms":"1",
               "email":"1",
               "pm":"1",
               "visible_staff":"1",
               "visible_staff_details":"1",
               "visible_coworkers":"1",
               "trade_shifts":"1",
               "coworkers_contacts":"0",
               "future_avail":"1",
               "weekly_avail":"1",
               "visible_overview":"0",
               "visible_own":"1",
               "timeout":"0",
               "message_wall_on":"0",
               "message_wall_emp":"0",
               "message_wall_comments":"1",
               "message_wall_uploads":"1",
               "on_now":"0",
               "shift_confirm":"1",
               "shift_drop":"0",
               "shift_autoconfirm":"0",
               "timeclock":"1",
               "tc_terminal_lock":"1",
               "tc_round_to":"-1",
               "tc_round_to_in":"-1",
               "tc_round_to_out":"-1",
               "tc_clock_in_timeframe":"-1",
               "tc_autoclockout":"0",
               "tc_webcam":"0",
               "tc_empl_import":"0",
               "tc_empl_addtime":"1",
               "24hr":"0",
               "draft":"1",
               "date":"M j, Y",
               "startday":"1",
               "currency":"1",
               "viewadvance":"-1",
               "login_splogo":"1",
               "scosting":"3",
               "start_day":"1",
               "end_day":"7",
               "start_time":"0",
               "end_time":"0",
               "overtime":"40",
               "timezone":"-05:00,1"
            },
            "staff":[
               {
                  "id":"564",
                  "name":"Alan Ford"
               },
               {
                  "id":"5122",
                  "name":"Bob Rock"
               }
            ],
            "locations":[
               {
                  "id":"0",
                  "name":"none"
               },
               {
                  "id":"477",
                  "name":"Test"
               }
            ],
            "positions":[
               {
                  "id":"3213",
                  "name":"Meeting",
                  "l_name":"null",
                  "l_id":"null"
               }
            ]
         }
      }
   ],
   "token":"xxxxxxx"
}
Suggest Edits

group.account

 

Group Account Management - Manage individual group account

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Account id

UPDATE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Account id

name (accepted)

varchar

Account name

is_parent (accepted)

integer

Is parent account

parent

varchar

Parent id

CREATE

Parameters
Type
Description

token (required)

Valid token

name (accepted)

min length 3

Name

administrator (accepted)

min length 3

Administrator

password (accepted)

min length 6

Password

email (accepted)

email

Email

domain (accepted)

min length 3

Domain

clone (accepted)

integer

Clone account - by id

clone_positions (accepted)

enum (0, 1)

Clone positions
0: Do not clone positions
1: Clone positions

clone_settings (accepted)

enum (0, 1)

Clone setings
0: Do not clone settings
1: Clone settings

clone_training (accepted)

enum (0, 1)

Clone training
0: Do not clone training
1: Clone training

submaster (accepted)

enum (0, 1)

Submaster

DELETE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Account id

DOCUMENTATION

GET
Retrieves an individual group account.
Level 3 is required

--
Example Request:

{
   "method":"GET",
   "module":"group.account",
   "request":{
       "id":"56"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "details":{
         "id":"56",
         "settings":{
            "admin_past_edit":"0",
            "book_days_off":"1",
            "book_days_off_adv":"1",
            "book_days_off_max":"11",
            "confirm_trade_before":"1",
            "confirm_trade_after":"1",
            "sms":"1",
            "email":"1",
            "pm":"1",
            "visible_staff":"1",
            "visible_staff_details":"1",
            "visible_coworkers":"1",
            "trade_shifts":"1",
            "coworkers_contacts":"0",
            "future_avail":"1",
            "weekly_avail":"1",
            "visible_overview":"0",
            "visible_own":"1",
            "timeout":"0",
            "message_wall_on":"0",
            "message_wall_emp":"0",
            "message_wall_comments":"1",
            "message_wall_uploads":"1",
            "on_now":"0",
            "shift_confirm":"1",
            "shift_drop":"0",
            "shift_autoconfirm":"0",
            "timeclock":"1",
            "tc_terminal_lock":"1",
            "tc_round_to":"-1",
            "tc_round_to_in":"-1",
            "tc_round_to_out":"-1",
            "tc_clock_in_timeframe":"-1",
            "tc_autoclockout":"0",
            "tc_webcam":"0",
            "tc_empl_import":"0",
            "tc_empl_addtime":"1",
            "24hr":"0",
            "draft":"1",
            "date":"M j, Y",
            "startday":"1",
            "currency":"1",
            "viewadvance":"-1",
            "login_splogo":"1",
            "scosting":"3",
            "start_day":"1",
            "end_day":"7",
            "start_time":"0",
            "end_time":"0",
            "overtime":"40",
            "timezone":"-05:00,1"
         },
         "staff":[
            {
               "id":"564",
               "name":"Alan Ford"
            },
            {
               "id":"5122",
               "name":"Bob Rock"
            }
         ],
         "locations":[
            {
               "id":"0",
               "name":"none"
            },
            {
               "id":"477",
               "name":"Test"
            }
         ],
         "positions":[
            {
               "id":"3213",
               "name":"Meeting",
               "l_name":"null",
               "l_id":"null"
            }
         ]
      }
   },
   "token":"xxxxxxx"
}

CREATE
Creates an individual group account.
Level 3 is required

--

Example Request:

{
   "method":"CREATE",
   "module":"group.account",
   "request":{
      "name":"Group",
      "clone_positions":"1",
      "clone_settings":"1"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "details":{
         "id":"57",
         "settings":{
            "admin_past_edit":"0",
            "book_days_off":"1",
            "book_days_off_adv":"1",
            "book_days_off_max":"11",
            "confirm_trade_before":"1",
            "confirm_trade_after":"1",
            "sms":"1",
            "email":"1",
            "pm":"1",
            "visible_staff":"1",
            "visible_staff_details":"1",
            "visible_coworkers":"1",
            "trade_shifts":"1",
            "coworkers_contacts":"0",
            "future_avail":"1",
            "weekly_avail":"1",
            "visible_overview":"0",
            "visible_own":"1",
            "timeout":"0",
            "message_wall_on":"0",
            "message_wall_emp":"0",
            "message_wall_comments":"1",
            "message_wall_uploads":"1",
            "on_now":"0",
            "shift_confirm":"1",
            "shift_drop":"0",
            "shift_autoconfirm":"0",
            "timeclock":"1",
            "tc_terminal_lock":"1",
            "tc_round_to":"-1",
            "tc_round_to_in":"-1",
            "tc_round_to_out":"-1",
            "tc_clock_in_timeframe":"-1",
            "tc_autoclockout":"0",
            "tc_webcam":"0",
            "tc_empl_import":"0",
            "tc_empl_addtime":"1",
            "24hr":"0",
            "draft":"1",
            "date":"M j, Y",
            "startday":"1",
            "currency":"1",
            "viewadvance":"-1",
            "login_splogo":"1",
            "scosting":"3",
            "start_day":"1",
            "end_day":"7",
            "start_time":"0",
            "end_time":"0",
            "overtime":"40",
            "timezone":"-05:00,1"
         },
         "staff":[
            {
               "id":"564",
               "name":"Alan Ford"
            },
            {
               "id":"5122",
               "name":"Bob Rock"
            }
         ],
         "locations":[
            {
               "id":"0",
               "name":"none"
            },
            {
               "id":"477",
               "name":"Test"
            }
         ],
         "positions":[
            {
               "id":"3213",
               "name":"Meeting",
               "l_name":"null",
               "l_id":"null"
            }
         ]
      }
   },
   "token":"xxxxxxx"
}

UPDATE
Updates an individual group account.
Level 3 is required

--
Example Request:

{
   "method":"UPDATE",
   "module":"group.account",
   "request":{
      "id":"57",
      "name":"John Smith"
   }
}

Example Response:


{
   "status":1,
   "data":{
      "details":{
         "id":"57",
         "settings":{
            "admin_past_edit":"0",
            "book_days_off":"1",
            "book_days_off_adv":"1",
            "book_days_off_max":"11",
            "confirm_trade_before":"1",
            "confirm_trade_after":"1",
            "sms":"1",
            "email":"1",
            "pm":"1",
            "visible_staff":"1",
            "visible_staff_details":"1",
            "visible_coworkers":"1",
            "trade_shifts":"1",
            "coworkers_contacts":"0",
            "future_avail":"1",
            "weekly_avail":"1",
            "visible_overview":"0",
            "visible_own":"1",
            "timeout":"0",
            "message_wall_on":"0",
            "message_wall_emp":"0",
            "message_wall_comments":"1",
            "message_wall_uploads":"1",
            "on_now":"0",
            "shift_confirm":"1",
            "shift_drop":"0",
            "shift_autoconfirm":"0",
            "timeclock":"1",
            "tc_terminal_lock":"1",
            "tc_round_to":"-1",
            "tc_round_to_in":"-1",
            "tc_round_to_out":"-1",
            "tc_clock_in_timeframe":"-1",
            "tc_autoclockout":"0",
            "tc_webcam":"0",
            "tc_empl_import":"0",
            "tc_empl_addtime":"1",
            "24hr":"0",
            "draft":"1",
            "date":"M j, Y",
            "startday":"1",
            "currency":"1",
            "viewadvance":"-1",
            "login_splogo":"1",
            "scosting":"3",
            "start_day":"1",
            "end_day":"7",
            "start_time":"0",
            "end_time":"0",
            "overtime":"40",
            "timezone":"-05:00,1"
         },
         "staff":[
            {
               "id":"564",
               "name":"Alan Ford"
            },
            {
               "id":"5122",
               "name":"Bob Rock"
            }
         ],
         "locations":[
            {
               "id":"0",
               "name":"none"
            },
            {
               "id":"477",
               "name":"Test"
            }
         ],
         "positions":[
            {
               "id":"3213",
               "name":"Meeting",
               "l_name":"null",
               "l_id":"null"
            }
         ]
      }
   },
   "token":"xxxxxxx"
}

DELETE
Deletes an individual group account.
Level 3 is required

--

Example Request:

{
   "method":"DELETE",
   "module":"group.account",
   "request":{
      "id":"147"
   }
}

Example Response:

{
   "status":1,
   "data":"",
   "token":"xxxxxxx"
}
Suggest Edits

group.reports

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Start date

end_date (required)

date

End date

type (required)

enum (schedule_summary, shifts_confirmed, crib_sheet, shift_exchanges, shifts_summary, open_shifts, position_summary, daily_peak_hours, budget, confirmed_timesheets, all_timesheets, group_statistics)

account (accepted)

integer

Account id

location (accepted)

integer

Location id

schedule (accepted)

integer

Position id

employee (accepted)

integer

Employee id

skill (accepted)

integer

Skill id

options (accepted)

integer

Options

deduct_breaks (accepted)

enum (0, 1)

0: do not desuct breaks
1: deduct breaks

split_overnight (accepted)

enum (0, 1)

0: do not split overnight
1: split overnight

group_results (accepted)

enum (0, 1)

0: do not group results
1: group results

DOCUMENTATION

GET
Group Account Management - Returns a list of all accounts in the Group.
Level 3 is required

--

Example Request:

{
   "method":"GET",
   "module":"group.reports",
   "request":{
      "start_date":"March 1,2017",
      "end_date":"March 5,2017",
      "type":"schedule_summary",
      "employee":"2097936"
   }
}

Example Response:

{
    "status": 1,
    "data": {
        "users": [
            {
                "id": "2097936",
                "name": "Test Employee",
                "store": "202039",
                "eid": "",
                "group_id": "2",
                "location": "574075",
                "shifts": [
                    {
                        "id": "386133309",
                        "start": "37",
                        "schedule": "1068294",
                        "end": "69",
                        "published": "1488563669",
                        "edited": "1488467096",
                        "start_date": "2864",
                        "end_date": "2864",
                        "start_timestamp": "2017-03-02 09:00:00",
                        "end_timestamp": "2017-03-02 17:00:00",
                        "schedule_name": "1w -test5",
                        "schedule_color": "3",
                        "users": "2097936"
                    }
                ],
                "total": 8,
                "reports": {
                    "2864": [
                        {
                            "id": "386133309",
                            "schedule_name": "1w -test5",
                            "schedule": "1068294",
                            "schedule_color": "E5922D",
                            "start": "9:00am",
                            "end": "5:00pm",
                            "hours": 8
                        }
                    ]
                }
            }
        ],
        "dates": [
            {
                "id": 2863,
                "formatted": "Mar 1, 2017",
                "total": 0
            },
            {
                "id": 2864,
                "formatted": "Mar 2, 2017",
                "total": 8
            },
            {
                "id": 2865,
                "formatted": "Mar 3, 2017",
                "total": 0
            },
            {
                "id": 2866,
                "formatted": "Mar 4, 2017",
                "total": 0
            },
            {
                "id": 2867,
                "formatted": "Mar 5, 2017",
                "total": 0
            }
        ],
        "total": 8
    },
    "token": "xxxxxxx"
}
Suggest Edits

location.locations

 

Returns a list of Locations.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

type (accepted)

enum (1,2)

1: location
2: remote site

DOCUMENTATION

GET
Returns an array that contains all locations.
Level 5 is required

--

Example Request:

{
   "module":"location.locations",
   "method":"GET",
   "request":{
      "type":"2"
   }
}

Example Response:

{
    "status": 1,
    "data": [
        {
            "id": 613062,
            "name": "Abraco",
            "country": "",
            "address": "86 East 7th Street, New York, NY 10003, USA",
            "lat": 0,
            "lon": 0,
            "store": 202039,
            "type": 1,
            "notes": "",
            "timezone_id": null,
            "map": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=86+East+7th+Street%2C+New+York%2C+NY+10003%2C+USA%2C+",
            "directions": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=86+East+7th+Street%2C+New+York%2C+NY+10003%2C+USA%2C+"
        }
    ],
    "token": "xxxxxxx"
}
Suggest Edits

location.location

 

Management of individual Location.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Location id

CREATE

Parameters
Type
Description

token (required)

Valid token

name (required)

varchar

Name

type (required)

enum (1, 2)

1: for Location
2: for Remote Site

country (accepted)

varchar

Country

address (accepted)

varchar

Address

lat (accepted)

varchar

Latitude

lon (accepted)

varchar

Longitude

timezone_id (accepted)

integer

Time zone id

UPDATE

Parameters
Type
Description

token

Valid token

id (required)

integer

Location id

name (accepted)

varchar

Location name

country (accepted)

varchar

Location country

address (accepted)

varchar

Location address

lat (accepted)

varchar

Latitude

lon (accepted)

varchar

Longitude

timezone_id (accepted)

integer

Time zone id

notes (accepted)

varchar

Notes

phone_number (accepted)

varchar

Phone number

DELETE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Location id

DOCUMENTATION

GET
Retrieves an individual location specified by id.
Level 5 is required

--

Example Request:

{
   "module":"location.location",
   "method":"GET",
   "request":{
      "id":"613062"
   }
}

Example Response:

{
    "status": 1,
    "data": {
        "id": 613062,
        "name": "Abraco",
        "country": "",
        "address": "86 East 7th Street, New York, NY 10003, USA",
        "lat": 0,
        "lon": 0,
        "store": 202039,
        "type": 1,
        "notes": "",
        "timezone_id": null,
        "map": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=86+East+7th+Street%2C+New+York%2C+NY+10003%2C+USA%2C+",
        "directions": "https://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=86+East+7th+Street%2C+New+York%2C+NY+10003%2C+USA%2C+"
    },
    "token": "xxxxxxxx"
}

CREATE
Creates new location.
Level 5 is required

--
Example Request:

{
   "module":"location.location",
   "method":"CREATE",
   "request":{
      "name":"newLocation",
      "type":"1"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "id":"40828",
      "name":"newLocation",
      "country":"",
      "address":"",
      "lat":"",
      "lon":"",
      "type":"1",
      "notes":"",
      "map":"http:\/\/maps.google.com\/maps?f=q&source=s_q&hl=en&geocode=&q=%2C+",
      "directions":"http:\/\/maps.google.com\/maps?f=q&source=s_q&hl=en&geocode=&q=%2C+"
   },
   "token":"xxxxxxx"
}

UPDATE
Updates location.
Level 5 is required

--

Example request:

{
   "module":"location.location",
   "method":"UPDATE",
   "request":{
      "id":"40828",
      "country":"PlanetFederation"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "id":"40828",
      "name":"newLocation",
      "country":"PlanetFederation",
      "address":"",
      "lat":"",
      "lon":"",
      "type":"1",
      "notes":"",
      "map":"http:\/\/maps.google.com\/maps?f=q&source=s_q&hl=en&geocode=&q=%2C+",
      "directions":"http:\/\/maps.google.com\/maps?f=q&source=s_q&hl=en&geocode=&q=%2C+"
   },
   "token":"f25a14018a61920589d1e04bd812ee95b8956d24"
}

DELETE
Deletes location.
Level 5 is required

--

Example Request:

{
   "module":"location.location",
   "method":"DELETE",
   "request":{
      "id":"40828"
   }
}

Example Response:

{
   "status":1,
   "data":"Location Removed",
   "token":"xxxxxxx"
}
Suggest Edits

messaging.messages

 

Retrieve/Delete/Add to the business message wall.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

mode

enum (to, from)

to : Recived messages
from: Sent messages

DOCUMENTATION

GET

Returns an array that contains all user messages.
You can specify if you want to retrieve just send, or receive messages, with parameter 'mode'.
Level 5 is required (all users can fetch this module)

--

Example Request:

    {
       "module":"messaging.messages",
       "method":"GET",
       "request":{
              "mode":"to"
       }
    }

Example Response:

{  
    "status":1,
    "data":[  
        {  
            "id":"1914",
            "from":{  
                "id":"3334",
                "name":"Alan Ford"
            },
            "to":{  
                "id":"124",
                "name":"Bob Rock"
            },
            "type":"1",
            "replyto":"0",
            "date_sent":"1338890805",
            "date_read":"0",
            "subject":"asda",
            "message":"sd",
            "message_formatted":"sd",
            "date_sent_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            },
            "date_read_formatted":[  

            ]
        },
        {  
            "id":"1913",
            "from":{  
                "id":"1061",
                "name":"Marc Smith"
            },
            "to":{  
                "id":"3334",
                "name":"Alan Ford"
            },
            "type":"1",
            "replyto":"0",
            "date_sent":"1338889951",
            "date_read":"1338912286",
            "subject":"re: tste",
            "message":"it's working :) fine...\n\n\n\n[quote=Alan Ford]tste[\/quote]",
            "message_formatted":"it's working :) fine... 
       \n 
       \n 
       \n 
        \ntste",
            "date_sent_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            },
            "date_read_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            }
        },
        {  
            "id":"1910",
            "from":{  
                "id":"3334",
                "name":"Alan Ford"
            },
            "to":{  
                "id":"5141",
                "name":"Steewe"
            },
            "type":"1",
            "replyto":"0",
            "date_sent":"1338889909",
            "date_read":"1338912226",
            "subject":"tst",
            "message":"tst",
            "message_formatted":"tst",
            "date_sent_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            },
            "date_read_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            }
        },
        {  
            "id":"1909",
            "from":{  
                "id":"3334",
                "name":"Alan Ford"
            },
            "to":{  
                "id":"1064",
                "name":"Alicia"
            },
            "type":"1",
            "replyto":"0",
            "date_sent":"1338889909",
            "date_read":"1338912214",
            "subject":"tst",
            "message":"tst",
            "message_formatted":"tst",
            "date_sent_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            },
            "date_read_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            }
        },
        {  
            "id":"1908",
            "from":{  
                "id":"3334",
                "name":"Alan Ford"
            },
            "to":{  
                "id":"5141",
                "name":"Steewe"
            },
            "type":"1",
            "replyto":"0",
            "date_sent":"1338889886",
            "date_read":"1338912217",
            "subject":"msg",
            "message":"ngs",
            "message_formatted":"ngs",
            "date_sent_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            },
            "date_read_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            }
        },
        {  
            "id":"1907",
            "from":{  
                "id":"234",
                "name":"Peter Griffin"
            },
            "to":{  
                "id":"1064",
                "name":"Alicia"
            },
            "type":"1",
            "replyto":"0",
            "date_sent":"1338889886",
            "date_read":"1338912218",
            "subject":"msg",
            "message":"ngs",
            "message_formatted":"ngs",
            "date_sent_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            },
            "date_read_formatted":{  
                "id":1133,
                "timestamp":1338854400,
                "month":6,
                "day":4,
                "year":2017,
                "week":23,
                "dayid":2,
                "weekday":"Mon",
                "mname":"Jun",
                "formatted":"Jun 4, 2017"
            }
        }
    ],
    "token":"xxxxxxx"
}
Suggest Edits

messaging.message

 

Retrieve/Delete/Send individual messages.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Message id

CREATE

Parameters
Type
Description

token (required)

Valid token

subject (required)

varchar

Message subject

message (required)

varchar

Message body

to (required)

integer

Receivers id

DELETE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Message id

UPDATE

Parmeters
Type
Description

token (required)

Valid token

id (required)

integer

Message id

read (accepted)

enum [0,1]

Is message read

0: Message is not read
1: Message is read

DOCUMENTATION

GET
Retrieves a specific message by id.
Level 5 is required

--

Example Request:

     {
        "module":"messaging.message",
        "method":"GET",
        "request":{
           "id":"1928"
        }
     }

Example Response:

{
        "status":1,
        "data":{
           "id":"1928",
           "from":{
              "id":"3334",
              "name":"Alan Ford"
           },
           "to":{
              "id":"3334",
              "name":"Alan Ford"
           },
           "type":"1",
           "replyto":"0",
           "date_sent":"1339601203",
           "date_read":"0",
           "subject":"test",
           "message":"test",
           "message_formatted":"test",
           "date_sent_formatted":{
              "id":1141,
              "timestamp":1339545600,
              "month":6,
              "day":07,
              "year":2012,
              "week":24,
              "dayid":3,
              "weekday":"Tue",
              "mname":"Jun",
              "formatted":"Jun 07, 2017"
           },
           "date_read_formatted":[
 
           ]
        },
        "token":"xxxxxxx"
}

CREATE
Creates new message.
Level 5 is required

--

Example Request:

     {
        "module":"messaging.message",
        "method":"CREATE",
        "request":{
           "subject":"subject",
           "message":"body",
           "to":"31256"
        }
     }

Example Response:

{  
    "status":1,
    "data":{  
        "id":"1929",
        "from":{  
            "id":"3334",
            "name":"Alan Ford"
        },
        "to":{  
            "id":"31256",
            "name":"Bob Rock"
        },
        "type":"1",
        "replyto":"0",
        "date_sent":"1339601203",
        "date_read":"0",
        "subject":"subject",
        "message":"body",
        "message_formatted":"test",
        "date_sent_formatted":{  
            "id":1141,
            "timestamp":1339545600,
            "month":6,
            "day":07,
            "year":2012,
            "week":24,
            "dayid":3,
            "weekday":"Tue",
            "mname":"Jun",
            "formatted":"Jun 07, 2017"
        },
        "date_read_formatted":[  

        ]
    },
    "token":"xxxxxxx"
    }

UPDATE
Updates message.
Level 5 is required

--

Example Request:

     {
        "module":"messaging.message",
        "method":"UPDATE",
        "request":{
           "id":"1929",
           "read":"1"
        }
     }

Example Response:

{  
    "status":1,
    "data":{  
        "id":"1929",
        "from":{  
            "id":"3334",
            "name":"Alan Ford"
        },
        "to":{  
            "id":"31256",
            "name":"Bob Rock"
        },
        "type":"1",
        "replyto":"0",
        "date_sent":"1339601203",
        "date_read":"0",
        "subject":"new subject",
        "message":"new body",
        "message_formatted":"test",
        "date_sent_formatted":{  
            "id":1141,
            "timestamp":1339545600,
            "month":6,
            "day":07,
            "year":2012,
            "week":24,
            "dayid":3,
            "weekday":"Tue",
            "mname":"Jun",
            "formatted":"Jun 07, 2012"
        },
        "date_read_formatted":{  
            "id":1141,
            "timestamp":1359500400,
            "month":1,
            "day":30,
            "year":2013,
            "week":5,
            "dayid":4,
            "weekday":"Wed",
            "mname":"Jan",
            "formatted":"Jan 30, 2017"
        }
    },
    "token":"xxxxxxx"
 }

DELETE
Deletes message.
Level 5 is required (all users can fetch this module)

--

Example Request:

     {
        "module":"messaging.message",
        "method":"DELETE",
        "request":{
           "id":"132"
        }
     }

Example Response:

     {
        "status":1,
        "data":"",
        "token":"xxxxxxx"
     }
Suggest Edits

messaging.notices

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

current (accepted)

enum(1)

DOCUMENTATION

GET

Get all group account notices

--

Example Request:

 {
        "module":"messaging.notices",
        "method":"GET",
        "request":{
 
        }
}

Example Response:

{
  "status": 1,
  "data": {
    "203": {
      "id": "203",
      "franchise": "202039",
      "date_sent": "2017-06-08 14:35:04",
      "subject": "Notice",
      "message": "Test Notice",
      "groups": [
        "5",
        "4",
        "3",
        "2",
        "6",
        "7"
      ],
      "start_timestamp": "2017-06-08 00:00:00",
      "end_timestamp": "2017-06-10 00:00:00",
      "last_edited": null,
      "edited_by": null,
      "from": "2097936",
      "visible_name": "0",
      "name": "Jelena Pavlovic",
      "start": {
        "id": 2962,
        "month": 6,
        "day": 8,
        "wday": 4,
        "year": 2017,
        "weekday": "Thu",
        "mname": "Jun",
        "week": 23,
        "dayid": 5,
        "timeid": 1,
        "timeid_exact": 1,
        "formatted": "Jun 8, 2017",
        "iso8601": "2017-06-08T00:00:00+0300",
        "time": "12:00am",
        "timestamp": 1496869200,
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "date": "2017-06-08 00:00:00",
        "day_of_year": "158",
        "week_adjusted": 23,
        "sp_wday": 5
      },
      "end": {
        "id": 2964,
        "month": 6,
        "day": 10,
        "wday": 6,
        "year": 2017,
        "weekday": "Sat",
        "mname": "Jun",
        "week": 23,
        "dayid": 7,
        "timeid": 1,
        "timeid_exact": 1,
        "formatted": "Jun 10, 2017",
        "iso8601": "2017-06-10T00:00:00+0300",
        "time": "12:00am",
        "timestamp": 1497042000,
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "date": "2017-06-10 00:00:00",
        "day_of_year": "160",
        "week_adjusted": 23,
        "sp_wday": 7
      }
    }
  },
  "token": "xxxxxxx"
}
Suggest Edits

messaging.notice

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Notice id

UPDATE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Notice id

groups (accepted)

varchar

Groups that notice has to be sent
2 - Manager
3 - Supervisors
4 - Scheduler
5 - Employee
6 - Schedule viewer
7 - Accountant

subject (accepted)

varchar

Notice subject

message (accepted)

varchar

Notice message content

start_timestamp (accepted)

varchar

Notice start date

end_timestamo (accepted)

varchar

Notice end date

visible_name (accepted)

min length 1

CREATE

Parameters
Type
Description

token (required)

Valid token

groups (accepted)

varchar

Groups that notice has to be sent

subject (accepted)

varchar

Notice subject

message (accepted)

varchar

Notice message content

start_timestamp (accepted)

varchar

Notice start date

end_timestamo (accepted)

varchar

Notice end date

visible_name (accepted)

min length 1

DELETE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Notice id

DOCUMENTATION

GET

Level 5 is required

Example Request:

{  
    "module":"messaging.notice",
    "method":"GET",
    "request":{  
        "id":"203"
    }
}

Example response:

{
  "status": 1,
  "data": {
    "203": {
      "id": "203",
      "franchise": "202039",
      "date_sent": "2017-06-08 14:35:04",
      "subject": "Notice",
      "message": "Test Notice",
      "groups": [
        "5",
        "4",
        "3",
        "2",
        "6",
        "7"
      ],
      "start_timestamp": {
        "id": 2962,
        "month": 6,
        "day": 8,
        "wday": 4,
        "year": 2017,
        "weekday": "Thu",
        "mname": "Jun",
        "week": 23,
        "dayid": 5,
        "timeid": 1,
        "timeid_exact": 1,
        "formatted": "Jun 8, 2017",
        "iso8601": "2017-06-08T00:00:00+0300",
        "time": "12:00am",
        "timestamp": 1496869200,
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "date": "2017-06-08 00:00:00",
        "day_of_year": "158",
        "week_adjusted": 23,
        "sp_wday": 5
      },
      "end_timestamp": {
        "id": -14363,
        "month": 11,
        "day": 30,
        "wday": 1,
        "year": -1,
        "weekday": "Mon",
        "mname": "Nov",
        "week": 49,
        "dayid": 2,
        "timeid": 1,
        "timeid_exact": 1,
        "formatted": "Nov 30, -0001",
        "iso8601": "-0001-11-30T00:00:00+0200",
        "time": "12:00am",
        "timestamp": -62169991200,
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "date": "-0001-11-30 00:00:00",
        "day_of_year": "333",
        "week_adjusted": 49,
        "sp_wday": 2
      },
      "last_edited": "2017-06-08 14:48:12",
      "edited_by": "2097936",
      "from": "2097936",
      "visible_name": "0"
    }
  },
  "token": "xxxxxxx"
}

CREATE
Creates new message.
Level 5 is required

--

Example Request:

{  
    "module":"messaging.notice",
    "method":"CREATE",
    "request":{  
        "groups":"2",
        "subject":"Test Notice"
    }
}

Example response:

{
  "status": 1,
  "data": "Notice Created",
  "token": "xxxxxxx"
}

UPDATE
Creates new message.
Level 2 is required

--

Example Request:

{  
    "module":"messaging.notice",
    "method":"UPDATE",
    "request":{  
         "id":"203",
         "groups":"5",
    }
}

Example response:

{
  "status": 1,
  "data": "Notice Updated",
  "token": "xxxxxxx"
}

DELETE
Creates new message.
Level 3 is required

--

Example Request:

{  
    "module":"messaging.notice",
    "method":"DELETE",
    "request":{  
         "id":"203"
    }
}

Example response:

{
  "status": 1,
  "data": "Notice Deleted",
  "token": "xxxxxxx"
}
Suggest Edits

messaging.shift

 

Send a message to all staff on a shift.

SUPPORTED METHODS:

CREATE

Parameters
Type
Description

token (required)

Valid token

subject (required)

varchar

Message subject

message (required)

varchar

Message body

id (required)

integer

Shift id

DOCUMENTATION

CREATE
Send a message to all staff in shift.
Level 5 is required (all users can fetch this module)

--

Example Request:

{  
    "module":"messaging.shift",
    "method":"CREATE",
    "request":{  
        "subject":"test",
        "message":"body",
        "id":"821"
    }
}

Example Response:

{  
    "status":"1",
    "data":{  
        "messages":[  
            {  
                "id":"3244",
                "from":{  
                    "id":"2",
                    "name":"John Smith"
                },
                "to":{  
                    "id":"156",
                    "name":"Alan Ford"
                },
                "type":"1",
                "replyto":"0",
                "date_sent":"1339601203",
                "date_read":"0",
                "subject":"Test",
                "message":"Body",
                "message_formatted":"Body",
                "date_sent_formatted":{  
                    "id":"1141",
                    "timestamp":"1339545600",
                    "month":"6",
                    "day":"12",
                    "year":"2012",
                    "week":"24",
                    "day_id":"3",
                    "weekday":"Tue",
                    "mname":"Jun",
                    "formatted":"Jun 12, 2017"
                },
                "date_read_formatted":{  

                }
            }
        ]
    },
    "token":"xxxxxxx"
}
Suggest Edits

messaging.wall

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

CREATE

token (required)

Valid token

post (required)

varchar

Post

id (accepted)

integer

Message id

title (accepted)

varchar

Message title

sticky (accepted)

enum (0,1)

Is wall message sticky?

0: Message is not sticky
1: Message is sticky

DELETE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Message id

delete (required)

enum(0,1)

Delete

0 : Delete message
1 : Delete comment

UPDATE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Message id

sticky (required)

enum (0,1)

Is wall message sticky?

0: Message is not sticky
1: Message is sticky

DOCUMENTATION

GET
Get wall message and comments.
Level 5 is required (all users can fetch this module)

--

Example Request:

 {
        "module":"messaging.wall",
        "method":"GET",
        "request":{
 
        }
}

Example Response:

{  
    "status":1,
    "data":[  
        {  
            "id":"171",
            "user":{  
                "id":"12",
                "name":"Alan Ford"
            },
            "date":"1337627278",
            "sticky":"0",
            "title":"Testing",
            "post":"Hello",
            "title_formatted":"Testing",
            "post_formatted":"Hello"
        },
        {  
            "id":"168",
            "user":{  
                "id":"5147",
                "name":"Bob Rock"
            },
            "date":"1337342896",
            "sticky":"0",
            "title":"Hi",
            "post":"Vihiiiiiiiiii :*",
            "title_formatted":"Hi",
            "post_formatted":"Vihiiiiiiiiii :*"
        },
        {  
            "id":"167",
            "user":{  
                "id":"4910",
                "name":"No 1"
            },
            "date":"1337341670",
            "sticky":"0",
            "title":"No avatar",
            "post":"test",
            "title_formatted":"No avatar",
            "post_formatted":"test",
            "comments":[  
                {  
                    "id":"217",
                    "user":{  
                        "id":"2",
                        "name":"Alan Ford"
                    },
                    "date":"1337342655",
                    "comment":"bla",
                    "comment_formatted":"bla"
                },
                {  
                    "id":"218",
                    "user":{  
                        "id":"5147",
                        "name":"Bob Rock"
                    },
                    "date":"1337348928",
                    "comment":"asdf",
                    "comment_formatted":"asdf"
                }
            ]
        }
    ],
    "token":"xxxxxxx"
}

CREATE
Creates new wall message or comment.
If message id is being specified, comment is added. Else, new message is being created. User can create new wall messages/comments, only if it is enabled in admin settings.
Level 5 is required (all users can fetch this module)

--

Example Request:

    {
       "module":"messaging.wall",
       "method":"CREATE",
       "request":{
          "title":"New Title"
          "post":"New message"
       }
    }

Example Response:


    {
       "status":1,
       "data":"",
       "token":"xxxxxxx"
    }

DELETE
Deletes wall message or comment.
Level 5 is required (all users can fetch this module)

--

Example Request:

    {
       "module":"messaging.wall",
       "method":"DELETE",
       "request":{
          "id":"934",
          "delete":"0"
       }
    }

Example Response:

    {
       "status":1,
       "data":"",
       "token":"xxxxxxx"
    }
Suggest Edits

payroll.report

 

Run Payroll Specific Reports on schedule / time sheet data.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

type (requires)

enum[scheduledhours,confirmedhours,timesheets]

scheduledhours: Takes all (confirmed and unconfirmed) shifts into the calculation.
confirmedhours: Takes only confirmed shifts into the calculation.
timesheets: By default takes only confirmed time sheets into the calculation.

start_date (accepted)

date

Start date

end_date (accepted)

date

End date

location (accepted)

integer

Location id

schedule (accepted)

integer

Schedule id

employee (accepted)

varchar

Employees
Array of employees ids (eg. "323,657,887")

skill (accepted)

varchar

Skill id

deduct_breaks (accepted)

enum (0, 1)

Deduct breaks

0: Do not deduct breaks
1: Deduct breaks

group_results (accepted)

enum (1, 2)

Group results

1: Group by employee
2: Group by employee/position

show_empty (accepted)

enum (0, 1)

Show empty

0: Do not show empty
1: Show empty

split_overnight (accepted)

enum (0, 1)

Show empty

0: Do not show empty
1: Show empty

remote_site (accepted)

integer

Remote site id

options (accepted)

integer

include_unapproved_ts (accepted)

integer

If set to 1, all time sheets (approved and unapproved) will be included into calculation.
Default value: 0

include_remote_sites (accepted)

integer

terminal_location (accepted)

integer

Terminal location id

show_only_mine (accepted)

enum(0,1)

show_break_times (accepted)

integer

include_notes (accepted)

enum(0,1)

0: do not notes
1: include notes

DOCUMENTATION

GET
Run Payroll Specific Reports on schedule / time sheet data.
Level 3 is required.

--

Example Request:

    {
       "module":"payroll.report",
       "method":"GET",
       "request":{
          "type":"timesheets",
          "employee":"258265"
          "start_date":"10/09/2013",
          "end_date":"10/15/2013"
       }
    }

Example Response:

{  
    "status":1,
    "data":[  
        {  
            "eid":"l123",
            "end_time":"5:00pm",
            "clock":"3952393",
            "date":{  
                "id":1624,
                "week":41,
                "formatted":"Oct 9, 2013",
                "dayid":4,
                "weekday":"Wed",
                "mname":"Oct",
                "month":10,
                "timestamp":1381269600,
                "year":2013,
                "day":9
            },
            "out_date":{  
                "id":1624,
                "week":41,
                "formatted":"Oct 9, 2013",
                "dayid":4,
                "weekday":"Wed",
                "mname":"Oct",
                "month":10,
                "timestamp":1381269600,
                "year":2013,
                "day":9
            },
            "userid":"258265",
            "start_time":"7:00am",
            "notes":"",
            "overnight":false,
            "employee":"Lisa",
            "hours":{  
                "regular":0,
                "cost":165,
                "ratecard":{  
                    "name":"Default Card",
                    "override_payroll":"0",
                    "pay_code":null,
                    "id":11264
                },
                "position":{  
                    "name":"Kids",
                    "id":"153311",
                    "start":"1",
                    "job_code":null,
                    "visible":"1",
                    "active":"1",
                    "color":"1",
                    "end":"97",
                    "user":"258225",
                    "ical":"41acb6085ceec40616c3a40b2a57a674",
                    "store":"18769",
                    "notify":"1"
                },
                "overtime":10,
                "rate":"10",
                "special":0,
                "breaks":0,
                "d_overtime":2,
                "total":10,
                "location":{  
                    "lon":"-95.71289100000001",
                    "name":"Springfield",
                    "id":"46233",
                    "country":"",
                    "notes":"",
                    "lat":"37.09024",
                    "type":"1",
                    "store":"18769",
                    "address":"United States",
                    "timezone_id":"314"
                },
                "base_wage":"10"
            }
        },
        {  
            "eid":"l123",
            "end_time":"11:51am",
            "clock":"3952399",
            "date":{  
                "id":1624,
                "week":41,
                "formatted":"Oct 9, 2013",
                "dayid":4,
                "weekday":"Wed",
                "mname":"Oct",
                "month":10,
                "timestamp":1381269600,
                "year":2013,
                "day":9
            },
            "out_date":{  
                "id":1624,
                "week":41,
                "formatted":"Oct 9, 2013",
                "dayid":4,
                "weekday":"Wed",
                "mname":"Oct",
                "month":10,
                "timestamp":1381269600,
                "year":2013,
                "day":9
            },
            "userid":"258265",
            "start_time":"11:32am",
            "notes":"",
            "overnight":false,
            "employee":"Lisa",
            "hours":{  
                "regular":0,
                "cost":"22.5",
                "ratecard":{  
                    "name":"Default Card",
                    "override_payroll":"0",
                    "pay_code":null,
                    "id":11264
                },
                "position":{  
                    "name":"",
                    "id":""
                },
                "overtime":"0.31583333333333",
                "rate":"10",
                "special":0,
                "breaks":0,
                "d_overtime":"0.31583333333333",
                "total":"0.31583333333333",
                "location":{  
                    "name":"",
                    "id":""
                },
                "base_wage":"10"
            }
        }
    ],
    "token":"xxxxxxx"
    }
Suggest Edits

payroll.ratecards

 

Returns a list of payroll rate cards.

SUPPORTED METHODS:

GET

Paremeters
Type
Description

token (Required)

Valid token

DOCUMENTATION

GET
Retrieves a list of payroll rate cards.
Level 5 is required

--

Example Request:

     {
        "method":"GET",
        "module":"payroll.ratecards",
        "request":{
 
        }
     }

Example Response:

  {  
    "status":1,
    "data":[  
        {  
            "id":"1",
            "name":"Default Card",
            "created":"1319296837",
            "def":"1"
        },
        {  
            "id":"73",
            "name":"Defaults Back Bug",
            "created":"1338474298",
            "def":"0"
        },
        {  
            "id":"2",
            "name":"Double Time",
            "created":"1319296927",
            "def":"0"
        },
        {  
            "id":"115",
            "name":"New Payroll Card",
            "created":"1339409420",
            "def":"0"
        },
        {  
            "id":"122",
            "name":"New Payroll Card 22",
            "created":"1339618952",
            "def":"0"
        },
        {  
            "id":"22",
            "name":"OT Test - Brett",
            "created":"1330918732",
            "def":"0"
        },
        {  
            "id":"109",
            "name":"Rate Card Bug",
            "created":"1339025152",
            "def":"0"
        },
        {  
            "id":"110",
            "name":"Rate Card Bug 2",
            "created":"1339026515",
            "def":"0"
        },
        {  
            "id":"111",
            "name":"Rate Card Bug 3",
            "created":"1339030955",
            "def":"0"
        },
        {  
            "id":"13",
            "name":"Ryan Day Test",
            "created":"1323026034",
            "def":"0"
        },
        {  
            "id":"114",
            "name":"SHR Issue",
            "created":"1339365581",
            "def":"0"
        },
        {  
            "id":"74",
            "name":"STACK UP",
            "created":"1338484585",
            "def":"0"
        },
        {  
            "id":"27",
            "name":"Steve OT Test",
            "created":"1331398094",
            "def":"0"
        },
        {  
            "id":"7",
            "name":"Support",
            "created":"1319514417",
            "def":"0"
        },
        {  
            "id":"8",
            "name":"Test",
            "created":"1319516454",
            "def":"0"
        },
        {  
            "id":"119",
            "name":"Wakatta",
            "created":"1339517493",
            "def":"0"
        },
        {  
            "id":"120",
            "name":"Wakatta 2",
            "created":"1339517515",
            "def":"0"
        }
    ],
    "token":"xxxxxxx"
{  
    "status":1,
    "data":[  
        {  
            "id":"1",
            "name":"Default Card",
            "created":"1319296837",
            "def":"1"
        },
        {  
            "id":"73",
            "name":"Defaults Back Bug",
            "created":"1338474298",
            "def":"0"
        },
        {  
            "id":"2",
            "name":"Double Time",
            "created":"1319296927",
            "def":"0"
        },
        {  
            "id":"115",
            "name":"New Payroll Card",
            "created":"1339409420",
            "def":"0"
        },
        {  
            "id":"122",
            "name":"New Payroll Card 22",
            "created":"1339618952",
            "def":"0"
        },
        {  
            "id":"22",
            "name":"OT Test - Brett",
            "created":"1330918732",
            "def":"0"
        },
        {  
            "id":"109",
            "name":"Rate Card Bug",
            "created":"1339025152",
            "def":"0"
        },
        {  
            "id":"110",
            "name":"Rate Card Bug 2",
            "created":"1339026515",
            "def":"0"
        },
        {  
            "id":"111",
            "name":"Rate Card Bug 3",
            "created":"1339030955",
            "def":"0"
        },
        {  
            "id":"13",
            "name":"Ryan Day Test",
            "created":"1323026034",
            "def":"0"
        },
        {  
            "id":"114",
            "name":"SHR Issue",
            "created":"1339365581",
            "def":"0"
        },
        {  
            "id":"74",
            "name":"STACK UP",
            "created":"1338484585",
            "def":"0"
        },
        {  
            "id":"27",
            "name":"Steve OT Test",
            "created":"1331398094",
            "def":"0"
        },
        {  
            "id":"7",
            "name":"Support",
            "created":"1319514417",
            "def":"0"
        },
        {  
            "id":"8",
            "name":"Test",
            "created":"1319516454",
            "def":"0"
        },
        {  
            "id":"119",
            "name":"Wakatta",
            "created":"1339517493",
            "def":"0"
        },
        {  
            "id":"120",
            "name":"Wakatta 2",
            "created":"1339517515",
            "def":"0"
        }
    ],
    "token":"xxxxxxx"
}{  
    "status":1,
    "data":[  
        {  
            "id":"1",
            "name":"Default Card",
            "created":"1319296837",
            "def":"1"
        },
        {  
            "id":"73",
            "name":"Defaults Back Bug",
            "created":"1338474298",
            "def":"0"
        },
        {  
            "id":"2",
            "name":"Double Time",
            "created":"1319296927",
            "def":"0"
        },
        {  
            "id":"115",
            "name":"New Payroll Card",
            "created":"1339409420",
            "def":"0"
        },
        {  
            "id":"122",
            "name":"New Payroll Card 22",
            "created":"1339618952",
            "def":"0"
        },
        {  
            "id":"22",
            "name":"OT Test - Brett",
            "created":"1330918732",
            "def":"0"
        },
        {  
            "id":"109",
            "name":"Rate Card Bug",
            "created":"1339025152",
            "def":"0"
        },
        {  
            "id":"110",
            "name":"Rate Card Bug 2",
            "created":"1339026515",
            "def":"0"
        },
        {  
            "id":"111",
            "name":"Rate Card Bug 3",
            "created":"1339030955",
            "def":"0"
        },
        {  
            "id":"13",
            "name":"Ryan Day Test",
            "created":"1323026034",
            "def":"0"
        },
        {  
            "id":"114",
            "name":"SHR Issue",
            "created":"1339365581",
            "def":"0"
        },
        {  
            "id":"74",
            "name":"STACK UP",
            "created":"1338484585",
            "def":"0"
        },
        {  
            "id":"27",
            "name":"Steve OT Test",
            "created":"1331398094",
            "def":"0"
        },
        {  
            "id":"7",
            "name":"Support",
            "created":"1319514417",
            "def":"0"
        },
        {  
            "id":"8",
            "name":"Test",
            "created":"1319516454",
            "def":"0"
        },
        {  
            "id":"119",
            "name":"Wakatta",
            "created":"1339517493",
            "def":"0"
        },
        {  
            "id":"120",
            "name":"Wakatta 2",
            "created":"1339517515",
            "def":"0"
        }
    ],
    "token":"xxxxxxx"
  }
Suggest Edits

payroll.ratecard

 

Returns a payroll rate card.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Rate card id

CREATE

Parameters
Type
Description

token (required)

Valid token

name (required)

varchar

Name

stack_overtime (accepted)

enum (0, 1)

Stack overtime

0: Do not stack overtime
1: Stack overtime

DELETE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Rate card id

def (accepted)

enum (0, 1)

Default

0: Not default rate card
1: Default rate card

UPDATE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Rate card id

name (accepted)

varchar

Name

def (accepted)

enum (0,1)

Default

0: Not default rate card
1: Default rate card

rates (accepted)

varchar

Update rates

overtime (accepted)

integer

Overtime

day_limit (accepted)

enum[CREATE,UPDATE,DELETE]

Day limit

CREATE: Create day limit
UPDATE: Update day limit
DELETE: Delete day limit

day_limit_id (accepted)

integer

Day limit id

day_limit_minimum (accepted)

integer

Day limit minimum

day_limit_rate (accepted)

integer

Day limit rate

pay_code (accepted)

varchar

Pay code

stack_overtime (accepted)

enum[0,1]

Stack overtime

0: Do not stack overtime
1: Stack overtime

override_payroll

enum[0,1]

DOCUMENTATION

GET
Retrieves a payroll rate card by id.
Level 5 is required (all users can fetch this module)

--

Example Request:

{
   "method":"GET",
   "module":"payroll.ratecard",
   "request":{
      "id":"198"
   }
}

Example Response:

{
   "status":1,
   "data":{
      "id":"120",
      "name":"Wakatta 2",
      "overtime":"100",
      "created":"1339517515",
      "def":"0",
      "stack_overtime":"0",
      "rates":{
         "1":{
            "name":"Sun",
            "24":"100.00",
            "23":"100.00",
            "22":"100.00",
            "21":"100.00",
            "20":"100.00",
            "19":"100.00",
            "18":"100.00",
            "17":"100.00",
            "16":"100.00",
            "15":"100.00",
            "14":"100.00",
            "13":"100.00",
            "12":"100.00",
            "11":"100.00",
            "10":"100.00",
            "9":"100.00",
            "1":"100",
            "2":"100",
            "3":"100",
            "4":"100",
            "5":"100",
            "6":"100",
            "7":"100",
            "8":"100"
         },
         "2":{
            "name":"Mon",
            "1":"100",
            "2":"100",
            "3":"100",
            "4":"100",
            "5":"100",
            "6":"100",
            "7":"100",
            "8":"100",
            "9":"100",
            "10":"100",
            "11":"100",
            "12":"100",
            "13":"100",
            "14":"100",
            "15":"100",
            "16":"100",
            "17":"100",
            "18":"100",
            "19":"100",
            "20":"100",
            "21":"100",
            "22":"100",
            "23":"100",
            "24":"100"
         },
         "3":{
            "name":"Tue",
            "1":"100",
            "2":"100",
            "3":"100",
            "4":"100",
            "5":"100",
            "6":"100",
            "7":"100",
            "8":"100",
            "9":"100",
            "10":"100",
            "11":"100",
            "12":"100",
            "13":"100",
            "14":"100",
            "15":"100",
            "16":"100",
            "17":"100",
            "18":"100",
            "19":"100",
            "20":"100",
            "21":"100",
            "22":"100",
            "23":"100",
            "24":"100"
         },
         "4":{
            "name":"Wed",
            "1":"100",
            "2":"100",
            "3":"100",
            "4":"100",
            "5":"100",
            "6":"100",
            "7":"100",
            "8":"100",
            "9":"100",
            "10":"100",
            "11":"100",
            "12":"100",
            "13":"100",
            "14":"100",
            "15":"100",
            "16":"100",
            "17":"100",
            "18":"100",
            "19":"100",
            "20":"100",
            "21":"100",
            "22":"100",
            "23":"100",
            "24":"100"
         },
         "5":{
            "name":"Thu",
            "1":"100",
            "2":"100",
            "3":"100",
            "4":"100",
            "5":"100",
            "6":"100",
            "7":"100",
            "8":"100",
            "9":"100",
            "10":"100",
            "11":"100",
            "12":"100",
            "13":"100",
            "14":"100",
            "15":"100",
            "16":"100",
            "17":"100",
            "18":"100",
            "19":"100",
            "20":"100",
            "21":"100",
            "22":"100",
            "23":"100",
            "24":"100"
         },
         "6":{
            "name":"Fri",
            "1":"100",
            "2":"100",
            "3":"100",
            "4":"100",
            "5":"100",
            "6":"100",
            "7":"100",
            "8":"100",
            "9":"100",
            "10":"100",
            "11":"100",
            "12":"100",
            "13":"100",
            "14":"100",
            "15":"100",
            "16":"100",
            "17":"100",
            "18":"100",
            "19":"100",
            "20":"100",
            "21":"100",
            "22":"100",
            "23":"100",
            "24":"100"
         },
         "7":{
            "name":"Sat",
            "9":"200.00",
            "10":"200.00",
            "11":"200.00",
            "12":"200.00",
            "13":"200.00",
            "14":"200.00",
            "15":"200.00",
            "16":"200.00",
            "17":"200.00",
            "18":"200.00",
            "19":"200.00",
            "20":"200.00",
            "21":"200.00",
            "22":"200.00",
            "23":"200.00",
            "24":"200.00",
            "8":"200.00",
            "1":"100.00",
            "2":"100.00",
            "3":"100.00",
            "4":"100.00",
            "5":"100.00",
            "6":"100.00",
            "7":"100.00"
         }
      },
      "day_overtime":[
 
      ]
   },
   "token":"xxxxxxx"
}
Suggest Edits

reports.budget

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Start date

end_date (required)

date

End date

location (accepted)

integer

Location id

remote_site

integer

Remote site id

position

integer

Position id

DOCUMENTATION

GET
Retrieves budget reports, between selected dates.
Level 3 is required.

--

Example Request:

     {
        "module":"reports.budget",
        "method":"GET",
        "request":{
           "start_date":"Dec 1, 2016",
           "end_date":"Dec 10, 2016"
        }
     }

Example Response:

{  
    "status":1,
    "data":{  
        "dates":[  
            {  
                "id":1312,
                "year":2016,
                "week":48,
                "last_day_in_week":true,
                "formatted":"Dec 1, 2016"
            },
            {  
                "id":1313,
                "year":2016,
                "week":49,
                "last_day_in_week":false,
                "formatted":"Dec 2, 2016"
            },
            {  
                "id":1314,
                "year":2016,
                "week":49,
                "last_day_in_week":false,
                "formatted":"Dec 3, 2016"
            },
            {  
                "id":1315,
                "year":2016,
                "week":49,
                "last_day_in_week":false,
                "formatted":"Dec 4, 2016"
            },
            {  
                "id":1316,
                "year":2016,
                "week":49,
                "last_day_in_week":false,
                "formatted":"Dec 5, 2016"
            },
            {  
                "id":1317,
                "year":2016,
                "week":49,
                "last_day_in_week":false,
                "formatted":"Dec 6, 2016"
            },
            {  
                "id":1318,
                "year":2016,
                "week":49,
                "last_day_in_week":false,
                "formatted":"Dec 7, 2016"
            },
            {  
                "id":1319,
                "year":2016,
                "week":49,
                "last_day_in_week":true,
                "formatted":"Dec 8, 2016"
            },
            {  
                "id":1320,
                "year":2016,
                "week":50,
                "last_day_in_week":false,
                "formatted":"Dec 9, 2016"
            },
            {  
                "id":1321,
                "year":2016,
                "week":50,
                "last_day_in_week":false,
                "formatted":"Dec 10, 2016"
            }
        ],
        "weeks":{  
            "2016":{  
                "48":{  
                    "year":2016,
                    "week":48,
                    "start":1306,
                    "end":1312
                },
                "49":{ 
                    "year":2016,
                    "week":49,
                    "start":1313,
                    "end":1319
                }
            }
        },
        "locations":{  
            "0":{  
                "id":0,
                "name":"Schedule Overview",
                "budget":[  

                ],
                "date":{  
                    "1317":3,
                    "1321":10
                },
                "week":{  
                    "2016":{  
                        "49":{  
                            "hours":3
                        },
                        "50":{  
                            "hours":10
                        }
                    }
                }
            },
            "42267":{  
                "id":"42267",
                "name":"New New York",
                "budget":[  

                ],
                "date":{  
                    "1317":3,
                    "1321":10
                },
                "week":{  
                    "2016":{  
                        "49":{  
                            "hours":3
                        },
                        "50":{  
                            "hours":10
                        }
                    }
                }
            }
        }
    },
    "token":"xxxxxxx"
    }
Suggest Edits

reports.custom

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

fields (required)

varchar

Fields

Allowed fields:

type = 'timesheets':
'employee', 'eid', 'user', 'location',
'schedule_id', 'schedule_name','start_day',
'end_day', 'start_time', 'end_time',
'total_time', 'notes'

type = 'confirmedtimesheets':
'employee', 'eid', 'user', 'location',
'schedule_id', 'schedule_name', 'start_day',
'end_day', 'start_time', 'end_time', 'total_time',
'rate', 'ratecard', 'special', 'overtime',
'cost', 'notes'

type = 'shifts':
'employee', 'eid', 'user', 'location',
'schedule_id', 'schedule_name', 'start_day',
'end_day', 'start_time', 'end_time',
'total_time','title','notes'

type = 'confirmedshifts':
'employee', 'eid', 'user', 'location',
'schedule_id', 'schedule_name', 'start_day',
'end_day', 'start_time', 'end_time',
'total_time','title','notes'
type = 'openshifts':
'employees', 'slots', 'location', 'schedule_id',
'schedule_name', 'start_day', 'end_day',
'start_time', 'end_time', 'total_time',
'title','notes', 'published'

start_date (required)

date

Start date

end_date (required)

date

End date

type (required)

enum (timesheets, confirmedtimesheets, shifts, confirmedshifts, openshifts)

Type

timesheets,
confirmedtimesheets,
shifts,
confirmedshifts
openshifts

schedule (accepted)

integer

Schedule id

employee (accepted)

varchar

Employee

location (accepted)

integer

Location id

skill (accepted)

integer

Skill id

deduct_breaks (accepted)

min length 1

isset: Deduct breaks

remote_site (accepted)

integer

Remote site id

options

varchar

DOCUMENTATION

GET
Retrieves a list of custom reports.
Level 3 is required.

--

Example Request:

     {
        "module":"reports.custom",
        "method":"GET",
        "request":{
           "fields":"employee",
           "start_date":"May 19, 2017",
           "end_date":"May 20, 2017",
           "type":"confirmedshifts"
        }
     }

Example Response:

 {
        "status":"1",
        "data":[
           {
              "employee":"Alan"
           },
           {
              "employee":"Bond"
           },
           {
              "employee":"Brian"
           },
           {
              "employee":"Peter"
           },
           {
              "employee":"stewie "
           }
       ],
        "token":"xxxxxxx"
     }
Suggest Edits

reports.employee

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Start date

end_date (required)

date

End date

type (required)

enum (attendance, vacations, availability, unavailability, hourly-availability, vacation-summary)

Report type

attendance: Attendance report
vacations: Vacations report
availability: Availability report
unavailability: Unavailability report

location (accepted)

integer

Location id

schedule (accepted)

varchar

Schedule

employee (accepted)

varchar

Employee id

Array of employees ids (eg. "234,563,770")

skill (accepted)

varchar

Skill id

Skill id (accepted)

integer

Force mater database

0: do not force master
1: force master

remote_site (accepted)

integer

Remote site id

leave_type (accepted)

integer

Remote site id

DOCUMENTATION

GET
Retrieves a list of employee's reports.
Level 5 is required

--

Example Request:

     {
        "method":"GET",
        "module":"reports.employee",
        "request":{
         "start_date":"Dec 15, 2016",
         "end_date":"Dec 16, 2016",
         "type":"availability",
         "employee": 250832
         }
     }

Example Response:

{  
    "status":1,
    "data":{  
        "statuses":{  
            "1":"All Day",
            "2":"Available",
            "3":"On Vacation",
            "4":"Not Available"
        },
        "dates":[  
            {  
                "id":1326,
                "date":{  
                    "id":1326,
                    "month":12,
                    "day":15,
                    "wday":6,
                    "year":2016,
                    "weekday":"Sat",
                    "mname":"Dec",
                    "week":51,
                    "dayid":7,
                    "timeid":1,
                    "formatted":"Dec 15, 2016",
                    "time":"00:00",
                    "timestamp":1355526000,
                    "hours":0,
                    "minutes":0,
                    "seconds":0,
                    "date":"2016-12-15 00:00:00",
                    "day_of_year":"349",
                    "sp_wday":7
                },
                "formatted":"Dec 15, 2016"
            },
            {  
                "id":1327,
                "date":{  
                    "id":1327,
                    "month":12,
                    "day":16,
                    "wday":0,
                    "year":2016,
                    "weekday":"Sun",
                    "mname":"Dec",
                    "week":51,
                    "dayid":1,
                    "timeid":1,
                    "formatted":"Dec 16, 2016",
                    "time":"00:00",
                    "timestamp":1355612400,
                    "hours":0,
                    "minutes":0,
                    "seconds":0,
                    "date":"2016-12-16 00:00:00",
                    "day_of_year":"350",
                    "sp_wday":1
                },
                "formatted":"Dec 16, 2016"
            }
        ],
        "users":[  

        ]
    },
    "token":"xxxxxxx"
}
Suggest Edits

reports.daily_peak_hours_new

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Start date

end_date (required)

date

End date

location (accepted)

varchar

Location

schedule (accepted)

varchar

Schedule

skill (accepted)

varchar

Skill

remote_site (accepted)

integer

Remote site

exclude_disabled_emp (accepted)

enum (-1, 1)

Exclude disabled employees

DOCUMENTATION

GET
Retrieves a list of custom reports.
Level 3 is required.

--

Example Request:

     {
        "module":"reports.daily_peak_hours_new",
        "method":"GET",
        "request":{
           "start_date":"May 1, 2017",
           "end_date":"May 5, 2017",
        }
     }

Example request:

{
  "status": 1,
  "data": {
    "2924": {
      "locations": {
        "0": {
          "1068294": {
            "group_name": "1w -test5",
            "chunks": [],
            "total": 0
          },
          "1068295": {
            "group_name": "Waiter",
            "chunks": {
              "11": 180,
              "12": 360,
              "13": 180,
              "15": 120,
              "16": 180,
              "18": 120,
              "19": 180
            },
            "total": 22
          },
          "1068296": {
            "group_name": "1w -test1",
            "chunks": {
              "11": 180,
              "12": 180,
              "13": 180,
              "14": 180,
              "20": 540,
              "21": 180,
              "22": 180
            },
            "total": 27
          },
          "1068297": {
            "group_name": "1w -test2",
            "chunks": {
              "10": 120,
              "11": 120,
              "15": 180,
              "16": 180,
              "17": 180,
              "23": 180
            },
            "total": 16
          },
          "1074363": {
            "group_name": "1w -test4",
            "chunks": {
              "17": 420
            },
            "total": 7
          },
          "1419138": {
            "group_name": "1w -test7",
            "chunks": [],
            "total": 0
          },
          "1419140": {
            "group_name": "1w -test3",
            "chunks": [],
            "total": 0
          },
          "1419145": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1419167": {
            "group_name": "Test 3",
            "chunks": [],
            "total": 0
          },
          "1507657": {
            "group_name": "1w -test6",
            "chunks": [],
            "total": 0
          },
          "1574713": {
            "group_name": "API Position",
            "chunks": [],
            "total": 0
          },
          "location_name": "Company Default Location"
        },
        "574075": {
          "1419141": {
            "group_name": "Pozicija 2",
            "chunks": [],
            "total": 0
          },
          "1419142": {
            "group_name": "Pozicija 3",
            "chunks": [],
            "total": 0
          },
          "1419143": {
            "group_name": "Pozicija 4",
            "chunks": [],
            "total": 0
          },
          "location_name": "New Humanity"
        },
        "604850": {
          "1491344": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1491345": {
            "group_name": "Test 1",
            "chunks": [],
            "total": 0
          },
          "location_name": "Lokacija 1"
        },
        "613062": {
          "1497176": {
            "group_name": "Sample Position",
            "chunks": [],
            "total": 0
          },
          "1497177": {
            "group_name": "Barista",
            "chunks": [],
            "total": 0
          },
          "1497178": {
            "group_name": "Expeditor/Barback",
            "chunks": [],
            "total": 0
          },
          "1497179": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "1551136": {
            "group_name": "API test position",
            "chunks": [],
            "total": 0
          },
          "1585960": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "location_name": "Abraco"
        }
      },
      "total": 72
    },
    "2925": {
      "locations": {
        "0": {
          "1068294": {
            "group_name": "1w -test5",
            "chunks": {
              "19": 60,
              "20": 60,
              "21": 60,
              "22": 60,
              "23": 60
            },
            "total": 5
          },
          "1068295": {
            "group_name": "Waiter",
            "chunks": {
              "8": 180,
              "9": 360,
              "10": 180,
              "11": 60,
              "12": 120,
              "13": 60,
              "16": 60,
              "19": 60
            },
            "total": 18
          },
          "1068296": {
            "group_name": "1w -test1",
            "chunks": {
              "0": 135,
              "11": 60,
              "12": 60,
              "13": 60,
              "14": 60,
              "21": 60,
              "22": 60
            },
            "total": 8.25
          },
          "1068297": {
            "group_name": "1w -test2",
            "chunks": {
              "8": 120,
              "9": 120,
              "15": 60,
              "16": 60,
              "17": 60,
              "23": 60
            },
            "total": 8
          },
          "1074363": {
            "group_name": "1w -test4",
            "chunks": {
              "17": 60
            },
            "total": 1
          },
          "1419138": {
            "group_name": "1w -test7",
            "chunks": [],
            "total": 0
          },
          "1419140": {
            "group_name": "1w -test3",
            "chunks": [],
            "total": 0
          },
          "1419145": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1419167": {
            "group_name": "Test 3",
            "chunks": [],
            "total": 0
          },
          "1507657": {
            "group_name": "1w -test6",
            "chunks": [],
            "total": 0
          },
          "1574713": {
            "group_name": "API Position",
            "chunks": [],
            "total": 0
          },
          "location_name": "Company Default Location"
        },
        "574075": {
          "1419141": {
            "group_name": "Pozicija 2",
            "chunks": [],
            "total": 0
          },
          "1419142": {
            "group_name": "Pozicija 3",
            "chunks": [],
            "total": 0
          },
          "1419143": {
            "group_name": "Pozicija 4",
            "chunks": [],
            "total": 0
          },
          "location_name": "New Humanity"
        },
        "604850": {
          "1491344": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1491345": {
            "group_name": "Test 1",
            "chunks": [],
            "total": 0
          },
          "location_name": "Lokacija 1"
        },
        "613062": {
          "1497176": {
            "group_name": "Sample Position",
            "chunks": [],
            "total": 0
          },
          "1497177": {
            "group_name": "Barista",
            "chunks": [],
            "total": 0
          },
          "1497178": {
            "group_name": "Expeditor/Barback",
            "chunks": [],
            "total": 0
          },
          "1497179": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "1551136": {
            "group_name": "API test position",
            "chunks": [],
            "total": 0
          },
          "1585960": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "location_name": "Abraco"
        }
      },
      "total": 40.25
    },
    "2926": {
      "locations": {
        "0": {
          "1068294": {
            "group_name": "1w -test5",
            "chunks": [
              60,
              60,
              60
            ],
            "total": 3
          },
          "1068295": {
            "group_name": "Waiter",
            "chunks": {
              "8": 60,
              "9": 120,
              "10": 60,
              "11": 60,
              "12": 120,
              "13": 60,
              "16": 60,
              "19": 60
            },
            "total": 10
          },
          "1068296": {
            "group_name": "1w -test1",
            "chunks": {
              "0": 45,
              "11": 60,
              "12": 60,
              "13": 60,
              "14": 60,
              "21": 60,
              "22": 60
            },
            "total": 6.75
          },
          "1068297": {
            "group_name": "1w -test2",
            "chunks": {
              "15": 60,
              "16": 60,
              "17": 60,
              "23": 60
            },
            "total": 4
          },
          "1074363": {
            "group_name": "1w -test4",
            "chunks": {
              "17": 60
            },
            "total": 1
          },
          "1419138": {
            "group_name": "1w -test7",
            "chunks": [],
            "total": 0
          },
          "1419140": {
            "group_name": "1w -test3",
            "chunks": [],
            "total": 0
          },
          "1419145": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1419167": {
            "group_name": "Test 3",
            "chunks": [],
            "total": 0
          },
          "1507657": {
            "group_name": "1w -test6",
            "chunks": [],
            "total": 0
          },
          "1574713": {
            "group_name": "API Position",
            "chunks": [],
            "total": 0
          },
          "location_name": "Company Default Location"
        },
        "574075": {
          "1419141": {
            "group_name": "Pozicija 2",
            "chunks": [],
            "total": 0
          },
          "1419142": {
            "group_name": "Pozicija 3",
            "chunks": [],
            "total": 0
          },
          "1419143": {
            "group_name": "Pozicija 4",
            "chunks": [],
            "total": 0
          },
          "location_name": "New Humanity"
        },
        "604850": {
          "1491344": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1491345": {
            "group_name": "Test 1",
            "chunks": [],
            "total": 0
          },
          "location_name": "Lokacija 1"
        },
        "613062": {
          "1497176": {
            "group_name": "Sample Position",
            "chunks": [],
            "total": 0
          },
          "1497177": {
            "group_name": "Barista",
            "chunks": [],
            "total": 0
          },
          "1497178": {
            "group_name": "Expeditor/Barback",
            "chunks": [],
            "total": 0
          },
          "1497179": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "1551136": {
            "group_name": "API test position",
            "chunks": [],
            "total": 0
          },
          "1585960": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "location_name": "Abraco"
        }
      },
      "total": 24.75
    },
    "2927": {
      "locations": {
        "0": {
          "1068294": {
            "group_name": "1w -test5",
            "chunks": [],
            "total": 0
          },
          "1068295": {
            "group_name": "Waiter",
            "chunks": {
              "8": 60,
              "9": 120,
              "10": 60,
              "11": 60,
              "12": 120,
              "13": 60,
              "16": 120,
              "19": 60
            },
            "total": 11
          },
          "1068296": {
            "group_name": "1w -test1",
            "chunks": {
              "0": 45,
              "11": 60,
              "12": 60,
              "13": 60,
              "14": 60,
              "21": 60,
              "22": 60
            },
            "total": 6.75
          },
          "1068297": {
            "group_name": "1w -test2",
            "chunks": {
              "15": 60,
              "16": 60,
              "17": 60,
              "23": 60
            },
            "total": 4
          },
          "1074363": {
            "group_name": "1w -test4",
            "chunks": {
              "17": 60
            },
            "total": 1
          },
          "1419138": {
            "group_name": "1w -test7",
            "chunks": [],
            "total": 0
          },
          "1419140": {
            "group_name": "1w -test3",
            "chunks": [],
            "total": 0
          },
          "1419145": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1419167": {
            "group_name": "Test 3",
            "chunks": [],
            "total": 0
          },
          "1507657": {
            "group_name": "1w -test6",
            "chunks": [],
            "total": 0
          },
          "1574713": {
            "group_name": "API Position",
            "chunks": [],
            "total": 0
          },
          "location_name": "Company Default Location"
        },
        "574075": {
          "1419141": {
            "group_name": "Pozicija 2",
            "chunks": [],
            "total": 0
          },
          "1419142": {
            "group_name": "Pozicija 3",
            "chunks": [],
            "total": 0
          },
          "1419143": {
            "group_name": "Pozicija 4",
            "chunks": [],
            "total": 0
          },
          "location_name": "New Humanity"
        },
        "604850": {
          "1491344": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1491345": {
            "group_name": "Test 1",
            "chunks": [],
            "total": 0
          },
          "location_name": "Lokacija 1"
        },
        "613062": {
          "1497176": {
            "group_name": "Sample Position",
            "chunks": [],
            "total": 0
          },
          "1497177": {
            "group_name": "Barista",
            "chunks": [],
            "total": 0
          },
          "1497178": {
            "group_name": "Expeditor/Barback",
            "chunks": [],
            "total": 0
          },
          "1497179": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "1551136": {
            "group_name": "API test position",
            "chunks": [],
            "total": 0
          },
          "1585960": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "location_name": "Abraco"
        }
      },
      "total": 22.75
    },
    "2928": {
      "locations": {
        "0": {
          "1068294": {
            "group_name": "1w -test5",
            "chunks": [],
            "total": 0
          },
          "1068295": {
            "group_name": "Waiter",
            "chunks": {
              "8": 60,
              "9": 120,
              "10": 60,
              "11": 60,
              "12": 120,
              "13": 60,
              "19": 60
            },
            "total": 9
          },
          "1068296": {
            "group_name": "1w -test1",
            "chunks": {
              "0": 45,
              "11": 60,
              "12": 60,
              "13": 60,
              "14": 60,
              "21": 60,
              "22": 60
            },
            "total": 6.75
          },
          "1068297": {
            "group_name": "1w -test2",
            "chunks": {
              "15": 60,
              "16": 60,
              "17": 60,
              "23": 60
            },
            "total": 4
          },
          "1074363": {
            "group_name": "1w -test4",
            "chunks": {
              "17": 60
            },
            "total": 1
          },
          "1419138": {
            "group_name": "1w -test7",
            "chunks": [],
            "total": 0
          },
          "1419140": {
            "group_name": "1w -test3",
            "chunks": [],
            "total": 0
          },
          "1419145": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1419167": {
            "group_name": "Test 3",
            "chunks": [],
            "total": 0
          },
          "1507657": {
            "group_name": "1w -test6",
            "chunks": [],
            "total": 0
          },
          "1574713": {
            "group_name": "API Position",
            "chunks": [],
            "total": 0
          },
          "location_name": "Company Default Location"
        },
        "574075": {
          "1419141": {
            "group_name": "Pozicija 2",
            "chunks": [],
            "total": 0
          },
          "1419142": {
            "group_name": "Pozicija 3",
            "chunks": [],
            "total": 0
          },
          "1419143": {
            "group_name": "Pozicija 4",
            "chunks": [],
            "total": 0
          },
          "location_name": "New Humanity"
        },
        "604850": {
          "1491344": {
            "group_name": "Test 2",
            "chunks": [],
            "total": 0
          },
          "1491345": {
            "group_name": "Test 1",
            "chunks": [],
            "total": 0
          },
          "location_name": "Lokacija 1"
        },
        "613062": {
          "1497176": {
            "group_name": "Sample Position",
            "chunks": [],
            "total": 0
          },
          "1497177": {
            "group_name": "Barista",
            "chunks": [],
            "total": 0
          },
          "1497178": {
            "group_name": "Expeditor/Barback",
            "chunks": [],
            "total": 0
          },
          "1497179": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "1551136": {
            "group_name": "API test position",
            "chunks": [],
            "total": 0
          },
          "1585960": {
            "group_name": "Baker",
            "chunks": [],
            "total": 0
          },
          "location_name": "Abraco"
        }
      },
      "total": 20.75
    }
  },
  "token": "xxxxxxx"
}
Suggest Edits

reports.daily_peek_hours

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Start date

end_date (required)

date

Start date

location

varchar

Location

DOCUMENTATION

GET
Retrieves daily peak hours between selected dates.
Level 3 is required.

--

Example Request:

     {
        "method":"GET",
        "module":"reports.daily_peak_hours",
        "request":{
           "start_date":"May 10, 2017",
           "end_date":"May 20, 2017",
        }
     }

Example Response:

{  
    "status":1,
    "data":{  
        "dates":{  
            "1168":{  
                "id":1168,
                "formatted":"Jul 10, 2017"
            },
            "1169":{  
                "id":1169,
                "formatted":"Jul 11, 2017"
            },
            "1170":{  
                "id":1170,
                "formatted":"Jul 12, 2017"
            },
            "1171":{  
                "id":1171,
                "formatted":"Jul 13, 2017"
            },
            "1172":{  
                "id":1172,
                "formatted":"Jul 14, 2017"
            },
            "1173":{  
                "id":1173,
                "formatted":"Jul 15, 2017"
            },
            "1174":{  
                "id":1174,
                "formatted":"Jul 16, 2017"
            },
            "1175":{  
                "id":1175,
                "formatted":"Jul 17, 2017"
            },
            "1176":{  
                "id":1176,
                "formatted":"Jul 18, 2017"
            },
            "1177":{  
                "id":1177,
                "formatted":"Jul 19, 2017"
            },
            "1178":{  
                "id":1178,
                "formatted":"Jul 20, 2017"
            }
        },
        "locations":[  
            {  
                "id":0,
                "name":"Schedule Overview",
                "date":{  
                    "1168":13.5,
                    "1169":6,
                    "1170":6,
                    "1171":32,
                    "1172":6,
                    "1173":6,
                    "1174":6,
                    "1175":24,
                    "1176":2,
                    "1177":2,
                    "1178":2
                },
                "total":105.5
            },
            {  
                "id":"294",
                "name":"Budget",
                "date":{  
                    "1168":7.5
                },
                "total":7.5
            }
        ]
    },
    "token":"xxxxxxx"
    }
Suggest Edits

reports.schedule

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Start date

end_date (required)

date

End date

type (required)

enum (schedule_summary, shift_confirmed, crib_sheet, shift_exchanges, open_shifts, position_summary, shift_acknowledgement)

Type

schedule_summary: Schedule summary
shift_confirmed: Confirmed shifts
crib_sheet: Crib sheet
shift_exchanges: Shift exchanges
open_shifts: Open shifts
position_summary: Position summary

location (accepted)

integer

Location id

schedule (accepted)

integer

Schedule id

employee (accepted)

integer

Employees

Array of employees ids (eg. "234,563,770")

skill (accepted)

integer

Skill id

with_statuses (accepted)

integer

With or without statuses

null : without statuses
isset: with statuses

options (accepted)

integer

1: Order by name

deductbreaks (accepted)

integer

Deduct breaks

remote_site (accepted)

integer

Remote site id

include_emp_per_pos (accepted)

integer

Include employees per position

acknowledgement_status (accepted)

varchar

Acknowledgement status

DOCUMENTATION

GET
Retrives a list of schedule reports betwen selected dates.
Level 5 is required (all users can fetch this module)

--

Example Request:

     {
        "method":"GET",
        "module":"reports.schedule",
        "request":{
           "start_date":"May 19, 2017",
           "end_date":"May 21, 2017",
           "type":"open_shifts"
        }
     }

Example Response:

{  
    "status":1,
    "data":{  
        "82185":{  
            "id":"82185",
            "series":"82015",
            "created":"1311728514",
            "published":"1339668653",
            "edited":"1311728514",
            "deleted":"0",
            "recurs":"1",
            "recur_rule":"2",
            "schedule":"866",
            "store":"11",
            "type":"1",
            "needed":"1",
            "have":"0",
            "working":"0",
            "user":"2",
            "start_date":{  
                "id":"1116",
                "month":"5",
                "day":"19",
                "year":"2017",
                "weekday":"Sat",
                "mname":"May",
                "week":"20",
                "dayid":7,
                "formatted":"May 19, 2017"
            },
            "end_date":{  
                "id":"1116",
                "month":"5",
                "day":"19",
                "year":"2017",
                "weekday":"Sat",
                "mname":"May",
                "week":"20",
                "dayid":7,
                "formatted":"May 19, 2017"
            },
            "start":"11 am",
            "end":"5 pm",
            "length":"0",
            "title":"",
            "location":"0",
            "notes":"",
            "confirmed":"0",
            "schedule_name":"Development",
            "schedule_color":"657050",
            "employee":[  
                null
            ]
        },
        "93829":{  
            "id":"93829",
            "series":"0",
            "created":"1337631224",
            "published":"1339668653",
            "edited":"1337631231",
            "deleted":"0",
            "recurs":"0",
            "recur_rule":"0",
            "schedule":"32410",
            "store":"11",
            "type":"1",
            "needed":"3",
            "have":"0",
            "working":"0",
            "user":"5148",
            "start_date":{  
                "id":"1117",
                "month":"5",
                "day":"20",
                "year":"2017",
                "weekday":"Sun",
                "mname":"May",
                "week":"20",
                "dayid":1,
                "formatted":"May 20, 2017"
            },
            "end_date":{  
                "id":"1117",
                "month":"5",
                "day":"20",
                "year":"2017",
                "weekday":"Sun",
                "mname":"May",
                "week":"20",
                "dayid":1,
                "formatted":"May 20, 2017"
            },
            "start":"8 am",
            "end":"4 pm",
            "length":"0",
            "title":"",
            "location":"0",
            "notes":"",
            "confirmed":"0",
            "schedule_name":"Cash",
            "schedule_color":"570026",
            "employee":[  
                null
            ]
        },
        "93901":{  
            "id":"93901",
            "series":"0",
            "created":"1337632834",
            "published":"1339668653",
            "edited":"1337934987",
            "deleted":"0",
            "recurs":"0",
            "recur_rule":"0",
            "schedule":"32408",
            "store":"11",
            "type":"1",
            "needed":"5",
            "have":"0",
            "working":"0",
            "user":"4910",
            "start_date":{  
                "id":"1119",
                "month":"5",
                "day":"22",
                "year":"2017",
                "weekday":"Tue",
                "mname":"May",
                "week":"21",
                "dayid":3,
                "formatted":"May 22, 2017"
            },
            "end_date":{  
                "id":"1119",
                "month":"5",
                "day":"22",
                "year":"2017",
                "weekday":"Tue",
                "mname":"May",
                "week":"21",
                "dayid":3,
                "formatted":"May 22, 2017"
            },
            "start":"8 am",
            "end":"5 pm",
            "length":"0",
            "title":"",
            "location":"0",
            "notes":"",
            "confirmed":"0",
            "schedule_name":"Admin\/meetings",
            "schedule_color":"484948",
            "employee":[  
                null
            ]
        }
    },
    "token":"xxxxxxx"
}
Suggest Edits

reports.tasks

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (accepted)

date

Start date

end_date (accepted)

date

End date

employee (accepted)

integer

Employee id

schedule (accepted)

integer

Position id

task (accepted)

integer

Task

location (accepted)

varchar

Location

task_state (accepted)

varchar

Task state

remote_site (accepted)

integer

Remote site

DOCUMENTATION

GET
Returns a list of worked units
Level 5 is required

--

Example Request:

   {
         "module":"reports.tasks",
         "method":"GET",
         "request":{
         }
     }

Example response:

{
  "status": 1,
  "data": [
    {
      "start_time": "Not started",
      "start_date": "Not started",
      "end_time": "Not completed",
      "end_date": "Not completed",
      "task_name": "task 2",
      "employee": "Brus Vejn",
      "duration": "0:00:00",
      "id": "2165774",
      "eid": "2222",
      "shift": "380740254"
    },
    {
      "start_time": "Not started",
      "start_date": "Not started",
      "end_time": "Not completed",
      "end_date": "Not completed",
      "task_name": "Task",
      "employee": "Hak Fin",
      "duration": "0:00:00",
      "id": "2098071",
      "eid": "",
      "shift": "381607716"
    },
    {
      "start_time": "Not started",
      "start_date": "Not started",
      "end_time": "Not completed",
      "end_date": "Not completed",
      "task_name": "task 2",
      "employee": "Brus Vejn",
      "duration": "0:00:00",
      "id": "2165774",
      "eid": "2222",
      "shift": "381327629"
    }
  ],
  "token": "xxxxxxx"
}
Suggest Edits

reports.timesheets

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Start date

end_date (required)

date

End date

type (required)

enum (timesheets_summary, timesheets_attendance, timesheets_late_summary)

Type

timesheets_summary: Timesheets summary
timesheets_attendance: Timesheets attendance
timesheets_late_summary:
Timesheets late summary

deductbreaks (accepted)

integer

Deduct breaks

null or 0 : Do not deduct breaks
1: Deduct breaks

location (accepted)

integer

Location

schedule (accepted)

varchar

Schedule

employee (accepted)

varchar

Employee

skill (accepted)

varchar

Skill

remote_site (accepted)

integer

Remote site

approval_status

integer

DOCUMENTATION

GET
Retrieves a list of timesheet reports.
Level 5 is required (all users can fetch this module)

--

Example Request:

     {
        "method":"GET",
        "module":"reports.schedule",
        "request":{
           "start_date":"1",
           "end_date":"15",
           "location":"342",
           "schedule":"1584",
           "employee":"954",
           "skill":"24",
           "type":"timesheets_summary"
        }
     }

Example Response:

{
        "status":"1",
        "data":{
           "id":"1376",
           "name":"John Smith",
           "shifts":"0",
           "hours_scheduled":"0",
           "hours_clocked":"0",
           "late":"0",
           "absent":"0",
           "karma":"0",
           "percent":"0"
        },
        "token":"xxxxxxxx"
 }
Suggest Edits

reports.workunits

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (accepted)

date

Start date

end date (accepted)

date

End date

employee (accepted)

varchar

Employee id

schedule (accepted)

varchar

Position id

task (deprecated)

varchar

Task

location (accepted)

varchar

Location id

task_state (depricated)

varchar

Task state

workunit (accepted)

varchar

Work Unit id - retrieve report only for this work unit

remote_site (accepted)

varchar

Remote site id

group_results (accepted)

enum [0, 1, 2]

0 - Default value - Don’t group
1 - Group by Employee
2 - Group by Employee & Position

DOCUMENTATION

GET
Returns a list of worked units
Level 5 is required

--

Example Request:

 {
     "module":"reports.workunits",
     "method":"GET",
     "request":{
          }
 }

Example Response:

{  
    "status":1,
    "token":"xxxxxxx",
    "data":[  
        {  
            "end_time":"4:00pm",
            "cost":"27.5",
            "date":"Oct 8, 2014",
            "worked_units":"55",
            "workunit_name":"Staples",
            "employee_id":"878708",
            "position":"Student",
            "start_time":"8:00am",
            "payrate":"0.50",
            "d":"2014-10-08 08:00:00",
            "position_id":605692,
            "employee":"John Doe",
            "location":"WorkShop",
            "employee_eid":null
        },
        {  
            "end_time":"4:00pm",
            "cost":10,
            "date":"Oct 8, 2014",
            "worked_units":"10",
            "workunit_name":"Cards",
            "employee_id":"878708",
            "position":"Student",
            "start_time":"8:00am",
            "payrate":"1.00",
            "d":"2014-10-08 08:00:00",
            "position_id":605692,
            "employee":"John Doe",
            "location":"WorkShop",
            "employee_eid":null
        },
        {  
            "end_time":"10:00pm",
            "cost":10,
            "date":"Oct 8, 2014",
            "worked_units":"10",
            "workunit_name":"Cards",
            "employee_id":"878708",
            "position":"Student",
            "start_time":"7:00pm",
            "payrate":"1.00",
            "d":"2014-10-08 19:00:00",
            "position_id":605692,
            "employee":"John Doe",
            "location":"WorkShop",
            "employee_eid":null
        },
        {  
            "end_time":"N/A",
            "cost":"2.5",
            "date":"Oct 9, 2014",
            "worked_units":"5",
            "workunit_name":"Staples",
            "employee_id":"878708",
            "position":"Student",
            "start_time":"N/A",
            "payrate":"0.50",
            "d":"Oct 9, 2014",
            "position_id":605692,
            "employee":"John Doe",
            "location":"WorkShop",
            "employee_eid":null
        }
      ]
    }
Suggest Edits

reports.wu_daily_reports

 

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (accepted)

date

Start date

end_date (accepted)

date

End date

employee (accepted)

varchar

Employee

schedule (accepted)

varchar

Position

task (deprecated)

varchar

Task

location (accepted)

varchar

Location

task_state (deprecated)

varchar

Task state

workunit (accepted)

varchar

Work unit

remote_site (accepted)

varchar

Remote site

DOCUMENTATION

GET
Returns a list of worked units
Level 5 is required

--
Example Request:

   {
         "module":"reports.wu_daily_report",
         "method":"GET",
         "request":{
             "start_date":"Oct 8, 2014",
             "end_date":"Oct 9, 2014"
         }
     }

Example response:


{  
    "status":1,
    "token":"xxxxxxx",
    "data":{  
        "wu_names":{  
            "605692":{  
                "108":"Cards",
                "107":"Staples"
            }
        },
        "data":{  
            "605692":{  
                "86941866":{  
                    "878708":{  
                        "start":"8:00am",
                        "cost":"37.5",
                        "worked_units":{  
                            "108":"10",
                            "107":"55"
                        },
                        "end":"4:00pm",
                        "employee_id":"878708",
                        "position":"Student",
                        "employee":"John Doe",
                        "location":"WorkShop",
                        "employee_eid":null
                    }
                },
                "1412838000878708":{  
                    "878708":{  
                        "start":"N/A",
                        "cost":"2.5",
                        "worked_units":{  
                            "108":0,
                            "107":"5"
                        },
                        "end":"N/A",
                        "employee_id":"878708",
                        "position":"Student",
                        "employee":"John Doe",
                        "location":"WorkShop",
                        "employee_eid":null
                    }
                },
                "86941886":{  
                    "878708":{  
                        "start":"7:00pm",
                        "cost":10,
                        "worked_units":{  
                            "108":"10",
                            "107":0
                        },
                        "end":"10:00pm",
                        "employee_id":"878708",
                        "position":"Student",
                        "employee":"John Doe",
                        "location":"WorkShop",
                        "employee_eid":null
                    }
                }
            }
        }
      }
}
Suggest Edits

schedule.adjust

 

Adjust a schedule using the adjust shift times wizard.

SUPPORTED METHODS:

UPDATE

Parameters
Type
Description

token (required)

Valid token

from (required)

date

Adjust shifts from date

to (required)

date

Adjust shifts to date - including that date

budge (required)

integer

Number of hours

location (accepted)

integer

Location id

flag (accepted)

enum (1, 2, 3, 4, 5, 6, 7)

1: Don't adjust shifts created during this timeline
2: Don't adjust shifts edited during this timeline
3: 1&2
4: Don't adjust shifts published during this timeline
5: 1&4
6: 2&4
7: 1&2&4

DOCUMENTATION

UPDATE
This method enables you to move your shifts n hours back and fourth.
Level 2 is required.

--

Example Request:

{
   "module":"schedule.adjust",
   "method":"UPDATE",
   "request":{
      "budge":1,
      "flag":3,
      "from":"Nov 18, 2017",
      "to":"Nov 24, 2017",
      "location":40456
   }
}

Example Response:

{
   "status":1,
   "data":[
      {
         "success":true,
         "affected_rows":0
      }
   ],
   "token":"xxxxxxx"
}
Suggest Edits

schedule.breakrule

 

Management of break rules.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Schedule id

CREATE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Schedule id

break (required)

integer

Break length in minutes

paid (required)

enum (0,1)

0 - not paid
1 - paid

min (accepted)

varchar

Minimum shift time

max (accepted)

varchar

Maximum shift time

exact (accepted)

varchar

DELETE

Parameters
Type
Description

token (required)

Valid token

id (required)

integer

Break rule id

DOCUMENTATION

GET
Retrieves all break rules for schedule.
Level 3 is required.

--

Example Request:

{
   "module":"schedule.breakrule",
   "method":"GET",
   "request":{
      "id":138641
   }
}

Example Response:

{
   "status":1,
   "data":[
      {
         "id":"31733",
         "store":"17949",
         "schedule":"138641",
         "user":"247525",
         "min":"1",
         "max":"9",
         "break":"15",
         "paid":"1",
         "date":"1352377163"
      }
     
}

CREATE
Creates a new break rule.
Level 3 is required.

--

Example request:

{
   "module":"schedule.breakrule",
   "method":"CREATE",
   "request":{
      "id":31733,
      "break":15,
      "paid":1,
      "min":"1",
      "max":"9"
   }
}

Example Response:

{
   "status":1,
   "data":"Breakrule Created",
   "token":"xxxxxxx"
}

DELETE
Deletes break rule.
Level 3 is required.

--

Example Request:

{
   "module":"schedule.breakrule",
   "method":"DELETE",
   "request":{
      "id":26911
   }
}

Example Response:

{
   "status":1,
   "data":"Breakrule Removed",
   "token":"xxxxxxx"
}
Suggest Edits

schedule.collisons

 

Returns a list of schedule collisions.

SUPPORTED METHODS:

GET

Parameters
Type
Description

token (required)

Valid token

start_date (required)

date

Start date

end_date (required)

date

End date

group_by

enum (1, 2)

DOCUMENTATION

GET
Level 7 is required

--

Example Request:

{
   "module":"schedule.collisions",
   "method":"GET",
   "request":{
      "start_date":"May 1, 2017",
      "end_date":"May 2, 2017"
   }
}

Example response:

{
  "status": 1,
  "data": [
    {
      "type": 5,
      "user": 2544639,
      "position": 1068296,
      "extras": {
        "shift": 337612824,
        "shifts": [
          399054609,
          399054610
        ]
      }
    },
    {
      "type": 5,
      "user": 2544639,
      "position": 1068296,
      "extras": {
        "shift": 399054609,
        "shifts": [
          337612824,
          399054610
        ]
      }
    },
    {
      "type": 5,
      "user": 2544639,
      "position": 1068296,
      "extras": {
        "shift": 399054610,
        "shifts": [
          337612824,
          399054609
        ]
      }
    },
    {
      "type": 9,
      "user": 2799483,
      "position": 1068295,
      "extras": {
        "shift": 337612830,
        "name": "API"
      }
    },
    {
      "type": 5,
      "user": 2799483,
      "position": 1068295,
      "extras": {
        "shift": 337612830,
        "shifts": [
          399054614,
          399054615
        ]
      }
    },
    {
      "type": 9,
      "user": 2799483,
      "position": 1068295,
      "extras": {
        "shift": 399054614,
        "name": "API"
      }
    },
    {
      "type": 5,
      "user": 2799483,
      "position": 1068295,
      "extras": {
        "shift": 399054614,
        "shifts": [
          337612830,
          399054615
        ]
      }
    },
    {
      "type": 9,
      "user": 2799483,
      "position": 1068295,
      "extras": {
        "shift": 399054615,
        "name": "API"
      }
    },
    {
      "type": 5,
      "user": 2799483,
      "position": 1068295,
      "extras": {
        "shift": 399054615,
        "shifts": [
          337612830,
          399054614
        ]
      }
    },
    {
      "type": 9,
      "user": 2242957,
      "position": 1068295,
      "extras": {
        "shift": 337612845,
        "name": "Marko Kraljevic"
      }
    },
    {
      "type": 5,
      "user": 2242957,
      "position": 1068295,
      "extras": {
        "shift": 337612845,
        "shifts": [
          399054618,
          399054619
        ]
      }
    },
    {
      "type": 10,
      "user": 2242957,
      "position": 1068295,
      "extras": {
        "shift": 337612845
      }
    },
    {
      "type": 9,
      "user": 2242957,
      "position": 1068295,
      "extras": {
        "shift": 399054618,
        "name": "Marko Kraljevic"
      }
    },
    {
      "type": 5,
      "user": 2242957,
      "position": 1068295,
      "extras": {
        "shift": 399054618,
        "shifts": [
          337612845,
          399054619
        ]
      }
    },
    {
      "type": 10,
      "user": 2242957,
      "position": 1068295,
      "extras": {
        "shift": 399054618
      }
    },
    {
      "type": 9,
      "user": 2242957,
      "position": 1068295,
      "extras": {
        "shift": 399054619,
        "name": "Marko Kraljevic"
      }
    },
    {
      "type": 5,
      "user": 2242957,
      "position": 1068295,
      "extras": {
        "shift": 399054619,
        "shifts": [
          337612845,
          399054618
        ]
      }
    },
    {
      "type": 10,
      "user": 2242957,
      "position": 1068295,
      "extras": {
        "shift": 399054619
      }
    },
    {
      "type": 5,
      "user": 2815057,
      "position": 1068297,
      "extras": {
        "shift": 399054612,
        "shifts": [
          399054613
        ]
      }
    },
    {
      "type": 5,
      "user": 2815057,
      "position": 1068297,
      "extras": {
        "shift": 399054613,
        "shifts": [
          399054612
        ]
      }
    },
    {
      "type": 5,
      "user": 2741245,
      "position": 1068295,
      "extras": {
        "shift": 337612813,
        "shifts": [
          399054563,
          399054564
        ]
      }
    },
    {
      "type": 5,
      "user": 2741245,
      "position": 1068295,
      "extras": {
        "shift": 399054563,
        "shifts": [
          337612813,
          399054564
        ]
      }
    },
    {
      "type": 5,
      "user": 2741245,
      "position": 1068295,
      "extras": {
        "shift": 399054564,
        "shifts": [
          337612813,
          399054563
        ]
      }
    },
    {
      "type": 5,
      "user": 2799468,
      "position": 1068296,
      "extras": {
        "shift": 337630715,
        "shifts": [
          399054561,
          399054562
        ]
      }
    },
    {
      "type": 5,
      "user": 2799468,
      "position": 1068296,
      "extras": {
        "shift": 399054561,
        "shifts": [
          337630715,
          399054562
        ]
      }
    },
    {
      "type": 5,
      "user": 2799468,
      "position": 1068296,
      "extras": {
        "shift": 399054562,
        "shifts": [
          337630715,
          399054561
        ]
      }
    },
    {
      "type": 5,
      "user": 2530682,
      "position": 1068295,
      "extras": {
        "shift": 337612814,
        "shifts": [
          399054567,
          399054568
        ]
      }
    },
    {
      "type": 5,
      "user": 2530682,
      "position": 1068295,
      "extras": {
        "shift": 399054567,
        "shifts": [
          337612814,
          399054568
        ]
      }
    },
    {
      "type": 5,
      "user": 2530682,
      "position": 1068295,
      "extras": {
        "shift": 399054568,
        "shifts": [
          337612814,
          399054567
        ]
      }
    },
    {
      "type": 5,
      "user": 2836672,
      "position": 1068296,
      "extras": {
        "shift": 337630716,
        "shifts": [
          399054570,
          399054571
        ]
      }
    },
    {
      "type": 5,
      "user": 2836672,
      "position": 1068296,
      "extras": {
        "shift": 399054570,
        "shifts": [
          337630716,
          399054571
        ]
      }
    },
    {
      "type": 5,
      "user": 2836672,
      "position": 1068296,
      "extras": {
        "shift": 399054571,
        "shifts": [
          337630716,
          399054570
        ]
      }
    },
    {
      "type": 5,
      "user": 2097936,
      "position": 1068295,
      "extras": {
        "shift": 399054573,
        "shifts": [
          399054574
        ]
      }
    },
    {
      "type": 5,
      "user": 2097936,
      "position": 1068295,
      "extras": {
        "shift": 399054574,
        "shifts": [
          399054573
        ]
      }
    },
    {
      "type": 5,
      "user": 2394366,
      "position": 1068297,
      "extras": {
        "shift": 337612827,
        "shifts": [
          399054575,
          399054576
        ]
      }
    },
    {
      "type": 5,
      "user": 2394366,
      "position": 1068297,
      "extras": {
        "shift": 399054575,
        "shifts": [
          337612827,
          399054576
        ]
      }
    },
    {
      "type": 5,
      "user": 2394366,
      "position": 1068297,
      "extras": {
        "shift": 399054576,
        "shifts": [
          337612827,
          399054575
        ]
      }
    },
    {
      "type": 4,
      "user": 2394366,
      "position": 1068297,
      "extras": {
        "max": 5,
        "in_row": 7,
        "from": "2017-05-01",
        "to": "2017-05-07",
        "shifts": [
          337612827,
          399054575,
          399054576,
          337612846,
          337612865,
          337612884,
          337612903,
          337612922,
          337612941
        ],
        "shifts_detailed": {
          "337612827": {
            "0": {
              "1": [],
              "2": {
                "2017": {
                  "18": 1
                }
              },
              "3": {
                "2017": {
                  "120": 1
                }
              }
            },
            "id": 337612827,
            "schedule": "1068297",
            "start": {
              "0": 1493640000,
              "1": "2017-05-01 15:00:00",
              "2": "2017-05-01 15:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 15,
              "mday": 1,
              "wday": 1,
              "mon": 5,
              "year": 2017,
              "yday": 120,
              "week": 18
            },
            "end": {
              "0": 1493643600,
              "1": "2017-05-01 16:00:00",
              "2": "2017-05-01 16:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 16,
              "mday": 1,
              "wday": 1,
              "mon": 5,
              "year": 2017,
              "yday": 120,
              "week": 18
            },
            "start_on_day": 1493586000,
            "start_in_timeframe": true,
            "end_in_timeframe": true,
            "length_without_break": 1
          },
          "337612846": {
            "0": {
              "1": [],
              "2": {
                "2017": {
                  "18": 1
                }
              },
              "3": {
                "2017": {
                  "121": 1
                }
              }
            },
            "id": 337612846,
            "schedule": "1068297",
            "start": {
              "0": 1493726400,
              "1": "2017-05-02 15:00:00",
              "2": "2017-05-02 15:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 15,
              "mday": 2,
              "wday": 2,
              "mon": 5,
              "year": 2017,
              "yday": 121,
              "week": 18
            },
            "end": {
              "0": 1493730000,
              "1": "2017-05-02 16:00:00",
              "2": "2017-05-02 16:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 16,
              "mday": 2,
              "wday": 2,
              "mon": 5,
              "year": 2017,
              "yday": 121,
              "week": 18
            },
            "start_on_day": 1493672400,
            "start_in_timeframe": true,
            "end_in_timeframe": true,
            "length_without_break": 1
          },
          "337612865": {
            "0": {
              "1": [],
              "2": [],
              "3": []
            },
            "id": 337612865,
            "schedule": "1068297",
            "start": {
              "0": 1493812800,
              "1": "2017-05-03 15:00:00",
              "2": "2017-05-03 15:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 15,
              "mday": 3,
              "wday": 3,
              "mon": 5,
              "year": 2017,
              "yday": 122,
              "week": 18
            },
            "end": {
              "0": 1493816400,
              "1": "2017-05-03 16:00:00",
              "2": "2017-05-03 16:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 16,
              "mday": 3,
              "wday": 3,
              "mon": 5,
              "year": 2017,
              "yday": 122,
              "week": 18
            },
            "start_on_day": 1493758800,
            "start_in_timeframe": false,
            "end_in_timeframe": false,
            "length_without_break": 1
          },
          "337612884": {
            "0": {
              "1": [],
              "2": [],
              "3": []
            },
            "id": 337612884,
            "schedule": "1068297",
            "start": {
              "0": 1493899200,
              "1": "2017-05-04 15:00:00",
              "2": "2017-05-04 15:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 15,
              "mday": 4,
              "wday": 4,
              "mon": 5,
              "year": 2017,
              "yday": 123,
              "week": 18
            },
            "end": {
              "0": 1493902800,
              "1": "2017-05-04 16:00:00",
              "2": "2017-05-04 16:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 16,
              "mday": 4,
              "wday": 4,
              "mon": 5,
              "year": 2017,
              "yday": 123,
              "week": 18
            },
            "start_on_day": 1493845200,
            "start_in_timeframe": false,
            "end_in_timeframe": false,
            "length_without_break": 1
          },
          "337612903": {
            "0": {
              "1": [],
              "2": [],
              "3": []
            },
            "id": 337612903,
            "schedule": "1068297",
            "start": {
              "0": 1493985600,
              "1": "2017-05-05 15:00:00",
              "2": "2017-05-05 15:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 15,
              "mday": 5,
              "wday": 5,
              "mon": 5,
              "year": 2017,
              "yday": 124,
              "week": 18
            },
            "end": {
              "0": 1493989200,
              "1": "2017-05-05 16:00:00",
              "2": "2017-05-05 16:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 16,
              "mday": 5,
              "wday": 5,
              "mon": 5,
              "year": 2017,
              "yday": 124,
              "week": 18
            },
            "start_on_day": 1493931600,
            "start_in_timeframe": false,
            "end_in_timeframe": false,
            "length_without_break": 1
          },
          "337612922": {
            "0": {
              "1": [],
              "2": [],
              "3": []
            },
            "id": 337612922,
            "schedule": "1068297",
            "start": {
              "0": 1494072000,
              "1": "2017-05-06 15:00:00",
              "2": "2017-05-06 15:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 15,
              "mday": 6,
              "wday": 6,
              "mon": 5,
              "year": 2017,
              "yday": 125,
              "week": 18
            },
            "end": {
              "0": 1494075600,
              "1": "2017-05-06 16:00:00",
              "2": "2017-05-06 16:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 16,
              "mday": 6,
              "wday": 6,
              "mon": 5,
              "year": 2017,
              "yday": 125,
              "week": 18
            },
            "start_on_day": 1494018000,
            "start_in_timeframe": false,
            "end_in_timeframe": false,
            "length_without_break": 1
          },
          "337612941": {
            "0": {
              "1": [],
              "2": [],
              "3": []
            },
            "id": 337612941,
            "schedule": "1068297",
            "start": {
              "0": 1494158400,
              "1": "2017-05-07 15:00:00",
              "2": "2017-05-07 15:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 15,
              "mday": 7,
              "wday": 0,
              "mon": 5,
              "year": 2017,
              "yday": 126,
              "week": 18
            },
            "end": {
              "0": 1494162000,
              "1": "2017-05-07 16:00:00",
              "2": "2017-05-07 16:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 16,
              "mday": 7,
              "wday": 0,
              "mon": 5,
              "year": 2017,
              "yday": 126,
              "week": 18
            },
            "start_on_day": 1494104400,
            "start_in_timeframe": false,
            "end_in_timeframe": false,
            "length_without_break": 1
          },
          "399054575": {
            "0": {
              "1": [],
              "2": {
                "2017": {
                  "18": 1
                }
              },
              "3": {
                "2017": {
                  "120": 1
                }
              }
            },
            "id": 399054575,
            "schedule": "1068297",
            "start": {
              "0": 1493640000,
              "1": "2017-05-01 15:00:00",
              "2": "2017-05-01 15:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 15,
              "mday": 1,
              "wday": 1,
              "mon": 5,
              "year": 2017,
              "yday": 120,
              "week": 18
            },
            "end": {
              "0": 1493643600,
              "1": "2017-05-01 16:00:00",
              "2": "2017-05-01 16:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 16,
              "mday": 1,
              "wday": 1,
              "mon": 5,
              "year": 2017,
              "yday": 120,
              "week": 18
            },
            "start_on_day": 1493586000,
            "start_in_timeframe": true,
            "end_in_timeframe": true,
            "length_without_break": 1
          },
          "399054576": {
            "0": {
              "1": [],
              "2": {
                "2017": {
                  "18": 1
                }
              },
              "3": {
                "2017": {
                  "120": 1
                }
              }
            },
            "id": 399054576,
            "schedule": "1068297",
            "start": {
              "0": 1493640000,
              "1": "2017-05-01 15:00:00",
              "2": "2017-05-01 15:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 15,
              "mday": 1,
              "wday": 1,
              "mon": 5,
              "year": 2017,
              "yday": 120,
              "week": 18
            },
            "end": {
              "0": 1493643600,
              "1": "2017-05-01 16:00:00",
              "2": "2017-05-01 16:00:00",
              "seconds": 0,
              "minutes": 0,
              "hours": 16,
              "mday": 1,
              "wday": 1,
              "mon": 5,
              "year": 2017,
              "yday": 120,
              "week": 18
            },
            "start_on_day": 1493586000,
            "start_in_timeframe": true,
            "end_in_timeframe": true,
            "length_without_break": 1
          }
        }
      }
    },
    {
      "type": 5,
      "user": 2799568,
      "position": 1068295,
      "extras": {
        "shift": 337612818,
        "shifts": [
          399054581,
          399054582
        ]
      }
    },
    {
      "type": 5,
      "user": 2799568,
      "position": 1068295,
      "extras": {
        "shift": 399054581,
        "shifts": [
          337612818,
          399054582
        ]
      }
    },
    {
      "type": 5,
      "user": 2799568,
      "position": 1068295,
      "extras": {
        "shift": 399054582,
        "shifts": [
          337612818,
          399054581
        ]
      }
    },
    {
      "type": 5,
      "user": 2799488,
      "position": 1068297,
      "extras": {
        "shift": 337612828,
        "shifts": [
          399054579,
          399054580
        ]
      }
    },
    {
      "type": 5,
      "user": 2799488,
      "position": 1068297,
      "extras": {
        "shift": 399054579,
        "shifts": [
          337612828,
          399054580
        ]
      }
    },
    {
      "type": 5,
      "user": 2799488,
      "position": 1068297,
      "extras": {
        "shift": 399054580,
        "shifts": [
          337612828,
          399054579
        ]
      }
    },
    {
      "type": 5,
      "user": 2695460,
      "position": 1068297,
      "extras": {
        "shift": 337612829,
        "shifts": [
          399054585,
          399054586
        ]
      }
    },
    {
      "type": 5,
      "user": 2695460,
      "position": 1068297,
      "extras": {
        "shift": 399054585,
        "shifts": [
          337612829,
          399054586
        ]
      }
    },
    {
      "type": 5,
      "user": 2695460,
      "position": 1068297,
      "extras": {
        "shift": 399054586,
        "shifts": [
          337612829,
          399054585
        ]
      }
    },
    {
      "type": 5,
      "user": 2643914,
      "position": 1074363,
      "extras": {
        "shift": 337630712,
        "shifts": [
          399054587,
          399054588,
          399054590
        ]
      }
    },
    {
      "type": 5,
      "user": 2643914,
      "position": 1074363,
      "extras": {
        "shift": 399054587,
        "shifts": [
          337630712,
          399054588,
          399054590
        ]
      }
    },
    {
      "type": 5,
      "user": 2643914,
      "position": 1074363,
      "extras": {
        "shift": 399054588,
        "shifts": [
          337630712,
          399054587,
          399054590
        ]
      }
    },
    {
      "type": 5,
      "user": 2643914,
      "position": 1074363,
      "extras": {
        "shift": 399054590,
        "shifts": [
          337630712,
          399054587,
          399054588
        ]
      }
    },
    {
      "type": 5,
      "user": 2799569,
      "position": 1068296,
      "extras": {
        "shift": 399054597,
        "shifts": [
          399054598
        ]
      }
    },
    {
      "type": 5,
      "user": 2799569,
      "position": 1068296,
      "extras": {
        "shift": 399054598,
        "shifts": [
          399054597
        ]
      }
    },
    {
      "type": 5,
      "user": 2119304,
      "position": 1068295,
      "extras": {
        "shift": 337612820,
        "shifts": [
          399054594,
          399054595
        ]
      }
    },
    {
      "type": 5,
      "user": 2119304,
      "position": 1068295,
      "extras": {
        "shift": 399054594,
        "shifts": [
          337612820,
          399054595
        ]
      }
    },
    {
      "type": 5,
      "user": 2119304,
      "position": 1068295,
      "extras": {
        "shift": 399054595,
        "shifts": [
          337612820,
          399054594
        ]
      }
    },
    {
      "type": 5,
      "user": 2579696,
      "position": 1068296,
      "extras": {
        "shift": 337612822,
        "shifts": [
          399054600,
          399054601
        ]
      }
    },
    {
      "type": 5,
      "user": 2579696,
      "position": 1068296,
      "extras": {
        "shift": 399054600,
        "shifts": [
          337612822,
          399054601
        ]
      }
    },
    {
      "type": 5,
      "user": 2579696,
      "position": 1068296,
      "extras": {
        "shift": 399054601,
        "shifts": [
          337612822,
          399054600
        ]
      }
    },
    {
      "type": 5,
      "user": 2448668,
      "position": 1068296,
      "extras": {
        "shift": 337630713,
        "shifts": [
          399054603,
          399054604
        ]
      }
    },
    {
      "type": 5,
      "user": 2448668,
      "position": 1068296,
      "extras": {
        "shift": 399054603,
        "shifts": [
          337630713,
          399054604
        ]
      }
    },
    {
      "type": 5,
      "user": 2448668,
      "position": 1068296,
      "extras": {
        "shift": 399054604,
        "shifts": [
          337630713,
          399054603
        ]
      }
    },
    {
      "typ