Abfrage von Bildbausteintypen. |
<request method="fetchImageModuleTypes" version="1.0.0"> <filter> <mandator_id filter_method="=" filter_value="1"/> </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: „fetchImageModuleTypes“ |
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 Kunden eines 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 |
<response method="fetchImageModuleTypes" version="1.0.0"> <report return_code="0"/> <image_module_type> <image_module_type_id>201</image_module_type_id> <mandator_id>1</mandator_id> <identifier>Hauptbild</identifier> <allow_url>true</allow_url> <allow_local>true</allow_local> </image_module_type> <image_module_type> <image_module_type_id>205</image_module_type_id> <mandator_id>1</mandator_id> <identifier>Seitenansicht</identifier> <allow_url>true</allow_url> <allow_local>true</allow_local> </image_module_type> <image_module_type> <image_module_type_id>206</image_module_type_id> <mandator_id>1</mandator_id> <identifier>Rückansicht</identifier> <allow_url>true</allow_url> <allow_local>true</allow_local> </image_module_type> </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: „fetchImageModuleTypes“ |
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 |
Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert. |
0..1 |
string |
|
image_module_type |
Wrapper-Element, das die Daten eines Bildbausteintypen zusammenfasst |
0..N |
Element |
|
image_module_type_id |
ID des Bildbausteintyps |
1 |
integer |
|
mandator_id |
ID des Mandanten dem der Bildbausteintyp zugeordnet ist. |
1 |
integer |
|
identifier |
Bezeichner des Bildbausteintypen |
1 |
string |
Länge: 0-50 Zeichen |
allow_url |
Sind im Web hinterlegte Bilder per URL erlaubt. |
1 |
boolean |
|
allow_local |
Legt fest ob Bilder lokal gespeichert werden können |
1 |
boolean |
Version |
Änderungsbeschreibung |
---|---|
3.2.9.75 |
Redaktionelle Überarbeitung |