Property Title Objects
A PropertyTitle info for validation.
Request wrapper for PropertyTitle info validation REST methods.
Response wrapper for PropertyTitle info REST methods.
A object containing the results of the validation.
PropertyTitleInfo
The PropertyTitleInfo structure is used to supply the information for validation.
firstName
Type: StringThe First name of the person (e.g. 'Smith').
lastName
Type: StringThe last name of the person (e.g. 'John').
latitude
Type: StringThe Latitude of the address (e.g. '-33.25933673').
longitude
Type: StringThe Longitude of the address (e.g. '151.54871059').
postcode
Type: StringThe Postcode component of the address (e.g. '2000').
townCity
Type: StringThe Town/City component of the address (e.g. 'WELLINGTON').
suburb
Type: StringThe Suburb component of the address (e.g. 'WELLINGTON CENTRAL').
street
Type: StringThe Street component of the address (e.g. 'GEORGE STREET').
streetNumber
Type: StringThe Street Number component of the address (e.g. '45A').
postal
Type: StringThe Postal address (e.g. 'PO BOX 123').
subdwelling
Type: StringThe 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: BooleanShow 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: StringThe 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: StringThe 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"
}
}
]
}
Last updated