IWS/API IWS3/getCategories
Aus ITscope GmbH - Wissensbasis
Inhaltsverzeichnis |
1 Beschreibung
getCategories liefert Kategorien im XML-Format. Abgefragt werden kann eine komplette Klassifizierung über die classId oder eine einzelne Kategorie mittels categoryId.
2 Ähnliche Methoden
3 Parameter
3.1 Allgemeine Parameter
Die folgenden Parameter können für jede Methode verwendet werden.
| Name des Parameters | Beschreibung | Benötigt | Zulässige Werte |
|---|---|---|---|
| validate | Ist validate = true, wird die Anfrage nicht ausgeführt, sondern nur auf syntaktische und inhaltliche Korrektheit überprüft (z.B. ob Parameterwerte stimmen oder plausibel sind) | Optional |
|
| iwsKey | Der Webservice-Nutzungskey für ITscope-Kunden. Nur mit diesem Key können Web Service Requests ausgeführt werden. | Ja | Ihr IWS-Key, zum Beispiel: qnAGOar2dsAIo1EnThWsKA. Sie erhalten den Key bei der Registrierung als Enterprise-User bei ITscope. |
3.2 Spezielle Parameter
| Name des
Parameters | Beschreibung | Benötigt | Zulässige Werte |
|---|---|---|---|
| categoryId | Ruft Daten und Unterkategorien einer Kategorie ein. Es besteht die Möglichkeit eine durch Kommas getrennte Liste von KategorieIds anzugeben. | Nein | Numerisch |
| classId | Ruft alle Kategorien einer Klassifizierung ab. | Ja, default 1 | Werte siehe Klassifizierungen |
| children | Kinderkategorien anzeigen, jedoch nur bei gesetztem Parameter categoryId | Nein |
|
4 Beispielaufrufe
- Beispiele für REST getCategories REST