Alle Schlagwörter auflisten (Tagcloud)
GET /api/credit-note-tags
<?xml version="1.0" encoding="UTF-8"?> <credit-note-tags type="array" page="1" per_page="100" total="2"> <credit-note-tag> <id type="integer">1</id> <name>foo</name> <count type="integer">12</count> </credit-note-tag> <credit-note-tag> <id type="integer">1</id> <name>bar</name> <count type="integer">7</count> </credit-note-tag> </credit-note-tags>
Alle Schlagworte einer Gutschrift auflisten
GET /api/credit-note-tags?credit_note_id={credit_note_id}
Schlagworte können immer nur für eine bestimmte Gutschrift zurückgegeben werden.
Deshalb ist credit_note_id ein Pflichtparameter.
<?xml version="1.0" encoding="UTF-8"?> <credit-note-tags type="array" page="1" per_page="100" total="2"> <credit-note-tag> ... <credit-note-tag> <credit-note-tag> ... <credit-note-tag> </credit-note-tags>
Einzelnes Schlagwort aufrufen
GET /api/credit-note-tags/{id}
<?xml version="1.0" encoding="UTF-8"?> <credit-note-tag> <id type="integer">1</id> <credit_note_id type="integer">1</credit_note_id> <name>foo</name> </credit-note-tag>
Schlagwort erstellen
POST /api/credit-note-tags
XML-Element | Beschreibung | Typ | Default-Wert | Pflichtfeld |
---|---|---|---|---|
credit_note_id | ID der Gutschrift | INT | ja | |
name | Schlagwort | ALNUM | ja |
<credit-note-tag> <credit_note_id>1</credit_note_id> <name>foo</name> </credit-note-tag>
<?xml version="1.0" encoding="UTF-8"?> <credit-note-tag> <id type="integer">1</id> <credit_note_id type="integer">1</credit_note_id> <name>foo</name> </credit-note-tag>
Schlagwort löschen
DELETE /api/credit-note-tags/{id}