PlaceTemplateCategory
PlaceTemplateCategory Service
Web service endpoints for retrieving categories of templates definitions.
Get Place Template Categories
GET /placeTemplateCategoriesReturn 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:
| Name | Type | Required | Description |
|---|
| startIndex | Integer | false | Starting index (offset) for categories in this request |
| count | Integer | false | Maximum number of categories to return in this request |
| filter | Object[] | false | The filter criteria used to select category objects |
| fields | String | false | Fields to be returned |
Retrieves:
PlaceTemplateCategory[]Return Status:
| HTTP Status Code | Description |
|---|
| 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:
| Name | Type | Required | Description |
|---|
| placeTemplateCategoryID | String | true | ID of the place template category to be returned |
Query Parameters:
| Name | Type | Required | Description |
|---|
| fields | String | false | Fields to be returned |
Retrieves:
PlaceTemplateCategory containing the specified
place template categoryReturn Status:
| HTTP Status Code | Description |
|---|
| 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 |
