Library Developer Home FD1 Client Protocol Home Conceptual Overview Using GET/POST Protocol Definition Authentication Authorisation Firehoses Examples General curl websocat Major APIs / Endpoints Endpoint Overview Accounts Customers Fetch Data Departments Devices Locations Products Sales Session Less Common Endpoints User Interface Worked Examples Temperature Monitor Custom Report Instore Customer Display External Customer Display Cross Domain Reporting Advanced Integration FieldpineDevices External Website Schema Definitions custdisp.sale.* device.bluetooth.announcement device.scale.reading firehose.status sale.create sale.read Diagnostic Schema tufe.error tusp.entry

FD1 UserInterface Endpoint

userinterface.link.htm

Returns a final target URL for a given input URL, providing mapping from one namespace to another. It is most helpful for menu links, where the page to be displayed can vary based on user, location and even device being used. A user on an ordering iPad wanting the "products" menu page probably has a different range of options to a product controller. With userinterface.link you can provide different URL redirects based on context.

Warning. This endpoint behaves differently based on how it is called.

You do not have to use this method of dynamically changing webpage content, there are other options, however this method can be helpful if creating a complete custom application website

Example. To create menu links on a page

... We are on a detail page, say single_product_info.htm ...
<menu>
    <a href='/fd1/userinterface.link.htm?k=products'>Products Menu</a>
</menu>

When this link is clicked, the web server will receive a navigation request for '/fd1/userinterface.link.htm?k=products'. If the webserver understands this URL scheme, then it will return the HTML, or 302 redirect, or other valid HTTP responses.