Catalog (XCF)

/api/xcf.dll/xcf

XCF covers all information related to the catalog: navigation, search, breadcrumbs and resources.

---

/getnodes — Catalog data

GET

Gets all child elements of a catalog folder.

GET /api/xcf.dll/xcf/getnodes?token={TOKEN}&lang=de&parentnode={NODEID}

Parameters

Parameter	Required	Description
token	Required	Authentication
profile	Optional	Server profile
parentnode	Optional	Catalog folder. Empty = top-level folder
lang	Optional	Display language
langalt	Optional	Alternative language

Response

JSON array:

Field	Description
nodeid	Unique ID of the node (including path). Contains ;, :, @. Can be used as parentnode.
text	Display text in the selected language
nodetype	F = Folder, A = Article, I = Info
manufacturer	Manufacturer ID
program	Series ID
basearticlenumber	Base article number (only for nodetype=A)
variantcode	Resolved article number (only for nodetype=A)
convertdate	Conversion date (top level only)
ressources	Array with restype and rescontent (e.g. IT = catalog image)

Example

[
  {
    "nodeid": "_D;webti:@FOLDERUB272;@FOLDERUB273;@FOLDERUB276",
    "text": "Vierfuß-Gestell quadratisch",
    "nodetype": "F",
    "variantcode": "",
    "basearticlenumber": "",
    "convertdate": "2018-04-20",
    "manufacturername": "Demodaten",
    "ressources": [
      {
        "restype": "IT",
        "rescontent": "xcf/ressource/_dx/webti/any/27R1014Q.jpg"
      }
    ],
    "manufacturer": "_dx",
    "program": "webti"
  }
]

Catalog image URL: https://web.3doffice.de/webkatalog2/api/xcf.dll/xcf/ressource/{PATH}?token={TOKEN}

---

/getnodesbreadcrumbs — Catalog path

GET

Returns the full catalog path to the given catalog folder.

GET /api/xcf.dll/xcf/getnodesbreadcrumbs?token={TOKEN}&lang=de&parentnode={NODEID}

Parameters

Parameter	Required	Description
token	Required	Authentication
profile	Optional	Server profile
parentnode	Optional	Catalog folder
lang	Optional	Display language
langalt	Optional	Alternative language

Response

[
  { "nodeid": "_D", "text": "Demodaten" },
  { "nodeid": "_D;TI:@FOLDERS1", "text": "Tische" },
  { "nodeid": "_D;TI:@FOLDERS1;@FOLDER1", "text": "(Art) Standardtische" }
]

Catalog path: Demodaten > Tische > (Art) Standardtische

---

/ressource — Resources

GET

Manufacturer level

GET /api/xcf.dll/xcf/ressource/{MANUID}/de/{NAME}

Returns resources at manufacturer level (e.g. the manufacturer logo).

Example: .../ressource/_dx/de/_dx.jpeg?token={TOKEN}

Series level

GET /api/xcf.dll/xcf/ressource/{MANUID}/{SERIESID}/{LANGUAGE}/{NAME}

{LANGUAGE} is a language code or any (language-independent). The simplest way is to use the path from rescontent unchanged.

Returns resources at series level (e.g. catalog images).

Example: .../ressource/_d/webti/any/tische.jpg?token={TOKEN}

---

/search — Search

GET

Searches article numbers and article short texts.

GET /api/xcf.dll/xcf/search/{MANUID}?token={TOKEN}&lang=de&q={SEARCHTEXT}

Parameters

Parameter	Required	Description
token	Required	Authentication
lang	Optional	Language
langalt	Optional	Alternative language
q	Required	Search text

Response

Same format as /getnodes — contains the search results.

Example

[
  {
    "nodeid": "_D;SEARCHRESULT0",
    "text": "Bildschirmtisch, links, Breite 1600 mm",
    "nodetype": "A",
    "variantcode": "",
    "basearticlenumber": "27B0616RL",
    "convertdate": "2018-04-20",
    "manufacturername": "Demodaten",
    "ressources": [
      {
        "restype": "IT",
        "rescontent": "xcf/ressource/_dx/WEBTI/any/27B0616RL.jpg"
      }
    ],
    "manufacturer": "_dx",
    "program": "WEBTI"
  }
]