GET melissa_data/advance_lookup

Available from CRM.COM R10.0.0

This method returns Addresses information from the Melissa Data Address Registry System with which CRM.COM integrates with. Multiple addresses might be returned by each call

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
street_name (optional)	String	Restricts the retrieved addresses to the addresses of the specified Street Name.
street_number (optional)	String	Restricts the retrieved addresses to the addresses of the specified Street Number.
municipality (optional)	String	Restricts the retrieved addresses to the addresses of the specified Municipality.
city (optional)	String	Restricts the retrieved addresses to the addresses of the specified Town/City.
area (optional)	String	Restricts the retrieved addresses to the addresses of the specified Area.
apartment_number (optional)	String	Restricts the retrieved addressed to the addresses of the specified Apartment Number.
postal_code (optional)	String	Restricts the retrieved addresses to the addresses of the specified Postal Code.
po_box (optional)	String	Restricts the retrieved addresses to the addresses of the specified PO Box.
country (optional)	String	Restricts the retrieved addresses to the addresses of the specified Country. Always defaults to the Country specified in Admin Settings if not specified. If specified, then the Country's 2-characters code must be defined
max_records (optional)	Integer	Defines the maximum number of addresses to be returned. Always defaults to 10.

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is 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 addresses 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 Global Express Entry. Available only when the request was not successfully sent
addresses	List of Melissa Data Address Objects	A list of addresses returned by the address search in Melissa Data Express Entry/Melissa Data Express Entry Form

Referred Objects Response Data

melissa_data object response data

Name	Type	Description
address	String	Full formatted address
street_name	String	Address Street Name
street_number	String	Address Street Number
postal_code	String	Address Postal Code
apartment_number	String	Address Apartment Number
area	String	Address Area
city	String	Address City/Town
district	String	Address District
municipality	String	Address Municipality
po_box	String	Address PO Box
country	String	Address Country

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "addresses": [
      {
        "postal_code": "",
        "address": "10 Leoforos Archiepiskopou Makariou G, Kaimakli, Nicosia",
        "street_number": "10",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Leoforos Archiepiskopou Makariou G",
        "city": "Nicosia",
        "po_box": "",
        "municipality": "Lefkosia",
        "area": "Kaimakli",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "10 Leoforos Archiepiskopou Makariou Iii, Nicosia",
        "street_number": "10",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Leoforos Archiepiskopou Makariou Iii",
        "city": "Nicosia",
        "po_box": "",
        "municipality": "Lefkosia",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "10 Odos Archiepiskopou Makariou Ii, Nicosia",
        "street_number": "10",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Archiepiskopou Makariou Ii",
        "city": "Nicosia",
        "po_box": "",
        "municipality": "Lefkosia",
        "area": "",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "10 Odos Archiepiskopou Makariou Ii, Kaimakli, Nicosia",
        "street_number": "10",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Archiepiskopou Makariou Ii",
        "city": "Nicosia",
        "po_box": "",
        "municipality": "Lefkosia",
        "area": "Kaimakli",
        "district": ""
      },
      {
        "postal_code": "",
        "address": "10 Odos Leontiou Machaira, Nicosia",
        "street_number": "10",
        "apartment_number": null,
        "country": "Cyprus",
        "street_name": "Odos Leontiou Machaira",
        "city": "Nicosia",
        "po_box": "",
        "municipality": "Lefkosia",
        "area": "",
        "district": ""
      }
    ],
    "result_description": "null",
    "result_code": "SOME"
  }
}