Artikel (OFML)

/api/ofml.dll/ofml

OFML umfasst alle Informationen über kaufmännische Daten und Metadaten eines Artikels.

---

/articles — Artikel laden

GET

Lädt einen kaufmännischen OCD-Artikel mit seinen Metadaten. Wird für das initiale Laden nach Katalognavigation verwendet.

GET /api/ofml.dll/ofml/articles?token={TOKEN}&manufacturer={MANU}&program={PROG}&basearticlenumber={ARTNR}&lang=de

Parameter

Parameter	Pflicht	Beschreibung
token	Pflicht	Authentifizierung
manufacturer	Pflicht	Herstellerkürzel, wie von /getnodes geliefert
program	Pflicht	Serienkürzel, wie von /getnodes geliefert
basearticlenumber	Pflicht	Grundartikelnummer
lang	Optional	Sprache
langalt	Optional	Alternativsprache
currency	Optional	Währung
showprice	Optional	true: Preise werden mitgeliefert
varcode	Optional	Variantencode
ocdreinitstring	Optional	Reinitstring für konfigurierten Artikel

Antwort

JSON-Objekt eines kompletten Artikels:

Top-Level

Feld	Beschreibung
id	Artikel-Kennung (für Nachkonfiguration)
rootid	Root-ID des obersten Vater-Artikels (bei Meta-Planung)
manufacturer	Herstellerkürzel
program	Serienkürzel
basearticlenumber	Grundartikelnummer
typename	Interne Bezeichnung des Meta-Typen
reinit	Meta-Reinitstring
children	Unterartikel, gruppiert nach Merkmal: Einträge { propname, value, childarticles }; die Artikel selbst stehen in childarticles
propclasses	Meta-Merkmale
metamessages	Nachrichten aus Meta-Kontext

ocd (Kaufmännische Daten)

Feld	Beschreibung
id	Interne kaufmännische ID
finalarticlenumber	Aufgelöste Artikelnummer (inkl. Codeschema)
price	Artikelpreis
currency	Währung
pricecomponents	Einzelne Preiskomponenten
shorttext	Kaufmännischer Kurztext
longtext	Kaufmännischer Langtext
varianttext	Merkmale mit aktuellem Wert
reinitstring	Kaufmännischer Reinitstring
convertdate	Konvertierungsdatum
articlewithprice	Hat der Artikel einen Preis?
propclasses	Merkmalsklassen mit Merkmalen und Werten
usermessages	Benutzernachricht aus OCD-Kontext
obligatory2c	True, wenn mindestens ein Merkmal optional ist, das trotzdem bewertet werden muss

Debug-Felder

Feld	Beschreibung
dump	Variantencode des Artikels (wird z. B. im OCI-Export verwendet)
debugreinitstring	Reinitstring zur Fehlersuche; nicht für die Integration verwenden
debugiscommercialvalid	Nicht implementiert
debugisvisiblepropertieswithvalue	Nicht implementiert

ocd.propclasses — Merkmalsklassen

Feld	Beschreibung
name	Interner Name
text	Anzeigetext
properties	Array der Merkmale

ocd.propclasses.properties — Merkmale

Feld	Beschreibung
name	Interner Name
text	Anzeigetext
proptype	C = alphanumerisch, N/L = numerisch
currentvalue	Aktueller Wert
enabled	Editierbar?
visible	Sichtbar?
obligatory	Pflichtmerkmal?
obligatory2c	True, wenn Merkmal optional (obligatory=false) aber trotzdem bewertet werden muss; Artikel ist ungültig solange mindestens ein obligatory2c=true Merkmal keinen Wert hat
addvalues	True, wenn zusätzliche Werte hinzugefügt werden können
propclassname	Name der Merkmalsklasse, in der das Merkmal enthalten ist
digits	Anzahl Stellen
decdigits	Nachkommastellen
propertyvalues	Verfügbare Werte
ranges	Wertebereiche (bei numerischen Merkmalen)

propertyvalues — Merkmalswerte

Feld	Beschreibung
valuefrom	Konkreter Wert
text	Anzeigetext
previewimage	Pfad zum Vorschaubild (relativ zu /api/ocd.dll/, siehe Vorschaubilder)
previewimagelarge	Pfad zum großen Vorschaubild (relativ zu /api/ocd.dll/)

ranges — Wertebereiche

Feld	Beschreibung
valuefrom	Untere Grenze (optional, dann offenes Intervall)
opfrom	GT = größer, GE = größer gleich
valueto	Obere Grenze (optional)
opto	LT = kleiner, LE = kleiner gleich
raster	Schrittweite (z.B. 0.2)

Beispiel

Vollständige Antwort anzeigen

