API

Methods

Objects

Validate Objects

EmailAddress An Email address for validation.
EmailList Container for Email addresses.
EmailRestRequest Request wrapper for email REST methods.
EmailRestResponse Response wrapper for email REST methods.
Phone A Phone number for validation.
PhoneList Container for Phone numbers.
PhoneRestRequest Request wrapper for phone REST methods.
PhoneRestResponse Response wrapper for phone REST methods.
ValidatedEmailAddress An Email address object containing the results of the validation.
ValidatedPhone A Phone number object containing the results of the validation.
PropertyTitleInfo A PropertyTitle info for validation.
PropertyTitleRestRequest Request wrapper for PropertyTitle info validation REST methods.
PropertyTitleRestResponse Response wrapper for PropertyTitle info REST methods.
ValidatedPropertyTitleInfo A object containing the results of the validation.

EmailAddress

The EmailAddress is used to supply email addresses for validation.

address

Type: String The email address (e.g. 'bob@example.org').

JSON Representation


    {
        "address": "bob@example.org"
    }

EmailList

An array or list of EmailAddress structures.

JSON Representation


    [ 
        { 
            address: "bob@example.org" 
        },
        {
            address: "sarah@example.org"
        },
        ... 
    ]

EmailRestRequest

An EmailRestRequest object is used when invoking the Harmony RightAddress email validation REST service methods.

payload

Type: EmailList The list of EmailAddress structures being passed to the REST service method.

JSON Representation


    {
        "payload": [ { "address": "bob@example.org" } ]
    }

EmailRestResponse

An EmailRestResponse object is returned from the Harmony RightAddress email validation REST service methods.

payload

Type: EmailList The list of EmailAddress structures being returned from the REST service method.

status

Type: String The status of the request (i.e. 'SUCCESS' or 'ERROR').

messages

Type: String[] Any error messages generated during the REST service method invocation (e.g. '[ "Access is denied" ]')

JSON Representation


    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [ 
            {
                "address": "bob@example.org"
            }
        ]
    }

Phone

The Phone structure is used to supply mobile phone numbers for validation.

fullPhone

Type: String The mobile phone number with optional country code (e.g. '+61412345678').

country

Type: String The two-character country code to be used for the validation (e.g. 'AU').

JSON Representation


    {
        "fullPhone": "+61412345678",
        "country": "AU"
    }

PhoneList

An array or list of Phone structures.

JSON Representation


    [ 
        { 
            "fullPhone": "+61412345678",
            "country": "AU"
        },
        {
            "fullPhone": "+61487654321",
            "country": "AU"
        },
        ... 
    ]

PhoneRestRequest

An PhoneRestRequest object is used when invoking the Harmony RightAddress phone validation REST service methods.

payload

Type: PhoneList The list of Phone structures being passed to the REST service method.

JSON Representation


    {
        "payload": 
            [
                { 
                    "fullPhone": "+61412345678",
   	                "country": "AU"
                },
                {
                    "fullPhone": "+61487654321",
                    "country": "AU"
                },
                ...
            ]
    }

PhoneRestResponse

An PhoneRestResponse object is returned from the Harmony RightAddress phone validation REST service methods.

payload

Type: PhoneList The list of Phone structures being returned from the REST service method.

status

Type: String The status of the request (i.e. 'SUCCESS' or 'ERROR').

messages

Type: String[] Any error messages generated during the REST service method invocation (e.g. '[ "Access is denied" ]')

JSON Representation


    {
        "status": "SUCCESS",
        "messages": [],
        "payload": [
            {
                "fullPhone": "+61412345678",
                "country": "AU"
            }
        ]
    }

ValidatedEmailAddress <<extends>> EmailAddress

A ValidatedEmailAddress object extends a standard EmailAddress object and is returned in the validate method response.

See EmailAddress for inherited attributes.

formatValidated

Type: Boolean email_valid: true if the email address syntax conforms to RFC 2822 standard, false otherwise.

blackListValidated

Type: Boolean True if the email address does not appear in the internal email black list, false otherwise.

domainValidated

Type: Boolean domain_exists: true if the domain of the email address exists and has proper Domain Name Server (DNS) records, false otherwise.

mailServerValidated

Type: Boolean mailserver_exists: True if there is a mail server for that domain, false otherwise.

mailboxValidated

Type: Boolean email_exists: true if the mailbox for the email address has been found to exist without sending an email, false otherwise.

JSON Representation


    {
        "address": "bob@example.org",
        "mailBoxValidated": false,
        "mailServerValidated": false,
        "domainValidated": false,
        "blackListValidated": true,
        "formatValidated": true
    }

ValidatedPhone <<extends>> Phone

A ValidatedPhone object extends a standard Phone object and is returned in the validate method response.

See Phone for inherited attributes.

countryCode

Type: String Any country code associated with the supplied phone number (e.g. '+61').

