Snitfladebeskrivelser og kaldemodeller for datakilder - produktion
- Kurt Hansen (Unlicensed)
- Kurt Hansen
- Lars Albert (Unlicensed)
Beskrivelse af snitflade som Orkestreringskomponenten anvender og som udstilles af datakilder, der leverer data til digitale overblik gennem Orkestreringskomponenten.
Redaktør: Kurt Hansen
Introduktion
Snitfladebeskrivelser er opdelt i et dokument per datamodel. Hvis der er flere versioner af en snitflade for en datamodel, vil der være et dokument per version.
På siden vises kun beskrivelser af snitflader i den seneste version i produktion, da det er denne version, som nye datakilder skal anvende.
Snitfladebeskrivelser
Datamodel | Snitfladedokumentation | Schema for kaldemodel |
|---|---|---|
Borgervendt Sag v3.0.0 | 
| 
|
Borgervendt Økonomisk ydelse v1.0.0 | 
| 
|
Borgervendt Ydelse v2.1.0 (Serviceydelser og hjælpemidler) | 
| 
|
Borgervendt Aftaler og frister v1.0.1 | 
| 
|
Borgervendt Gæld og betalinger v1.0.0 | 
| 
|
Borgervendt Akkreditiv v1.0.1 (Beviser, attester og tilladelser) | 
| 
|
Borgervendt Akkreditiv v1.1.0 (Beviser, attester og tilladelser) | 
| 
|
Borgervendt Stamdata v.1.0.0 | 
| 
|
Index ver 1.0.0 Bemærk at dette ikke er en datamodel, men beskrivelse af snitflade for datakilder til vedligeholdelse af data i Index i Orkestreringskomponenten. | 
| Se snitfladedokumentation |
Eksempler på request payload/udfyldt kaldemodel
Kald | Request payload/udfyldt kaldemodel |
|---|---|
Listekald/request | 
|
Detalje - Serviceydelser | 
|
Detalje - Aftale og Frister | 
|
Detalje - BevisAttest og Tilladelser | 
|
Detalje - Gæld og Betalinger | 
|
Detalje - Sag | 
|
Detalje - Økonomisk ydelse | 
|
Fejlhåndtering
Fejl der optræder på snitflader mod datakilder, håndteres af Orkestreringskomponenten, men rapporteres videre til visningsklienter i data-strukturen der returneres til visningsklienten.
Følgende fejltyper kan returneres:
Type | Title | Status |
Agreement-error | Internal error in OK during agreement control | 500 |
Data-source-error | Error calling data source | Get from Data source response status |
Data-source-timeout-error | Timeout reached for data source | 408 |
Data-source-internal-error | Internal error at data source | 500 |
Data-source-security-error | Security validation error when calling data source | 400 |
Data-source-format-error | Invalid format in response from data source | 422 |
Input-param-error | Invalid input parameter from display client | 400 |
Circuit-breaker-error | Circuit breaker is currently active for data source | 502 |
Data-validation-error | Validation error of data in response from data source | 400 |
Fejl returneres i en fejlstruktur der følger RFC 7807.