Abfrage von Versandkostenkategorien. |
<request method="fetchDeliveryChargeCategories" version="1.0.0"> <filter> <mandator_id filter_method="=" filter_value="1" /> <!-- <delivery_charge_category_id filter_method="=" filter_value="147"/> --> <!-- <identifier filter_method="=" filter_value="Kategorie 1 Großbrief"/> --> </filter> </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: „fetchDeliveryChargeCategories“ |
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 |
|
delivery_charge_category_id |
Schränkt die Ergebnismenge der Abfrage auf einen bestimmte Versandkostenkategorie ein. |
0..1 |
Element |
|
filter_method |
Attribut von delivery_charge_category_id. Legt das Verhalten des Versandkostenkategorie-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von delivery_charge_category_id. Legt den Filterwert des Versandkostenkategorie-Filters fest. |
1 |
integer |
|
identifier |
Schränkt die Ergebnismenge der Abfrage auf einen bestimmte Bezeichnung der Versandkostenkategorie ein. |
0..1 |
Element |
|
filter_method |
Attribut von identifier. Legt das Verhalten des Bezeichnungs-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von identifier. Legt den Filterwert des Bezeichnungs-Filters fest. |
1 |
string |
|
external_id |
Schränkt die Ergebnismenge der Abfrage auf einen bestimmte externe ID der Versandkostenkategorie ein. |
0..1 |
Element |
|
filter_method |
Attribut von external_id. Legt das Verhalten des Externe-ID-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von external_id. Legt den Filterwert des Externe-ID-Filters fest. |
1 |
string |
<response method="fetchDeliveryChargeCategories" version="1.0.0"> <report return_code="0" /> <delivery_charge_category> <delivery_charge_category_id>147</delivery_charge_category_id> <mandator_id>1</mandator_id> <identifier>Kategorie 1 Großbrief</identifier> <quantifier>0</quantifier> <external_id>GRS_BRF</external_id> </delivery_charge_category> <delivery_charge_category> <delivery_charge_category_id>148</delivery_charge_category_id> <mandator_id>1</mandator_id> <identifier>Kategorie 2 bis 2 KG</identifier> <quantifier>0</quantifier> <external_id>PKG1</external_id> </delivery_charge_category> </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: „fetchDeliveryChargeCategories“ |
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 |
|
delivery_charge_category |
Wrapper-Element, das die Versandkostenkategorie enthält. |
0..N |
Element |
|
delivery_charge_category_id |
ID der Versandkostenkategorie |
1 |
integer |
|
mandator_id |
ID des Mandanten dem die Versandkostenkategorie zugeordnet ist. |
1 |
integer |
|
identifier |
Bezeichnung der Versandkostenkategorie |
1 |
string |
|
quantifier |
Gewichtung der Versandkostenkategorie |
0..1 |
integer |
|
external_id |
Externe-ID der Versandkostenkategorie |
0..1 |
string |
Version |
Änderungsbeschreibung |
---|---|
3.2.9.75 |
Redaktionelle Überarbeitung |
3.3.2.181 |
Erweiterung des Calls um external_id. |