{"info":{"_postman_id":"0da31c35-2bdc-4b16-8f08-2955a069bde8","name":"Insurance-Manager 4.6 API","description":"

API Reference

\n
\n

NOTE: This copy of documentation is subject to change without notice.

\n
\n

REST API

\n

The RESTful Service for Insurance-Manager empowers customers and vetted partners and third parties to build custom applications that interact with Aedes or Aedes Vlaanderen. The Insurance-Manager API provides broad coverage of the Aedes and Aedes Vlaanderen insurance products.

\n

The reference documentation does not cover all scenarios or roles. Permission and client data will differ based on the individual configuration. Mock examples complete with requests, responses, and parameters are provided for general understanding.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API Reference","slug":"api-reference"}],"owner":"1106816","collectionId":"0da31c35-2bdc-4b16-8f08-2955a069bde8","publishedId":"UV5cAvYb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-11-03T07:20:15.000Z"},"item":[{"name":"RESTful API Overview","item":[{"name":"Authentication","item":[{"name":"User authentication","id":"5b7208e3-4216-4932-b32a-bb315065ccf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

Required.

\n

The type of content supported by the API endpoint.

\n","key":"Content-Type","value":"application/json"},{"description":"

Optional.

\n

The identifier of the desired tenant.

\n","key":"Abp.TenantId","value":"{{tenantId}}"},{"description":"

Optional.

\n

The desired languages of localized properties or messages.

\n","key":".AspNetCore.Culture","value":"{{culture}}"}],"body":{"mode":"raw","raw":"{\n \"password\": \"\",\n \"userNameOrEmailAddress\": \"\",\n \"captchaResponse\": \"\",\n \"rememberClient\": false,\n \"returnUrl\": \"\",\n \"singleSignIn\": false,\n \"twoFactorRememberClientToken\": \"\",\n \"twoFactorVerificationCode\": \"\"\n}"},"url":"//api/v1/system/authentication/token/authenticate","description":"

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescription
accessTokenThe unique credential that provides specific permission to use the API.
encryptedAccessTokenThe encrypted access token.
expireInSecondsThe number of seconds until the access token expires. This is a running countdown and is set to 86400 seconds (24 hours).
passwordResetCodeThe password reset code if the the needs to reset his password.
refreshTokenThe unique credential that allows a client to get a new access token.
refreshTokenExpireInSecondsThe number of seconds until the access token expires.
requiresTwoFactorVerificationA value indicating whether the two factor authentication is required
returnUrlThe return URL. Same URL as passed as input to the request.
shouldResetPasswordA value indicating whether the user should reset his password.
twoFactorAuthProvidersIndicates the two factor authentication provider.
twoFactorRememberClientTokenThe token to remember the client in case of a two factor authentication.
userIdThe user identity value of the authenticated user.
\n
","urlObject":{"path":["api","v1","system","authentication","token","authenticate"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"9b21b065-8e1f-44b7-8730-9ee3cd36ecfb","name":"Authenticated","originalRequest":{"method":"POST","header":[{"description":"*Required.*\n\nThe type of content supported by the API endpoint.","key":"Content-Type","value":"application/json"},{"description":"*Optional.*\n\nThe identifier of the desired tenant.","key":"Abp.TenantId","value":"{{tenantId}}"},{"description":"*Optional.*\n\nThe desired languages of localized properties or messages.","key":".AspNetCore.Culture","value":"{{culture}}"}],"body":{"mode":"raw","raw":"{\n \"password\": \"valid password\",\n \"userNameOrEmailAddress\": \"and valid user\",\n \"captchaResponse\": \"\",\n \"rememberClient\": false,\n \"returnUrl\": \"\",\n \"singleSignIn\": false,\n \"twoFactorRememberClientToken\": \"\",\n \"twoFactorVerificationCode\": \"\"\n}"},"url":"//api/v1/system/authentication/token/authenticate"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Request-Context","value":"appId=cid-v1:d9061de1-0352-413c-be37-82278189d630"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Rate-Limit-Limit","value":"1d"},{"key":"X-Rate-Limit-Remaining","value":"5394"},{"key":"X-Rate-Limit-Reset","value":"2021-10-27T09:19:45.2078262Z"},{"key":"Date","value":"Tue, 26 Oct 2021 09:33:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"accessToken\": \"\",\n \"encryptedAccessToken\": \"\",\n \"refreshTokenExpireInSeconds\": 31536000,\n \"requiresTwoFactorVerification\": false,\n \"returnUrl\": \"\",\n \"shouldResetPassword\": false,\n \"twoFactorAuthProviders\": null,\n \"twoFactorRememberClientToken\": null,\n \"userId\": 1\n },\n \"targetUrl\": null,\n \"success\": true,\n \"error\": null,\n \"unAuthorizedRequest\": false,\n \"__abp\": true\n}"},{"id":"6bf324ca-beb4-480e-92db-0a810791149c","name":"Failed","originalRequest":{"method":"POST","header":[{"description":"*Required.*\n\nThe type of content supported by the API endpoint.","key":"Content-Type","value":"application/json"},{"description":"*Optional.*\n\nThe identifier of the desired tenant.","key":"Abp.TenantId","value":"{{tenantId}}"},{"description":"*Optional.*\n\nThe desired languages of localized properties or messages.","key":".AspNetCore.Culture","value":"{{culture}}"}],"body":{"mode":"raw","raw":"{\n \"password\": \"\",\n \"userNameOrEmailAddress\": \"\",\n \"captchaResponse\": \"\",\n \"rememberClient\": false,\n \"returnUrl\": \"\",\n \"singleSignIn\": false,\n \"twoFactorRememberClientToken\": \"\",\n \"twoFactorVerificationCode\": \"\"\n}"},"url":"//api/v1/system/authentication/token/authenticate"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"Text","header":[{"key":"Content-Length","value":"188"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Request-Context","value":"appId=cid-v1:d9061de1-0352-413c-be37-82278189d630"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Rate-Limit-Limit","value":"1d"},{"key":"X-Rate-Limit-Remaining","value":"5397"},{"key":"X-Rate-Limit-Reset","value":"2021-10-27T09:19:45.2078262Z"},{"key":"Date","value":"Tue, 26 Oct 2021 09:24:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": null,\n \"targetUrl\": null,\n \"success\": false,\n \"error\": {\n \"code\": 0,\n \"message\": \"Invalid user name or password\",\n \"details\": null,\n \"validationErrors\": null\n },\n \"unAuthorizedRequest\": true,\n \"__abp\": true\n}"}],"_postman_id":"5b7208e3-4216-4932-b32a-bb315065ccf0"},{"name":"Refresh access token","id":"d33d2a0c-54e3-475c-8dce-f665a2109569","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"\""},"url":"//api/v1/system/authentication/token/refresh","description":"

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescription
accessTokenThe refreshed unique credential that provides specific permission to use the API.
encryptedAccessTokenThe refreshed encrypted access token.
expireInSecondsThe number of seconds until the access token expires. This is a running countdown and is set to 86400 seconds (24 hours).
\n
","urlObject":{"path":["api","v1","system","authentication","token","refresh"],"host":["/"],"query":[],"variable":[]}},"response":[],"_postman_id":"d33d2a0c-54e3-475c-8dce-f665a2109569"}],"id":"173ab66c-6e7a-4de1-9d45-bdd3320fb1ed","description":"

Send a secure request to get an authorization (bearer) token.

\n

Nearly every REST API endpoint you access requires that you supply a bearer token in the header of your request to verify that you are an authorized user.

\n

Get an access token

\n

You submit a POST request to the /v1/system/authentication/token/authenticate endpoint to obtain the access token that you must use in every API request.\nThe request body must contain the username and password you received from Aedes or Aedes Vlaanderen.

\n","_postman_id":"173ab66c-6e7a-4de1-9d45-bdd3320fb1ed"},{"name":"Multi-Tenancy","item":[],"id":"8df801cf-2a72-40ae-80cd-a2bc0e20d54d","description":"
\n

NOTE: Aedes and Aedes Vlaanderen are threated as different entities in the system. This is why a valid tenant identifier is needed for ervery request against the Insurance-Manager API.

\n
\n

Select a tenant

\n

There are severeal way how the Insurance-Manager API detects the tenant identifier.

\n
    \n
  1. If the user is logged in, the Insurance-Manager API gets the tenant identifier from the current claims. The claim name is http://www.aspnetboilerplate.com/identity/claims/tenantId and should contain an integer value.
    2. \n
  2. If the user has not logged in, then the Insurance-Manager API tries to resolve the tenant indentifier by using the following mehtods. The methods are run from top to down and the first successful resolver 'wins':
      \n
    1. Tries to resolve the tenant identifier from an Abp.TenantId header value, if present.
      2. \n
    2. Tries to resolve the tenant identifier from an Abp.TenantId cookie value, if present.
      3. \n
    \n
    3. \n
\n

The available tenant identifiers are:

\n
    \n
  • 4 for Aedes.
    • \n
  • 5 for Aedes Vlaanderen.
    • \n
\n","_postman_id":"8df801cf-2a72-40ae-80cd-a2bc0e20d54d"},{"name":"Localization","item":[{"name":"New Request","id":"90ed653b-45a2-481f-9845-fa8804253e5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"90ed653b-45a2-481f-9845-fa8804253e5a"}],"id":"9014b1a1-2b74-4620-b4f2-436491fe5306","description":"

