API Restful - Description - Address - funneladdress - Response

Support DQE
Support DQE
  • Updated

This page describes the JSON response returned by the /funneladdress/ endpoint used in Restful Funnel mode.

Related Address documentation:

Restful funneladdress success response

The JSON response is a dictionary containing two main keys:

  • Found: integer indicating the number of addresses found.
  • Addresses: list containing one or more address objects.

Each address object contains the following fields:

Field Meaning Always in JSON? Type / Format
PostalCode Postal / ZIP code. Yes STRING(10-20)
City City / ward name. Yes STRING(50)
Hamlet Hamlet or dependent locality. Yes STRING(50), may be empty
SpecialDistribution Special distribution flag. Yes STRING(1), may be empty
Country ISO country code. Yes STRING(3)
StateCode State or prefecture code. Yes STRING(10)
StateLabel State or prefecture label. Yes STRING(50)
AdministrativeArea Administrative area. Yes STRING(50)
SubLocality Sub-locality information. Yes STRING(50), may be empty
Suburb Suburb or district. Yes STRING(255), may be empty
CityId Unique city identifier. Yes STRING(20)
Input User input value. Yes STRING(50)
Label Formatted display label. Yes STRING(255)
Street Street name. Yes STRING(255), may be empty
StreetId Street identifier. Yes STRING(20), may be empty
StreetType Street type. Yes STRING(50), may be empty
StreetNumber Street or house number. Yes STRING(20), may be empty
StreetNumberOnly Numeric part of the street number. Yes STRING(20), may be empty
StreetNumberList List of valid street numbers. Yes STRING(1024), may be empty
StreetNumberListCount Number of items in StreetNumberList. Yes INTEGER
IsValidStreetNumber Indicates whether the street number is valid. Yes INTEGER
AdditionalAddress Additional address line. Yes STRING(255), may be empty
Company Company name. Yes STRING(255), may be empty
Latitude Latitude coordinate. Yes DECIMAL(18), empty string possible
Longitude Longitude coordinate. Yes DECIMAL(18), empty string possible

Example:

{
  "Found": 1,
  "Addresses": [
    {
      "PostalCode": "108-6390",
      "City": "ﾐﾅﾄｸ",
      "Hamlet": "",
      "SpecialDistribution": "",
      "Country": "JPN",
      "StateCode": "13",
      "SubLocality": "",
      "CityId": "402574",
      "Input": "108-6390",
      "Label": "〒108-6390 ﾄｳｷｮｳﾄﾐﾅﾄｸﾐﾀ",
      "AdditionalAddress": "",
      "StreetNumber": "",
      "StreetType": "",
      "Street": "ﾐﾀ",
      "StreetId": "558204",
      "IsValidStreetNumber": 1,
      "StreetNumberListCount": 0,
      "StreetNumberList": "",
      "StreetNumberOnly": "",
      "StateLabel": "ﾄｳｷｮｳﾄ",
      "AdministrativeArea": "ﾐﾅﾄｸ",
      "Suburb": "",
      "Company": "",
      "Latitude": "",
      "Longitude": ""
    }
  ]
}

Restful funneladdress response error

Error type Response type
Missing mandatory parameter { "status": 400, "message": "Missing parameters", "details": "PostalCode", "error": "bad request" }
Country value is not ISO3 { "status": 400, "message": "Country doesn't exist", "details": "JPNde", "error": "bad request" }
Wrong licence value { "status": 401, "message": "Your licence is not allowed to cover this functionality", "details": "WRONG LICENSE", "error": "unauthorized_client" }

Related to

Was this article helpful?

0 out of 0 found this helpful