TileCategory

TileCategory Service

Web service endpoints for retrieving categories of tiles definitions.

Get Tile Categories

GET /tiles/categories

Return a paginated list of tile categories that match the specified filter criteria. Tile categories that are hidden will not be returned.

This service supports the following filters. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.

Filter Params Example
tileState one or more tile states, separated by commas. By default all tile definitions will be included. ?filter=tileState(published,archived)
Query Parameters:
NameTypeRequiredDescription
startIndexIntegerfalseStarting index (offset) for categories in this request
countIntegerfalseMaximum number of categories to return in this request
filterObject[]falseThe filter criteria used to select category objects
fieldsStringfalseFields to be returned
Retrieves:
  • TileCategory[]
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed

    Get Tile Category

    GET /tiles/categories/{tileCategoryID}

    Return the specified tile category with the specified fields.

    Path Parameters:
    NameTypeRequiredDescription
    tileCategoryIDStringtrueID of the tile category to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • TileCategory containing the specified tile category
  • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)An input field is malformed
    404 (Not Found)The specified tile category does not exist