Overview
| Excerpt |
|---|
Request for User’s to update their status Work Locations based on date and time. |
Details
Type
POST
Endpoint
{{url}}/api/User/SetScheduleSetWorkLocations
Request
The Id or EmailAddress can be used; at least one is required to identify the correct user.
The DefaultLocationSchedule DefaultWorkLocations is an array of weekdays, this is the user's default weekly schedule.
The FutureLocationSchedule WorkLocationExceptions option is an array of dates with a custom working location, this overwrites the default schedule.
Example
| Code Block | ||
|---|---|---|
| ||
{
"Id": int,
"EmailAddress": "string (email address)",
"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"
}
]
} |
Response
The response should indicate a successful update of the data.
Example
| Code Block | ||
|---|---|---|
| ||
{
"Updated" true
} |