Introduction

Client Site Settings can be accessed by API and Data Lab. Filtering by settings saves time when auditing site configurations, enforcing standards, or troubleshooting discrepancies across multiple sites. 

The filtering for client sites that have a particular setting requires knowledge of three things:

1. The “tag” name of the Client Setting as implemented in the back end
2. The “value” of the Client Setting as implemented in the back end
3. A boolean nomenclature to append the API call (equal true, equal false, equal {value}

See a client site’s settings

GET /clients/{id}/settings

Get a list of Client Sites with a particular Setting

There are three different ways that a list of Client Sites can be obtained based on a Setting.

Boolean True or False (enabled/disabled)

For settings that can have two different states of Enabled or Disabled, these are to be treated as boolean, meaning “equal true” or “equal false”. They look like this in the web portal:

To look for these in a list of Client Sites, you need to use the “equal true” comparison, with the hasSettingWithValue filter.

{
  "tag": "DisplayGpsCoordinates",
  "value": false,
  "description": "Display GPS Coordinates on Patrol Tour Report Details?",
  "category": "REPORT"
}

Notice the “tag” and the “value”. In a boolean setting, the tag will stay the same, but the value can be true, or false.

E.g.

GET /clients?hasSettingWithValue=DisplayGpsCoordinates equal true

If you’re looking for a disabled setting, then you would equal false:

GET /clients?hasSettingWithValue=DisplayGpsCoordinates equal false

Setting is Set to a Value (equal value)

For settings that not boolean, which typically means a list of options, these settings can have any number of “value”s defined, like with Back Office Defaults for “Manage hard skill requirements“

For Settings like these, their “value” definition will be a string constant:

{
  "tag": "HardSkillRequirementsBehaviour",
  "value": "BLOCK_EXPIRED_QUALIFICATIONS",
  "description": "Manage hard skill requirements",
  "category": "BACKOFFICE"
}

And therefore to find Client Sites with one of these available selections set, you will need to compare the tag with the desired value, like this:

GET /clients?hasSettingWithValue=HardSkillRequirementsBehaviour equal BLOCK_EXPIRED_QUALIFICATIONS

Notice the search value of equality that is of format “{tag} equal {value}”.

Common Settings Definitions

If a setting you’re dealing with isn’t in the list above, you can inspect the web portal control to find its VALUE definition and then try to look it up for the Client Site in question.

E.g.

Common Tag/Value Examples

• TimeZone → America/New_York → Timezone of the account

• DisplayGpsCoordinates → false → Display GPS on Patrol Tour Report?

• DualBranding → false → Enable dual branding?

• HardSkillRequirementsBehaviour → REGION_DEFAULT / BLOCK_EXPIRED_QUALIFICATIONS → Manage hard skill requirements

• HazardAlertDuration → 5 → Hazard alert duration (minutes)

• HazardAlertBehavior → SIREN → Device behavior

For a complete list, check your portal’s Client Site settings page.