Property V4:LookupHomesByOwner

From Melissa Data Wiki
Jump to navigation Jump to search

← Property

Property Navigation
Introduction
Licensing
Input/Output
LookupDeeds
  ↳  Request
  ↳  Response
  ↳  Service Codes
LookupHomesByOwner
  ↳  Request
  ↳  Response
LookupProperty
  ↳  Request
  ↳  Response
  ↳  Service Codes
  ↳  Frequencies
Examples
REST JSON
POST JSON
POST XML
Result Codes
Result Code Use
Property Result Codes
Sample Code



The LookupHomesByOwner endpoint returns an array of homes owned by a homeowner based on their address (MAK).

Request

A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is required.

Property V4 supports the REST protocol to access the service.


URL

LookupHomesByOwner

Use URL
Secure https://property.melissadata.net/v4/WEB/LookupHomesByOwner


Field Names

This is a list of the request field names and their protocol naming conventions.

Field Name Level REST
Transmission Reference Request t
License Key id
Format format
Owner MAK Record mak
Free Form ff


Minimum Inputs

The following are the possible minimum input requirements.

  1. Owner MAK
  2. Free Form


Request Elements

The following elements set the basic options for each request. These apply to the entire request, not the individual records.

Transmission Reference

Optional.
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax
REST ?t = string


License Key

Required.
This is a string value containing the License Key issued to the customer by Melissa for Property V4.
If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa sales representative at 1-800-MELISSA.
Protocol Syntax
REST &id = string


Format

Optional.
The desired format of the response. Possible values are json or xml.
Protocol Syntax
REST &format = string


Request Record Elements

REST will only contain the Records element.

Protocol Definition
REST The REST interface only allows a single record per request.


Owner MAK

Optional.
A propietary unique key identifier for an address. This is derived from Address Checking.
Protocol Syntax
REST &mak = string


Free Form

Optional.
The free form address.
Protocol Syntax
REST &ff = string


Response

A response is the result of a request. This consists of returned results codes, property addresses, MAKs, FIPs and APNs.

Field Names

This is a list of the response field names and their grouping.

Field Name Group
Version [DEFAULT]

Always return in the output structure.

TransmissionReference
Results
TotalRecords
Records
MAK
BaseMAK
FIPS
APN
PropertyAddress
PropertyCity
PropertyState
PropertyZip
PropertyPlus4


[DEFAULT]

Version

The current web service version.
Protocol Syntax
JSON "Version":"string"


TransmissionReference

A pass-through of the input Transmission Reference.
Protocol Syntax
JSON "TransmissionReference":"string"


Results

Returns the result/error codes. For more information, see Property V4 Result Codes.
Protocol Syntax
JSON "Results":"string"


TotalRecords

The total number of records returned in the records array.
Protocol Syntax
JSON "TotalRecords":"string"


Records

This is the returned array of records.
Protocol Syntax
JSON "Records":"string"


MAK

(Melissa Address Key) A unique key assigned to the address record.
Protocol Syntax
JSON "MAK":"string"


BaseMAK

A unique key assigned to the base address of a complex with apartments or suites.
Protocol Syntax
JSON "BaseMAK":"string"


FIPS

The six-digit Federal Information Processing Standard (FIPS) code for the county containing the property.
Protocol Syntax
JSON "FIPS":"string"


APN

The Assessor's Parcel Number (APN).
Protocol Syntax
JSON "APN":"string"


PropertyAddress

The address of the property.
Protocol Syntax
JSON "PropertyAddress":"string"


PropertyCity

The city containing the property.
Protocol Syntax
JSON "PropertyCity":"string"


PropertyState

The state containing the property.
Protocol Syntax
JSON "PropertyState":"string"


PropertyZip

The Zip code containing the property.
Protocol Syntax
JSON "PropertyZip":"string"


PropertyPlus4

The plus 4 of the zip code containing the property.
Protocol Syntax
JSON "PropertyPlus4":"string"