fetchDispatchTypes

Navigation:  WebService Calls > Options for Growth >

fetchDispatchTypes

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Abfrage von Versandarten.

Beispiel Request

Code

<request method="fetchDispatchTypes" version="1.0.0">

   <filter>

      <mandator_id filter_method="=" filter_value="1" />

      <!-- <identifier filter_method="=" filter_value="DHL Paket" /> -->

      <external_id filter_method="=" filter_value="STD" />

   </filter>

</request>

Feldliste 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:

„fetchDispatchTypes“

version

Attribut von request. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

filter

Legt Parameter fest nach denen die Ergebnismenge eingeschränkt wird. Mehrere Filter werden als ODER-Verknüpfung, Elemente innerhalb des Filters als UND-Verknüpfung behandelt.

1..N

Element

mandator_id

Schränkt die Ergebnismenge der Abfrage auf einen bestimmten Mandanten ein.

1

Element

filter_method

Attribut von mandator_id. Legt das Verhalten des Mandanten-Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von mandator_id. Legt den Filterwert des Mandanten-Filters fest.

1

integer

identifier

Schränkt die Ergebnismenge der Abfrage auf einen bestimmten Bezeichner ein.

1

Element

filter_method

Attribut von identifier. Legt das Verhalten des Bezeichner-Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von identifier. Legt den Filterwert des Bezeichner-Filters fest.

1

string

external_id

Schränkt die Ergebnismenge der Abfrage auf eine bestimmte exteren ID ein.

1

Element

filter_method

Attribut von external_id. Legt das Verhalten des Externen-ID-Filters fest.

1

string

Fester Wert: „=“

filter_value

Attribut von external_id. Legt den Filterwert des Externen-ID-Filters fest.

1

string

Beispiel Response

Code

<response method="fetchDispatchTypes" version="1.0.0">

   <report return_code="0"/>

   <dispatch_type>

      <dispatch_type_id>1295498</dispatch_type_id>

      <mandator_id>1</mandator_id>

      <identifier>DHL Paket</identifier>

      <external_id>PV</external_id>

   </dispatch_type>

   <dispatch_type>

      <dispatch_type_id>1295499</dispatch_type_id>

      <mandator_id>1</mandator_id>

      <identifier>DHL Päckchen</identifier>

      <external_id>STD</external_id>

   </dispatch_type>

</response>

Feldliste 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:

„fetchDispatchTypes“

version

Attribut von response. Legt die Version der Anfrage fest.

1

integer

Fester Wert: „1.0.0“

report

Information über die ausgeführte Operation.

1

Element

return_code

Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind.

1

integer

0 = OK.

< 0 = Fehler

error_description

Fehlerbeschreibung falls bei der Durchführung der Operation Fehler aufgetreten sind.

0..1

string

dispatch_type

Wrapper-Element, das die Daten einer Versandart zusammenfasst

0..N

Element

dispatch_type_id

ID der Versandart

1

integer

mandator_id

ID des Mandanten

1

integer

identifier

Bezeichnung der Versandart

1

string

Länge:

0-50 Zeichen

external_id

externe ID

0..1

string

 

Änderungsübersicht

Version

Änderungsbeschreibung

3.2.9.75

Redaktionelle Überarbeitung

3.5.37

Hinzufügen der externen ID