Overview
| Excerpt |
|---|
Request for a list of available Working LocationsWork Places. |
This can be filtered based on a user or a location specifically.
This will require a Admin Console update.
Documenation for this change coming soon.
Details
Type
POST
Endpoint
{{url}}/api/GetWorkingLocationsUsers/GetWorkPlacesList
Request
There are 3 optional request parameters.
UserId- used to identify the user the Working Locations are relevant for. This will be based on their Default Location.EmailAddress- Similar to theUserId, this identifies users and returns values based on their location.LocationId- This returns Working Locations Work Places that are available for a specific Location.
If no value is passed then results will reflect “System Settings” Working LocationsWork Places
Example
| Code Block | ||
|---|---|---|
| ||
{
"UserId": int,
"EmailAddress": "string",
"LocationId": int
} |
Response
The response will be an array of admin-configured working locationsWork Places.
These will be created in System Settings or a specific Location.
...
Field name | Data type | Explanation | ||||||
|---|---|---|---|---|---|---|---|---|
Id
| Integer | Unique ID for the Working LocationWork Place. | ||||||
Name
| String | A custom text name for the Working LocationWork Place, such as Office or Remote. | ||||||
IconPath
| URL | A URL to an uploaded icon image to help depict this working locationWork Place, such as an image of an office or a house. | ||||||
LocationId | Integer | If the working location Work Place is specific/unique to a country or individual office this will indicate which Location ID it is unique assigned. If the response value is NULL then this is a System Setting’s Working Location Work Place and valid for all locations. |
Example
| Code Block | ||
|---|---|---|
| ||
{
"WorkingLocationsWorkPlaces" Array[
Object{
"Id" int,
"Name": "string",
"IconPath": "string",
"LocationId": null/int
},
]
} |