The culture in which InsuranceManager API will return properties or messages can be selected. The following cultures are supported:

\n
    \n
  • French – fr
    • \n
  • Dutch – nl
    • \n
  • English – en (validation and error messages but not all internal translations)
    • \n
  • German – de (validation and error messages but not all internal translations)
    • \n
\n

To switch the culture, the Insurance-Manager API offers different methods. The methods are run from top to down and the first successful resolver 'wins':

\n
    \n
  • Query string - Specify the culture using a query string.\nExample:
    • \n
\n
culture=fr&ui-culture=fr\n
    \n
  • Request Header - Setting the .AspNetCore.Culture value in the header of a request.\nExample:
    • \n
\n
.AspNetCore.Culture: c=fr|uic=fr\n
    \n
  • Cookie - Setting the .AspNetCore.Culture cookie value.\nExample:
    • \n
\n
c=fr|uic=fr\n
    \n
  • Request Header - Setting the Accept-Language value in the header of a request.\nExample:
    • \n
\n
accept-language: fr,fr;q=0.8,en;q=0.6\n
","_postman_id":"9014b1a1-2b74-4620-b4f2-436491fe5306"},{"name":"Response Codes","item":[],"id":"b4fadb13-376a-4007-b03c-398aead326dc","description":"

The response to your request contains the status code in the response header and any requested data in the response body.

