Property V4:LookupDeeds: Difference between revisions
Jump to navigation
Jump to search
Created page with "{{PropertyV4Nav |InputOutputCollapse= }} {{CustomTOC}} The LookupDeeds endpoint returns an array of deeds and/or transactions from the recorder table when given either a de..." |
No edit summary |
||
| Line 197: | Line 197: | ||
|TransmissionReference | |TransmissionReference | ||
|- | |- | ||
| | |Results | ||
|- | |- | ||
|TotalRecords | |TotalRecords | ||
| Line 510: | Line 510: | ||
<h3 style="background-color:rgb(240,240,240);"> | <h3 style="background-color:rgb(240,240,240);">Results</h3> | ||
:Returns the | :Returns the result/error codes. For more information, see [[Property V4:Result Codes|Property V4 Result Codes]]. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Revision as of 23:47, 27 November 2017
| Property Navigation | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
| |||||||||||||
| |||||||||||||
| |||||||||||||
| Sample Code |
The LookupDeeds endpoint returns an array of deeds and/or transactions from the recorder table when given either a deed transaction ID or the FIPs and APN.
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 |
|---|---|---|
| Transmission Reference | Request | t |
| License Key | id | |
| Columns | cols | |
| Format | format | |
| Property MAK | Record | mak |
| FreeForm | ff | |
| FIPS | fips | |
| APN | apn | |
| Transaction ID | txid |
Minimum Inputs
The following are the possible minimum input requirements.
- FIPS & APN
- Property MAK
- Transaction ID
- 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
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
Columns
- Optional.
- This string value specifies which column(s) to be output as a comma delimited string.
Protocol Syntax REST &cols = 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
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. |
Property 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
FIPS
- Optional.
- Federal Information Processing Standard (FIPS) code for the property.
Protocol Syntax REST &fips = string
APN
- Optional.
- Assessor's Parcel Number for the property.
Protocol Syntax REST &apn = string
Transaction ID
- Optional.
- Specific transaction ID to specify one deed or transaction.
Protocol Syntax REST &txid = 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.
Field Name Group Version [DEFAULT] Always return in the output structure.
TransmissionReference Results TotalRecords Records TypeCode GrpDocInfo NumberFormatted NumberLegacy InstrumentNumber Book Page InstrumentDate RecordingDate TransactionType GrpTxDefInfo TransferInfoPurchaseTypeCode ForeclosureAuctionSale TransferInfoDistressCircumstanceCode QuitclaimFlag TransferInfoMultiParcelFlag ArmsLengthFlag PartialInterest TransferAmount GrpTxAmtInfo TransferAmountInfoAccuracy TransferTaxTotal TransferTaxCounty Name1Full GrpPrimaryGrantor Name1First Name1Middle Name1Last Name1Suffix Name1ClassType Name1LegalType Name2Full Name2First Name2Middle Name2Last Name2Suffix Name2ClassType Name2LegalType Name3Full GrpSecondaryGrantor Name3First Name3Middle Name3Last Name3Suffix Name3ClassType Name4Full Name4First Name4Middle Name4Last Name4Suffix Name4ClassType Name1Full GrpPrimaryGrantee Name1First Name1Middle Name1Last Name1Suffix Name1ClassType Name1LegalType Name2Full Name2First Name2Middle Name2Last Name2Suffix Name2ClassType Name3Full GrpSecondaryGrantee Name3First Name3Middle Name3Last Name3Suffix Name3ClassType Name4Full Name4First Name4Middle Name4Last Name4Suffix Name4ClassType StandardizedCode GrpTitleCompInfo StandardizedName TitleCompanyRaw DocNumberFormatted GrpMortgage1 DocNumberLegacy InstrumentNumber Book Page RecordingDate Type Amount LenderCode LenderFullName LenderFirstName LenderLastName LenderAddress LenderCity LenderState LenderZip LenderType IsLenderSeller Term TermType TermDate PrepaymentPenaltyFlag PrepaymentTerm InterestRateType InterestRate InterestTypeInitial FixedStepConvRate InterestMargin InterestIndex InterestRateMax AdjustableRateIndex InterestOnlyFlag InterestOnlyPeriod DocNumberFormatted GrpMortgage2 DocNumberLegacy InstrumentNumber Book Page RecordingDate Type Amount LenderCode LenderFullName LenderFirstName LenderLastName LenderAddress LenderCity LenderState LenderZip LenderType IsLenderSeller Term TermType TermDate PrepaymentPenaltyFlag PrepaymentTerm InterestRateType InterestRate InterestTypeInitial FixedStepConvRate InterestMargin InterestIndex InterestRateMax AdjustableRateIndex InterestOnlyFlag InterestOnlyPeriod EstDownPayment GrpValuation EstLTV
[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 "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"
GrpDocInfo
Protocol Syntax JSON "":"string"