Available from CRM.COM R9.0.0
GET melissa_data/advance_lookup
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
http://host_name/crmapi/rest/$version/melissa_data/advance_lookup
Parameters
Name | Type | Description |
account_id (mandatory) | String | The Melissa Data Account ID as specified in the Address Registry Settings |
| address1 (mandatory) | String | Information about the address whose details will be retrieved in free text
|
address2 (optional) | String | Additional information about the address whose details will be retrieved in free text |
address3 (optional) | String | Additional information about the address whose details will be retrieved in free text |
municipality (optional) | String | Restricts the retrieved addresses to the addresses of the specified Municipality. |
district (optional) | String | Restricts the retrieved addresses to the addresses of the specified District. |
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. |
post_code (optional) | String | Restricts the retrieved addresses to the addresses of the specified Postal Code. |
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 codes must be defined |
max_records (optional) | Integer | Defines the maximum number of addresses to be returned. Always defaults to 10. |
format (optional) | String | Defines the format of the response. Available values are JSON and XML. Always defaults to JSON. |
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 |
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
Examples
HTTP Method: GET
Request:
Response:
GET melissa_data/quick_lookup
This method returns address 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 |
account_id (mandatory) | String | The Melissa Data Account ID as specified in the Address Registry Settings |
address (mandatory) | String | Detailed information about the address that will be retrieved through the Address Registry System in free text. |
country (optional) | String | Restricts the retrieved addresses to the addresses of the specified Country. Always defaults to the Country specified in Admin Settings |
max_records (optional) | Integer | Defines the maximum number of addresses to be returned. Always defaults to 10. |
format (optional) | String | Defines the format of the response. Available values are JSON and XML. Always defaults to JSON. |
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 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 |
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
Examples
HTTP Method: GET
Request:
Response:
POST melissa_data/verify
This method verifies an address registered in CRM.COM against the information of Melissa Data System. Only one address can be verified in each call.
Resource URL
Parameters
Name | Type | Description |
account_id (mandatory) | String | The Melissa Data Account ID as specified in the Address Registry Settings |
| address1 (optional) | String | Input address line 1
|
address2 (optional) | String | Input address line 2 |
address3 (optional) | String | Input address line 3 |
address4 (optional) | String | Input address line 4 |
address5 (optional) | String | Input address line 5 |
address6 (optional) | String | Input address line 6 |
address7 (optional) | String | Input address line 7 |
address8 (optional) | String | Input address line 8 |
municipality (optional) | String | Input municipality information to be verified |
city (optional) | String | Input city information to be verified |
country (optional) | String | Restricts the retrieved addresses to the addresses of the specified Country. Always defaults to the Country specified in Admin Settings |
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 | String | Defines the address verification result. In case of failed verification, the description of all of the invalid address information will be included in the results |
| formatted_address | String | The Full address |
| city | String | Address city |
| municipality | String | Address municipality |
| postal_code | String | Address post code |
| country | String | Address Country |
| street_name | String | Address street name |
| street_number | String | Address street number |
| apartment | String | Address apartment number |
| po_pox_postal_code | String | Address PO Box post code |
Examples
HTTP Method: GET
Request:
Response: