Property V4:LookupProperty

From Melissa Data Wiki
Revision as of 01:18, 30 November 2017 by Admin (talk | contribs) (Created page with "{{PropertyV4Nav |InputOutputCollapse= }} {{CustomTOC}} The LookupProperty endpoint returns general information regarding a property. =Request= A request consists of a prot...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

← Property V4

Property V4 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 V4 Result Codes
Sample Code



The LookupProperty endpoint returns general information regarding a property.

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.


Field Names

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

Field Name Level REST POST
Transmission Reference Request t TransmissionReference
License Key id CustomerId
Columns cols Columns
Total Records TotalRecords
Format format Format
Record ID Record RecordID
Address Key addresskey AddressKey
FIPS fips FIPS
APN apn APN
MAK mak MAK
FreeForm ff FreeForm


Minimum Inputs

The following are the possible minimum input requirements.

  1. Address Key
  2. FIPS & APN
  3. FIPS & Account Number
  4. MAK
  5. FreeForm


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
POST "TransmissionReference": "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
POST "CustomerId": "string"


Columns

Optional.
This string value specifies which column(s) to be output as a comma delimited string.
Protocol Syntax
REST &cols = string
POST "Columns": "string"


Entering the column name will return the column. Specifying a group name will return all columns in the group.
List multiple columns in the following format, with multiple options delimited with a ",".
Syntax
ColumnName,ColumnName,ColumnName


TotalRecords

Required.
Used with POST. The number of records in the request.
Protocol Syntax
POST "TotalRecords": "string"


Format

Optional.
The desired format of the response. Possible values are json or xml.
Protocol Syntax
REST &format = string
POST "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.
POST The POST interface allows up to 100 input records per request.


Record ID

Optional.
Used in POST.
Protocol Syntax
POST "RecordID": "string"


Address Key

Optional.
Protocol Syntax
REST &addresskey = string
POST "AddressKey": "string"


FIPS

Optional.
Federal Information Processing Standard (FIPS) code for the property.
Protocol Syntax
REST &fips = string
POST "FIPS": "string"


APN

Optional.
Assessor's Parcel Number for the property.
Protocol Syntax
REST &apn = string
POST "APN": "string"


MAK

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


Free-Form

Optional.
The free-form address.
Protocol Syntax
REST &ff = string
POST "FreeForm": "string"


Response

A response is the result of a request. This consists of returned results codes, deed, and transaction information.

Field Names

This is a list of the response field names and their grouping. To return all available fields, use GrpAll.

Field Name Group
Version [DEFAULT]

Always return in the output structure.

TransmissionReference
TransmissionResults
TotalRecords
Records
RecordID
Results
FIPSCode GrpParcel


[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"


TransmissionResults

Returns the result/error codes. For more information, see Property V4 Result Codes.
Protocol Syntax
JSON "TransmissionResults":"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"


[DEFAULT]

Record ID

Protocol Syntax
JSON "RecordID":"string"


Results

Protocol Syntax
JSON "Results":"string"


GrpParcel

FIPS Code

Protocol Syntax
JSON "FIPSCode":"string"


Protocol Syntax
JSON "":"string"