Overview
| Excerpt |
|---|
Request for User’s to update their status Work Places based on date and time. |
Details
Type
POST
Endpoint
{{url}}/api/UserUsers/SetScheduleSetWorkPlaces
Request
The Id or EmailAddress can be used; at least one is required to identify the correct user.
The DefaultLocationSchedule DefaultWorkPlaces is an array of weekdays, this is the user's default weekly schedule.
The FutureLocationSchedule WorkPlaceExceptions option is an array of dates with a custom working location, this overwrites the default schedule.
Users can add, edit or remove WorkPlaceExceptions, this is defined by the Action field.
Add- This requires start and end values.Edit- This requires the event ID as well as the updated start and end values.Remove- This requires the event ID value.
Example
| Code Block | ||
|---|---|---|
| ||
{
"Id": int,
"EmailAddress": "string (email address)",
"DefaultLocationScheduleDefaultWorkPlaces": 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[],
}
"FutureLocationScheduleWorkPlaceExceptions": Array[
Object{
"Action": "Add",
"Id": null,
"Date": "dd/MM/yyyy",
"StartTime": "HH:mm",
"EndTime": "HH:mm",
"WorkingLocationWorkingPlace": "string"
}
]
} |
Response
The response should indicate a successful update of the data.
Example
| Code Block | ||
|---|---|---|
| ||
{
"Updated" true
} |