\n

Success Codes

\n

Successful requests return the requested resource and the return status success code.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
RequestReturn status success-codeRequested resource
GET200 OKThe current JSON representation of the resource. API endpoint worked as expected. If the user does not have access to the requested resource, the GET returns 403 Forbidden.
POST200 OKThe current JSON representation of the created resource. API endpoint worked as expected. If the user does not have access to create the resource, the POST returns 403 Forbidden.
PUT200 OKThe current JSON representation of the updated resource. If the user does not have access to update the resource, the PUT returns 403 Forbidden.
DELETE200 OKIf the user does not have access to delete the resource, the DELETE returns 403 Forbidden.
\n

Error Codes

\n

Sometimes requests to the Insurance-Manager API are not successful. Errors can occur for a wide range of reasons. In all cases, the Insurance-Manager API returns a status code that indicates the nature of the failure with a response body containing additional information.

\n

Here are some of the most common error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeMeaningDescription
400Bad requestThis usually occurs because of a missing or malformed parameter. Check the details field of the response body, the documentation and the syntax of the request and try again.
401No authorizationA valid API key was not provided with the request, so the API could not associate a user with the request.
403ForbiddenThe user does not have access to the requested resource. The API key and request syntax were valid but the server is refusing to complete the request.
404Not foundThe object specified by the request does not exist.
429To many requestsThis usually occurs when you exceed your request limits.
500Internal server errorThere was a problem on the application server.
\n
","_postman_id":"b4fadb13-376a-4007-b03c-398aead326dc"},{"name":"Rate limiting","item":[],"id":"d0645b7f-ea4e-485a-96dc-b3af57bfdf1c","description":"

For performance and security reasons, the Insurance-Manager API has active rate limits.\nIf too many requests are send from the same IP addresse, the requests will be rejected with an HTTP status code 429. The access will be blocked for a certain time.

\n

For the sake of security, the active limits are not listed in this documentation.

\n","_postman_id":"d0645b7f-ea4e-485a-96dc-b3af57bfdf1c"},{"name":"Data validation","item":[{"name":"Binding validation","item":[],"id":"0fc464f4-f71c-4428-8790-f6dfba20e979","description":"

