updateMessages |
  
|
updateMessages |
|
Mit dieser Funktion ist es möglich plattformspezifische Nachrichten zu aktualisieren. |
<request method="updateMessages" version="1.0.0"> <!-- [platform_specific_messages] --><!-- Plattformspezifische Daten --> </request> |
Name |
Beschreibung |
Anz. |
Typ |
sonstiges |
|---|---|---|---|---|
request |
Root-Element der Anfrage |
1 |
Element |
|
method |
Attribut von request. Name der Webservice-Methode. |
1 |
string |
Fester Wert: „updateMessages“ |
version |
Attribut von request. Legt die Version der Anfrage fest. |
1 |
string |
Fester Wert: „1.0.0“ |
[platform_specific_messages] |
Platzhalter für die verschiedenen Daten der Verkaufsplattformen. Die möglichen Daten sind im Abschnitt "Plattformspezifische Daten" des Calls updateMessages beschrieben. |
0..N |
Element |
<response method="updateMessages" version="1.0.0"> <report return_code="0" reference_id="1"> <!-- [platform_specific_message] --><!-- Plattformspezifische Daten --> </report> </response> |
Name |
Beschreibung |
Anz. |
Typ |
sonstiges |
|---|---|---|---|---|
response |
Root-Element der Antwort |
1 |
Element |
|
method |
Attribut von response. Name der Webservice-Methode. |
1 |
string |
Fester Wert: „updateMessages“ |
version |
Attribut von response. Legt die Version der Anfrage fest. |
1 |
integer |
Fester Wert: „1.0.0“ |
report |
Information über die ausgeführte Operation. Für jedes Nachrichten-Element aus dem Request wird ein Report zurückgegeben. |
0..N |
Element |
|
return_code |
Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind. |
1 |
integer |
Feste Werte: Siehe Return-Codes |
reference_id |
Optionales Attribut. In diesem Feld kann eine beliebige ID angegeben werden die später im zugehörigen Report-Block der Response-Daten wieder erscheint. |
0..1 |
string |
|
error_description |
Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert |
0..1 |
string |
|
[platform_specific_message] |
Platzhalter für die verschiedenen Daten der plattformspezifischen Nachrichten. Die möglichen Daten sind im Abschnitt "Plattformspezifische Daten" des Calls updateMessages beschrieben. |
1 |
Element |
•Die reference_id wird nicht in Speed4Trade CONNECT gespeichert und ist damit auch nicht fest an die betroffene Nachricht gebunden. Die gleiche ID kann daher in unterschiedlichen Calls problemlos wiederverwendet werden. Sie dient lediglich zur schnellen Zuordnung eines Reports in den Response-Daten zu einem Block aus den Request-Daten. Dies ist insbesondere dann nützlich wenn es bei der Verarbeitung eines oder mehrerer der übergebenen Nachrichten zu Fehlern kommt. So kann die resultierende Fehlermeldung schnell zu einem Request-Bestandteil zugeordnet werden. |
Für den Webservice-Call "updateMessages" sind folgende Return-Codes möglich: |
Code |
Beschreibung |
0 |
Die Nachricht wurde erfolgreich geändert. |
-1 |
Die Nachricht konnte auf Grund eines unspezifizierten Fehlers nicht geändert werden. Bitte beachten Sie die mitgelieferte Fehlerbeschreibung. |
Weitere Return-Codes gibt es unter den plattformspezifischen Daten |
Version |
Änderungsbeschreibung |
|---|---|
3.4.9.1 |
Integration des Calls zum Aktualisieren von Nachrichten |