Filter criteria for landmark categories

The following table describes the different criteria by which you can search for landmark categories and lists the required Filter object properties per criterion. Table: Filter object properties for a category search describes the actual properties.

Table: Category search criteria

Criterion

Description

Properties to specify

Name

You can search for categories by name. The name search is not case sensitive and supports wild cards, for example "?" (single character) and "*" (zero or more characters).

  • CategoryName

  • [MaximumMatches]

  • [PreviousMatchesOnly]

The following table describes the Filter object properties for GetList calls that retrieve information about landmark categories.

Table: Filter object properties for a category search

Property

Description

Type

Value

[DatabaseURI]

Specifies the landmark database in which to search for landmark categories. If this is not specified, the search is performed on the default database.

string

Maximum length 255 characters

[CategoryName]

Specifies the category name to search by. This is checked against the CategoryName property of a landmark category.

This string is not case sensitive and supports wild cards, for example "?" (single character) and "*" (zero or more characters).

string

Maximum length 124 characters

[MaximumMatches]

Specifies the maximum number of landmark category items to retrieve. If this property is not specified, GetList returns all categories matching the search criteria.

number

 

[PreviousMatchesOnly]

Specifies whether to perform the search on previous search results only:

  • If set to true, GetList searches for matching landmark categories in previous search results only.

  • If set to false, GetList performs a new search on the entire database.

The default value is false.

boolean

Possible values:

  • true

  • false