Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R14.2.0

Excerpt

This method returns city-state combinations from the Melissa Data Address Registry System based on the Postal Code provided. Multiple sets might be returned by each call and this is applicable only for U.S. Postal Codes.

...

Name

Type

Description

token

String

The token retrieved from the login method

postal_code

(mandatory)

String

Restricts the retrieved city-states sets to the ones of the specified Postal Code.

max_records

(optional)

IntegerDefines the maximum number of city-states sets to be returned. Always defaults to 10.

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejs
linenumberstrue
 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "addresses": [
      {         "postal_code"result_description": "",
        "address": "1 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "1",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "2 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "2",
        "apartment_number": null,
        "country": "Cyprus",
result_code": "XS01",
       "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",_state_set": [
        "address": "3 Odos Ilia Papakyriakou, Paralimni",         "street_number": "3",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "4 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "4",
        "apartment_number": null,
     
  "country": "Cyprus",         "street_name": "Odos Ilia Papakyriakou",         "city": "Paralimni",
        "po_box": ""San Bruno",
        "municipality": "Ammochostos",
        "areastate": "CA",
        "district": ""       },
      {
        "postal_code": "",
        "address": "5 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "5",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
        ]
    },
      {
        "postal_code": "",
        "address": "6 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "6",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      "status": {
        "postal_code": "OK",
        "addressdescription": "7 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "7",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "8 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "8",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "9 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "9",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "10 Odos Ilia Papakyriakou, Paralimni",
        "street_number": "10",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Ilia Papakyriakou",
        "city": "Paralimni",
        "po_box": "",
        "municipality": "Ammochostos",
        "area": "",
        "district": ""
      }
    ],
    "result_description": "null",
    "result_code": "ALL"message": ""
    }
}