Reserved words
A list of reserved words exists for common used practices
Query parameters
| Term | Description | Example | Ref |
|---|---|---|---|
When a collection resources is paged, use this parameter to request a specific page. Page numbers are 1-based. |
?page=3&pageSize=20 |
||
When a collection resources is paged, use this parameter to specify the page size. |
?page=3&pageSize=20 |
||
The standard search parameter to do a full-text search. |
?q=Proximus |
||
Filter the resource properties to the ones specified. |
?select=(name,address) |
||
Multi-value query param with list of properties to sort on. Default sorting direction is ascending. To indicate descending direction, the property may be prefixed with -. |
?sort=age&sort=-name |
||
embed |
Request to embed subresource |
?embed=mainAddress |
|
language to filter multi-language descriptions |
?lang=fr |
JSON properties
| Term | Description | Example | Ref |
|---|---|---|---|
The next-reference contains the absolute URL of the next page in a paged collection result. |
|
||
The previous-reference contains the absolute URL of the previous page in a paged collection result. |
|
||
The self-reference contains the absolute URL of the resource itself. |
|
||
A reference (absolute URL) to another resource. |
|
||
A reference (absolute URL) to the first page in a paged collection result. |
|
||
A reference (absolute URL) to the last page in a paged collection result. |
|
||
items |
an array with the items of a collection result. |
||
total |
the total number of items in a collection result, after filtering. |
||
page |
the index of a page in a paged collection result |
||
pageSize |
the maximum number of items in a page of a paged collection result. |
||
embedded |
a map of embedded subresources, with URIs as property key and the resource as value |
HTTP headers
This list includes all standardized and common non-standard HTTP headers.
Rule: HTTP header names [hdr-case]
Applications MUST treat HTTP header names as case-insensitive as per the HTTP specification.
However, by convention, Kebab-Case with uppercase SHOULD be used for readability and consistency.
Rule: Custom HTTP headers [cst-header]
Custom HTTP headers SHOULD be prefixed with the organization’s name.
Custom headers that are standardized across Belgian Government organizations use the BelGov- prefix.
X- headers were initially reserved for unstandardized parameters, but the usage of X- headers is deprecated (RFC-6648).
Instead, it is recommended that organization’s specific header names should incorporate the organization’s name.
However, for backwards compatibility reasons, headers with the X- prefix may still be used.
| HTTP Header | Type | Description | Reference |
|---|---|---|---|
Location |
Response |
Used in redirection, or when a new resource has been created. |
Create a new resource, POST, status codes 301, 303 and 307 |
Accept |
Request |
Media type(s) that is(/are) acceptable for the response. |
|
Content-Type |
Request/Response |
The Media type of the body of the request. |
|
X-HTTP-Method-Override |
Request |
Override the method specified in the request. |
|
Retry-After |
Response |
Suggest amount of time for the client to wait before retrying the request when temporarily unavailable or quota reached |
Service Unavailable, Too Many Requests, Too Many Failed Requests |
Allow |
Response |
Valid methods for a specified resource. |
|
ETag |
Request |
Identifier for returned response content |
|
If-None-Match |
Response |
Return resource if ETag changed |
|
Last-Modified |
Request |
Time on which resource was last modified |
|
If-Modified-Since |
Response |
Return resource only if changed since specified timestamp |
|
Vary |
Response |
Specifies which request headers change response content |
|
Cache-Control |
Response |
Indicates HTTP client how to cache responses |
| HTTP Header | Type | Description | Reference |
|---|---|---|---|
BelGov-Trace-Id |
Request/Response |
Unique ID for tracing purposes, identifying the request or response |
|
BelGov-Related-Trace-Id |
Response |
BelGov-Trace-Id value used on related request |