(> )
:
:
:
Login to Kliko Container Manager
OR
Welvaarts
Welvaarts
:
:
:
:
:
:
:
:
:
:
:
:
Welvaarts
Welvaarts
:
:
:
:
:
Application programming interface
Below are the endpoints you currently have access to based on your roles.
Per controller the available actions are listed. You'll see the endpoint to send a HTTPS request to. If
available, a short textual description is provided. Also, the return type is shown.
Controllers and endpoints might be added, removed or changed.
To copy the OpenAPI text to your clipboard left-click the text.
Most API endpoints require authentication. If an endpoint does not require authentication it's mentioned in the endpoint table. Authentication can be done multiple ways:
- By providing a 'token' property to the JSON input of the request. Get your token from the user/getToken endpoint.
- HTTP Authorization. Basically provide 'Basic email:password' in the 'Authentication' header in your request. The email:password part must be base64 encoded.
Most endpoints require input. All input and output is JSON encoded, unless mentioned otherwise. What JSON properties to send to the endpoint is listed as well.
Per attribute you'll see an array describing the value. The first value is the default value used if no value is supplied in your input. The second value in the array describes the type of input. Available types are:
| FILTER_VALIDATE_INT | Requires input to be an integer. |
| FILTER_VALIDATE_NULLABLE_INT | Requires input to be an integer, or NULL. |
| FILTER_VALIDATE_DECIMAL | Requires input to be an decimal. |
| FILTER_VALIDATE_NULLABLE_DECIMAL | Requires input to be an decimal, or NULL. |
| FILTER_VALIDATE_HEX | Requires input to be hexadecimal (with or without 0x). |
| FILTER_VALIDATE_NULLABLE_HEX | Requires input to be hexadecimal (with or without 0x), or NULL. |
| FILTER_VALIDATE_DATE | Requires input to be a date in YYYY-MM-DD HH:MM:SS format. |
| FILTER_VALIDATE_EMPTY_DATE | Requires input to be a date in YYYY-MM-DD HH:MM:SS format or empty. |
| FILTER_VALIDATE_TIME | Requires input to be a time in HH:MM:SS format. |
| FILTER_VALIDATE_EMPTY_TIME | Requires input to be a time in HH:MM:SS format or empty. |
| FILTER_VALIDATE_DATETIME | Requires input to be a date in YYYY-MM-DD format. |
| FILTER_VALIDATE_EMPTY_DATETIME | Requires input to be a date in YYYY-MM-DD format or empty. |
| FILTER_VALIDATE_BOOLEAN | Requires input to be a boolean. 0/1 yes/no is allowed. |
| FILTER_VALIDATE_EMPTY_BOOLEAN | Requires input to be a boolean. 0/1 yes/no is allowed. Can also be NULL |
| FILTER_VALIDATE_EMPTY_STRING | Requires input to be a string, may be an empty one or NULL. |
| FILTER_VALIDATE_NON_EMPTY_STRING | Requires input to be a string, must have a value. |
| FILTER_VALIDATE_ENUM | Requires input to be one of an enum. A third value in the array is supplied describing what every object must look like. |
| FILTER_VALIDATE_EMPTY_ENUM | Requires input to be one of an enum or empty. A third value in the array is supplied describing what every object must look like. |
| FILTER_VALIDATE_INT_ARRAY | Requires input to be an array of integers, could be an empty one. |
| FILTER_VALIDATE_NON_EMPTY_INT_ARRAY | Requires input to be an array of integers, must have at least one value. |
| FILTER_VALIDATE_STRING_ARRAY | Requires input to be an array of strings, could be an empty one. |
| FILTER_VALIDATE_OBJECT | Requires input to be an object. A third value in the array is supplied describing what the object must look like. |
| FILTER_VALIDATE_OBJECT_ARRAY | Requires input to be an array of objects. A third value in the array is supplied describing what every object must look like. |
| FILTER_VALIDATE_ASSOC_STRING_ARRAY | Requires input to be an associative array. |
When using lists, you can search rather specific for your desired items. Below are the rules:
Numeric columns
- Defaults to exact match on search input
- Use > to search for values greater than input
- Use >= to search for values greater than or equal to input
- Use < to search for values smaller than input
- Use <= to search for values smaller than or equal to input
- Use & to combine values, for example '>=10&<20' to search for values 10-19
- Use = to search for values delimited by ,. For example '=20,21,25' searches for values 20, 21 or 25
- Use != to exclude values delimited by ,. For example '!=20,21,25' searches for values other than 20, 21 or 25
Textual columns (Including enumerations)
- Defaults to match any field containing the input, case insensitive
- Use = to search for the exact value
- When using = you can search for multiple exact values by delimiting them with a ,
Date[time] columns
- Defaults to exact match on search input
- Use > to search for values after input
- Use >= to search for values after than or equal to input
- Use < to search for values before than input
- Use <= to search for values before or equal to input
- Use & to combine values, for example '>=2020-01-01&<2020-02-01' to search for January 2020
Response bodies are in JSON, except for some SOAP requests.
The HTTP status header is heavily used to indicate your request was successful (200 OK).
When not authenticating, you'll get a 401 response. When requesting an endpoint where you have no access to, you'll get a 403. When the input is incorrect, you'll get a 400.
In the event of a non-200 response, the body contains a JSON object with information about what went wrong.
Please always check the response code before accepting the response as your desired outcome!
The HTTP status header is heavily used to indicate your request was successful (200 OK).
When not authenticating, you'll get a 401 response. When requesting an endpoint where you have no access to, you'll get a 403. When the input is incorrect, you'll get a 400.
In the event of a non-200 response, the body contains a JSON object with information about what went wrong.
Please always check the response code before accepting the response as your desired outcome!
Loading...
English
Nederlands
Français