PlaceTemplateCategory

PlaceTemplateCategory Service

Web service endpoints for retrieving categories of templates definitions.

Get Place Template Categories

GET /placeTemplateCategories

Return a paginated list of template categories that match the specified filter criteria. Template 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
templateState one or more tile states, separated by commas. By default all page templates will be included. ?filter=templateState(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:
  • PlaceTemplateCategory[]
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed

    Get Place Template Category

    GET /placeTemplateCategories/{placeTemplateCategoryID}

    Return the specified place template category with the specified fields.

    Path Parameters:
    NameTypeRequiredDescription
    placeTemplateCategoryIDStringtrueID of the place template category to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • PlaceTemplateCategory containing the specified place template category
  • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access the specified place template category
    404 (Not Found)The specified place template category does not exist