Mit dieser Funktion haben Sie die Möglichkeit eine Datenverfügbarkeitsabfrage umzusetzen. Die Schnittstelle liefert entsprechende Informationen darüber, ob zu einem bestimmten Artikel artikelbezogene Informationen in OXOMI hinterlegt sind.
Mithilfe dieser Funktion ist es im einfachsten Fall möglich informationsabhängig die Oberfläche der integrierenden Anwendung anzupassen oder alternativ dazu eine eigene Logik einzubauen.
Die einfache Datenverfügbarkeitsabfrage ermöglicht es gezielt die Verfügbarkeit für bestimmte Artikel oder konkrete Inhalte abzufragen.
Wenn Sie wissen möchten, welche Daten zu einem Artikel verfügbar sind, dann benutzen Sie die nachfolgenden Parameter.
| Parameter | Beschreibung |
|---|---|
| item |
Eigene Artikelnummer (Erklärung und Beispiel im nachfolgenden Absatz) |
| itemNumber |
Artikelnummer |
| supplierNumber |
Eine Lieferantennummer.
Sollten Sie selbst der Lieferant sein oder selbst Artikelinformationen in OXOMI eingespielt haben,
so belegen Sie diesen Parameter mit |
| model |
Gibt das Modell bzw. den Typ des Artikels an, damit in Dokumenten auch danach gesucht werden kann. |
| gtin | Gibt die GTIN des Artikels an, damit in Dokumenten auch nach dieser gesucht werden kann. |
| contentType |
Schränkt die zu überprüfenden Inhalte ein. Geben Sie hierzu die gewünschten Inhaltstypen als
kommagetrente Liste an. Verfügbare Inhaltsprüfungen sind:
|
| id |
Gibt die Id eines Inhaltselement an. Wenn dieser angegeben wird, wird geprüft, ob es ein Dokument/Video/Exposé mit dieser Id gibt. |
Liegt bei Ihnen der Fall vor, dass Sie eigene Dokumente mit Artikeln von Herstellern verknüpft haben,
so steht Ihnen für die Abfrage der item Parameter zur Verfügung. Mit diesem Parameter
übergeben Sie die Artikelnummer, die Sie innerhalb der Dokumente verwenden, falls diese sich von
der Artikelnummer des Herstellers unterscheidet.
Beispiel: Sie haben eine Preisliste. In dem Preislisten-Dokument wird Ihr Artikel mit der
Artikelnummer DK-12345 bezeichnet. Der Hersteller von dem Sie diesen Artikel beziehen,
bezeichnet diesen Artikel mit Duschkopf-ABC (Werksartikelnummer). In diesem Fall belegen Sie die
Parameter wie folgt:
oxomi.exists({
"item": "DK-12345",
"itemNumber": "Duschkopf-ABC",
"supplierNumber": "LIEFERANTENNUMMER"
});
Sollten Sie zum Beispiel die Anforderung umsetzen wollen, die Datenverfügbarkeit mehrerer Artikel auf einmal darzustellen (z.B. auf einer Produkt-Übersichtsseite), dann haben Sie die Möglichkeit eine einzige Mehrfachabfrage zu benutzen, anstatt für jeden Artikel einzeln die Datenverfügbarkeit abfragen zu müssen.
Für eine Mehrfachabfrage übergeben Sie dem Aufruf eine dynamische Liste mit Parametern. Die Parameter für Artikel- und Lieferantennummer werden hierbei mit einem fortlaufenden Index ergänzt.
oxomi.exists({
"itemNumber1": "1234",
"supplierNumber1": "LIEF1",
"itemNumber2": "5678",
"supplierNumber2": "LIEF2",
"itemNumber3": "12abc",
"supplierNumber3": "LIEF3"
});
Mit dem Parameter id können Sie schnell überprüfen ob ein Inhalt mit einer bestimmten Id oder Code
im Portal verfügbar ist. Dieser Parameter wird am besten mit dem gewünschtem Inhaltstyp im Parameter
contentType (catalog,video,gallery) verknüpft. Dies kann zum Beispiel genutzt werden,
um zu überprüfen ob ein Nutzer die nötige Portalrolle hat um ein Dokument anzusehen.
Die aus der Verfügbarkeitsabfrage abgefragten Daten lassen sich auf zweierlei Arten auswerten beziehungsweise anwenden.
In diesem Anwendungsfall entfernt die Funktion eine HTML-Klasse von den HTML-Elementen, in welchen die vorliegenden Daten angezeigt werden sollen.
| Parameter | Beschreibung |
|---|---|
| imagesTarget |
jQuery-Selektor des Ziel-Elements für Bilddaten |
| pagesTarget |
jQuery-Selektor des Ziel-Elements für Dokumentseiten |
| attachmentsTarget |
jQuery-Selektor des Ziel-Elements für Zusatzdokumente |
| textTarget |
jQuery-Selektor des Ziel-Elements für Langtexte |
| videosTarget |
jQuery-Selektor des Ziel-Elements für Videos |
| galleriesTarget |
jQuery-Selektordes Ziel-Elements für Exposés |
| classToRemove |
Die HTML-Klasse, welche die Funktion entfernt, falls Daten vorhanden sind. |
oxomi.exists({
"itemNumber": "ST.001.A",
"imagesTarget": "#tab-images",
"pagesTarget": "#tab-pages",
"attachmentsTarget": "#tab-attachments",
"textTarget": "#tab-text",
"videosTarget": "#tab-videos"
});
Falls Sie mehr als nur ein einfaches Entfernen einer Klasse benötigen, dann haben Sie die Möglichkeit, die von der Schnittstelle gelieferten Daten mit einer eigenen Logik auszuwerten und entsprechende Funktionen einzubinden.
| Parameter | Beschreibung |
|---|---|
| callback |
Funktion, die mit den gelieferten Informationen als Parameter (JSON-Objekt) aufgerufen wird |
{
"success":true,
"error":false,
"catalog":true,
"video":true,
"gallery":true,
"image":true,
"attachment":true,
"text":true,
"datasheet": "https://oxomi.com/p/DEMO/datasheet/-/ST.001.A"
}
{
"success":true,
"error":false,
"exists":[{
"contentType":"",
"id":"",
"itemNumber":"ST.001.A",
"supplierNumber":"",
"catalog":false,
"video":true,
"gallery":true,
"image":true,
"attachment":true,
"text":true,
"datasheet": "https://oxomi.com/p/DEMO/datasheet/-/ST.001.A"
},
{
"contentType":"",
"id":"",
"itemNumber":"ST.002.B",
"supplierNumber":"",
"catalog":false,
"video":true,
"gallery":true,
"image":true,
"attachment":true,
"text":true,
"datasheet": "https://oxomi.com/p/DEMO/datasheet/-/ST.002.B"
}]
}
oxomi.exists({
"itemNumber": "ST.001.Axxx",
"callback": function(json) {
if(!json.image) {
alert("Zu diesem Artikel haben wir leider keine Bilder.");
}
}
});
Wenn Sie einen eigenen callback benutzen, wird, sobald eine Datenverfügbarkeitsabfrage erfolgreich
ist („success“: true) und artikelbezogene Datenin OXOMI gefunden wurden, mit der Antwort
automatisch ein Link zu einem von OXOMI automatisch erstellten Datenblatt geliefert. Dieses stellt die
gefundenen Informationen übersichtlich dar, was Ihnen die Möglichkeit bietet bei einer erfolgreichen
„exists“-Abfrage automatisch dem Nutzer (z.B. eines ERP) als Service den Link zum Datenblatt zu liefern.
Zum Datenblatt-Showcase