Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 7 Next »

Overview

Request for User’s to update their Work Places based on date and time.

Details

Type

POST

Endpoint

{{url}}/api/User/SetWorkPlaces

Request

The Id or EmailAddress can be used; at least one is required to identify the correct user.
The DefaultWorkPlaces is an array of weekdays, this is the user's default weekly schedule.
The WorkPlaceExceptions option is an array of dates with a custom working location, this overwrites the default schedule.

Example

{
  "Id": int,
  "EmailAddress": "string (email address)",
  "DefaultWorkLocations": 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{
      "Date": "dd/MM/yyyy",
      "StartTime": "HH:mm",
      "EndTime": "HH:mm",
      "WorkingLocation": "string"
    }
  ]
}

Response

The response should indicate a successful update of the data.

Example

{
  "Updated" true
}
  • No labels