Skip to content

Lookup

Detail

This feature retrieves detailed information about an entity. The id is usually retrieved from a previous entity search results list. The entity details will be dependent on the entity type which are an address or a POI. Generally, the entity details will be evaluated to determine entity detail results type. The developer will build logic based on the entity detail results type.

Request URI

Request URI Supported Methods
/v5/detail/json GET, POST

GET

Request Parameters

Name Description Required
entity_ids This API support look-up for single entity or batch look-up for multiple entities. Accepts list of entity IDs separated by ",". Yes
detail_level Indicates how much data about entity to return. BASIC: returns just basic information. FULL: returns all available information. No
locale The preferred language for the response content. No
show_address_lines An optional parameter to return formatted address in one or multiple lines. If this parameter is set, "address_lines" will be returned in response. No
user_id The id associated with the user who is sending the request. No 
1
{host}/entity/v5/detail/json?locale=en-US&entity_ids=P-1449852911

POST

Request Body

Name Data Type Required/Optional Description
requestParam EntityGetDetailRequest required Request object to customize the request. 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "entity_ids": [
    "P-1012321",
    "P-1012322"
  ],
  "detail_options": {
    "detail_level": "FULL",
    "show_address_lines": true
  },
  "locale": "en-US"
}

Response Body

Top-level JSON object:

Name Data Type Required/Optional Description
status Status required Status
response_time Number required Response time in milliseconds.
reference_id String required Reference id associated with response.
results [ Entity ] required List of results that match search criteria. 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
  "status":{
    "status":12200,
    "message":"SUCCESS"
  },
  "results":[
    {
      "id":"P-1449852911",
      "type":"PLACE",
      "place":{
        "name":"Niall Kennedys Weblog",
        "phone_numbers":[
          "4154252417"
        ],
        "address":{
          "formatted_address":"747 Natoma St, San Francisco CA 94103, USA",
          "house_number":"747",
          "street":{
            "body":"Natoma St",
            "formatted_name":"Natoma St"
          },
          "city":"San Francisco",
          "state":"CA",
          "country":"USA",
          "postal_code":"94103",
          "geo_coordinates":{
            "latitude":37.77594,
            "longitude":-122.41281
          },
          "nav_coordinates":{
            "latitude":37.77594,
            "longitude":-122.41281
          },
          "address_lines":[
            "747 Natoma St",
            "San Francisco CA 94103, USA"
          ]
        }
      },
      "facets":{
        "nearby":{
          "nearby_categories":[
            {
              "category":{
                "id":"771",
                "name":"Electric Charge"
              },
              "count":3
            }
          ]
        }
      }
    }
  ],
  "response_time":0
}

Status Code

Code Message Description
12200 SUCCESS Indicates that no errors occurred.
12200 PARTIAL_SUCCESS Only applicable for "batch" look-up. Indicates that look-up operation for some of IDs was not successful.
12301 ENTITY_MOVED Indicates an entity id change in detail response.
12400 INVALID_REQUEST Indicates either that a required parameter is missing or value of a parameter cannot be parsed.
12404 ENTITY_NOT_FOUND Applicable only for "single" look-up. Indicates that service was not able to find data for the requested ID.
12500 INTERNAL_SERVER_ERROR Indicates technical difficulties on API.