POST organisation/regional_settings/verify_address_coverage

Available from CRM.COM R12.3.0

This method is used to verify if a specific address is covered and can be used in order to deliver services or physical goods. Only one address can be verified through each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

area

(semi-optional)

String

The area of the address

district

(semi-optional)

String

The district of the address

town_city

(semi-optional)

String

The town / city of the address

postal_code

(semi-optional)

String

The postal code of the address

job_type_identifier

(mandatory)

Job Type Identifier

The identifier of the job type that will be used to deliver the services or physical goods on the specified address. The allowed job type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job type

name

(semi-optional)

String

The name of the job type

alternative_code

(semi-optional)

String

The alternative code of the job type

fields_set
(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

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

Response Data

Name	Type	Description
verified	Boolean	If true then the specified address is covered otherwise it is not covered

Examples

Example 1

HTTP Method: POST

Request:

Body:

 {
  "token":"{{token}}",
  "area":"Strovolos",
  "town_city":"Nicosia",
  "postal_code":"2035",
  "job_type_identifier":{"name":"Bill based on delivered items"}
}

Response:

 {
    "data": {
        "verified": "true"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Example 2

HTTP Method: POST

Request:

Body:

{
  "token":"{{token}}",
  "town_city":"Nicosia",
  "postal_code":"4035",
  "job_type_identifier":{"name":"Bill based on delivered items"}
}

Response:

 {
    "data": {
        "verified": "false"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}