Introduction

The object used to specify the arguments when searching for Zone(s).

Properties

ExternalReference

Search for Zones with this External Reference. Wildcard can be used by prepending/appending "%" to string. Example "%reference%".

FromDate

Search for Zones that were active at this date or after. Set to UTC now to search for only currently active (non-archived) zones.

Groups

Search for Zones that are members of these GroupSearch(s) one of it's children or one of it's parents. Available GroupSearch options are:

• Id

Id

Search for an entry based on the specific Id.

IncludeGroups

Include zones that are in the in this hierarchy of the GroupSearch(s) provided. If no GroupSearch(s) are provided the user's data scope groups will be used. Default: IncludeGroups.ParentAndChild.

Keywords

Search for entities that contain specific keywords in all wildcard string-searchable fields.

MinimumRadiusInMeters

Exclude Zones whose radius is smaller than this size (meters).

Name

Search for Zones with this Name. Wildcard can be used by prepending/appending "%" to string. Example "%name%".

SearchArea

The BoundingBox search for Zones in this area extent, the zones being retrieved must be located in this area. Typically used for retrieving Zones in the extents of a bounding box. The SearchArea object should contain the minimum and maximum latitude and longitude representing the search area.

ToDate

Search for Zones that were active at this date or before.

ZoneTypes

Search for Zones that are of type ZoneTypeSearch(s). Available ZoneTypeSearch options are:

• Id