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 |
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
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"addresses": [
{
"postal_code": "",
"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",
"street_name": "Odos Ilia Papakyriakou",
"city": "Paralimni",
"po_box": "",
"municipality": "Ammochostos",
"area": "",
"district": ""
},
{
"postal_code": "",
"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": "",
"municipality": "Ammochostos",
"area": "",
"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": ""
},
{
"postal_code": "",
"address": "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"
}
}