The following is a list of binding validation messages in the supported languages:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EnglishFrançaisNederlandsDeutsch
The value {0} is not valid for ‘{1}’.La valeur {0} n’est pas valable pour ‘{1}’.De waarde {0} is niet geldig voor ‘{1}’.Der Wert {0} ist nicht gültig für ‘{1}’.
A value for the ‘{0}’ property was not provided.Une valeur pour le champ ‘{0}’ n’a pas été fournie.Een waarde voor de “{0}” eigenschap werd niet gegeven.Ein Wert für das Feld ‘{0}’ wurde nicht angegeben.
A value is required.Une valeur est requise.Een waarde is vereist.Ein Wert ist erforderlich.
A non-empty request body is required.Un Request-Body non-vides est nécessaire.De specificatie van een Request-Body is vereist.Die Angabe eines Request-Body’s ist erforderlich.
The value {0} is not valid.La valeur {0} n’est pas valide.De waarde {0} is niet geldig.Der Wert {0} ist ungültig.
The supplied value is invalid.La valeur fournie n’est pas valable.De geleverde waarde is ongeldig.Der angegebene Wert ist ungültig.
The field must be a number.Le champ doit être un numéro.Het veld moet een nummer zijn.Das Feld muss eine Zahl sein.
The supplied value is invalid for ‘{0}’.La valeur fournie n’est pas valable pour ‘{0}’.De geleverde waarde is ongeldig voor ‘{0}’.Der angegebene Wert für ‘{0}’ ist ungültig.
The value {0} is invalid.La valeur {0} n’est pas valide.De waarde {0} is ongeldig.Der Wert {0} ist ungültig.
The field ‘{0}’ must be a number.Le champ ‘{0}’ doit être un nombre.Het veld ‘{0}’ moet een getal zijn.Das Feld ‘{0}’ muss eine Zahl sein.
The value {0} is invalid.La valeur {0} n’est pas valide.De waarde {0} is niet geldig.Der Wert {0} ist ungültig.
\n
","_postman_id":"0fc464f4-f71c-4428-8790-f6dfba20e979"},{"name":"Data validation","item":[],"id":"29914926-8052-416c-a068-baeb579af065","description":"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EnglishFrançaisNederlandsDeutsch
‘{PropertyName}’ is not a valid email address.‘{PropertyName}’ n’est pas une adresse email valide.‘{PropertyName}’ is geen geldig email adres.‘{PropertyName}’ ist keine gültige E-Mail-Adresse.
‘{PropertyName}’ must be greater than or equal to ‘{ComparisonValue}’.‘{PropertyName}’ doit être plus grand ou égal à ‘{ComparisonValue}’.‘{PropertyName}’ moet meer dan of gelijk zijn aan ‘{ComparisonValue}’.Der Wert von ‘{PropertyName}’ muss grösser oder gleich ‘{ComparisonValue}’ sein.
‘{PropertyName}’ must be greater than ‘{ComparisonValue}’.‘{PropertyName}’ doit être plus grand que ‘{ComparisonValue}’.‘{PropertyName}’ moet groter zijn dan ‘{ComparisonValue}’.Der Wert von ‘{PropertyName}’ muss grösser sein als ‘{ComparisonValue}’.
‘{PropertyName}’ must be between {MinLength} and {MaxLength} characters. You entered {TotalLength} characters.‘{PropertyName}’ doit contenir entre {MinLength} et {MaxLength} caractères. {TotalLength} caractères ont été saisis.De lengte van ‘{PropertyName}’ moet tussen {MinLength} en {MaxLength} karakters zijn. Er zijn {TotalLength} karakters ingevoerd.Die Länge von ‘{PropertyName}’ muss zwischen {MinLength} und {MaxLength} Zeichen liegen. Es wurden {TotalLength} Zeichen eingetragen.
The length of ‘{PropertyName}’ must be at least {MinLength} characters. You entered {TotalLength} characters.‘{PropertyName}’ doit être supérieur ou égal à {MinLength} caractères. Vous avez saisi {TotalLength} caractères.De lengte van ‘{PropertyName}’ moet groter zijn dan of gelijk aan {MinLength} tekens. U hebt {TotalLength} -tekens ingevoerd.Die Länge von ‘{PropertyName}’ muss größer oder gleich {MinLength} sein. Sie haben {TotalLength} Zeichen eingegeben.
The length of ‘{PropertyName}’ must be {MaxLength} characters or fewer. You entered {TotalLength} characters.‘{PropertyName}’ doit être inférieur ou égal à {MaxLength} caractères. Vous avez saisi {TotalLength} caractères.De lengte van ‘{PropertyName}’ moet kleiner zijn dan of gelijk aan {MaxLength} tekens. U hebt {TotalLength} -tekens ingevoerd.Die Länge von ‘{PropertyName}’ muss kleiner oder gleich {MaxLength} sein. Sie haben {TotalLength} Zeichen eingegeben.
‘{PropertyName}’ must be less than or equal to ‘{ComparisonValue}’.‘{PropertyName}’ doit être plus petit ou égal à ‘{ComparisonValue}’.‘{PropertyName}’ moet minder dan of gelijk zijn aan ‘{ComparisonValue}’.Der Wert von ‘{PropertyName}’ muss kleiner oder gleich ‘{ComparisonValue}’ sein.
‘{PropertyName}’ must be less than ‘{ComparisonValue}’.‘{PropertyName}’ doit être plus petit que ‘{ComparisonValue}’.‘{PropertyName}’ moet minder zijn dan ‘{ComparisonValue}’.Der Wert von ‘{PropertyName}’ muss kleiner sein als ‘{ComparisonValue}’.
‘{PropertyName}’ must not be empty.‘{PropertyName}’ ne doit pas être vide.‘{PropertyName}’ mag niet leeg zijn.‘{PropertyName}’ darf nicht leer sein.
‘{PropertyName}’ must not be equal to ‘{ComparisonValue}’.‘{PropertyName}’ ne doit pas être égal à ‘{ComparisonValue}’.‘{PropertyName}’ moet anders zijn dan ‘{ComparisonValue}’.‘{PropertyName}’ darf nicht ‘{ComparisonValue}’ sein.
‘{PropertyName}’ must not be empty.‘{PropertyName}’ ne doit pas avoir la valeur null.‘{PropertyName}’ mag niet leeg zijn.‘{PropertyName}’ darf kein Nullwert sein.
The specified condition was not met for ‘{PropertyName}’.‘{PropertyName}’ ne respecte pas la condition fixée.‘{PropertyName}’ voldoet niet aan de vereisten.Der Wert von ‘{PropertyName}’ entspricht nicht der festgelegten Bedingung.
The specified condition was not met for ‘{PropertyName}’.‘{PropertyName}’ ne respecte pas la condition fixée.‘{PropertyName}’ voldoet niet aan de vereisten.Der Wert von ‘{PropertyName}’ entspricht nicht der festgelegten Bedingung.
‘{PropertyName}’ is not in the correct format.‘{PropertyName}’ n’a pas le bon format.‘{PropertyName}’ voldoet niet aan het verwachte formaat.‘{PropertyName}’ weist ein ungültiges Format auf.
‘{PropertyName}’ must be equal to ‘{ComparisonValue}’.‘{PropertyName}’ doit être égal à ‘{ComparisonValue}’.‘{PropertyName}’ moet gelijk zijn aan ‘{ComparisonValue}’.‘{PropertyName}’ muss gleich ‘{ComparisonValue}’ sein.
‘{PropertyName}’ must be {MaxLength} characters in length. You entered {TotalLength} characters.‘{PropertyName}’ doit être d’une longueur de {MaxLength} caractères. {TotalLength} caractères ont été saisis.De lengte van ‘{PropertyName}’ moet {MaxLength} karakters zijn. Er zijn {TotalLength} karakters ingevoerd.‘{PropertyName}’ muss genau {MaxLength} lang sein. Es wurden {TotalLength} eingegeben.
‘{PropertyName}’ must be between {From} and {To}. You entered {Value}.‘{PropertyName}’ doit être entre {From} et {To}. Vous avez saisi {Value}.‘{PropertyName}’ moet tussen {From} en {To} liggen. Je hebt ingevuld {Value}.‘{PropertyName}’ muss zwischen {From} and {To} sein. Es wurde {Value} eingegeben.
‘{PropertyName}’ must be between {From} and {To} (exclusive). You entered {Value}.‘{PropertyName}’ doit être entre {From} et {To} (exclusif). Vous avez saisi {Value}.‘{PropertyName}’ moet na {From} komen en voor {To} liggen. Je hebt ingevuld {Value}.‘{PropertyName}’ muss zwischen {From} und {To} sein (exklusiv). Es wurde {Value} eingegeben.
‘{PropertyName}’ is not a valid credit card number.‘{PropertyName}’ n’est pas un numéro de carte de crédit valide.‘{PropertyName}’ is geen geldig credit card nummer.‘{PropertyName}’ ist keine gültige Kreditkartennummer.
‘{PropertyName}’ must not be more than {ExpectedPrecision} digits in total, with allowance for {ExpectedScale} decimals. {Digits} digits and {ActualScale} decimals were found.‘{PropertyName}’ ne doit pas dépasser {ExpectedPrecision} chiffres au total, avec une tolérance pour les décimales {ExpectedScale}. Les chiffres {Digits} et les décimales {ActualScale} ont été trouvés.‘{PropertyName}’ mag in totaal niet meer dan {ExpectedPrecision} decimalen nauwkeurig zijn, met een grote van {ExpectedScale} gehele getallen. Er zijn {Digits} decimalen en een grote van {ActualScale} gehele getallen gevonden.‘{PropertyName}’ darf insgesamt nicht mehr als {ExpectedPrecision} Ziffern enthalten, mit Berücksichtigung von {ExpectedScale} Dezimalstellen. Es wurden {Digits} Ziffern und {ActualScale} Dezimalstellen gefunden.
‘{PropertyName}’ must be empty.‘{PropertyName}’ devrait être vide.‘{PropertyName}’ hoort leeg te zijn.‘{PropertyName}’ sollte leer sein.
‘{PropertyName}’ must be empty.‘{PropertyName}’ devrait être vide.‘{PropertyName}’ moet leeg zijn.‘{PropertyName}’ sollte leer sein.
‘{PropertyName}’ has a range of values which does not include ‘{PropertyValue}’.‘{PropertyName}’ a une plage de valeurs qui n’inclut pas ‘{PropertyValue}’.‘{PropertyValue}’ komt niet voor in het bereik van ‘{PropertyName}’.‘{PropertyName}’ hat einen Wertebereich, der ‘{PropertyValue}’ nicht enthält.
‘{PropertyName}’ must be between {MinLength} and {MaxLength} characters.‘{PropertyName}’ doit contenir entre {MinLength} et {MaxLength} caractères.De lengte van ‘{PropertyName}’ moet tussen {MinLength} en {MaxLength} karakters zijn.Die Länge von ‘{PropertyName}’ muss zwischen {MinLength} und {MaxLength} Zeichen liegen.
The length of ‘{PropertyName}’ must be at least {MinLength} characters.‘{PropertyName}’ doit être supérieur ou égal à {MinLength} caractères.De lengte van ‘{PropertyName}’ moet groter zijn dan of gelijk aan {MinLength} tekens.Die Länge von ‘{PropertyName}’ muss größer oder gleich {MinLength} sein.
The length of ‘{PropertyName}’ must be {MaxLength} characters or fewer.‘{PropertyName}’ doit être inférieur ou égal à {MaxLength} caractères.De lengte van ‘{PropertyName}’ moet kleiner zijn dan of gelijk aan {MaxLength} tekens.Die Länge von ‘{PropertyName}’ muss kleiner oder gleich {MaxLength} sein.
‘{PropertyName}’ must be {MaxLength} characters in length.‘{PropertyName}’ doit être d’une longueur de {MaxLength} caractères.De lengte van ‘{PropertyName}’ moet {MaxLength} karakters zijn.‘{PropertyName}’ muss genau {MaxLength} lang sein.
‘{PropertyName}’ must be between {From} and {To}.‘{PropertyName}’ doit être entre {From} et {To}.‘{PropertyName}’ moet tussen {From} en {To} liggen.‘{PropertyName}’ muss zwischen {From} and {To} sein.
‘{PropertyName}’ contains a non-existing reference identifier.‘{PropertyName}’ contient un identifiant de référence inexistant.‘{PropertyName}’ bevat een niet-bestaande referentie-identificatiecode.‘{PropertyName}’ enthält einen nicht existierenden Referenzidentifikator.
‘{PropertyName}’ collection can’t contain multiple items of same type.La collection ‘{PropertyName}’ ne peut pas contenir plusieurs éléments du même type.De ‘{PropertyName}’ collectie kan niet meerdere items van hetzelfde type bevatten.Die Auflistung ‘{PropertyName}’ kann nicht mehrere Einträge desselben Typs enthalten.
‘{PropertyName}’ collection should have one item of type ‘{TypeNameValue}’.La collection ‘{PropertyName}’ doit contenir un élément du type ‘{TypeNameValue}’.De ‘{PropertyName}’ collectie moet één item van het type ‘{TypeNameValue}’ hebben.Die Auflistung ‘{PropertyName}’ sollte einen Eintrag des Typs ‘{TypeNameValue}’ enthalten.
The value of ‘{PropertyName}’ is not allowed in the current situation.La valeur de ‘{PropertyName}’ n’est pas autorisée dans la situation actuelle.De waarde van ‘{PropertyName}’ is niet toegestaan in de actuele situatie.Der Wert von ‘{PropertyName}’ ist in der aktuellen Situation nicht zulässig.
The object referenced by ‘{PropertyName}’ is in a state where the operation is not allowed.L’objet référencé par ‘{PropertyName}’ est dans un état où l’opération n’est pas autorisée.Het object waarnaar wordt verwezen door ‘{PropertyName}’ bevindt zich in een toestand waarin de bewerking niet is toegestaan.Das Objekt, auf das von ‘{PropertyName}’ verwiesen wird, befindet sich in einem Zustand, in dem der Vorgang nicht zulässig ist.
\n
","_postman_id":"29914926-8052-416c-a068-baeb579af065"}],"id":"0b513b12-7d70-44de-8d7f-abe54a8de400","description":"

