Snitfladebeskrivelser for visningsklienter - produktion
- Kurt Hansen (Unlicensed)
- Kurt Hansen
- Lars Albert (Unlicensed)
- Mads Østergaard
Beskrivelse af snitflader som Orkestreringskomponenten udstiller og som anvendes af visningklienter der implementerer overbliksvisninger. På siden vises kun nyeste version af snitflader.
Redaktør: Kurt Hansen
1. 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.
Snitfladebeskrivelser
Datamodel | Snitfladedokumentation |
|---|---|
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.1.0 (Beviser, attester og tilladelser) | 
|
Borgervendt Stamdata v1.0.0 | 
|
| 
|
2. Fejlhåndtering og fejl-struktur
Fejl der optræder på snitflader mod datakilder, håndteres af Orkestreringskomponenten, men rapporteres videre til visningsklienter sammen med fejl fra Orkestreringskomponenten i data-strukturen , der returneres til visningsklienten, således at visningsklienter kan vise relevant information om fejl til borgere.
Følgende fejltyper kan returneres fra Orkestreringskomponenten.
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 |
Fejlstruktur.
Fejl returneres i en fejlstruktur der følger RFC 7807, og har følgende skema-definition.
"fejlstruktur": {
"type": "object",
"properties": {
"error": {
"oneOf": [
{
"$ref": "#/definitions/ErrorStructure"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"ErrorStructure": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "string"
},
"detail": {
"type": "string"
},
"instance": {
"type": "string"
},
"datakilde": {
"type": [
"string",
"null"
]
}
},
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"additionalProperties": false
}
Eksempel på udfyldt fejlstruktur.
<fejlstruktur>
<type>https://orchestrationcomponent.digst.dk/probs/Input-param-error</type>
<title>Invalid input parameter from display client</title>
<status>400</status>
<detail>There was an error when validating the display client</detail>
<instance>https://orchestrationcomponent.digst.dk/correlationID/78306376-
8f3c-4630-890a-4f3d490722f1</instance>
<datakilde/>
</fejlstruktur>