{"__v":15,"_id":"55157b0ec859ac2f0001b53d","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"**Table Tracker** is a table location system that identifies where guests are sitting so you can deliver food faster. A key component of the Table Tracker system, the *Table Tracker Gateway* is a small, on-premise device. It interfaces with iOS Table Tracker, but also supports access via a REST API.\n\n##How Does it Work? \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Order\",\n    \"h-1\": \"Locate\",\n    \"h-2\": \"Deliver\",\n    \"h-3\": \"Analyze\",\n    \"0-0\": \"A Tracker is given to customers when they order.\",\n    \"0-1\": \"The Tracker reads tags on the customer's table and broadcasts its location.\",\n    \"0-2\": \"Food runners reference the Order View to identify a guest's location and deliver food.\",\n    \"0-3\": \"Managers can use the Table Tracker app or LRS Connect to view performance reports.\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\nOrders represent a customer interaction and have the following properties:\n\n  * Identified by numbers, such as 1, 2, 3,... that are assigned and associated with a Tracker.\n  * Move through states such as **started**, **located** and **cleared**.\n  * Have an order type of `ON_PREMISE` or `TO_GO` and can change types.\n  * A `TO_GO` order will still be located when a customer places the Tracker on a table while waiting on their order.\n  * Orders can be paged to notify a customer that their `TO_GO` order is ready for pickup.\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Supported Operations\"\n}\n[/block]\nThe Table Tracker Gateway API provides all the necessary methods to implement an solution equivalent to the iOS Table Tracker application.\n\nWith the API, you can:\n\n  * Start, Locate, Page and Clear active orders.\n  * Search for all Active Orders.\n  * Register a REST endpoint to be notified when the status changes for any Active Order.\n  * Search Order History for reporting or tracking purposes.\n  * Query daily order statistics to measure average delivery times against a goal. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication\"\n}\n[/block]\nAuthentication is handled via basic authentication. Each request must be authenticated via a key provided by LRS during implementation. The system uses the Basic Authentication mechanism. \n\nUse API key as the username and blank for the password. **Do not forget the colon at the end.**\nbase64(\"API_key:\")\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"SSL\"\n}\n[/block]\nThis manner of authentication is only secure if SSL is employed everywhere.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Discovery Service\"\n}\n[/block]\nThe Gateway discovery mechanism provides a way of dynamically discovering devices that are capable of interacting with the Gateway. The discovery protocol is an implementation of [Bonjour](https://developer.apple.com/bonjour/index.html). The Gateway advertises the service type of `_tracker-http._tcp`.","category":"55157b0dc859ac2f0001b53b","createdAt":"2015-03-27T15:45:18.648Z","excerpt":"The Table Tracker Gateway API provides all the necessary methods to implement an solution equivalent to the iOS Table Tracker application.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"project":"55157b0cc859ac2f0001b537","slug":"getting-started","sync_unique":"","title":"Table Tracker Gateway API","type":"basic","updates":[],"user":"55157a70c859ac2f0001b535","version":"55157b0dc859ac2f0001b53a","childrenPages":[]}

Table Tracker Gateway API

The Table Tracker Gateway API provides all the necessary methods to implement an solution equivalent to the iOS Table Tracker application.

**Table Tracker** is a table location system that identifies where guests are sitting so you can deliver food faster. A key component of the Table Tracker system, the *Table Tracker Gateway* is a small, on-premise device. It interfaces with iOS Table Tracker, but also supports access via a REST API. ##How Does it Work? [block:parameters] { "data": { "h-0": "Order", "h-1": "Locate", "h-2": "Deliver", "h-3": "Analyze", "0-0": "A Tracker is given to customers when they order.", "0-1": "The Tracker reads tags on the customer's table and broadcasts its location.", "0-2": "Food runners reference the Order View to identify a guest's location and deliver food.", "0-3": "Managers can use the Table Tracker app or LRS Connect to view performance reports." }, "cols": 4, "rows": 1 } [/block] Orders represent a customer interaction and have the following properties: * Identified by numbers, such as 1, 2, 3,... that are assigned and associated with a Tracker. * Move through states such as **started**, **located** and **cleared**. * Have an order type of `ON_PREMISE` or `TO_GO` and can change types. * A `TO_GO` order will still be located when a customer places the Tracker on a table while waiting on their order. * Orders can be paged to notify a customer that their `TO_GO` order is ready for pickup. [block:api-header] { "type": "basic", "title": "Supported Operations" } [/block] The Table Tracker Gateway API provides all the necessary methods to implement an solution equivalent to the iOS Table Tracker application. With the API, you can: * Start, Locate, Page and Clear active orders. * Search for all Active Orders. * Register a REST endpoint to be notified when the status changes for any Active Order. * Search Order History for reporting or tracking purposes. * Query daily order statistics to measure average delivery times against a goal. [block:api-header] { "type": "basic", "title": "Authentication" } [/block] Authentication is handled via basic authentication. Each request must be authenticated via a key provided by LRS during implementation. The system uses the Basic Authentication mechanism. Use API key as the username and blank for the password. **Do not forget the colon at the end.** base64("API_key:") [block:api-header] { "type": "basic", "title": "SSL" } [/block] This manner of authentication is only secure if SSL is employed everywhere. [block:api-header] { "type": "basic", "title": "Discovery Service" } [/block] The Gateway discovery mechanism provides a way of dynamically discovering devices that are capable of interacting with the Gateway. The discovery protocol is an implementation of [Bonjour](https://developer.apple.com/bonjour/index.html). The Gateway advertises the service type of `_tracker-http._tcp`.