{
  "typename": "",
  "id": "{A4A000D2-D647-49C0-B9D1-2661DB5B8C86}",
  "rootid": "{A4A000D2-D647-49C0-B9D1-2661DB5B8C86}",
  "manufacturer": "_dx",
  "program": "webti",
  "basearticlenumber": "27R0614Q",
  "reinit": "",
  "propclasses": [],
  "children": [],
  "ocd": {
    "id": "{5DA01879-ED51-47FC-A073-2199F95FE50B}",
    "finalarticlenumber": "27 R 06 14 KL Q",
    "price": 540,
    "currency": "EUR",
    "pricecomponents": [],
    "shorttext": "Rechtecktisch, Tiefe 600 mm, Breite 1400 mm",
    "longtext": "Rechtecktisch\\nTiefe: 600 mm\\nBreite: 1400 mm\\nQuadratisches Vierfuß-Gestell",
    "varianttext": "Höhe: 720 mm - 1160 mm\\nPlattenfarbe: Buche\\nKantenfarbe: Buche\\nGestellfarbe: Anthrazit\\nKabeldurchlass: Links + Rechts\\n",
    "reinitstring": "eJytkUEOgkAMRf9ZOIDRxLghLhhBII6IAy504_1v4Wtl75CYJp3On__baZt0w2aVipwnTvM159v9VS3RBNYpqVGvALtfkI1GdBXIzNuAf4IcVcAtMtSVHsQJxO4ztwGF6WOWvgWbvHbETHfP0gW4O-21xX6zZ9iHTG7nv7hk_v_MBBJYA2tcOujYQNQLJDAP4zWrc12I_5XLZmy5JuLKd5yTofbN9LAG347lWFf3myFHZd0Gr1LTZfLdlvoAe9lltw::",
    "convertdate": "2018-04-20",
    "propclasses": [
      {
        "name": "SONSTIGE",
        "text": "Sonstige",
        "properties": [
          {
            "name": "H",
            "text": "Höhe",
            "proptype": "C",
            "currentvalue": "KL",
            "enabled": true,
            "visible": true,
            "obligatory": true,
            "propertyvalues": [
              { "valuefrom": "F", "text": "740 mm - fest" },
              { "valuefrom": "KL", "text": "720 mm - 1160 mm" }
            ]
          },
          {
            "name": "FARBE_PL",
            "text": "Plattenfarbe",
            "proptype": "C",
            "currentvalue": "HOLZ_BUCHE",
            "propertyvalues": [
              { "valuefrom": "HOLZ_BUCHE", "text": "Buche", "previewimage": "ocd/preview/_dx/basics/holz_buche.jpg" },
              { "valuefrom": "HOLZ_EICHE", "text": "Eiche", "previewimage": "ocd/preview/_dx/basics/holz_eiche.jpg" },
              { "valuefrom": "HOLZ_NUSSB", "text": "Nussbaum", "previewimage": "ocd/preview/_dx/basics/holz_nussb.jpg" }
            ]
          }
        ]
      }
    ],
    "articlewithprice": true,
    "usermessages": ""
  }
}

---

/articles — Artikel ändern

POST

Ändert einen OCD-Artikel (Merkmal/Wert ändern).

POST /api/ofml.dll/ofml/articles?token={TOKEN}&manufacturer={MANU}&program={PROG}&basearticlenumber={ARTNR}&ocdreinitstring={REINIT}&lang=de&langalt=en&currency=EUR&showprice=true

lang, langalt, currency und showprice wirken wie bei GET /articles.

Request Body

{
  "id": "{000-0000-0-0-00-0000}",
  "rootid": "{000-0000-0-0-00-0000}",
  "proptype": "ocd",
  "propclass": "MERKMALSKLASSE",
  "prop": "MERKMALSNAME",
  "newvalue": "NEWVALUE",
  "jsondata": "{...}"
}

Feld	Pflicht	Beschreibung
id	Pflicht	Artikel-Kennung
rootid	Pflicht	Oberster Artikel der Meta-Planung
proptype	Pflicht	ocd = kaufmännisch, meta = Meta-Merkmal
propclass	Pflicht	Name der Merkmalsklasse
prop	Pflicht	Name des Merkmals
newvalue	Pflicht	Neuer Wert (valuefrom)
jsondata	Pflicht	Komplettes JSON des obersten Artikels

Antwort

Entspricht dem Format von GET /articles — enthält den aktualisierten Artikel mit neuem reinitstring.

---

Vorschaubilder

GET

Die Felder previewimage und previewimagelarge eines Merkmalswerts enthalten einen Pfad. Die Bild-URL entsteht so:

GET /api/ocd.dll/{previewimage}?token={TOKEN}

Beispiel: /api/ocd.dll/ocd/preview/_dx/basics/holz_buche.jpg?token={TOKEN}