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 2 Next »

Overview

Request for a list of available Working Locations.

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/GetWorkingLocations

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 the UserId, this identifies users and returns values based on their location.

  • LocationId - This returns Working Locations that are available for a specific Location.

If no value is passed then results will reflect “System Settings” Working Locations

Example

{
  "UserId": int,
  "EmailAddress": "string",
  "LocationId": int
}

Response

The response will be an array of admin-configured working locations.
These will be created in System Settings or a specific Location.

Required values include.

Field name

Data type

Explanation

Id REQUIRED

Integer

Unique ID for the Working Location.

Name REQUIRED

String

A custom text name for the Working Location, such as Office or Remote.

IconPath REQUIRED

URL

A URL to an uploaded icon image to help depict this working location, such as an image of an office or a house.

LocationId

Integer

If the working location 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 and valid for all locations.

Example

{
  "WorkingLocations" Array[
    Object{
      "Id" int,
      "Name": "string",
      "IconPath": "string",
      "LocationId": null/int
    },
  ]
}
  • No labels