GetResult
Introduction
This new webservice is introduced in order to enable clients to retrieve the result of a case in the desired format in order to display it in an easy readable format.
GET /getResult
This endpoint can be used to retrieve an existing already assessed result. The result gets returned in the desired format in order to be visualised in a client application.
| Parameter | Description |
|---|---|
caseId |
CaseId of the case |
subId |
SubId of the case |
loggingArea |
Logging-Area of the COMPASS Kernel |
language |
The Language of the case result |
format |
The desired format of the resul: xml/json/html |
Response body:
The result is returned in a HTTP Response in a CompassResponse [1] Element. In case a result exists for the requested case, the required information is extracted from the result database and added to the response in the desired format.
{
"path": "/getResult",
"status": 0,
"statusText": "OK",
"errorDescriptions": [],
"jsonContent": null,
"byteContent": null,
"textContent": null
}
The result in html or xml format will be returned in textContent, the json format result, will be returned in jsonContent.
HTTP Status |
200 OK; no errors occurred |
path |
path of the invoked service, it will always be "/getResult" |
status - statusText |
the status of the response sent by the interface, it can have three values; |
errorDescriptions |
A list that contains the detailed error code and the error message regarding the error occurred during processing the input JSON. If no errors occur, then an empty list is returned. |
jsonContent |
contains the result in json format, otherwise null |
byteContent |
contains the byte content of the response, will always be null |
textContent |
contains the result in html or xml format, otherwise null |
Response Structure
<CaseResult>
<Name>Testfall24</Name>
<PolicyCanBeIssued>false</PolicyCanBeIssued>
<AssessmentDate>2022-10-11T14:35:47.542Z</AssessmentDate>
<NumberOfChangeAssessCycles>6</NumberOfChangeAssessCycles>
<CaseRisks>
<OverallResult id="1005">
<Name>Gesamtergebnis Antrag Testfall24</Name>
<ResultLevel id="5">weiterleiten</ResultLevel>
<APResult id="1008">
<Name>Personenergebnis VP Supergirl</Name>
<Person>Supergirl</Person>
<ResultLevel id="5">weiterleiten</ResultLevel>
<Groups>
<Group>
<GroupTitle>Weiterleiten</GroupTitle>
<Result>
<RiskText>Kein abgeschlossenes Studium/Ausbildung. Bitte prüfen.</RiskText>
</Result>
</Group>
<Group>
<GroupTitle>Inkonsistente Angaben prüfen</GroupTitle>
<Result>
<RiskText> keine Einzelkrankheitsangaben (Fragezeitraum/-nr. beachten)</RiskText>
</Result>
<Result>
<RiskText> Unfälle, Verletzungen, Vergiftungen (j/n)</RiskText>
</Result>
</Group>
<Group>
<GroupTitle>Hinweis Rentenhöhe</GroupTitle>
<Result>
<RiskText>Summen-Limit BU: 1233 EUR/Monat</RiskText>
</Result>
<Result>
<RiskText> beantragte Rente kleiner als Bedarf</RiskText>
</Result>
</Group>
</Groups>
</APResult>
<BenefitResult id="1007">
<Name>Tarif Tod - Tod VP Supergirl</Name>
<Person>Supergirl</Person>
<Description>Leben TarifangabeTod</Description>
<ResultLevel id="4">noch normal</ResultLevel>
<Groups>
<Group>
<GroupTitle>Hinweis auf Verzicht</GroupTitle>
<Result>
<RiskText>Auf medizinischen Bagatellzuschlag wurde verzichtet</RiskText>
<Reason>Entsteht aus</Reason>
<Result>
<RiskText> Zuschlag 0.3 %o</RiskText>
<Reason>Entsteht aus</Reason>
<Result>
<RiskText> Übersterblichkeit 25 %</RiskText>
<Reason>Entsteht aus</Reason>
<Result>
<RiskText>Erkrankung Hypertonie: Übersterblichkeit 25 %</RiskText>
</Result>
</Result>
</Result>
</Result>
</Group>
</Groups>
</BenefitResult>
<BenefitResult id="1007">
<Name>Tarif BUZ1/2 - BU VP Supergirl</Name>
<Person>Supergirl</Person>
<Description>BU TarifangabeBUZ1/2</Description>
<ResultLevel id="0">Angebot</ResultLevel>
<Groups>
<Group>
<GroupTitle>Zuschlag</GroupTitle>
<Result>
<RiskText>25 %</RiskText>
<Reason>Entsteht aus</Reason>
<Result>
<RiskText>Erkrankung Hypertonie: Zuschlag 25 %</RiskText>
</Result>
</Result>
</Group>
<Group>
<GroupTitle>Prämienklasse</GroupTitle>
<Result>
<RiskText>2</RiskText>
</Result>
</Group>
</Groups>
</BenefitResult>
</OverallResult>
</CaseRisks>
</CaseResult>