fetchTextModuleTypes

Navigation:  WebService Calls > Options for Growth >

fetchTextModuleTypes

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Abfrage von Textbausteintypen.

Beispiel Request

Code

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

   <filter>

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

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

„fetchTextModuleTypes“

version

Attribut von request. Legt die Version der Anfrage fest.

1

string

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

Beispiel Response

Code

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

   <report return_code="0"/>

   <text_module_type>

      <text_module_type_id>14</text_module_type_id>

      <mandator_id>1</mandator_id>

      <identifier>Kurzbeschreibung</identifier>

      <is_html>true</is_html>

   </text_module_type>

   <text_module_type>

      <text_module_type_id>15</text_module_type_id>

      <mandator_id>1</mandator_id>

      <identifier>Beschreibung</identifier>

      <is_html>false</is_html>

   </text_module_type>

   <text_module_type>

      <text_module_type_id>167</text_module_type_id>

      <mandator_id>1</mandator_id>

      <identifier>Titel</identifier>

      <is_html>false</is_html>

   </text_module_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:

„fetchTextModuleTypes“

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

text_module_type

Wrapper-Element, das die Daten eines Textbausteintypen zusammenfasst

0..N

Element

text_module_type_id

ID des Textbausteintyps

1

integer

mandator_id

ID des Mandanten dem der Textbausteintyp zugeordnet ist.

1

integer

identifier

Bezeichner des Textbausteintypen

1

string

Länge:

0 – 50 Zeichen

is_html

Ist der Textbausteintyp im HTML-Format

1

boolean

max_length

Maximale Länge des Textbausteintyps

1

integer

 

Änderungsübersicht

Version

Änderungsbeschreibung

3.2.9.75

Redaktionelle Überarbeitung