Before executing a request, the incomming data is always validated. The validation process is organized in two steps:

\n
    \n
  • Binding validation:
    • \n
\n

During this step, the Insurance-Manager API tries to convert the passed data. If a value can’t be converted, you will receive error messages for this.\nFor instance, the date 08/10/202O can not be converted because the last character is a character and not a value.

\n
    \n
  • Data validation:
    • \n
\n

During this step, the request body content will be validated. If the content is invalid, a list of validation error messages is returned.

\n","_postman_id":"0b513b12-7d70-44de-8d7f-abe54a8de400"},{"name":"Pagination","item":[],"id":"1fde11eb-1a08-432b-9cab-09d9f104b571","description":"

The ability to paginate and filter can be useful for limiting large bodies of data.

\n

In general, endpoints which can return a larger amount of data support paging and filtering. Use the following query string parameters to paginate, filter or sort the returned data.

\n

Limit or pagesize

\n

Use this query string parameter to limit the number of returned records. A value of 0 returns all avalaible records.

\n

Example:

\n
GET {{base_url}}/api/v1/policies?maxresultcount=50\n

OR

\n
GET {{base_url}}/api/v1/policies?maxresultcount=0\n

Offset or page

\n

Use this query string parameter to skip a given number of records.

\n

Example:

\n
GET {{base_url}}/api/v1/policies?maxresultcount=50&skipcount=25\n

