Fehlerbehandlung API Parameter

Inhaltliche Fehler bei den Übergabeparametern im json Objekt „dataSetApi“ werden gesondert zu den technischen Server Fehlern behandelt.

Jedes Rückgabeobjekt enthält das json Objekt „errorLog“. Hier werden gefundene Fehler an den Eingabeparametern (aus dem Objekt „dataSetApi“) aufgelistet.

Das Array „errorLogList“ ist leer und der value für „noErrorsFound“ ist true.

{
	"svsDataType": "de.schalloehrverlag.kernel.data.output.OutputDataApi",
	"resultDataSetApi": {...},
	"errorLog": {
		"svsDataType": "de.schalloehrverlag.kernel.data.output.error.ErrorLog",
		"noErrorsFound": true,
		"errorLogList": [
		],
		"uuid": "5058c6e7-e669-488f-9eed-ca6396379dee"
	}
}

Beim parsen der Übergabeparameter ist ein Fehler aufgetreten. Der value für „noErrorsFound“ ist false.
Nun können Sie der „errorLogList“ die Fehlermeldungen entnehmen. Jede Fehlermeldung enthält:

1. einen allgemeinem Fehlercode,
2. eine allgemeine Fehler Nachricht zum Fehlercode,
3. eine sprechende Fehlermeldung (message) nicht standtisiert für debugging,
4. den Namen des fehlerhaften Parameters (parameterName),
5. den an die API übergebenen Parameter Wert (parameterValueReceived),
6. sowie ein Fehlerlevel (1: Error, 2: Warning).
   

Für den Parameter command im dataSetApi wird ein unbekannter Befehl („calculateXXX“) übergeben:

{
	"svsDataType": "de.schalloehrverlag.kernel.data.output.OutputDataApi",
	"resultDataSetApi": {...},
	"errorLog": {
		"svsDataType": "de.schalloehrverlag.kernel.data.output.error.ErrorLog",
		"noErrorsFound": false,
		"errorLogList": [
			{
				"parameterValueReceived": "calculateXXX",
				"level": 1,
				"talkingErrorMessage": "Parameter does not match expected valuelist",
				"errorCode": "1303",
				"parameterName": "command",
				"message": "calculateXXX is not a valid command"
			}
		],
		"uuid": "c881928a-aa9e-4d97-a052-51251bd3f4af"
	},
	"uuid": "821db703-8d26-4c12-a94e-0d47e21f1790"
}