Versions Compared

Version Old Version 16 New Version 17
Changes made by

Elliot Dooleysmith

Elliot Dooleysmith

Saved on

Key

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

...

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 StartDateTime & EndDateTime are optional and used to get a user's status based on a specific date & time framerange; if not included the status should be returned based on the current timeday.

Example

Code Block
languagejson
{
  "Id": int,
  "EmailAddress": "string (email address)",
  "DateStartDateTime": "dd/MM/yyyy",
  "StartTime": "dd/MM/yyyy HH:mm",
  "EndTimeEndDateTime": "dd/MM/yyyy HH:mm"
}

Response

...

Code Block
languagejson
{
  "Id": int,
  "EmailAddress": "string (email address)",
  "DateStartDateTime": "yyyydd/MM/DD",
  "StartTime": "yyyy HH:mm",
  "EndTimeEndDateTime": "dd/MM/yyyy HH:mm"
  "Status": "string", // available, busy, do not disturb, away, offline
  "CurrentWorkPlace": "string",
  "ActiveBooking": int, // if in a booking include booking ID
  "DefaultWorkPlaces": Object{
    "Monday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
    ],
    "Tuesday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
    ],
    "Wednesday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
    ],
    "Thursday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
    ],
    "Friday": Array[
      Object{"StartTime": "09:00", "EndTime": "17:00", "Place": "string"}
    ],
    "Saturday": Array[],
    "Sunday": Array[],
  }
  "WorkPlaceExceptions": Array[
    Object{
      "Id": int,
      "Date": "dd/MM/yyyy",
      "StartTime": "HH:mm",
      "EndTime": "HH:mm",
      "WorkPlace": "string"
    }
  ]
}