areaCode

Type: String Any area code associated with the supplied (non-mobile) phone number (e.g. '02').

localNumber

Type: String The local part of the supplied number (e.g. '12345678')

operatorName

Type: String The mobile operator associated with the supplied number (e.g. 'Telstra')

phoneStatus

Type: String The current status of the mobile phone with the supplied number (e.g. 'Active').

exception

Type: String A message outlining an errors that occurred during validation.

JSON Representation


    {
        "fullPhone": "+61412345678",
        "country": "AU",
        "areaCode": "",
        "localNumber": "0412345678",
        "operatorName": 'Telstra',
        "phoneStatus": 'Active',
        "exception": null
    }

PropertyTitleInfo

The PropertyTitleInfo structure is used to supply the information for validation.

firstName

Type: String The First name of the person (e.g. 'Smith').

lastName

Type: String The last name of the person (e.g. 'John').

latitude

Type: String The Latitude of the address (e.g. '-33.25933673').

longitude

Type: String The Longitude of the address (e.g. '151.54871059').

postcode

Type: String The Postcode component of the address (e.g. '2000').

townCity

Type: String The Town/City component of the address (e.g. 'WELLINGTON').

suburb

Type: String The Suburb component of the address (e.g. 'WELLINGTON CENTRAL').

street

Type: String The Street component of the address (e.g. 'GEORGE STREET').

streetNumber

Type: String The Street Number component of the address (e.g. '45A').

postal

Type: String The Postal address (e.g. 'PO BOX 123').

subdwelling

Type: String The Subdwelling component of the address (e.g. 'SE 202'). This includes subdwelling, floor, block and lot information.

JSON Representation


    {
        "firstName":"John", 
        "lastName":"Doe", 
        "streetNumber":"000", 
        "street":"xxxx st", 
        "suburb":"wellington central", 
        "townCity":"wellington"
    }

PropertyTitleRestRequest

An PropertyTitleRestRequest object is used when invoking the Harmony RightAddress nz property title ownership validation REST service methods.

payload

Type: PropertyTitleInfo The PropertyTitleInfo structure being passed to the REST service method.

showDetails

Type: Boolean Show details of the property title in the response or not (i.e. 'true' or 'false'). Default is false.

JSON Representation


    {
        "payload":{
        	"firstName":"John", 
        	"lastName":"Doe", 
        	"streetNumber":"000", 
        	"street":"xxxx st", 
        	"suburb":"wellington central", 
        	"townCity":"wellington"
        	},
        "showDetails":"true"}
    }

PropertyTitleRestResponse

An PropertyTitleRestResponse object is returned from the Harmony RightAddress nz property title ownership validation REST service methods.

payload

Type: ValidatedPropertyTitleInfo The ValidatedPropertyTitleInfo structure being returned from the REST service method.

status

Type: String The status of the request (i.e. 'SUCCESS' or 'ERROR').

messages

Type: String[] Any error messages generated during the REST service method invocation (e.g. '[ "Access is denied" ]')

JSON Representation


    {
        {
        	"status":"SUCCESS",
        	"messages":[],
       		 "payload":{
       		 	"response":"fail",
       		 	"attributes":[
       		 		{"type":"NZ_PROPERTY_TITLE",
       		 			"attributes":{
       		 			"guaranteeStatus":"Guarantee",
       		 			"status":"LIVE",
       		 			"descrption":"Fee Simple, 1/1, Lot x Deposited Plan xxx, 401 m2",
       		 			"spatialExtensShared":"T",
       		 			"ownsNumber":"1",
       		 			"issueDate":"1986/09/10 00:00:00",
       		 			"titleNo":"xxxx",
       		 			"type":"Freehold",
       		 			"owners":"xxxx",
       		 			"titleId":"xxxx",
       		 			"landDistrict":"Wellington"
   		 			}
 				}
 				]
			}
		}
    }

ValidatedPropertyTitleInfo

A ValidatedPropertyTitleInfo object with validation response and list of attributes if showDetails set as true in the request.

response

Type: String The response of the validation (i.e. 'pass' or 'fail').

attributes

A list of attributes for the property title

JSON Representation


    {
       "response":"fail",
       	"attributes":[
       		{"type":"NZ_PROPERTY_TITLE",
       		 "attributes":{
       		 		"guaranteeStatus":"Guarantee",
       		 		"status":"LIVE",
       		 		"descrption":"Fee Simple, 1/1, Lot x Deposited Plan xxx, 401 m2",
       		 		"spatialExtensShared":"T",
       		 		"ownsNumber":"1",
       		 		"issueDate":"1986/09/10 00:00:00",
       		 		"titleNo":"xxxx",
       		 		"type":"Freehold",
       		 		"owners":"xxxx",
       		 		"titleId":"xxxx",
       		 		"landDistrict":"Wellington"
   		 		}
	 		}
 		]
    }