Locations

{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Locations","type":"basic","slug":"locations","excerpt":"","body":"Locations are typically a restaurant or other venue, but could also be a floor or subsection of a venue.\n\n**Location Attributes**\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Name\",\n \"h-1\": \"Description\",\n \"h-2\": \"Details\",\n \"0-0\": \"accountGuid\",\n \"0-1\": \"Unique identifier for the managing account.\",\n \"1-0\": \"locationGuid\",\n \"2-0\": \"name\",\n \"1-1\": \"Unique identifier for the location.\",\n \"2-1\": \"The name of the location.\",\n \"3-0\": \"addressLine1\",\n \"4-0\": \"addressLine2\",\n \"3-1\": \"1st line of address.\",\n \"4-1\": \"2nd line of address.\",\n \"5-0\": \"country\",\n \"5-1\": \"Country\",\n \"8-0\": \"city\",\n \"9-0\": \"province\",\n \"8-1\": \"City\",\n \"9-1\": \"Province OR State\",\n \"10-0\": \"zipcode\",\n \"11-0\": \"phoneNumber\",\n \"10-1\": \"Mailing zipcode.\",\n \"11-1\": \"Phone Number\",\n \"7-0\": \"state\",\n \"7-1\": \"state\",\n \"12-0\": \"cacheKey\",\n \"12-1\": \"CRC32 bit checksum. The value for this key will get change if anything updated from location object.\",\n \"6-0\": \"countryCode\",\n \"6-1\": \"Country code\",\n \"13-0\": \"primaryWaitlist\",\n \"13-1\": \"Primary waitlist information\",\n \"14-0\": \"primaryWaitlist.isDeleted\",\n \"14-1\": \"Does waitlist removed\",\n \"15-0\": \"primaryWaitlist.guid\",\n \"17-0\": \"primaryWaitlist.number\",\n \"18-0\": \"primaryWaitlist.cacheKey\",\n \"19-0\": \"primaryWaitlist.waitlistSetting\",\n \"20-0\": \"primaryWaitlist.waitlistSetting.maxCapacity\",\n \"21-0\": \"primaryWaitlist.waitlistSetting.minPartySize\",\n \"15-1\": \"Guid of primary waitlist\",\n \"17-1\": \"Number of waitlist\",\n \"17-2\": \"example. 1, 2 etc\",\n \"18-1\": \"Cache key of waitlist\",\n \"18-2\": \"This will get updated if anything update from waitlist.\",\n \"19-1\": \"Configuration of waitlist\",\n \"22-0\": \"primaryWaitlist.waitlistSetting.isWaitlistOpen\",\n \"20-1\": \"Maximum party size for waitlist\",\n \"21-1\": \"Minimum party size for waitlist\",\n \"22-1\": \"Does waitlist open for booking\",\n \"22-2\": \"true: Waitlist is open for booking.\\nfalse: Waitlist is closed for booking.\",\n \"16-0\": \"primaryWaitlist.name\",\n \"16-1\": \"Name of the waitlist\"\n },\n \"cols\": 3,\n \"rows\": 23\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"get\",\n \"title\": \"/rest/v3/locations{?accountGuid}\"\n}\n[/block]\nRetrieve locations for all authorized accounts of a single account by passing in the accountGuid query parameter.\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Parameters\"\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Name\",\n \"h-1\": \"Description\",\n \"h-2\": \"Details\",\n \"0-0\": \"accountGuid\",\n \"0-1\": \"The unique identifier of the account managing the location.\",\n \"0-2\": \"string, optional\"\n },\n \"cols\": 3,\n \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"// Report Controller single location (GET https://connect.lrsus.com/rest/v3/locations)\\n\\n$.ajax({\\n url: \\\"https://connect.lrsus.com/rest/v3/locations\\\",\\n type: \\\"GET\\\",\\n headers: {\\n \\\"Authorization\\\": \\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\",\\n },\\n})\\n.done(function(data, textStatus, jqXHR) {\\n console.log(\\\"HTTP Request Succeeded: \\\" + jqXHR.status);\\n console.log(data);\\n})\\n.fail(function(jqXHR, textStatus, errorThrown) {\\n console.log(\\\"HTTP Request Failed\\\");\\n})\\n.always(function() {\\n /* ... */\\n});\\n\",\n \"language\": \"javascript\"\n },\n {\n \"code\": \"import java.io.IOException;\\nimport org.apache.http.client.fluent.*;\\n\\npublic class SendRequest\\n{\\n public static void main(String[] args) {\\n sendRequest();\\n }\\n \\n private static void sendRequest() {\\n \\n // Report Controller single location (GET )\\n \\n try {\\n \\n // Create request\\n Content content = Request.Get(\\\"https://connect.lrsus.com/rest/v3/locations\\\")\\n \\n // Add headers\\n .addHeader(\\\"Authorization\\\", \\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\")\\n \\n // Fetch request and return content\\n .execute().returnContent();\\n \\n // Print content\\n System.out.println(content);\\n }\\n catch (IOException e) { System.out.println(e); }\\n }\\n}\",\n \"language\": \"java\"\n },\n {\n \"code\": \"// Report Controller single location (GET https://connect.lrsus.com/rest/v3/locations)\\n\\nNSURL* URL = [NSURL URLWithString::::at:::\\\"https://connect.lrsus.com/rest/v3/locations\\\"];\\nNSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];\\nrequest.HTTPMethod = @\\\"GET\\\";\\n\\n// Headers\\n\\n[request addValue:@\\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\" forHTTPHeaderField:@\\\"Authorization\\\"];\\n\\n// Connection\\n\\nNSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];\\n[connection start];\\n\\n\",\n \"language\": \"objectivec\"\n },\n {\n \"code\": \"curl -X \\\"GET\\\" \\\"https://connect.lrsus.com/rest/v3/locations\\\" \\\\\\n\\t-H \\\"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\"\\n\",\n \"language\": \"curl\"\n },\n {\n \"code\": \"# Install the Python Requests library:\\n# `pip install requests`\\n\\nimport requests\\n\\ndef send_request():\\n # Report Controller single location (GET https://connect.lrsus.com/rest/v3/locations)\\n\\n try:\\n r = requests.get(\\n url=\\\"https://connect.lrsus.com/rest/v3/locations\\\",\\n headers = {\\n \\\"Authorization\\\":\\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\",\\n },\\n )\\n print('Response HTTP Status Code : {status_code}'.format(status_code=r.status_code))\\n print('Response HTTP Response Body : {content}'.format(content=r.content))\\n except requests.exceptions.RequestException as e:\\n print('HTTP Request failed')\\n\",\n \"language\": \"python\"\n }\n ]\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Response 200 (application/json)\"\n}\n[/block]\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \" {\\n \\\"status\\\": 200,\\n \\\"count\\\": \\\"25\\\",\\n \\\"offset\\\" : 50,\\n \\\"limit\\\" : 25,\\n \\\"first\\\" : \\\"https://connect.lrsus.com/rest/v3/locations?offset=0&limit=25\\\",\\n \\\"previous\\\" : \\\"https://connect.lrsus.com/rest/v3/locations?offset=25&limit=25\\\",\\n \\\"next\\\" : \\\"https://connect.lrsus.com/rest/v3/locations?offset=75&limit=25\\\",\\n \\\"last\\\" : \\\"https://connect.lrsus.com/rest/v3/locations?offset=8745&limit=25\\\",\\n \\\"items\\\": [\\n {\\n \\\"accountGuid\\\": \\\"777a5eb-59ea-4003-9c1c-77760879c88d\\\",\\n \\\"locationGuid\\\": \\\"9e1da5eb-59ea-4003-9c1c-15160879c88d\\\",\\n \\\"name\\\": \\\"Bob's Deli\\\",\\n \\\"addressLine1\\\": \\\"5050 Beltline Rd.\\\",\\n \\\"addressLine2\\\": \\\"5000 Frisco Rd.\\\",\\n \\\"country\\\": \\\"United states\\\",\\n \\\"countryCode\\\" : \\\"US\\\",\\n \\\"city\\\": \\\"Addison\\\",\\n \\\"province\\\": \\\"TX\\\",\\n \\\"zipcode\\\": \\\"75254\\\",\\n \\\"phoneNumber\\\" : \\\"888-999-9999\\\",\\n \\\"cacheKey\\\": \\\"2452593609\\\",\\n \\\"primaryWaitlist\\\": {\\n \\\"isDeleted\\\": false,\\n \\\"guid\\\": \\\"c2210066-20fb-47b0-ab19-c4013008646e\\\",\\n \\\"number\\\": 1,\\n \\\"name\\\": \\\"Waiting\\\",\\n \\\"cacheKey\\\": \\\"3607024173\\\",\\n \\\"waitlistSetting\\\": {\\n \\\"maxCapacity\\\": 10,\\n \\\"minPartySize\\\": 1,\\n \\\"isWaitlistOpen\\\": true\\n }\\n \\t}\\n },\\n ...\\n {\\n \\\"accountGuid\\\": \\\"777a5eb-59ea-4003-9c1c-77760879c88d\\\",\\n \\\"locationGuid\\\": \\\"9e1da5eb-59ea-4003-9c1c-15160879c88d\\\",\\n \\\"name\\\": \\\"Bob's Deli Frisco\\\",\\n \\\"addressLine1\\\": \\\"5555 Frisco Rd.\\\",\\n \\\"addressLine2\\\": \\\"5000 Frisco Rd.\\\",\\n\\t\\t\\t\\t\\t\\t \\\"country\\\": \\\"United states\\\",\\n \\\"countryCode\\\" : \\\"US\\\",\\n \\\"city\\\": \\\"Frisco\\\",\\n \\\"province\\\": \\\"TX\\\",\\n \\\"zipcode\\\": \\\"75254\\\",\\n \\\"phoneNumber\\\" : \\\"888-999-9999\\\",\\n \\\"cacheKey\\\": \\\"2630976542\\\",\\n \\\"primaryWaitlist\\\": {\\n \\\"isDeleted\\\": false,\\n \\\"guid\\\": \\\"c2210066-20fb-47b0-ab19-c401233008646e\\\",\\n \\\"number\\\": 1,\\n \\\"name\\\": \\\"Waiting\\\",\\n \\\"cacheKey\\\": \\\"36070241273\\\",\\n \\\"waitlistSetting\\\": {\\n \\\"maxCapacity\\\": 10,\\n \\\"minPartySize\\\": 1,\\n \\\"isWaitlistOpen\\\": true\\n }\\n \\t}\\n }\\n ]\\n }\",\n \"language\": \"json\"\n }\n ]\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"get\",\n \"title\": \"/rest/v3/locations/{locationGuid}\"\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"// Report Controller locations (GET https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06)\\n\\n$.ajax({\\n url: \\\"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\\\",\\n type: \\\"GET\\\",\\n headers: {\\n \\\"Authorization\\\": \\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\",\\n },\\n})\\n.done(function(data, textStatus, jqXHR) {\\n console.log(\\\"HTTP Request Succeeded: \\\" + jqXHR.status);\\n console.log(data);\\n})\\n.fail(function(jqXHR, textStatus, errorThrown) {\\n console.log(\\\"HTTP Request Failed\\\");\\n})\\n.always(function() {\\n /* ... */\\n});\\n\",\n \"language\": \"javascript\"\n },\n {\n \"code\": \"import java.io.IOException;\\nimport org.apache.http.client.fluent.*;\\n\\npublic class SendRequest\\n{\\n public static void main(String[] args) {\\n sendRequest();\\n }\\n \\n private static void sendRequest() {\\n \\n // Report Controller locations (GET )\\n \\n try {\\n \\n // Create request\\n Content content = Request.Get(\\\"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\\\")\\n \\n // Add headers\\n .addHeader(\\\"Authorization\\\", \\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\")\\n \\n // Fetch request and return content\\n .execute().returnContent();\\n \\n // Print content\\n System.out.println(content);\\n }\\n catch (IOException e) { System.out.println(e); }\\n }\\n}\",\n \"language\": \"java\"\n },\n {\n \"code\": \"// Report Controller locations (GET https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06)\\n\\nNSURL* URL = [NSURL URLWithString:@\\\"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\\\"];\\nNSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];\\nrequest.HTTPMethod = @\\\"GET\\\";\\n\\n// Headers\\n\\n[request addValue:@\\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\" forHTTPHeaderField:@\\\"Authorization\\\"];\\n\\n// Connection\\n\\nNSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];\\n[connection start];\\n\\n\",\n \"language\": \"objectivec\"\n },\n {\n \"code\": \"curl -X \\\"GET\\\" \\\"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\\\" \\\\\\n\\t-H \\\"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\"\\n\",\n \"language\": \"curl\"\n },\n {\n \"code\": \"# Install the Python Requests library:\\n# `pip install requests`\\n\\nimport requests\\n\\ndef send_request():\\n # Report Controller locations (GET https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06)\\n\\n try:\\n r = requests.get(\\n url=\\\"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\\\",\\n headers = {\\n \\\"Authorization\\\":\\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\\\",\\n },\\n )\\n print('Response HTTP Status Code : {status_code}'.format(status_code=r.status_code))\\n print('Response HTTP Response Body : {content}'.format(content=r.content))\\n except requests.exceptions.RequestException as e:\\n print('HTTP Request failed')\\n\",\n \"language\": \"python\"\n }\n ]\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Parameters\"\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Name\",\n \"h-1\": \"Description\",\n \"h-2\": \"Details\",\n \"0-0\": \"locationGuid\",\n \"0-1\": \"The unique identifier of the location to retrieve.\",\n \"0-2\": \"string, required\"\n },\n \"cols\": 3,\n \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Response 200 (application/json)\"\n}\n[/block]\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"status\\\": 200,\\n \\\"location\\\" : {\\n \\\"accountGuid\\\": \\\"777a5eb-59ea-4003-9c1c-77760879c88d\\\",\\n \\\"locationGuid\\\": \\\"9e1da5eb-59ea-4003-9c1c-15160879c88d\\\",\\n \\\"name\\\": \\\"Jason's Deli Frisco\\\",\\n \\\"addressLine1\\\": \\\"5000 Frisco Rd.\\\",\\n \\\"addressLine2\\\": \\\"5000 Frisco Rd.\\\",\\n\\t\\t\\t\\t\\t\\t \\\"country\\\": \\\"United states\\\",\\n\\t \\\"countryCode\\\": \\\"US\\\",\\n \\\"city\\\": \\\"Frisco\\\",\\n \\\"province\\\": \\\"TX\\\",\\n \\\"zipcode\\\": \\\"75254\\\",\\n \\\"phoneNumber\\\" : \\\"888-999-9999\\\",\\n \\\"cacheKey\\\": \\\"2630976542\\\",\\n \\t\\\"primaryWaitlist\\\": {\\n \\\"isDeleted\\\": false,\\n \\\"guid\\\": \\\"c2210066-20fb22-47b0-ab19-c4013008646e\\\",\\n \\\"number\\\": 1,\\n \\\"name\\\": \\\"Waiting\\\",\\n \\\"cacheKey\\\": \\\"360702412273\\\",\\n \\\"waitlistSetting\\\": {\\n \\\"maxCapacity\\\": 10,\\n \\\"minPartySize\\\": 1,\\n \\\"isWaitlistOpen\\\": true\\n }\\n \\t}\\n }\\n}\",\n \"language\": \"json\"\n }\n ]\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"58766da64a24f82f00bbf28a","createdAt":"2015-08-05T14:58:02.125Z","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"58766da64a24f82f00bbf286","version":"58766da54a24f82f00bbf285","project":"552819c1555b9e0d00564f74","createdAt":"2015-04-10T18:43:14.538Z","__v":0},"project":"552819c1555b9e0d00564f74","version":{"version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["58766da64a24f82f00bbf286","5e97f10ca9631a0231d9c19a"],"_id":"58766da54a24f82f00bbf285","releaseDate":"2017-01-11T17:38:45.993Z","project":"552819c1555b9e0d00564f74","__v":2,"createdAt":"2017-01-11T17:38:45.993Z"},"user":"55157a70c859ac2f0001b535","__v":0,"githubsync":"","parentDoc":null}

Locations are typically a restaurant or other venue, but could also be a floor or subsection of a venue. **Location Attributes** [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Details", "0-0": "accountGuid", "0-1": "Unique identifier for the managing account.", "1-0": "locationGuid", "2-0": "name", "1-1": "Unique identifier for the location.", "2-1": "The name of the location.", "3-0": "addressLine1", "4-0": "addressLine2", "3-1": "1st line of address.", "4-1": "2nd line of address.", "5-0": "country", "5-1": "Country", "8-0": "city", "9-0": "province", "8-1": "City", "9-1": "Province OR State", "10-0": "zipcode", "11-0": "phoneNumber", "10-1": "Mailing zipcode.", "11-1": "Phone Number", "7-0": "state", "7-1": "state", "12-0": "cacheKey", "12-1": "CRC32 bit checksum. The value for this key will get change if anything updated from location object.", "6-0": "countryCode", "6-1": "Country code", "13-0": "primaryWaitlist", "13-1": "Primary waitlist information", "14-0": "primaryWaitlist.isDeleted", "14-1": "Does waitlist removed", "15-0": "primaryWaitlist.guid", "17-0": "primaryWaitlist.number", "18-0": "primaryWaitlist.cacheKey", "19-0": "primaryWaitlist.waitlistSetting", "20-0": "primaryWaitlist.waitlistSetting.maxCapacity", "21-0": "primaryWaitlist.waitlistSetting.minPartySize", "15-1": "Guid of primary waitlist", "17-1": "Number of waitlist", "17-2": "example. 1, 2 etc", "18-1": "Cache key of waitlist", "18-2": "This will get updated if anything update from waitlist.", "19-1": "Configuration of waitlist", "22-0": "primaryWaitlist.waitlistSetting.isWaitlistOpen", "20-1": "Maximum party size for waitlist", "21-1": "Minimum party size for waitlist", "22-1": "Does waitlist open for booking", "22-2": "true: Waitlist is open for booking.\nfalse: Waitlist is closed for booking.", "16-0": "primaryWaitlist.name", "16-1": "Name of the waitlist" }, "cols": 3, "rows": 23 } [/block] [block:api-header] { "type": "get", "title": "/rest/v3/locations{?accountGuid}" } [/block] Retrieve locations for all authorized accounts of a single account by passing in the accountGuid query parameter. [block:api-header] { "type": "basic", "title": "Parameters" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Details", "0-0": "accountGuid", "0-1": "The unique identifier of the account managing the location.", "0-2": "string, optional" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "// Report Controller single location (GET https://connect.lrsus.com/rest/v3/locations)\n\n$.ajax({\n url: \"https://connect.lrsus.com/rest/v3/locations\",\n type: \"GET\",\n headers: {\n \"Authorization\": \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\",\n },\n})\n.done(function(data, textStatus, jqXHR) {\n console.log(\"HTTP Request Succeeded: \" + jqXHR.status);\n console.log(data);\n})\n.fail(function(jqXHR, textStatus, errorThrown) {\n console.log(\"HTTP Request Failed\");\n})\n.always(function() {\n /* ... */\n});\n", "language": "javascript" }, { "code": "import java.io.IOException;\nimport org.apache.http.client.fluent.*;\n\npublic class SendRequest\n{\n public static void main(String[] args) {\n sendRequest();\n }\n \n private static void sendRequest() {\n \n // Report Controller single location (GET )\n \n try {\n \n // Create request\n Content content = Request.Get(\"https://connect.lrsus.com/rest/v3/locations\")\n \n // Add headers\n .addHeader(\"Authorization\", \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\")\n \n // Fetch request and return content\n .execute().returnContent();\n \n // Print content\n System.out.println(content);\n }\n catch (IOException e) { System.out.println(e); }\n }\n}", "language": "java" }, { "code": "// Report Controller single location (GET https://connect.lrsus.com/rest/v3/locations)\n\nNSURL* URL = [NSURL URLWithString:@\"https://connect.lrsus.com/rest/v3/locations\"];\nNSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];\nrequest.HTTPMethod = @\"GET\";\n\n// Headers\n\n[request addValue:@\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\" forHTTPHeaderField:@\"Authorization\"];\n\n// Connection\n\nNSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];\n[connection start];\n\n", "language": "objectivec" }, { "code": "curl -X \"GET\" \"https://connect.lrsus.com/rest/v3/locations\" \\\n\t-H \"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\"\n", "language": "curl" }, { "code": "# Install the Python Requests library:\n# `pip install requests`\n\nimport requests\n\ndef send_request():\n # Report Controller single location (GET https://connect.lrsus.com/rest/v3/locations)\n\n try:\n r = requests.get(\n url=\"https://connect.lrsus.com/rest/v3/locations\",\n headers = {\n \"Authorization\":\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\",\n },\n )\n print('Response HTTP Status Code : {status_code}'.format(status_code=r.status_code))\n print('Response HTTP Response Body : {content}'.format(content=r.content))\n except requests.exceptions.RequestException as e:\n print('HTTP Request failed')\n", "language": "python" } ] } [/block] [block:api-header] { "type": "basic", "title": "Response 200 (application/json)" } [/block] [block:code] { "codes": [ { "code": " {\n \"status\": 200,\n \"count\": \"25\",\n \"offset\" : 50,\n \"limit\" : 25,\n \"first\" : \"https://connect.lrsus.com/rest/v3/locations?offset=0&limit=25\",\n \"previous\" : \"https://connect.lrsus.com/rest/v3/locations?offset=25&limit=25\",\n \"next\" : \"https://connect.lrsus.com/rest/v3/locations?offset=75&limit=25\",\n \"last\" : \"https://connect.lrsus.com/rest/v3/locations?offset=8745&limit=25\",\n \"items\": [\n {\n \"accountGuid\": \"777a5eb-59ea-4003-9c1c-77760879c88d\",\n \"locationGuid\": \"9e1da5eb-59ea-4003-9c1c-15160879c88d\",\n \"name\": \"Bob's Deli\",\n \"addressLine1\": \"5050 Beltline Rd.\",\n \"addressLine2\": \"5000 Frisco Rd.\",\n \"country\": \"United states\",\n \"countryCode\" : \"US\",\n \"city\": \"Addison\",\n \"province\": \"TX\",\n \"zipcode\": \"75254\",\n \"phoneNumber\" : \"888-999-9999\",\n \"cacheKey\": \"2452593609\",\n \"primaryWaitlist\": {\n \"isDeleted\": false,\n \"guid\": \"c2210066-20fb-47b0-ab19-c4013008646e\",\n \"number\": 1,\n \"name\": \"Waiting\",\n \"cacheKey\": \"3607024173\",\n \"waitlistSetting\": {\n \"maxCapacity\": 10,\n \"minPartySize\": 1,\n \"isWaitlistOpen\": true\n }\n \t}\n },\n ...\n {\n \"accountGuid\": \"777a5eb-59ea-4003-9c1c-77760879c88d\",\n \"locationGuid\": \"9e1da5eb-59ea-4003-9c1c-15160879c88d\",\n \"name\": \"Bob's Deli Frisco\",\n \"addressLine1\": \"5555 Frisco Rd.\",\n \"addressLine2\": \"5000 Frisco Rd.\",\n\t\t\t\t\t\t \"country\": \"United states\",\n \"countryCode\" : \"US\",\n \"city\": \"Frisco\",\n \"province\": \"TX\",\n \"zipcode\": \"75254\",\n \"phoneNumber\" : \"888-999-9999\",\n \"cacheKey\": \"2630976542\",\n \"primaryWaitlist\": {\n \"isDeleted\": false,\n \"guid\": \"c2210066-20fb-47b0-ab19-c401233008646e\",\n \"number\": 1,\n \"name\": \"Waiting\",\n \"cacheKey\": \"36070241273\",\n \"waitlistSetting\": {\n \"maxCapacity\": 10,\n \"minPartySize\": 1,\n \"isWaitlistOpen\": true\n }\n \t}\n }\n ]\n }", "language": "json" } ] } [/block] [block:api-header] { "type": "get", "title": "/rest/v3/locations/{locationGuid}" } [/block] [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "// Report Controller locations (GET https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06)\n\n$.ajax({\n url: \"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\",\n type: \"GET\",\n headers: {\n \"Authorization\": \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\",\n },\n})\n.done(function(data, textStatus, jqXHR) {\n console.log(\"HTTP Request Succeeded: \" + jqXHR.status);\n console.log(data);\n})\n.fail(function(jqXHR, textStatus, errorThrown) {\n console.log(\"HTTP Request Failed\");\n})\n.always(function() {\n /* ... */\n});\n", "language": "javascript" }, { "code": "import java.io.IOException;\nimport org.apache.http.client.fluent.*;\n\npublic class SendRequest\n{\n public static void main(String[] args) {\n sendRequest();\n }\n \n private static void sendRequest() {\n \n // Report Controller locations (GET )\n \n try {\n \n // Create request\n Content content = Request.Get(\"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\")\n \n // Add headers\n .addHeader(\"Authorization\", \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\")\n \n // Fetch request and return content\n .execute().returnContent();\n \n // Print content\n System.out.println(content);\n }\n catch (IOException e) { System.out.println(e); }\n }\n}", "language": "java" }, { "code": "// Report Controller locations (GET https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06)\n\nNSURL* URL = [NSURL URLWithString:@\"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\"];\nNSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:URL];\nrequest.HTTPMethod = @\"GET\";\n\n// Headers\n\n[request addValue:@\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\" forHTTPHeaderField:@\"Authorization\"];\n\n// Connection\n\nNSURLConnection* connection = [NSURLConnection connectionWithRequest:request delegate:nil];\n[connection start];\n\n", "language": "objectivec" }, { "code": "curl -X \"GET\" \"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\" \\\n\t-H \"Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\"\n", "language": "curl" }, { "code": "# Install the Python Requests library:\n# `pip install requests`\n\nimport requests\n\ndef send_request():\n # Report Controller locations (GET https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06)\n\n try:\n r = requests.get(\n url=\"https://connect.lrsus.com/rest/v3/locations/e35bdd62-c807-4e89-9cb1-3178075a3b06\",\n headers = {\n \"Authorization\":\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0MzU3NjkzNjQsInN1YiI6IjNJWFFIRVA0SDhWNUdJUjVMNDBLMVo5STkiLCJpc3MiOiJodHRwczovL2FwaS5zdG9ybXBhdGguY29tL3YxL2FwcGxpY2F0aW9ucy81c3VtdGdod3A2Vkw2cUdTbUN3VDJjIiwiaWF0IjoxNDM1NzY4MTY0fQ.xmtQRP19eiWhe4ci7QCQLwkCNwnMhnIoA73zTVvKwmA\",\n },\n )\n print('Response HTTP Status Code : {status_code}'.format(status_code=r.status_code))\n print('Response HTTP Response Body : {content}'.format(content=r.content))\n except requests.exceptions.RequestException as e:\n print('HTTP Request failed')\n", "language": "python" } ] } [/block] [block:api-header] { "type": "basic", "title": "Parameters" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Details", "0-0": "locationGuid", "0-1": "The unique identifier of the location to retrieve.", "0-2": "string, required" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Response 200 (application/json)" } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"location\" : {\n \"accountGuid\": \"777a5eb-59ea-4003-9c1c-77760879c88d\",\n \"locationGuid\": \"9e1da5eb-59ea-4003-9c1c-15160879c88d\",\n \"name\": \"Jason's Deli Frisco\",\n \"addressLine1\": \"5000 Frisco Rd.\",\n \"addressLine2\": \"5000 Frisco Rd.\",\n\t\t\t\t\t\t \"country\": \"United states\",\n\t \"countryCode\": \"US\",\n \"city\": \"Frisco\",\n \"province\": \"TX\",\n \"zipcode\": \"75254\",\n \"phoneNumber\" : \"888-999-9999\",\n \"cacheKey\": \"2630976542\",\n \t\"primaryWaitlist\": {\n \"isDeleted\": false,\n \"guid\": \"c2210066-20fb22-47b0-ab19-c4013008646e\",\n \"number\": 1,\n \"name\": \"Waiting\",\n \"cacheKey\": \"360702412273\",\n \"waitlistSetting\": {\n \"maxCapacity\": 10,\n \"minPartySize\": 1,\n \"isWaitlistOpen\": true\n }\n \t}\n }\n}", "language": "json" } ] } [/block]

Documentation

LRSC List