Difference between revisions of "Property V4:LookupProperty"

From Melissa Data Wiki
Jump to navigation Jump to search
(Created page with "{{PropertyV4Nav |InputOutputCollapse= }} {{CustomTOC}} The LookupProperty endpoint returns general information regarding a property. =Request= A request consists of a prot...")
 
Line 256: Line 256:
|Results
|Results
|-
|-
|FIPSCode||rowspan="1"|'''GrpParcel'''
|FIPSCode||rowspan="11"|'''GrpParcel'''
|-
|-
|County
|-
|UnformattedAPN
|-
|FormattedAPN
|-
|AlternateAPN
|-
|APNYearChange
|-
|PreviousAPN
|-
|AccountNumber
|-
|YearAdded
|-
|MapBook
|-
|MapPage
|-
|LegalDescription||rowspan="15"|'''GrpLegal'''
|-
|Range
|-
|Township
|-
|Section
|-
|Quarter
|-
|QuarterQuarter
|-
|Subdivision
|-
|Phase
|-
|TractNumber
|-
|Block1
|-
|Block2
|-
|LotNumber1
|-
|LotNumber2
|-
|LotNumber3
|-
|Unit
|-
|Address||rowspan="9"|'''GrpPropertyAddress'''
|-
|City
|-
|State
|-
|Zip
|-
|AddressKey
|-
|MAK
|-
|BaseMAK
|-
|Latitude
|-
|Longitude
|-
|Range||rowspan="7"|'''GrpParsedPropertyAddress'''
|-
|PreDirectional
|-
|StreetName
|-
|Suffix
|-
|PostDirectional
|-
|SuiteName
|-
|SuiteRange
|-
|Name1Full||rowspan="14"|'''GrpPrimaryOwner'''
|-
|Name1First
|-
|Name1Middle
|-
|Name1Last
|-
|Name1Suffix
|-
|TrustFlag
|-
|CompanyFlag
|-
|Name2Full
|-
|Name2First
|-
|Name2Middle
|-
|Name2Last
|-
|Name2Suffix
|-
|Type
|-
|VestingType
|-
|Name3Full||rowspan="11"|'''GrpSecondaryOwner'''
|-
|Name3First
|-
|Name3Middle
|-
|Name3Last
|-
|Name3Suffix
|-
|Name4Full
|-
|Name4First
|-
|Name4Middle
|-
|Name4Last
|-
|Name4Suffix
|-
|Type
|-
|Address||rowspan="7"|'''GrpOwnerAddress'''
|-
|City
|-
|State
|-
|Zip
|-
|CarrierRoute
|-
|MAK
|-
|BaseMAK
|-
|Name1Full||rowspan="20"|'''GrpLastDeedOwnerInfo'''
|-
|Name1First
|-
|Name1Middle
|-
|Name1Last
|-
|Name1Suffix
|-
|Name2Full
|-
|Name2First
|-
|Name2Middle
|-
|Name2Last
|-
|Name2Suffix
|-
|Name3Full
|-
|Name3First
|-
|Name3Middle
|-
|Name3Last
|-
|Name3Suffix
|-
|Name4Full
|-
|Name4First
|-
|Name4Middle
|-
|Name4Last
|-
|Name4Suffix
|-
|MortgageAmount||rowspan="10"|'''GrpCurrentDeed'''
|-
|MortgageDate
|-
|MortgageLoanTypeCode
|-
|MortgageTermCode
|-
|MortgageTerm
|-
|MortgageDueDate
|-
|LenderCode
|-
|LenderName
|-
|SecondMortgageAmount
|-
|SecondMortgageLoanTypeCode
|-
|YearAssessed||rowspan="23"|'''GrpTax'''
|-
|AssessedValueTotal
|-
|AssessedValueImprovements
|-
|AssessedValueLand
|-
|AssessedImprovementsPerc
|-
|PreviousAssessedValue
|-
|MarketValueYear
|-
|MarketValueTotal
|-
|MarketValueImprovements
|-
|MarketValueLand
|-
|MarketImprovementsPerc
|-
|TaxFiscalYear
|-
|TaxRateArea
|-
|TaxBilledAmount
|-
|TaxDelinquentYear
|-
|LastTaxRollUpdate
|-
|AssrLastUpdated
|-
|TaxExemptionHomeowner
|-
|TaxExemptionDisabled
|-
|TaxExemptionSenior
|-
|TaxExemptionVeteran
|-
|TaxExemptionWidow
|-
|TaxExemptionAdditional
|-
|YearBuilt||rowspan="6"|'''GrpPropertyUseInfo'''
|-
|YearBuiltEffective
|-
|ZonedCodeLocal
|-
|PropertyUseMuni
|-
|PropertyUseGroup
|-
|PropertyUseStandardized
|-
|AssessorLastSaleDate||rowspan="13"|'''GrpSaleInfo'''
|-
|AssessorLastSaleAmount
|-
|AssessorPriorSaleDate
|-
|AssessorPriorSaleAmount
|-
|LastOwnershipTransferDate
|-
|LastOwnershipTransferDocumentNumber
|-
|LastOwnershipTransferTxID
|-
|DeedLastSaleDocumentBook
|-
|DeedLastSaleDocumentPage
|-
|DeedLastDocumentNumber
|-
|DeedLastSaleDate
|-
|DeedLastSalePrice
|-
|DeedLastSaleTxID
|-
|AreaBuilding||rowspan="19"|'''GrpPropertySize'''
|-
|AreaBuildingDefinitionCode
|-
|AreaGross
|-
|Area1stFloor
|-
|Area2ndFloor
|-
|AreaUpperFloors
|-
|AreaLotAcres
|-
|AreaLotSF
|-
|LotDepth
|-
|LotWidth
|-
|AtticArea
|-
|AtticFlag
|-
|BasementArea
|-
|BasementAreaFinished
|-
|BasementAreaUnfinished
|-
|ParkingGarage
|-
|ParkingGarageArea
|-
|ParkingCarport
|-
|ParkingCarportArea
|-
|Pool||rowspan="3"|'''GrpPool'''
|-
|PoolArea
|-
|SaunaFlag
|-
|Foundation||rowspan="7"|'''GrpIntStructInfo'''
|-
|Construction
|-
|InteriorStructure
|-
|PlumbingFixturesCount
|-
|ConstructionFireResistanceClass
|-
|SafetyFireSprinklersFlag
|-
|FlooringMaterialPrimary
|-
|BathCount||rowspan="27"|'''GrpIntRoomInfo'''
|-
|BathPartialCount
|-
|BedroomsCount
|-
|RoomsCount
|-
|StoriesCount
|-
|UnitsCount
|-
|BonusRoomFlag
|-
|BreakfastNookFlag
|-
|CellarFlag
|-
|CellarWineFlag
|-
|ExcerciseFlag
|-
|FamilyCode
|-
|FamilyFlag
|-
|GreatFlag
|-
|HobbyFlag
|-
|LaundryFlag
|-
|MediaFlag
|-
|MudFlag
|-
|OfficeArea
|-
|OfficeFlag
|-
|SafeRoomFlag
|-
|SittingFlag
|-
|StormFlag
|-
|StudyFlag
|-
|SunroomFlag
|-
|UtilityArea
|-
|UtilityCode
|-
|Fireplace||rowspan="10"|'''GrpIntAmmenities'''
|-
|FireplaceCount
|-
|AccessabilityElevatorFlag
|-
|AccessabilityHandicapFlag
|-
|EscalatorFlag
|-
|CentralVacuumFlag
|-
|IntercomFlag
|-
|SoundSystemFlag
|-
|WetBarFlag
|-
|SecurityAlarmFlag
|-
|StructureStyle||rowspan="6"|'''GrpExtStructInfo'''
|-
|Exterior1Code
|-
|RoofMaterial
|-
|RoofConstruction
|-
|StormShutterFlag
|-
|OverheadDoorFlag
|-
|ViewDescription||rowspan="9"|'''GrpExtAmmenities'''
|-
|PorchCode
|-
|PorchArea
|-
|PatioArea
|-
|DeckFlag
|-
|DeckArea
|-
|FeatureBalconyFlag
|-
|BalconyArea
|-
|BreezewayFlag
|-
|BuildingsCount||rowspan="45"|'''GrpExtBuildings'''
|-
|BathHouseArea
|-
|BathHouseFlag
|-
|BoatAccessFlag
|-
|BoatHouseArea
|-
|BoatHouseFlag
|-
|CabinArea
|-
|CabinFlag
|-
|CanopyArea
|-
|CanopyFlag
|-
|GazeboArea
|-
|GazeboFlag
|-
|GraineryArea
|-
|GraineryFlag
|-
|GreenHouseArea
|-
|GreenHouseFlag
|-
|GuestHouseArea
|-
|GuestHouseFlag
|-
|KennelArea
|-
|KennelFlag
|-
|LeanToArea
|-
|LeanToFlag
|-
|LoadingPlatformArea
|-
|LoadingPlatformFlag
|-
|MilkHouseArea
|-
|MilkHouseFlag
|-
|OutdoorKitchenFireplaceFlag
|-
|PoolHouseArea
|-
|PoolHouseFlag
|-
|PoultryHouseArea
|-
|PoultryHouseFlag
|-
|QuonsetArea
|-
|QuonsetFlag
|-
|ShedArea
|-
|ShedCode
|-
|SiloArea
|-
|SiloFlag
|-
|StableArea
|-
|StableFlag
|-
|StorageBuildingArea
|-
|StorageBuildingFlag
|-
|UtilityBuildingArea
|-
|UtilityBuildingFlag
|-
|PoleStructureArea
|-
|PoleStructureFlag
|-
|HVACCoolingDetail||rowspan="6"|'''GrpUtilities'''
|-
|HVACHeatingDetail
|-
|HVACHeatingFuel
|-
|SewageUsage
|-
|WaterSource
|-
|MobileHomeHookupFlag
|-
|RVParkingFlag||rowspan="4"|'''GrpParking'''
|-
|ParkingSpaceCount
|-
|DrivewayArea
|-
|DrivewayMaterial
|-
|TopographyCode||rowspan="14"|'''GrpYardGardenInfo'''
|-
|FenceCode
|-
|FenceArea
|-
|CourtyardFlag
|-
|CourtyardArea
|-
|ArborPergolaFlag
|-
|SprinklersFlag
|-
|GolfCourseGreenFlag
|-
|TennisCourtFlag
|-
|SportsCourtFlag
|-
|ArenaFlag
|-
|WaterFeatureFlag
|-
|PondFlag
|-
|BoatLiftFlag
|-
|EstimatedValue||rowspan="5"|'''GrpEstimatedValue'''
|-
|EstimatedMinValue
|-
|EstimatedMaxValue
|-
|ConfidenceScore
|-
|ValuationDate
|-
|WellKnownText||rowspan="1"|'''GrpShape'''
|}
|}



