Overview

This will return the user's status and working location Work Locations based on a date and time frame.

Details

Type

POST

Endpoint

{{url}}/api/User/GetScheduleGetWorkLocations

Request

The request will have five valid parameters.

The Id or EmailAddress can be used; at least one is required.
The 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 StartTime & 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.

Example

{
  "Id": int,
  "EmailAddress": "string (email address)",
  "Date": "dd/MM/yyyy",
  "StartTime": "dd/MM/yyyy HH:mm",
  "EndTime": "dd/MM/yyyy HH:mm"
}

Response

The response will include the user's status and working location based on the requested time range.

If the user has a booking during the requested time frame then information about that booking should also be returned.

The WorkingLocation Work Locations should be returned based on the requested time frame.
DefaultLocationSchedule DefaultWorkLocations should also be included which is the default weekly schedule the user has defined.

FutureLocationSchedule WorkLocationExceptions will be dates and times that the user has specified as differing from their default schedule. This will only show future events.

Example

{
  "Id": int,
  "EmailAddress": "string (email address)",
  "Date": "yyyy/MM/DD",
  "StartTime": "HH:mm",
  "EndTime": "HH:mm"
  "Status": "string", // available, busy, do not disturb, away, offline
  "CurrentWorkingLocation": "string",
  "ActiveBooking": int, // if in a booking include booking ID
  "DefaultLocationScheduleDefaultWorkLocations": Object{
    "Monday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Location": "string"}
    ],
    "Tuesday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Location": "string"}
    ],
    "Wednesday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Location": "string"}
    ],
    "Thursday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Location": "string"}
    ],
    "Friday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Location": "string"}
    ],
    "Saturday": Array[],
    "Sunday": Array[],
  }
  "FutureLocationScheduleWorkLocationExceptions": Array[
    Object{
      "Date": "dd/MM/yyyy",
      "StartTime": "HH:mm",
      "EndTime": "HH:mm",
      "WorkingLocation": "string"
    }
  ]
}