API Demo

Mit dieser API Demo können Sie die Verbindung zum Rechenkern und die Struktur Ihrer erzeugten json Anfrage testen.

API Call

Das Anfrage Objekt an die API enthält den Session-Key zur Authentifikation,
einen command um die gewünschte API anzusteuern (apiDemoResponse),
einen „target“ um den richtigen Service anzusprechen (SVCalculationAPIService),
sowie ein parameter Objekt.
Das parameter Objekt hat immer den „svsDataType“: „de.schalloehrverlag.kernel.apidata.input.isocalculator.ApiDemoResponseParamSet“ und eine Random UUID.
Innerhalb des parameter Objekts werden die für die Berechnungen notwendigen Parameter in Form des json Objekts „dataSetApi“ übergeben.


Parameter	Type	Values	Default
sessionKey	String		Muss vorab gezogen werden.
command	String	apiDemoResponse	—
target	String	SVCalculationAPIService	—
parameter	JSONObject		Dieses Object enthält die Anfrage Parameter für die API „dataSetApi“

Beispiel Anfrage Objekt an die API

{
	"sessionKey": "<Session-Key>",
	"command": "apiDemoResponse",
	"target": "SVCalculationAPIService",
	"parameter" : {
		"dataSetApi": {
			...
		},
		"svsDataType": "de.schalloehrverlag.kernel.data.input.InputDataApi",
		"uuid": "7761be6e-f7de-4d61-9231-df52c28c9591"
	}
}

Eingabe Parameter: dataSetApi


Parameter	Type	Values	Default
command	String	calculateAdd, calculateSub, calculateMulti	—
value1	Double		0.0
value2	Double		0.0

Beispiel dataSetApi

"dataSetApi": {
	"svsDataType": "de.schalloehrverlag.kernel.apidata.input.isocalculator.ApiDemoResponseParamSet",
			"command": "calculateAdd",
			"value1": 1000.0,
			"value2": 1240.87,
			"uuid": "9ed73b5a-cf46-4116-994e-b11bb7e519c6"
}

Rückgabe Parameter: resultDataSetApi


Parameter	Type	Description
kapitalAnfang	result

Beispiel resultDataSetApi

 "resultDataSetApi": {
            "result": 2240.87,
            "svsDataType": "de.schalloehrverlag.kernel.data.output.api.iso.dataset.ApiDemoResponseResParamSet",
            "responseMessage": "You successfully connected to the API!",
            "uuid": "c7aff221-cad3-45f1-9701-ae54729c73ca"
        }

Sie können übergebenen Werte addieren, multiplitzieren oder Wert 2 und 3 vom Wert 1 subtrahieren.

Demo Call

{
   "command":"apiDemoResponse",
   "sessionKey":"b96bf6f4-64dc-4bb1-9af1-972bf3ca1463",
   "target":"SVCalculationAPIService",
   "parameter":{
      "dataSetApi":{
         "svsDataType":"de.schalloehrverlag.kernel.apidata.input.isocalculator.ApiDemoResponseParamSet",
         "command":"calculateAdd",
         "value1":1000,
         "value2":1240.87,
         "uuid":"f9b5138c-7e76-4029-ab42-cadaf4044092"
         },
       "svsDataType":"de.schalloehrverlag.kernel.data.input.InputDataApi",
       "uuid":"22d24084-810a-4e0a-bbad-be130f91d697"
    }
 }

Demo Response

{
    "responsecode": 0,
    "status": "ok",
    "result": {
        "svsDataType": "de.schalloehrverlag.kernel.data.output.OutputDataApi",
        "resultDataSetApi": {
            "result": 2240.87,
            "svsDataType": "de.schalloehrverlag.kernel.data.output.api.iso.dataset.ApiDemoResponseResParamSet",
            "responseMessage": "You successfully connected to the API!",
            "uuid": "79e50d23-8547-404d-8d55-b4ae868b5264"
        },
        "errorLog": {
            "svsDataType": "de.schalloehrverlag.kernel.data.output.error.ErrorLog",
            "noErrorsFound": true,
            "errorLogList": [
                
            ],
            "uuid": "780ead58-9755-44e5-9c81-4242b9eee84e"
        },
        "uuid": "5acbbcca-2a91-421b-b093-6b76eebce10f"
    }
}