Overview
| Excerpt |
|---|
Request for User Work Locations Places based on date and time. |
This will return the user's Work Locations Places based on a date and time frame.
Details
Type
POST
Endpoint
{{url}}/api/User/GetWorkLocationsGetWorkPlaces
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
| Code Block | ||
|---|---|---|
| ||
{
"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.
...
The Work Locations should be returned based on the requested time frame.DefaultWorkLocations DefaultWorkPlaces should also be included which is the default weekly schedule the user has defined.
WorkLocationExceptions WorkPlaceExceptions will be dates and times that the user has specified as differing from their default schedule. This will only show future events.
Example
| Code Block | ||
|---|---|---|
| ||
{
"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
"CurrentWorkingLocationCurrentWorkPlace": "string",
"ActiveBooking": int, // if in a booking include booking ID
"DefaultWorkLocationsDefaultWorkPlaces": Object{
"Monday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "LocationPlace": "string"}
],
"Tuesday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "LocationPlace": "string"}
],
"Wednesday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "LocationPlace": "string"}
],
"Thursday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "LocationPlace": "string"}
],
"Friday": Array[
Object{"StartTime": "09:00", "EndTime": "17:00", "LocationPlace": "string"}
],
"Saturday": Array[],
"Sunday": Array[],
}
"WorkLocationExceptionsWorkPlaceExceptions": Array[
Object{
"Date": "dd/MM/yyyy",
"StartTime": "HH:mm",
"EndTime": "HH:mm",
"WorkingLocationWorkPlace": "string"
}
]
} |