Die folgenden Unterseiten zeigen die Aufrufe, die über die Schnittstelle ausgeführt werden können. Daher müssen sie nicht implementiert werden.
Administration und Generierung
Sie können Ihre Vorlagen verwalten oder eine neue Erstellung über REST starten.
Alle Aufrufe werden über eine POST-Anfrage gestartet, die Parameter im JSON-Format im Body enthalten kann.
Die Rückgabe erfolgt immer im JSON-Format. Sie enthält den Ergebnisparameter “success”, um anzuzeigen, 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.
Die folgenden Fehler sind möglich:
| Fehlercode | Meldung | Bei Anfrage |
| 1 | Vorlagenname ungültig | adminTemplateFetch, adminTemplateEdit, adminTemplateDelete, generatePdf, adminTemplateAdd |
| 2 | Vorlage nicht vorhanden | adminTemplateFetch, adminTemplateEdit, adminTemplateDelete, generatePdf |
| 3 | Vorlagenname bereits in Gebrauch | adminTemplateAdd |
| 400 | ungültige Anfrage | Alle |
| 500 | interner Fehler | Alle |
(Die Fehler 400 und 500 entsprechen den HTTP-Statuscodes und weisen auf Fehler beim Parsen des Parameters oder auf Verarbeitungsfehler hin.)
Die Unterseiten beschreiben das Zusammenführen und Speichern von PDFs sowie die verschiedenen Anfragen zur Verwaltung Ihrer Vorlagen.
