Overview

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

Details

Type

POST

Endpoint

{{url}}/api/User/Status

Request

The request will have five valid parameters.

The userId or emailAddress can be used but at least one is required.
The date is optional and used to find the user's status for a future day, if not included then the current date should be used.
The start & end 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

{
  "userId": 13,
  "emailAddress": "charlotte.hill@email.com",
  "date": "dd/MM/yyyy",
  "start": "dd/MM/yyyy HH:mm",
  "end": "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.

Example

{
  "userId": 13,
  "EmailAddress": "charlotte.hill@email.com",
  "date": "yyyy/MM/DD",
  "startTime": "HH:mm",
  "endTime": "HH:mm"
  "Status": "available", // available, busy, do not disturb, away, offline
  "WorkingLocation": "Office",
  "ActiveBooking": xxxx, // if in a booking include booking ID
}