Wheniwok Inventory

The inventory of objects consumed from Wheniwork. We only utilize what we need from each object, so the models noted below only indicate what is currently in use. Fields marked as ** may be undocumented in the Wheniwork API but are in-use by Core.

Account model

• https://apidocs.wheniwork.com/external/index.html#tag/Accounts

{
  "account": {
    "timezone_name": "America/New_York"
  }
}

User model

• https://apidocs.wheniwork.com/external/index.html#tag/Users

{
  "user": {
    "id": 10000,
    "role": 1,
    "email": "jdoe@wheniwork.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": 16511234567,
    "activated": true,
    "hourly_rate": 15,
    "is_deleted": false,
    "is_hidden": false,
    "is_private": false,

    "position_rates": {
        "8872385": 10,
        "8872387": 25
    }, // **

    "avatar": "https://lorempixel.com/640/480/?28661" // **
  }
}

Position model

• https://apidocs.wheniwork.com/external/index.html#tag/Positions

{
  "positions": [
    {
      "id": 10000,
      "name": "Dishwasher",
      "color": "cc0000",
      "sort": 2
    }
  ]
}

Locations (Schedules/Geos) model

• https://apidocs.wheniwork.com/external/index.html#tag/Schedules-(Locations)

{
  "locations": [
    {
      "id": 10000,
      "account_id": 10000,
      "place_id": 2,
      "name": "Front of House",
      "postal_code": "55401",
      "region": "MN",
      "deleted_at": "2020-05-23T17:42:22Z",
      "is_default": false,
      "is_deleted": false,
      "sort": 0
    }
  ]
}

Sites model

• https://apidocs.wheniwork.com/external/index.html#tag/Sites

{
  "sites": [
    {
      "id": 10000,
      "location_id": 4566628, // **
      "name": "Indie Hospital", // **
      "color": "8dbfd9", // **
      "description": "Some notes...", // **
      "address": "990 Spring Garden Street, Philadelphia, PA 19123, USA", // **
      "latitude": 39.961456, // **
      "longitude": -75.154144 // **
    }
  ]
}

Shifts model

• https://apidocs.wheniwork.com/external/index.html#tag/Shifts

{
  "shifts": [
    {
      "id": 10000,
      "user_id": 101,
      "location_id": 1045,
      "position_id": 19483,
      "site_id": 4351,
      "start_time": "Fri, 07 Mar 2016 08:30:00 -0600",
      "end_time": "Fri, 07 Mar 2016 14:30:00 -0600",

      "notified_at": "2020-05-19 12:11:41", // **
      "creator_id": "34263237", // **
      "color": "ff0000", // **
      "notes": "Some notes...", // **
      "alerted": true, // **
      "published": true, // **
      "acknowledged": true", // **
    }
  ]
}