updateTextModuleTypes |
  
|
updateTextModuleTypes |
|
Anlegen und Bearbeiten von Textbausteintypen. |
<request method="updateTextModuleTypes" version="1.0.0"> <text_module_type significant_key="identifier" reference_id="[ref_id]"> <mandator_id>1</mandator_id> <text_module_type_id>695477</text_module_type_id> <identifier>TextModuleType001</identifier> <max_length>500</max_length> <is_html>true</is_html> </text_module_type> </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: „updateTextModuleTypes“ |
version |
Attribut von request. Legt die Version der Anfrage fest. |
1 |
string |
Fester Wert: „1.0.0“ |
text_module_type |
Wrapper-Element, das die Daten des Textbausteintyps zusammenfasst. |
0..N |
Element |
|
significant_key |
Gibt an welches Feld zur Identifikation des Textbausteintyps beim Update genutzt wird. |
1 |
String |
Feste Werte: "text_module_type_id", "identifier" |
reference_id |
Optionales Attribut des Elements "text_module_type". In diesem Feld kann eine beliebige ID angegeben werden die später im zugehörigen Report-Block der Response-Daten wieder erscheint. |
0..1 |
String |
|
mandator_id |
ID des Mandanten dem der Textbausteintyp zugeordnet ist |
1 |
integer |
|
text_module_type_id |
ID des Textbausteintyps |
0..1 |
integer |
Nur für Updates als eindeutiger Identifier verwendbar. |
identifier |
Bezeichnung des Textbausteintyps |
0..1 |
string |
Länge: 1-50 Zeichen |
max_length |
Legt die maximale Zeichenanzahl des Textbausteintyps fest |
0..1 |
integer |
|
is_html |
Gibt an im Textbausteintyp HTML verwendet werden darf |
0..1 |
boolean |
<response method="updateTextModuleTypes" version="1.0.0"> <report action="update" reference_id="[ref_id]" return_code="0"> <text_module_type> <text_module_type_id>695477</text_module_type_id> <mandator_id>1</mandator_id> <identifier>TextModuleType001</identifier> <is_html>true</is_html> <max_length>500</max_length> </text_module_type> </report> </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 |
text_module_type |
Wrapper-Element, das die Daten des Textbausteintyps zusammenfasst. |
1 |
Element |
|
text_module_type_id |
ID des Textbausteintyps |
1 |
integer |
|
mandator_id |
ID des Mandanten dem der Textbausteintyp zugeordnet ist |
1 |
integer |
|
identifier |
Bezeichnung des Textbausteintyps |
1 |
string |
|
is_html |
Gibt an im Textbausteintyp HTML verwendet werden darf |
1 |
boolean |
|
max_length |
Legt die maximale Zeichenanzahl des Textbausteintyps fest |
0..1 |
integer |
Wird nicht ausgegeben, wenn der Textbausteintyp bisher keine maximale Zeichenzahl hinterlegt hat. |
Version |
Änderungsbeschreibung |
|---|---|
4.12.27 |
Einführung des Calls. |