Hinzufügen einer Kategorie, Methode: /api/category/add/
Beispiel:
№ | Feld | Art | Beschreibung | Obligatorisch oder nicht | Kommentar |
1 | login | string | Melden Sie sich im BOX-System an | Pflichtfeld. | |
2 | password | string | Passwort im md5-Format | Pflichtfeld. | Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API |
3 | name | string | Kategoriename | Pflichtfeld. | |
4 | code | string | id Kategorien aus Ihrem System | Nicht erforderliches Feld. | Dies ist eine eindeutige Kategorie-ID aus Ihrem System (aus Ihrem Geschäft).. Wenn eine Kategorie mit dieser ID vorhanden ist, gibt die API einen Fehler aus |
5 | description | string | Kategorie beschreibung | Nicht erforderliches Feld. | |
6 | parentid | integer | id übergeordnete Kategorie aus unserem System | Nicht erforderliches Feld. | In diesem Feld können Sie den übergeordneten Kategoriecode aus unserem System eingeben. Wenn es keine Kategorie mit diesem Code gibt, ist das Feld leer. |
7 | image | array | Kategorie Bildarray | Nicht erforderliches Feld. | Bilder sollten als Array mit dem vollständigen Pfad zu ihnen gesendet werden. Das System arbeitet mit folgenden Bildformaten: jpg, png |
8 | hidden | boolean | versteckte Kategorie | Nicht erforderliches Feld. | Standardmäßig ist die Kategorie nicht ausgeblendet (hidden=0) |
9 | parentcode | string | code1c Kategorien (Kategorie-ID aus Ihrem System) | Nicht erforderliches Feld. | In diesem Feld können Sie den übergeordneten Kategoriecode aus Ihrem System eingeben. Wenn es keine Kategorie mit diesem Code gibt, ist das Feld leer. |
Löschen einer Kategorie, Methode: /api/category/delete/
Beispiel:
№ | Feld | Art | Beschreibung | Obligatorisch oder nicht | Kommentar |
1 | login | string | Melden Sie sich im BOX-System an | Pflichtfeld. | |
2 | password | string | Passwort im md5-Format | Pflichtfeld. | Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API |
3 | id | integer | Kategorie ID | Oder Kategorie-ID oder Code erforderlich | Kategoriecode im BOX-System |
4 | code | string | Kategorie ID | Kategorie-ID aus Ihrem System (aus Ihrem Geschäft) |
Kategoriebearbeitung, Methode: /api/category/update/
Beispiel:
№ | Feld | Art | Beschreibung | Obligatorisch oder nicht | Kommentar |
1 | login | string | Melden Sie sich im BOX-System an | Pflichtfeld. | |
2 | password | string | Passwort im md5-Format | Pflichtfeld. | Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API |
3 | id | integer | Kategorie ID | Oder Kategorie-ID oder Code erforderlich | Kategoriecode im BOX-System |
4 | code | string | Kategorie ID | Kategorie-ID aus Ihrem System (aus Ihrem Geschäft) | |
5 | name | string | Kategoriename | Nicht erforderliches Feld. | |
6 | description | string | Kategorie beschreibung | Nicht erforderliches Feld. | |
7 | parentid | string | id übergeordnete Kategorie aus Ihrem System | Nicht erforderliches Feld. | In diesem Feld können Sie den übergeordneten Kategoriecode aus Ihrem System eingeben. Wenn es keine Kategorie mit diesem Code gibt, ist das Feld leer. |
8 | image | array | Kategorie Bildarray | Nicht erforderliches Feld. | Bilder sollten als Array mit dem vollständigen Pfad zu ihnen gesendet werden. Das System arbeitet mit folgenden Bildformaten: jpg, png |
9 | hidden | boolean | versteckte Kategorie | Nicht erforderliches Feld. | Standardmäßig ist die Kategorie nicht ausgeblendet (hidden=0) |
10 | parentcode | string | code1c Kategorien (Kategorie-ID aus Ihrem System) | Nicht erforderliches Feld. | In diesem Feld können Sie den übergeordneten Kategoriecode aus Ihrem System eingeben. Wenn es keine Kategorie mit diesem Code gibt, ist das Feld leer. |
Eine Kategorie bekommen und alle Kategorien bekommen Methode: /api/category/get/
Beispiel:
№ | Feld | Art | Beschreibung | Obligatorisch oder nicht | Kommentar |
1 | login | string | Melden Sie sich im BOX-System an | Pflichtfeld. | |
2 | password | string | Passwort im md5-Format | Pflichtfeld. | Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API |
3 | id | integer | Kategorie ID | Oder Kategorie-ID oder Code erforderlich | Wenn Sie eine bestimmte Kategorie benötigen, übergeben Sie in diesem Feld entweder die ID der Kategorie, die Ihnen unsere API bei der Erstellung zurückgegeben hat. Oder geben Sie eine externe Kategorie-ID an (field code beim Erstellen einer Kategorie) Die Engine findet diese und gibt sie zurück. Feldwerte zurückgeben id - id Kategorien, name - Name der Kategorie, code - externe Kategorie-ID, image - Kategorie Bildarray, description - Kategorie beschreibung, parentid - id Eltern-Kategorie, hidden - versteckte Kategorie |
4 | code | string | Kategorie ID |
Beispiel:
№ | Feld | Art | Beschreibung | Obligatorisch oder nicht | Kommentar |
1 | login | string | Melden Sie sich im BOX-System an | Pflichtfeld. | |
2 | password | string | Passwort im md5-Format | Pflichtfeld. | Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API |
Feldwerte zurückgeben id - id Kategorien, name - Name der Kategorie, code - externe Kategorie-ID, image - Kategorie Bildarray, description - Kategorie beschreibung, parentid - id Eltern-Kategorie, hidden - versteckte Kategorie |
Mögliche Antworten auf die Anfrage
№ | Status | Nachricht | Nachrichtenbeschreibung |
1 | ok | categoryid | Gibt die ID der hinzugefügten Kategorie zurück |
2 | fail | Login is empty! | Fehlende Anmeldung |
3 | fail | Password is empty! | Fehlendes Passwort |
4 | fail | Category name is empty! | Kategoriename fehlt |
5 | fail | Bad user level! | Niedriges Benutzerlevel zum Ausführen dieser Aktion (benötigt Level 2 und höher) |
6 | fail | Login or password not correct! | Login oder Passwort falsch eingegeben |
7 | fail | Category with this ID already exists! | Kategorie mit dieser ID existiert bereits |
8 | fail | Incorrect picture! | Falsches Bildformat |
9 | fail | You don't available category for delete! | Sie haben keine Kategorie zum Löschen ausgewählt |
10 | fail | Category with this ID does not exists! | Kategorie mit dieser ID existiert nicht |
11 | fail | Category with this Code does not exists! | Kategorie mit diesem Code existiert nicht |
12 | fail | You don't available category for update! | Sie haben keine Kategorie zum Aktualisieren ausgewählt |
13 | fail | parentid = categoryid | id Die übergeordnete Kategorie ist gleich der ID der Kategorie selbst oder die ID des übergeordneten Elements der übergeordneten Kategorie ist gleich der ID der hinzugefügten Kategorie (Schleife) |
14 | fail | Parentid is not corectly! | id Die übergeordnete Kategorie ist ungültig |