fetchTemplates

Navigation:  WebService Calls > Options for Growth >

fetchTemplates

 Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Abfrage von Angebotsvorlagen.

Beispiel Request

Code

<request method="fetchTemplates" 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:

„fetchTemplates“

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

Beispiel Response

Code

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

   <report return_code="0"/>

   <template>

      <template_id>1613038</template_id>

      <mandator_id>1</mandator_id>

      <bezeichnung>Standard-Template</bezeichnung>

      <value>

         &lt;P&gt;[Langbeschreibung_de]&lt;/P&gt;

         &lt;P&gt;&amp;nbsp;&lt;/P&gt;

         &lt;P&gt;[Kurzbeschreibung_de]&lt;/P&gt;

      </value>

      <channels>

         <channel_id>7000</channel_id>

      </channels>

   </template>

   <template>

      <template_id>1209909</template_id>

      <mandator_id>1</mandator_id>

      <bezeichnung>Aktions-Template</bezeichnung>

      <value>[Kurzbeschreibung_de]</value>

      <channels>

         <channel_id>1000</channel_id>

      </channels>

   </template>

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

„fetchTemplates“

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

template

Wrapper-Element, das die Daten einer Angebotsvorlage zusammenfasst

0..N

Element

template_id

ID der Angebotsvorlage

1

integer

mandator_id

Mandant-ID

1

integer

bezeichnung

Bezeichnung der Angebotsvorlage

0..1

string

identifier

value

Wert zur Angebotsvorlage

0..1

string

channels

Wrapper-Element, das die Channeldaten zu einer Angebotsvorlage zusammenfasst

1

Element

channel_id

ID des Channels

0..N

integer

 

Änderungsübersicht

Version

Änderungsbeschreibung

3.2.9.75

Redaktionelle Überarbeitung