Fehlerbehandlung

 

SOAP-Fehlermeldungen

Es wird zu jedem Ereignis, welches über einen Call ausgeführt wird, eine entsprechende Antwort im Response zurückgegeben.
Wird beispielsweise eine Liste von 25 neuen Kunden hinzugefügt, gibt es 25 Antwortmeldungen. Sobald ein Kunde korrekt hinzugefügt wurde, wird Success auf true gesetzt und in SuccessMessages ist eine entsprechende Meldung über diesen Kunden enthalten. Werden aus verschiedenen Gründen 10 von den 25 Kunden nicht in das System hinzugefügt, enthält die Antwort 15 SuccessMessages und 10 ErrorMessages. Im Fall der SuccessMessages wird in der Antwort der Code 200 und als Message die neue ID des Kunden zurückgeliefert.

Dieses Prinzip gilt für alle SOAP-Calls.

Die Informationen dieser Handbuchseite beziehen sich auf die SOAP-API ab Version 110.
Beachten Sie auch das Kapitel Meldungen auf der Handbuchseite Einführung.

Response-Parameter

Jeder Response enthält folgende Parameter:

Parameter Datentyp Erläuterung
Success Boolean Gibt an, ob der Abruf ein Erfolg/Teilerfolg war.
ErrorMessages PlentySoapResponseMessage siehe nachfolgende Tabelle
SuccessMessages PlentySoapResponseMessage siehe nachfolgende Tabelle

Der Datentyp PlentySoapResponseMessage enthält folgende Parameter:

Parameter Datentyp Erläuterung
Code String Der zu der Erfolgs- oder Fehlermeldung gehörige Code. Dieser steht jeweils in der Beschreibung der einzelnen SOAP Calls.
IdentificationKey String Name eines Parameters, der eine Beziehung zwischen Request und Response herstellt und somit einen Call eindeutig identifiziert.
IdentificationValue String Wert eines Parameters, der eine Beziehung zwischen Request und Response herstellt und somit einen Call eindeutig identifiziert.
SuccessMessages ArrayOfPlentysoapresponsesubmessage siehe nachfolgende Tabelle

Der Datentyp ArrayOfPlentysoapresponsesubmessage enthält folgende Parameter:

Parameter Datentyp Erläuterung
SuccessMessages    
Value String Wert eines Parameters. Es wird ein eindeutiger Wert zurückgegeben.
Key String Name eines Parameters.
ErrorMessages    
Value String Wert eines Parameters. Es wird eine entsprechende Fehlerinformation angezeigt.
Key String Name eines Parameters.

Beispiele

Beispiel 1
true

    
        200
        CustomerNumber
        38374921
        
            
                119
                CustomerID
            
         
Beispiel 2
false

    
    800
    CustomerNumber
    38374921
    
    
        
            Missing parameter
            ZIP
        
        
            Missing parameter
            Language
        
     
Die genaue Erklärung der Error- und Success-Messages ist in der jeweiligen Dokumentation der einzelnen Calls zu finden.

SOAP-Log

Für die SOAP-API-Schnittstelle wurde ein eigenes detailliertes Logging System integriert. Sie finden das Tab SOAP-Log unter Datenaustausch » API Log in Ihrem plentymarkets-System. Hier kann nach den Parametern SOAP Call, UserID und Datum gesucht werden.

Bild 1: Tab SOAP-Log
Es werden alle Request- und Respons-XML-Dateien 4 Tage lang gespeichert und können über die entsprechenden Links in der Tabelle unter Request bzw. Response (siehe Bild 1) aufgerufen werden.

Im Tab SOAP-Statistik finden Sie weitere Informationen zu Ihren SOAP-Calls, u.a. wie viele Calls ausgeführt wurden.

Bild 2: Tab SOAP-Statistik

Beispiel eines Requests

Bild 3: Beispiel eines Requests

Fehler im Detail

Nachfolgend finden Sie Details zu Fehlermeldungen.

Aufruf ohne Header

Wenn Sie einen Call ohne den oben genannten Header aufrufen, kommt es zu folgender Fehlermeldung:

< ?xml version="1.0" encoding="UTF-8"? >
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <SOAP-ENV:Fault>
            <faultcode>SOAP-ENV:Server</faultcode>
            <faultstring>Unauthorized Request - Token required</faultstring>
        </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Tipp
Kontrollieren Sie in diesem Fall ihr Request-XML und nehmen Sie ggf. entsprechende Korrekturen vor.

Anzahl der SOAP-Calls überschritten

Fehlermeldung, wenn die maximal zulässige Anzahl an SOAP-Calls für einen bestimmten Benutzer und einen bestimmten Call überschritten wurde (Im Beispiel ist es der SOAP-Call: GetAuthentificationToken).

false

    
        820
        Call
        GetAuthentificationToken
        
        
            
                30
                Call limit
            
            
                mmuster
                User ID
            
         

 

Nach oben