Revision as of 20:25, 11 December 2017

← 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
County
UnformattedAPN
FormattedAPN
AlternateAPN
APNYearChange
PreviousAPN
AccountNumber
YearAdded
MapBook
MapPage
LegalDescription GrpLegal
Range
Township
Section
Quarter
QuarterQuarter
Subdivision
Phase
TractNumber
Block1
Block2
LotNumber1
LotNumber2
LotNumber3
Unit
Address GrpPropertyAddress
City
State
Zip
AddressKey
MAK
BaseMAK
Latitude
Longitude
Range GrpParsedPropertyAddress
PreDirectional
StreetName
Suffix
PostDirectional
SuiteName
SuiteRange
Name1Full GrpPrimaryOwner
Name1First
Name1Middle
Name1Last
Name1Suffix
TrustFlag
CompanyFlag
Name2Full
Name2First
Name2Middle
Name2Last
Name2Suffix
Type
VestingType
Name3Full GrpSecondaryOwner
Name3First
Name3Middle
Name3Last
Name3Suffix
Name4Full
Name4First
Name4Middle
Name4Last
Name4Suffix
Type
Address GrpOwnerAddress
City
State
Zip
CarrierRoute
MAK
BaseMAK
Name1Full GrpLastDeedOwnerInfo
Name1First
Name1Middle
Name1Last
Name1Suffix
Name2Full
Name2First
Name2Middle
Name2Last
Name2Suffix
Name3Full
Name3First
Name3Middle
Name3Last
Name3Suffix
Name4Full
Name4First
Name4Middle
Name4Last
Name4Suffix
MortgageAmount GrpCurrentDeed
MortgageDate
MortgageLoanTypeCode
MortgageTermCode
MortgageTerm
MortgageDueDate
LenderCode
LenderName
SecondMortgageAmount
SecondMortgageLoanTypeCode
YearAssessed GrpTax
AssessedValueTotal
AssessedValueImprovements
AssessedValueLand
AssessedImprovementsPerc
PreviousAssessedValue
MarketValueYear
MarketValueTotal
MarketValueImprovements
MarketValueLand
MarketImprovementsPerc
TaxFiscalYear
TaxRateArea
TaxBilledAmount
TaxDelinquentYear
LastTaxRollUpdate
AssrLastUpdated
TaxExemptionHomeowner
TaxExemptionDisabled
TaxExemptionSenior
TaxExemptionVeteran
TaxExemptionWidow
TaxExemptionAdditional
YearBuilt GrpPropertyUseInfo
YearBuiltEffective
ZonedCodeLocal
PropertyUseMuni
PropertyUseGroup
PropertyUseStandardized
AssessorLastSaleDate GrpSaleInfo
AssessorLastSaleAmount
AssessorPriorSaleDate
AssessorPriorSaleAmount
LastOwnershipTransferDate
LastOwnershipTransferDocumentNumber
LastOwnershipTransferTxID
DeedLastSaleDocumentBook
DeedLastSaleDocumentPage
DeedLastDocumentNumber
DeedLastSaleDate
DeedLastSalePrice
DeedLastSaleTxID
AreaBuilding GrpPropertySize
AreaBuildingDefinitionCode
AreaGross
Area1stFloor
Area2ndFloor
AreaUpperFloors
AreaLotAcres
AreaLotSF
LotDepth
LotWidth
AtticArea
AtticFlag
BasementArea
BasementAreaFinished
BasementAreaUnfinished
ParkingGarage
ParkingGarageArea
ParkingCarport
ParkingCarportArea
Pool GrpPool
PoolArea
SaunaFlag
Foundation GrpIntStructInfo
Construction
InteriorStructure
PlumbingFixturesCount
ConstructionFireResistanceClass
SafetyFireSprinklersFlag
FlooringMaterialPrimary
BathCount GrpIntRoomInfo
BathPartialCount
BedroomsCount
RoomsCount
StoriesCount
UnitsCount
BonusRoomFlag
BreakfastNookFlag
CellarFlag
CellarWineFlag
ExcerciseFlag
FamilyCode
FamilyFlag
GreatFlag
HobbyFlag
LaundryFlag
MediaFlag
MudFlag
OfficeArea
OfficeFlag
SafeRoomFlag
SittingFlag
StormFlag
StudyFlag
SunroomFlag
UtilityArea
UtilityCode
Fireplace GrpIntAmmenities
FireplaceCount
AccessabilityElevatorFlag
AccessabilityHandicapFlag
EscalatorFlag
CentralVacuumFlag
IntercomFlag
SoundSystemFlag
WetBarFlag
SecurityAlarmFlag
StructureStyle GrpExtStructInfo
Exterior1Code
RoofMaterial
RoofConstruction
StormShutterFlag
OverheadDoorFlag
ViewDescription GrpExtAmmenities
PorchCode
PorchArea
PatioArea
DeckFlag
DeckArea
FeatureBalconyFlag
BalconyArea
BreezewayFlag
BuildingsCount GrpExtBuildings
BathHouseArea
BathHouseFlag
BoatAccessFlag
BoatHouseArea
BoatHouseFlag
CabinArea
CabinFlag
CanopyArea
CanopyFlag
GazeboArea
GazeboFlag
GraineryArea
GraineryFlag
GreenHouseArea
GreenHouseFlag
GuestHouseArea
GuestHouseFlag
KennelArea
KennelFlag
LeanToArea
LeanToFlag
LoadingPlatformArea
LoadingPlatformFlag
MilkHouseArea
MilkHouseFlag
OutdoorKitchenFireplaceFlag
PoolHouseArea
PoolHouseFlag
PoultryHouseArea
PoultryHouseFlag
QuonsetArea
QuonsetFlag
ShedArea
ShedCode
SiloArea
SiloFlag
StableArea
StableFlag
StorageBuildingArea
StorageBuildingFlag
UtilityBuildingArea
UtilityBuildingFlag
PoleStructureArea
PoleStructureFlag
HVACCoolingDetail GrpUtilities
HVACHeatingDetail
HVACHeatingFuel
SewageUsage
WaterSource
MobileHomeHookupFlag
RVParkingFlag GrpParking
ParkingSpaceCount
DrivewayArea
DrivewayMaterial
TopographyCode GrpYardGardenInfo
FenceCode
FenceArea
CourtyardFlag
CourtyardArea
ArborPergolaFlag
SprinklersFlag
GolfCourseGreenFlag
TennisCourtFlag
SportsCourtFlag
ArenaFlag
WaterFeatureFlag
PondFlag
BoatLiftFlag
EstimatedValue GrpEstimatedValue
EstimatedMinValue
EstimatedMaxValue
ConfidenceScore
ValuationDate
WellKnownText GrpShape


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