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 |
token | String | The token retrieved from the login method |
account_id (mandatory) | String | The Melissa Data Account ID as specified in the Address Registry Settings |
| 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 |
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:
{
"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"
}
}
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 |
token | String | The token retrieved from the login method |
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. 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 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:
{
"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"
}
}
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 |
token | String | The token retrieved from the login method |
account_id (mandatory) | String | The Melissa Data Account ID as specified in the Address Registry Settings |
| street_number (optional) | String | Input street number information to be verified
|
| street_name (optional) | String | Input street name information to be verified |
municipality (optional) | String | Input municipality information to be verified |
city (optional) | String | Input city information to be verified |
postal_code (optional) | String | Input postal code 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. If specified, then the Country's 2-characters code must be defined |
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:
Body:
{
"token":"{{token}}",
"account_id":"114452481",
"street_name":"Odos Pindarou",
"street_number":"10",
"municipality":"Lefkosia",
"city":"Latsia",
"postal_code":"2020",
"country":"CY"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"formatted_address": "10 Odos Pindarou;Agios Georgios;2020 Latsia",
"postal_code": "2020",
"apartment": null,
"street_number": null,
"country": "Cyprus",
"street_name": "Odos Pindarou",
"city": "Latsia",
"po_pox_postal_code": "",
"municipality": "Lefkosia",
"result": "AC09,AV24"
}
}