Filter

\n

Use this query string parameter to filter the results returned.

\n

Example:

\n
GET {{base_url}}/api/v1/policies?filter=brokerCode=\"600002\"\n

Order

\n

Use this query string parameter to sort the results returned. By default, the objects are sorted in ascending order (ASC) . To sort in a descending order, append DESC to the column name. Multiple columns can be specified and must be seperated by a comma.

\n

Example:

\n
GET {{base_url}}/api/v1/policies?maxresultcount=50?sorting=brokername DESC, effectdate ASC\n
","_postman_id":"1fde11eb-1a08-432b-9cab-09d9f104b571"}],"id":"36c4a7c5-d822-4ba2-a431-f67ec5688001","description":"

JSON

\n

Every resource you interact with using the Insurance-Manager API must be represented in JSON format.

\n

Request header

\n

At a minimum, the request header typically specifies:

\n
    \n
  • The access_token to authenticate you to the server.
    • \n
  • The content-type to identify the format of the data.
    • \n
\n

Optional parameters are:

\n
    \n
  • The Abp.TenantId to switch between the tenant Aedes and Aedes Vlaanderen. See Multi-Tenancy for more information.
    • \n
  • The accept-language or .AspNetCore.Culture to select the language for localized properties or messages. See Localization for more information.
    • \n
