API Restful - Description - Address - funnelpostcode - Response

Support DQE
Support DQE
  • Updated

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

Related Address documentation:

Restful funnelpostcode success response

The JSON response is a dictionary containing two main keys:

  • Found: integer indicating the number of postal codes found.
  • PostalCodes: list containing one or more postal code objects.

Each PostalCodes object contains the following fields:

Field Meaning Always in JSON? Type / Format
PostalCode Postal or ZIP code. Yes STRING(10-20)
City City name. Yes STRING(50)
Hamlet Hamlet or dependent locality. Yes STRING(50), may be empty
SpecialDistribution Special distribution flag. Yes STRING(1)
Country ISO country code. Yes STRING(3)
AdministrativeArea Administrative area. Yes STRING(50)
StateLabel State or prefecture label. Yes STRING(50)
StateCode State or prefecture code. Yes STRING(10)
SubLocality Sub-locality information. Yes STRING(50), may be empty
CityId Unique identifier for the city and postal code. Yes STRING(50)
Latitude Latitude coordinate. Yes DECIMAL(18), empty string possible
Longitude Longitude coordinate. Yes DECIMAL(18), empty string possible
Informations Nested address details. Yes OBJECT

Informations object:

Field Meaning Always in JSON? Type / Format
AdditionalAddress Additional address line. Yes STRING(255), may be empty
AdditionalAddress_2 Additional address line 2. Yes STRING(255), may be empty
StreetNumberList List of street numbers. Yes STRING(1024), may be empty
StreetType Street type. Yes STRING(50), may be empty
Street Street name. Yes STRING(255), may be empty
Suburb Suburb or district. Yes STRING(255), may be empty
StreetId Street identifier. Yes STRING(20), may be empty
Company Company name. Yes STRING(255), may be empty

Example:

{
  "Found": 1,
  "PostalCodes": [
    {
      "PostalCode": "108-6390",
      "City": "港区",
      "Hamlet": "",
      "SpecialDistribution": "0",
      "Country": "JPN",
      "AdministrativeArea": "港区",
      "StateLabel": "東京都",
      "StateCode": "13",
      "SubLocality": "",
      "CityId": "402573_1086390",
      "Latitude": "",
      "Longitude": "",
      "Informations": {
        "AdditionalAddress": "",
        "AdditionalAddress_2": "",
        "StreetNumberList": "",
        "StreetType": "",
        "Street": "",
        "Suburb": "",
        "StreetId": "",
        "Company": ""
      }
    }
  ]
}

Restful funnelpostcode 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