PUT Adjust shift

Changed on

/schedule/adjust Permission level: 5

put/schedule/adjust

Request

  • Base URL
    https://www.humanity.com/api/v2
  • Auth
    API key in query parameter access_token

Path parameters

idinteger required

Request body application/x-www-form-urlencoded

trade_acceptinteger
approve_overtimeinteger
employee_idinteger
schedulestring
typeinteger

0 -> Standard; 1 -> Open

neededinteger
start_timestring
end_timestring
start_datestring
end_datestring
notesstring
titlestring
confirmedinteger

0 -> Not Confirmed; 1 -> Confirmed

addstring

Add employee to a shift either by user_id, or by full employee name

removeinteger

Remove user by id

detailedstring
locationinteger

Remote Location id

forceinteger

0 -> Do not force adding staff; 1 -> Force adding staff

repeatinteger
repeat_untilstring
repeat_staffinteger

1 -> With Time Only; 2 -> With employees

repeat_customstring

Custom repeat cycle (eg. SSSOOOO) S-Shift, O-Day off)

repeat_cyclestring

enum[day,week]

repeat_cycle_onstring

0 -> Repeat cycle on, 1 -> Repeat cycle off

repeat_cycle_stepinteger

Cycle step: Every n days/weeks.

update_seriesstring

1 -> Make all future shifts the same as this one; 2 -> Make all shifts in the series the same as this one; 3 -> Revert this shift to original

update_staffinteger

enum[0, 1]

update_timeinteger

enum[0, 1]

update_typeinteger

enum[0, 1]

update_notesinteger

enum[0, 1]

update_scheduleinteger

enum[0, 1]

update_tasksinteger

enum[0, 1]

copy_tostring

Copy to date

restoreinteger

enum[0, 1]

addOnCallinteger
removeOnCallinteger
do_not_initiate_conflictsinteger

Response

200

statusinteger
tokenstring

Example response

{
  "status": 1,
  "data": {
    "id": "321823002",
    "created": "1472128649",
    "published": "1472128658",
    "edited": 1472221925,
    "deleted": "0",
    "schedule": "1321636",
    "type": "0",
    "needed": "0",
    "working": 1,
    "user": "2736727",
    "start_date": {
      "id": 2676,
      "month": 8,
      "day": 26,
      "wday": 5,
      "year": 2016,
      "weekday": "Fri",
      "mname": "Aug",
      "week": 34,
      "dayid": 6,
      "timeid": 37,
      "timeid_exact": 37,
      "formatted": "Aug 26, 2016",
      "time": "9:00am",
      "timestamp": 1472194800,
      "hours": 9,
      "date": "2016-08-26 09:00:00",
      "day_of_year": "238",
      "week_adjusted": 34,
      "sp_wday": 6
    },
    "end_date": {
      "id": 2676,
      "month": 8,
      "day": 26,
      "wday": 5,
      "year": 2016,
      "weekday": "Fri",
      "mname": "Aug",
      "week": 34,
      "dayid": 6,
      "timeid": 69,
      "timeid_exact": 69,
      "formatted": "Aug 26, 2016",
      "time": "5:00pm",
      "timestamp": 1472223600,
      "hours": 17,
      "date": "2016-08-26 17:00:00",
      "day_of_year": "238",
      "week_adjusted": 34,
      "sp_wday": 6
    },
    "length": 8,
    "location": "0",
    "notes": "Changed Notes",
    "ref": "0",
    "start_timestamp": "2016-08-26 09:00:00",
    "end_timestamp": "2016-08-26 17:00:00",
    "perms": "2",
    "paidtime": 8,
    "start_time": {
      "id": 37,
      "time": "9:00am"
    },
    "end_time": {
      "id": 69,
      "time": "5:00pm"
    },
    "schedule_name": "Desk Service",
    "schedule_color": 11,
    "employees": [
      {
        "id": "2744092",
        "name": "Derrick Arnold",
        "avatar": "0",
        "status": "1",
        "last_active": "0",
        "ratecard": "0",
        "present": "0"
      }
    ],
    "cost": {
      "staff": 1,
      "hours": 8
    },
    "repeats": "0",
    "staff": {
      "scheduled": [
        [
          "2744092"
        ]
      ]
    },
    "break": 8
  },
  "token": "xxxxxxx"
}

Changes