IWS/API IWS3/getProductTypes
Aus ITscope GmbH - Wissensbasis
Inhaltsverzeichnis |
1 Beschreibung
getProductTypes liefert die Definition technischer Merkmale und ihre Gruppierung zu Produkttypen(Set) im XML-Format. Jedes Produkt hat genau einen Produkttyp (auch "Set" genannt), der seine Merkmale festlegt. Dadurch werden dann indirekt auch Eigenschaftscluster für Suchergebnisse bestimmt (siehe auch Profisuche).
Beispiel: Eine productLookup-Response enthält nur Produkte vom Produkttyp Notebook. Dadurch sind die Cluster auf die Merkmale dieses Typs beschränkt.
Verwendet werden die Merkmals-Metadaten beispielsweise für folgende Zwecke:
- Beschreibung von Eigenschaftsclustern (der Merkmalstyp wird dort als <its:eigKonkret> referenziert), siehe productLookup.
- Beschreibung einzelner technischer Merkmale bei Produkten (der Merkmalstyp wird dort als <its:attrTypeId> referenziert).
1.1 Details Merkmalsbeschreibung
Wichtige Daten eines Merkmaltyps (Ausprägungen / Eigenschaften von Produkten ) (its3:feature) sind
- its:uid - Eindeutige ID (Präfix ECO)
- its3:rank - Anzeigereihenfolge (aufsteigend sortiert, kann negative Werte enthalten, z.B. ist -312 wichtiger als 14)
- its3:rigidity - Die Rigidität ist mehr oder weniger eine Aussage welche Unterscheidungs-/Aussagekraft eine Eigenschaft in Bezug auf das Produkt hat.
- its3:name - Name
- its3:displays - veraltet
- its3:pos - veraltet
- its3:abstractFeature - Merkmalskonzept, das Merkmale gleicher Art miteinander verbindet
- its3:unit - Die Einheit.
Wichtige Daten eines Merkmalkonzepts (its3:abstractFeature) sind
- its:uid - Eindeutige Id (Präfix EAB)
- its:propertyType - Datentyp der Eigenschaft
- its:basicUnit - Basiseinheit
- its:conceptName - Name
- Wert 0 - ganzzahlige Eigenschaft (bei Dezimalzahlen ist die Basiseinheit so gewählt, daß ganzzahlige Werte herauskommen)
- Wert 1 oder 2 - Wort aus Wortliste (siehe getFeatureWords)
Wichtige Daten einer Einheit (its3:unit) sind:
- its:uid - Eindeutige Id (Präfix UNI)
- its:name - Name
- its:descrip - Beschreibung
- its:text - Mögliche Texte
- its:redText - Anzeigetext
- its:basicUnit - Basiseinheit
- its:mulfaktor - Multiplikator auf die Basiseinheit
- its:divfaktor - Divisor auf die Basiseinheit
Auf Basis von its:mulfaktor / its:divfaktor werden die Werte in den Clustern und den Produktmerkmalen umgerechnet
Beispiel anhand des Merkmalkonzepts Speicherkapzität
- Merkmalstypen (Ausprägungen) sind z.B. RAM-Hauptspeicher, Grafik-Ram, Festplatten-Speicher, CF-Card-Speicher
- Einheiten sind z.B. Byte, KiloByte, MegaByte, GigaByte, TeraByte
- Basiseinheit ist z.B. Byte
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 |
|---|---|---|---|
| setId | Ruft Name und Merkmale eines bestimmten Produkttyps ab. | Nein | Produkttypen |
| showFeatureList | Überträgt die möglichen Merkmale der Produkttypen mit (Standardwert = true). Bei false wird nur einer Liste der Produkttypen dargestellt. | Nein |
|
4 Beispielaufrufe
- Beispiele für REST getProductTypes REST