Technische Angaben
Fehlerbehandlung
Alle Services benutzen einheitlich definierte Fehlercodes, um Systemfehler zu melden. Ein Fehler wird mittels eines SOAP-Fault gemeldet.
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<soapenv:Fault>
<faultcode>soapenv:Client</faultcode>
<faultstring>SOA-01001</faultstring>
<detail>
<SystemError Id="44ae07df-bd39-40d2-94f9-f149c047b589"
xmlns="https://socialsecurity.be/errors/v1">
<Origin>Consumer</Origin>
<Code>SOA-01001</Code>
<Message xml:lang="en">Service call not authenticated.</Message>
<Environment>Production</Environment>
</SystemError>
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Jede Fehlermeldung umfasst neben einem Fehlercode und einer Beschreibung auch einen eindeutigen Fehlerstring (//SystemError/@Id), mit dem der (System)Fehler von unseren Supportdiensten weiter überprüft werden kann. Es ist wichtig, dass die Clientanwendung immer diese eindeutige ID erfasst.
Eine Übersicht der möglichen Fehlermeldungen befindet sich in der folgenden Tabelle.
| Code | Beschreibung | Ursache | Erklärung |
|---|---|---|---|
| SOA-00001 | Service error | This is the default error sent to the consumer in case no more details are known. | |
| SOA-01001 | Service call not authenticated | Consumer | From the security information provided, either the consumer could not be identified or the credentials provided are not correct. |
| SOA-01002 | Service call not authorized | Consumer | The consumer is identified and authenticated, but is not allowed to call the given service. |
| SOA-02001 | Service not available. Please contact service desk. | Provider | An unexpected error has occurred. Retries will not work. Service desk may help with root cause analysis. |
| SOA-02002 | Service temporarily not available. Please try later. | Provider | An unexpected error has occurred. Retries should work. If the problem persists service desk may help. |
| SOA-03001 | Malformed message | Consumer | This is the default error for content related errors in case no more details are known. |
| SOA-03002 | Message must be SOAP | Consumer | Message does not respect the SOAP standard. |
| SOA-03003 | Message must contain SOAP body | Consumer | Message respects the SOAP standard, but body is missing. |
| SOA-03004 | WS-I compliance failure | Consumer | Message does not respect the WS-I standard. |
| SOA-03005 | WSDL compliance failure | Consumer | Message is not compliant with WSDL. |
| SOA-03006 | XSD compliance failure | Consumer | Message is not compliant with XSD. |
| SOA-03007 | Message content validation failure | Consumer | From the message content (conform XSD): extended checks on the element format failed or cross-checks between fields failed. |
Die häufigsten Probleme werden auf der FAQ-Seite erläutert.