Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The request will have five valid parameters.

The userId UserId or emailAddress EmailAddress can be used; at least one is required.
The date Date is optional and used to find the user's status for a future day; if not included the current date should be used.
The start StartTime & end EndTime are optional and used to get a user's status based on a specific time frame; if not included the status should be returned based on the current time.

...

Code Block
languagejson
{
  "userIdUserId": 13,
  "emailAddressEmailAddress": "charlotte.hill@email.com",
  "dateDate": "dd/MM/yyyy",
  "startStartTime": "dd/MM/yyyy HH:mm",
  "endEndTime": "dd/MM/yyyy HH:mm"
}

Response

...

Code Block
languagejson
{
  "userIdUserId": 13,
  "EmailAddress": "charlotte.hill@email.com",
  "dateDate": "yyyy/MM/DD",
  "startTimeStartTime": "HH:mm",
  "endTimeEndTime": "HH:mm"
  "Status": "available", // available, busy, do not disturb, away, offline
  "WorkingLocation": "Office",
  "ActiveBooking": xxxx, // if in a booking include booking ID
  "WorkingLocatingSchedule": {
    "Monday": [
      {"StartTime": "09:00", "EndTime": "17:00", "Location": "Office"}
    ],
    "Tuesday": [
      {"StartTime": "09:00", "EndTime": "17:00", "Location": "Office"}
    ],
    "Wednesday": [
      {"StartTime": "09:00", "EndTime": "17:00", "Location": "Office"}
    ],
    "Thursday": [
      {"StartTime": "09:00", "EndTime": "17:00", "Location": "Office"}
    ],
    "Friday": [
      {"StartTime": "09:00", "EndTime": "17:00", "Location": "Home"}
    ],
    "Saturday": [],
    "Sunday": [],
  }
  "CustomWorkingLocation": [
    {
      "Date": "dd/MM/yyyy",
      "StartTime": "HH:mm",
      "EndTime": "HH:mm",
      "WorkingLocation": "string"
    }
  ]
}