System API
General:
Basics:
Base-URL: https://capi.lagerkoll.com/v1/system/
Parameters in the url should all be encoded and all data sent should be UTF-8
MAX number of requests per minute is set to 200.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.
Headers:
Accept: application/json Content-Type: application/json
Errors:
| Code | Description |
|---|---|
| 900001 | Credentials don't match |
| 900101 | Common error |
| 900429 | Too many requests |
{
"errorCode" : 900101,
"errorMessage" : "Something went wrong on the server",
"errorField" : null,
"errorData" : null
}
System API:
System
Ping
GETUrl: /ping
Headers:
Accept: application/json or application/xml
Other headers: Open request, no identification-headers needed
Other headers: Open request, no identification-headers needed
Ping server to check that it is alive
Body:
Successfull response:
Get release notes
GETUrl: /releasenotes
Headers:
Accept: application/json or application/xml
Other headers: Open request, no identification-headers needed
Other headers: Open request, no identification-headers needed
Get release notes
Body:
Successfull response:
{"notes": [{ "date": "date", "sv": [{}], "en": [{}], "version": "version" }]}
Get system message
GETUrl: /message
Headers:
Accept: application/json or application/xml
Other headers: Open request, no identification-headers needed
Other headers: Open request, no identification-headers needed
Get current active system message
Body:
Successfull response:
{ "title": "title", "message": "message", "priority": "priority", "updated": 1765847259721 }
Get system configuration
GETUrl: /config
Headers:
Accept: application/json or application/xml
Other headers: Open request, no identification-headers needed
Other headers: Open request, no identification-headers needed
Get configurations valid for this system
Classes:
ReleaseNoteDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
|---|---|---|---|---|---|---|---|
| date | String | R | |||||
| version | String | R | |||||
| sv | List | R | |||||
| en | List | R |
ReleaseNotesDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
|---|---|---|---|---|---|---|---|
| notes | List | R |
SystemConfigDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
|---|---|---|---|---|---|---|---|
| supportsBankIDLogin | boolean | Flag to indicate if login with BankID is activated | R |
SystemMessageDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
|---|---|---|---|---|---|---|---|
| title | String | R | |||||
| message | String | R | |||||
| priority | String | LOW, MEDIUM, HIGH | R | ||||
| updated | Date | R |