billomat[API]: Vorlagen

Alle Vorlagen auflisten

GET /api/templates
Response: 200 OK
<?xml version="1.0" encoding="UTF-8"?> <templates type="array"> <template> ... </template> <template> ... </template> </templates>

Über Parameter kann gefiltert werden:

GET /api/template?type=INVOICE

Listet alle Rechnungsvorlagen auf. Groß- und Kleinschreibung wird ignoriert.

Folgende Parameter stehen zur Verfügung:

Parameter

Beschreibung

type

Art der Vorlage (INVOICE für Rechnungsvorlagen, OFFER für Angebotsvorlagen)

Einzelne Vorlage aufrufen

GET /api/templates/{id}
Response: 200 OK
<?xml version="1.0" encoding="UTF-8"?> <template> <id type="integer">1</id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <type>INVOICE</type> <name>Meine Vorlage</name> <format>doc</format> <base64file>{base64-kodierte Vorlagendatei}</base64file> </template>

Vorlage erstellen

POST /api/templates

Erstellt eine neue Vorlage.

XML-Element

Beschreibung

Typ

Default-Wert

Pflichtfeld

name

Bezeichnung der Vorlage

ALNUM

ja

type

Typ (INVOICE oder OFFER)

Vorlagentyp

ja

format

Format (doc, docx oder rtf)

Dateiformat

ja

base64file

base64-kodierte Vorlagendatei

ja

Request Body
<template> <name>Meine Vorlage</name> <type>INVOICE</type> <format>doc</format> <base64file>{base64-kodierte Vorlagendatei}</base64file> </template>
Response: 201 Created
<?xml version="1.0" encoding="UTF-8"?> <template> <id type="integer">1234</id> <created type="datetime">2007-12-13T12:12:00+01:00</created> <type>INVOICE</type> <name>Meine Vorlage</name> <format>doc</format> <base64file>{base64-kodierte Vorlagendatei}</base64file> </template>

Vorlage bearbeiten

PUT /api/templates/{id}

Aktualisiert eine Vorlage mit den übergebenen Paramtern.

Request Body
<template> <name>Spezialvorlage</name> </template>
Response: 200 OK

Vorlagen löschen

DELETE /api/templates/{id}

Löscht eine Vorlage.

Response: 200 OK

Vorschau einer Vorlage aufrufen

GET /api/templates/{id}/thumb

Es wird immer nur die erste Seite der Vorlage zurückgegeben.

Das gewünschte Bild-Format kann über den Parameter format angegeben werden.

Parameter

Beschreibung

format

Bild-Format. Kann png, gif oder jpg sein. Standard-Format ist png.

Response: 200 OK
Du bist hier: Startseite » API » Vorlagen