Die folgenden Unterseiten zeigen die Aufrufe, die über die Schnittstelle ausgeführt werden können.
Daher müssen sie nicht implementiert werden.
Verwaltung und Generierung
Sie können Ihre Vorlagen verwalten oder eine neue Kreation über REST starten.
Alle Aufrufe werden über einen POST-Request gestartet, der Parameter im JSON-Format im Body enthalten kann.
Die Rückgabe erfolgt immer im JSON-Format.
Er enthält den Ergebnisparameter “success”, um anzugeben, ob der Aufruf erfolgreich war.
Wenn der Aufruf nicht erfolgreich ist, werden ein Fehlercode (als Rückgabeparameter “code”) und eine Fehlermeldung (als Rückgabeparameter “message”) zurückgegeben.
Folgende Fehler sind möglich:
Die Rückgabe erfolgt immer im JSON-Format.
Er enthält den Ergebnisparameter “success”, um anzugeben, ob der Aufruf erfolgreich war.
Wenn der Aufruf nicht erfolgreich ist, werden ein Fehlercode (als Rückgabeparameter “code”) und eine Fehlermeldung (als Rückgabeparameter “message”) zurückgegeben.
Folgende Fehler sind möglich:
| Fehlercode-Meldung | auf Anfrage | |
| 1 | Vorlagenname ungültig | adminTemplateFetch, adminTemplateEdit, adminTemplateDelete, generatePdf, adminTemplateAdd |
| 2 | Vorlage nicht vorhanden | adminTemplateFetch, adminTemplateBearbeiten, adminTemplateDelete, generatePdf |
| 3 | Vorlagenname wird bereits verwendet | adminTemplateAdd |
| 400 | ungültige Anfrage | Alle |
| 500 | interner Fehler | Alle |
(Fehler 400 und 500 entsprechen den HTTP-Statuscodes und weisen auf Fehler beim Parsen des Parameters oder Verarbeitungsfehler hin)
Die Unterseiten beschreiben das Zusammenführen und Speichern von PDFs sowie die verschiedenen Anfragen zur Verwaltung Ihrer Vorlagen.
