The following subpages show the calls that can be executed via the interface. Therefore they do not have to be implemented.
Administration and Generation
You can manage your templates or start a new creation via REST.
All calls are started via a POST request, which may contain parameters in JSON format in the body.
The return is always in JSON format. It includes the result parameter “success” to indicate whether the call was successful.
If the call is not successful, an error code (as a return parameter “code”) and an error message (as a return parameter “message”) are returned.
The following errors are possible:
Error Code | Message | At Request |
1 | template name invalid | adminTemplateFetch, adminTemplateEdit, adminTemplateDelete, generatePdf, adminTemplateAdd |
2 | template not existing | adminTemplateFetch, adminTemplateEdit, adminTemplateDelete, generatePdf |
3 | template name already in use | adminTemplateAdd |
400 | bad request | All |
500 | internal error | All |
(Errors 400 and 500 correspond to the HTTP status codes and indicate errors when parsing the parameter or processing errors)
The sub-sites describe the merging and saving of PDFs as well as the different requests to manage your templates.