\n

Example:

\n
authorization: Bearer {{oauth_token}}\ncontent-type: application/json; charset=utf-8\nCache-Control: no-cache, no-transform\nAccept-Language: \nAbp.TenantId: 4\n

Request Body

\n

For example, include JSON like the following in the request body to create a policyholder for John Doe:

\n
{\n    \"address\": {\n        \"city\": \"BRUXELLES\",\n        \"countryId\": \"B\",\n        \"houseNumber\": \"99\",\n        \"postCode\": \"1000\",\n        \"street\": \"Rue de la Loi\"\n    },\n    \"birthdate\": \"1965-08-13\",\n    \"firstName\": \"John\",\n    \"licenseDate\": \"1985-09-21\",\n    \"name\": \"Doe\",\n}\n

For reasons of simplification, not all fields have been specified in this demo request body.

\n

Response content

\n

The Insurance-Manager API wraps the response content in a special response object. An actual response looks like this:

\n
{\n    \"success\": true,\n    \"result\": {\n        ...\n    },\n    \"error\": null,\n    \"targetUrl\": null,\n    \"unAuthorizedRequest\": false,\n    \"__abp\": true\n}\n

Here's an explanation of all the fields:

\n
    \n
  • success A boolean value that indicates the status of the operation.
    • \n
  • result The actual return value. It’s valid if the request was successfully and the server sends a return value.
    • \n
  • error In the case of a failed request an object that contains a message and details field with the error description.
    • \n
  • targetUrl This provides a way for the server to redirect the client to another URL if needed.
    • \n
  • unAuthorizedRequest This provides a method for the server to inform the client that this operation is not authorized or the user is not authenticated.
    • \n
  • __abp A special signature that is returned. You don’t use this yourself.
    • \n
\n

Handling errors

\n

As described previously, success will be false in the case of an error. The error element contains information about the error. A response of a failed request will look like this:

\n
{\n    \"success\": false,\n    \"result\": null,\n    \"error\": {\n        \"message\": \"An internal error occurred during your request!\",\n        \"details\": \"...\"\n    },\n    \"targetUrl\": null,\n    \"unAuthorizedRequest\": false,\n    \"__abp\": true\n}\n

Endpoint

\n

The endpoint is a URL that identifies the resource you want to access. Endpoints have a form like the following:

\n
{{base_url}}/v1/brokers/{{123456789}}\n
    \n

  • The {{base_url}} is typically represented as a variable and, as an example, might resolve to a path such as: https://{{insurance-manager-domain-and-path}}/api

    \n
    • \n

  • The version is typically represented by a constant, such as v1 in the preceding example and points to the desired version of the endpoint.

    \n
    • \n

  • The path to the resource can include one or more segments, such as brokers and 123456789 in the preceding example, where 123456789 is the ID of the specific broker you are requesting.

    \n
    • \n
\n

Base URL

\n

The base URL is formed as follows:

\n
https://{{insurance-manager-domain-and-path}}/api\n

where {{insurance-manager-domain-and-path}} is the fully qualified domain name and path to the Insurance-Manager API.

\n

The Insurance-Manager API is available for two different environments. The first is staging environement and this can be used for testing purposes. The second is the production environment.\nBoth environments use different base URL's:

\n\n

Example of a valid staging URL:

\n
https://insurancemanager.staging.api.aedessa.be/api/v1/brokers/600001\n

Example of a valid production URL:

\n
https://insurancemanager.api.aedessa.be/api/v1/brokers/600001\n

HTTP Verbs

\n

The Insurance-Manager API rely on the four standard HTTP verbs to access and manipulate resources:

\n
    \n
  • POST creates the resource
    • \n
  • GET reads the resource
    • \n
  • PUT updates the resource
    • \n
  • DELETE deletes the resource
    • \n
\n","_postman_id":"36c4a7c5-d822-4ba2-a431-f67ec5688001"},{"name":"Application","item":[],"id":"299f0a3f-152c-4bb0-a2da-97a8fdfcf4e0","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a81f8991-25e3-4175-a5f9-ccb531a45dbb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3865437a-afee-41c9-9551-c53f15bd1610","type":"text/javascript","exec":[""]}}],"_postman_id":"299f0a3f-152c-4bb0-a2da-97a8fdfcf4e0","description":""},{"name":"System","item":[],"id":"64226c8d-ca3f-4d53-ace0-28eb21d94245","_postman_id":"64226c8d-ca3f-4d53-ace0-28eb21d94245","description":""}],"event":[{"listen":"prerequest","script":{"id":"16b48f9b-c5e6-41e9-8d6b-d956b40012bc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2b6d134f-0a4e-411e-bb90-694b8bf29b2d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"/"},{"key":"tenantId","value":"{{tenantId}}"},{"key":"culture","value":"{{culture}}"}]}