listojs v1.2.3
Listojs
Listojs is an experimental single-page application (SPA) that allows api-communications, and adresses several purposes. The current reference-version of the software implements a frontend to manage restaurant-functionalities. The application uses a (jQuery-based), customized version of the AdminLTE-software in order to administer the customer-frontends and allow the staff-operations (waiter, cook, manager, web-administrator). Data are retrieved via a special JSON-based API, which returns a special tabular JSON - format with headers, whose data must be accessed by zero-based arrays. The general format of this json-data has the following generic structure:
{
"_VariableLabels":
..., "_VariableTypes":...,"_rc":
returncode,"count":number of returned rows,"rows": [ { "rn":
rownumber, "s":zero-based array with the actual data to be accessed},
more rows:{...},{...},],"variableNames":
...}
var someVariable=data.rows
rowIndex.scolumnIndex
or by using the get-function with the variable-label:
var someVariable=get(data,
rowIndex,variableLabel)
The library uses the following function for Ajax-calls:
sendAjax(
urlShort, params, myCallback, args)
where urlShort is one of the calls to the documented API (See API-directory of this documentation).
Non-public calls are implemented with a bearer-token-authentification-mechanism. See below example.
EXAMPLE
CALL-ID listorante.Waiter.6 of the waiterAPI
"/listorante/waiter/showcart/" + bill + "/" + table+ "?LOC=en"
returns following JSON:
{
"_VariableLabels":
"qty",
"prodname",
"idproduct",
"price",
"pricesum",
"tablenumber",
"idbillnumber"
,
"_VariableTypes":
"stringType",
"stringType",
"stringType",
"stringType",
"stringType",
"integerType",
"integerType"
,
"_rc": 0,
"count": 17,
"rows": [
{
"rn": 1,
"s":
"36",
"Hamburger",
"9",
"2.99",
"107.64",
"20",
"27"
},
{...},{...},
{
"rn": 17,
"s":
"433",
"TOTAL",
" ",
"0.00",
"3,003.51",
"20",
"27"
}
],
"variableNames":
"qty",
"prodname_en",
"idproduct",
"price",
"pricesum",
"tablenumber",
"idbillnumber"
}
Based on this JSON-data, getting the product-name of the first row can be achieved in following ways. Either:
or:
var productname=get(data,
0,"prodname")
Beware: rows.rn returns the NON-zero-based index of the row.
As this is a secured call with prior bearer-token-authentication, below function can be used to retrieve the JSON-data. (Prior to the call, the client must login and set a cookie with the returned token from the login-call. This is already implemented in the Login-screen of the application).
function showCart(bill, table) {
var bearerCookie = getCookie(bearerCookieName);
var url = "/listorante/waiter/showcart/" + bill + "/" + table + "?LOC=" + locale;
sendAjax(url, {header : {"Authorization" : "Bearer " + bearerCookie,"Content-Type" : "application/x-www-form-urlencoded;charset=UTF-8"} },
function(data) {
var prodname2=get(data,1,"prodname");
// do something else ...
},{"met" : "post" });
}
DEMO: (NON-SSL-Beta-Version in current development) www.listorante.com/integrationusername:demo, passwort:demo