[EXPERIMENTAL] Endpoints for managing Categories.
Experimental Status: These endpoints have an experimental status since their complexity was impacted by a removed feature. We intend at the very least
to vastly simplify these endpoints by removing the code-subresource.
[EXPERIMENTAL] This endpoint allows you to retrieve list of categories of an entity.
OK
{- "data": [
- {
- "entity": "location",
- "code": "codeA",
- "labels": {
- "default_label": "low emission zone",
- "languages": {
- "nl": "lage emissie zone",
- "fr": "zone à faible émission"
}
}
}
], - "page": {
- "total_items": 100,
- "total_pages": 10,
- "page_size": 10,
- "current_page": 1
}
}[EXPERIMENTAL] This endpoint allows you to get the category of an entity with a given code, including the ETag header for optimistic locking purpose
OK
The entity is not found
General error payload
{- "entity": "location",
- "code": "codeA",
- "labels": {
- "default_label": "low emission zone",
- "languages": {
- "nl": "lage emissie zone",
- "fr": "zone à faible émission"
}
}
}[EXPERIMENTAL] This endpoint allows you to create or update an existing category of an entity.
When the code does not exist, a new category will be created for the entity. No ETag header is required yet. For a given code, the properties will be overwritten and then an ETag header is required. Do remark that the code in the body of the request, must correspond with the code in the path identifier
Update category of an entity request body
required | object (MultiLanguages) Descriptive labels for this category. |
Update successful
Authentication required
Access forbidden
The entity is not found
Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.
{- "labels": {
- "default_label": "low emission zone",
- "languages": {
- "nl": "lage emissie zone",
- "fr": "zone à faible émission"
}
}
}{- "title": "Invalid ...",
- "status": 400,
- "detail": "string",
- "instance": "an URI",
- "violations": [
- {
- "field": "class.field",
- "message": "a violation message"
}
]
}[EXPERIMENTAL] This endpoint allows you to delete an existing category of an entity
A category can only be deleted when no active entities are still using it.
Delete successful
Authentication required
Access forbidden
The entity is not found
Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.
{- "title": "Invalid ...",
- "status": 400,
- "detail": "string",
- "instance": "an URI",
- "violations": [
- {
- "field": "class.field",
- "message": "a violation message"
}
]
}