Daten schreiben

Daten schreiben

Daten werden mittels der HTTP-Methoden POST, PUT und DELETE geschrieben.
Genau wie bei der Ausgabe wir dabei standardmäßig das XML-Format verwendet. Jeder schreibende Request sollte daher im Header „Content-type: application/xml“ mitsenden und die eigentlichen Daten fein säuberlich in XML-Tags verpackt im Body enthalten:

curl -v -X POST
-H 'X-BillomatApiKey: {apischluessel}'
-H 'Content-Type: application/xml'
-d '<client><name>Musterfirma</name></client>'
https://{billomatid}.billomat.net/api/clients

Alternativ kann anstatt XML auch JSON verwendet werden, wenn „Content-Type: application/json“ mitgesendet wird:

curl -v -X POST
-H 'X-BillomatApiKey: {apischluessel}'
-H 'Content-Type: application/json'
-d '{"client":{"name":"Musterfirma"}}'
https://{billomatid}.billomat.net/api/clients

Dies erzeugt mittels POST eine neue Ressource – in diesem Beispie einen neuen Kunden mit der Bezeichnung ‚Musterfirma‘.
Als Antwort kommt der Status 201 Created und im Request-Body das komplette Objekt.
Eine bereits angelegte Ressource wird mit der PUT-Methode bearbeitet:

curl -v -X PUT
-H 'X-BillomatApiKey: {apischluessel}'
-H 'Content-Type: application/xml'
-d '<client><name>Musterkunde</name></client>'
https://{billomatid}.billomat.net/api/clients/1

War die Bearbeitung erfolgreich, kommt Status 200 OK zurück, inklusive des bearbeiteten Objektes.
Das Löschen funktioniert ganz ähnlich über die DELETE-Methode, allerdings ohne zusätzliche Parameter im Request-Body:

curl -v -X DELETE
-H 'X-BillomatApiKey: {apischluessel}'
https://{billomatid}.billomat.net/api/clients/1

Auch hier kommt nach erfolgreichem Löschen der Status 200 OK zurück.