GET melissa_data/postal_code_based_lookup

Available from CRM.COM R14.2.0

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.

Resource URL

Parameters

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)	Integer	Defines the maximum number of city-states sets to be returned. Always defaults to 10.

Restrictions

It is mandatory to specify at least one of the semi-optional parameters. Multiple of those parameters are allowed to be specified.

Response Data

Name	Type	Description
result_code	String	Code indicating whether a successful request was sent or not. For successful requests, the code denote the number of city-state sets included in the response and the available values are ALL, NONE and SOME. For un-successfull requests the results_description provides information of the erroneous request.
result_description	String	Description of the error returned by Melissa Data Express Postal Code Entry. Available only when the request was not successfully sent
city_state_set	List of Melissa City State Set Objects	A list of city and states set, returned by the address search in Melissa Express Postal Code Entry

Referred Objects Response Data

melissa_city_state_set object response data

Name	Type	Description
city	String	Address City/Town
state	String	Address State

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
    "data": {
        "result_description": "",
        "result_code": "XS01",
        "city_state_set": [
            {
                "city": "San Bruno",
                "state": "CA"
            }
        ]
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}