Skip to content

URL Parameters ​

All available parameters for calling the visual interface (/planning).

Note

Both boolean values (true/false) and numeric values (1/0) are supported. Exception: buttongeneratereinitid and buttongenerateparentnode expect true.

Authentication ​

ParameterRequiredDescription
tokenOptionalSecurity key. Without token, the last one passed is used; if there is none, the login page opens (in an iFrame, in a new tab). See Authentication. Example: &token={08646A79-2763-4A7C-B6C1-51E05C7F3C76}

Display ​

ParameterDefaultDescription
showlogoutbtntrueLogout button visible
showlanguageselectiontrueLanguage selection visible
showpricetrueShow the price. The value is also passed to the server. If a server profile is loaded, its show_price applies and the URL parameter is ignored.
showdefaultpreviewimagetrueShow preview images of property values; false hides them
hidegroundplanefalseHide the floor plane in the 3D scene; only its light grey outline is visible
hidedisabledpropertiesfalseHide non-editable properties
darkmode–true = dark, false = light design; without the parameter, the last chosen setting applies
showmenubartrueShow the menu bar at the top; with false, the 3D view and information panel fill the full height

Language & currency ​

ParameterDescription
langLanguage of the interface and data: de, en, fr, nl, pl or cz. Without the parameter, the last language chosen applies, otherwise German.
langaltAlternative language if lang texts are missing
currencyCurrency according to ISO 4217 (e.g. EUR). No conversion — display only.

Prices ​

ParameterDescription
vkrabattSales price discount in percent. The original price is struck through and the new net sales price is shown. Example: &vkrabatt=10
mwstVAT in percent. The gross price is shown in addition (with a discount, based on the discounted price). Example: &mwst=19

3D scene ​

ParameterDefaultDescription
rotatescenefalseAutomatic rotation of the object around its center
disablepanfalseDisable the pan function (right mouse button)
minzoom0Closest distance of the camera to the article in meters; decimals allowed (e.g. 1.5)

Catalog ​

ParameterDescription
opencatalogueOpen the catalog automatically when the page loads
disablecatalogueDisable the catalog — the user can only see the loaded article. Breadcrumbs are hidden as well.
parentnodeStart folder of the catalog (nodeid). Hides the breadcrumbs. Takes precedence over locally persisted catalog state on the initial load. Empty (parentnode=) starts at the top level without binding the catalog: the breadcrumbs stay visible.

Loading articles ​

ParameterDescription
manufacturerManufacturer code (e.g. from a catalog call)
currentmanufacturerManufacturer for logo and contact details. Takes precedence over the manufacturer derived from parentnode (first segment of the node path).
programSeries code
basearticlenumberBase article number
ocdreinitReinit string for commercial data (frontend use)
permanentidPreviously generated PermanentID for a meta configuration
idID from /ofml/reinit for reconfiguring a shopping cart article, see Shopping Cart Integration. Takes precedence over permanentid.

Shopping cart & wishlist ​

ParameterDescription
urlwarenkorbURL of the external shopping cart (without http:///https://). Shows the "Add to shopping cart" button. Example: www.meinserver.de/warenkorb/kundenid
urlmerkzettelURL of the wishlist. Shows the "Add to wishlist" button.
warenkorbbtntextCustom text for the shopping cart button. Only useful with urlwarenkorb.
merkzettelbtntextCustom text for the wishlist button. Only useful with urlmerkzettel. If urlwarenkorb is set as well, the wishlist appears as an icon button and the text as its tooltip.
obxexportShows the "OBX exchange" section in the Download tab (export/import of .obx files) and allows dragging an .obx file onto the WebKatalog. See OBX. Default: false.

Layout variants ​

ParameterDefaultDescription
pevcompactProperty Editor layout: full or compact
advmodularArticle drawer variant: single or modular

Admin & debug ​

ParameterDescription
devmodeEnable developer mode. Shows debug info and performance overlays.
cacheEnable/disable client-side caching (default: true). With false, no data is cached in localStorage.
buttongeneratereinitidShow the button for generating PermanentIDs (admin)
buttongenerateparentnodeShows a button that displays the current catalog path (nodeid for parentnode) in a dialog (admin)

3D office WebKatalog 2.5 — ub.unitel GmbH