POST Create Lookup Zones with Custom Data

The Zones endpoint within lookup allows you to create Zones from the lookup results. The Zones created will have a circular or rectangular Geofence and a Custom Action created by default. This example demonstrates adding of custom data fields while creating a Zones from the Places lookup results.

URL to call

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

Content Type

The content type should be specified in the Content-Type HTTP header as “application/json”.

image

Content-Type: application/json

Parameters

No URL Parameters required. See example JSON below.

Key JSON fields

Information on the primary fields can be found here.

Custom Fields array JSON fields

Name Required Data Type Description Format
key String The name of the metadata field to be returned as part of the custom action callback on the device.
value String The value of the metadata field to be returned as part of the custom action callback on the device.

Parameters to be used in the custom data fields

Parameter Description
geometry It contains geometry information about the result, generally including the location of the place and the viewport identifying its general area of coverage.
icon It contains the URL of a recommended icon which may be displayed to the user when indicating this result.
name It contains the human-readable name for the returned result.
photos It contains an array of photo objects, each containing a reference to an image.
place_id It a textual identifier that uniquely identifies a place.
rating It contains the place’s rating, from 1.0 to 5.0, based on aggregated user reviews.
search_keyword The search keyword provided in the Create Lookup request.
search_type The search type provided in the Create Lookup request.
types It contains an array of feature types describing the given result.
vicinity It contains a feature name of a nearby location. Often this feature refers to a street or neighborhood within the given results.

Example: JSON request to create Zones from the lookup results

URL to call

https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0/zones

“Zone” request with Custom Data

{
    "security": {
        "customerApiKey": "d851c260-9a31-11e5-b7e5-b8ca3a6b879d",
        "apiKey": "7e9a7d30-1f09-11e7-ad24-06a56cd124c5"
    },
    "content": {
        "place_ids": ["ChIJj0s0A81_j4ARbMK9LbiEB9M", "ChIJ7zxvyAR-j4AR_ueCaXrCefk", "ChIJ10DmyyR-j4ARBZDBrVVevpo"],
        "zoneName": "{name} ({search_type} - {search_keyword})",
        "checkout": true,
        "minimumRetriggerTime": "20:00",
        "fence": {
            "type": "circle",
            "name": "20m Circle around {vicinity}",
            "radius": 20
        },
        "customFields": [{
            "key": "place_id",
            "value": "{place_id}"
        }, {
            "key": "vicinity",
            "value": "{vicinity}"
        }, {
            "key": "types",
            "value": "{types}"
        }, {
            "key": "rating",
            "value": "{rating}"
        }]
    }
}

Example: JSON response to request

{
    "zonesCreated": [
        "16d8ac8d-93be-4c79-b7c9-2fc1e1e87931",
        "04c98fe8-4b2f-4cb1-a535-d01da52b0be1",
        "ad6f3d7e-61ff-4850-8825-b6be3c4d5132"
    ],
    "message": "Your request has been successfully processed.",
    "messageCode": 200
}
Created by Bluedot DevOps on January 31, 2018

Start the discussion