billomat[API]: Einheiten

Alle Einheiten auflisten

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

Über Parameter kann gefiltert werden:

GET /api/units?name=stunde

Listet alle Einheiten auf, die "stunde" in der Bezeichnung haben. Groß- und Kleinschreibung wird ignoriert.

Folgende Parameter stehen zur Verfügung:

Parameter

Beschreibung

name

Bezeichnung der Einheit

Einzelne Einheit aufrufen

GET /api/units/{id}
Response: 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<unit>
    <id type="integer">1</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <name>Stunde</name>
</unit>

Einheit erstellen

POST /api/units

Erstellt eine neue Einheit.

XML-Element

Beschreibung

Typ

Default-Wert

Pflichtfeld

name

Bezeichnung der Einheit

ALNUM

ja

Request Body
<unit>
    <name>Stück</name>
</unit>
Response: 201 Created
<?xml version="1.0" encoding="UTF-8"?>
<unit>
    <id type="integer">1234</id>
    <created type="datetime">2007-12-13T12:12:00+01:00</created>
    <name>Stück</name>
</unit>

Einheit bearbeiten

PUT /api/units/{id}

Aktualisiert eine Einheit mit den übergebenen Paramtern.

Request Body
<unit>
    <name>Paletten</name>
</unit>
Response: 200 OK

Einheit löschen

DELETE /api/units/{id}

Löscht eine Einheit.

Es können nur Einheiten gelöscht werden, die keinem Artikel zugeordnet sind.

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