GET Lookup

image

The GET lookup results will take between 1 – 10 mins depending on the area requested and search criteria. Once the results are ready the “ready” field in the response will be sent as “true”.

URL to call

https://api.bluedotinnovation.com/1/poi/lookup/{lookupId}

Parameters

Name Required Data Type Description Format
lookupId String The lookupId returned when the lookup request was made
customerApiKey String API key for the customer found in the Account Management tab of Point Access UI.
apiKey String API Key of the relevant app found in the Manage Apps section of the App and Beacon Management tab of Point Access UI.

GET lookup results

 

https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0?customerApiKey=d851c260-9a31-11e5-b7e5-b8ca3a6b879d&apiKey=7e9a7d30-1f09-11e7-ad24-06a56cd124c5

Example: JSON response for a completed GET lookup results

{
    "url": "https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0",
    "location": "San Francisco, California, United States",
    "status": "processing",
    "searchesUsed": 0,
    "searchesRemaining": 100000,
    "ready": false,
    "keyword": "mexican",
    "type": "restaurant",
    "resultUrl": "https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0?customerApiKey=d851c260-9a31-11e5-b7e5-b8ca3a6b879d&apiKey=7e9a7d30-1f09-11e7-ad24-06a56cd124c5",
    "message": "Your request has been successfully processed.",
    "messageCode": 200
}

Example: JSON response for a completed GET lookup results

{
    "url": "https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0",
    "location": "San Francisco, California, United States",
    "status": "complete",
    "searchesUsed": 286,
    "searchesRemaining": 99714,
    "ready": true,
    "keyword": "mexican",
    "type": "restaurant",
    "resultsUrl": "https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0/results/1?customerApiKey=d851c260-9a31-11e5-b7e5-b8ca3a6b879d&apiKey=7e9a7d30-1f09-11e7-ad24-06a56cd124c5",
    "zoneUrl": "https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0/zones",
    "message": "Your request has been successfully processed.",
    "messageCode": 200
}

Next Step

Created by Bluedot DevOps on January 31, 2018

Start the discussion