API Documentation - Version 0.3.0
General information
This page contains general information about the API.Note that this API does not follow any API standard (except that the response data is close to JSONAPI, see below). Also note that this API does not claim to be a true REST API.
Host and protocol
All actions of the API can be reached under https://www.claims-online.de .
The WebCert API is a HTTP API. The protocol to access all actions (end points) is HTTPS.
Data exchange format
Unless otherwise stated, the request and response format of all actions is JSON. All data must be submitted in JSON format with content type application/json . All data is delivered in JSON format, with content type application/json .
The format of the response data is strongly oriented towards, but does not claim to be fully compliant with JSONAPI. Please refer to the specification to understand how data or errors are delivered.
The exception is document content. The submitted content is expected to be a binary string and is delivered as such. The content type of each request is ignored. The content type of each response depends on the type of document and based on IANA Mediatypes (for example application/pdf for PDF).
Authentication
For security reasons, the type of authentication is not described here and is only communicated on request.
Status codes
Unless otherwise stated, the API returns the following HTTP status codes:
| Status code | Description |
|---|---|
| 200 | The request was successful. |
| 201 | The resource was successfully created. |
| 401 | Authentication failed. The API client could not be authenticated. |
| 403 | Authorization denied. The API client is not authorized to access the request resource. |
| 404 | Resource not found. |
| 422 | Validation error. The submitted data was not valid. |
| 500 | Internal server error |
Errors
Errors are return JSONAPI like. For example, the following response describes the error that the claim was not found:
{
"errors": [
{
"status":404,
"code":"not_found",
"detail":"The claim was not found.",
"source":{"parameter":"id"},
"meta":{"id":"XJ7UY1"}
}
]
}
The status
is the HTTP status code.
The code
is an API specific unique error identifier.
This can also be a business rule error such as
cannot_report_completed_claim
.
The detail
is a text describing the error more human friendly.
The source
is the source of the error.
If parameter
is used an URL parameter is meant,
if pointer
is used a "path" in the submitted form parameters is meant,
e.g. /claim/client/street
.
Parameter types
The following parameter types exist and are referenced in this documentation:
| Name | Description | Example |
|---|---|---|
| ID | The resource ID as 6 character string | KN67QP |
| address | An address object (see Addresses ) | See Addresses |
| amount | A float considered as an amount (format xxx(.yy)) | 1000, 1000.0, 750.42 |
| boolean | A boolean | true, false |
| country | A string containing ISO 3166 country code | DE, US |
| currency | A string containing ISO 4217 currency code | EUR, USD |
| date | A string containing ISO 2014 date | 2024-06-25 |
| integer | An integer | 42, 1000 |
| string | A string | "In the kitchen" |
| text | A multi line text | "Some\nlong\ntext" |
| time | A string containing ISO 8601 time | 2024-06-25T12:13:14Z |
Caching
Caching is currently not supported, but might be supported in the future.
Available Actions
See sidebar.Workflow
A typical procedure can look like this:
A claim is created in the system and gets the status "draft". The claim is not processed further by Carl Schröter.
One or more documents are added . The claim is updated several times if necessary. Here too, the claim is not further processed by Carl Schröter.
If all data required by the API is available and all information has been transferred from the API client's perspective, the claim can be reported .
This triggers the processing of the claim by Carl Schröter. The claim receives the status "reported" and a Carl Schröter claim number.
Further additions can be made to the damage (similar to the update).
If Carl Schröter has completed processing, the claim receives the status "paid" or "rejected". Changes to the claim are no longer possible.
Get started
If the authentication has been clarified, it is recommended to test this by retrieving the available policies via List policies .
For testing and/or developing against the API with an API client, please see Test system