Admin at 19:34, 7 December 2018

2018-12-07T19:34:02Z

← Older revision		Revision as of 19:34, 7 December 2018
Line 12:		Line 12:

	Property V4 supports the REST protocol to access the service.		Property V4 supports the REST protocol to access the service.


			==URL==
			{{URL-PropertyV4-LookupHomesByOwner}}

Admin at 20:26, 11 December 2017

2017-12-11T20:26:08Z

← Older revision		Revision as of 20:26, 11 December 2017
Line 123:		Line 123:
	!Field Name !! Group		!Field Name !! Group
	\|-		\|-
	\|Version\|\|rowspan="13"\|'''[DEFAULT]'''		\|Version\|\|rowspan="14"\|'''[DEFAULT]'''
	Always return in the output structure.		Always return in the output structure.
	\|-		\|-

Admin at 23:25, 27 November 2017

2017-11-27T23:25:16Z

← Older revision		Revision as of 23:25, 27 November 2017
Line 128:		Line 128:
	\|TransmissionReference		\|TransmissionReference
	\|-		\|-
	\|~~TranmissionResults~~		\|Results
	\|-		\|-
	\|TotalRecords		\|TotalRecords
Line 134:		Line 134:
	\|Records		\|Records
	\|-		\|-
	\|~~PropertyMAK~~		\|MAK
	\|-		\|-
	\|BaseMAK		\|BaseMAK
Line 149:		Line 149:
	\|-		\|-
	\|PropertyZip		\|PropertyZip
			\|-
			\|PropertyPlus4
	\|}		\|}

Line 173:		Line 175:


	<h3 style="background-color:rgb(240,240,240);">~~TransmissionResults~~</h3>		<h3 style="background-color:rgb(240,240,240);">Results</h3>
	:Returns the ~~generic web service level~~ result/error codes. For more information, see [[Property V4:Result Codes\|Property V4 Result Codes]].		:Returns the result/error codes. For more information, see [[Property V4:Result Codes\|Property V4 Result Codes]].

	:{\| class="alternate01"		:{\| class="alternate01"
	!Protocol !! Syntax		!Protocol !! Syntax
	\|-		\|-
	\|JSON\|\|<code>"~~TransmissionResults~~":"'''''string'''''"</code>		\|JSON\|\|<code>"Results":"'''''string'''''"</code>
	\|}		\|}

Line 203:		Line 205:


	<h3 style="background-color:rgb(240,240,240);">~~PropertyMAK~~</h3>		<h3 style="background-color:rgb(240,240,240);">MAK</h3>
	:(Melissa Address Key) A unique key assigned to the address record.		:(Melissa Address Key) A unique key assigned to the address record.

Line 209:		Line 211:
	!Protocol !! Syntax		!Protocol !! Syntax
	\|-		\|-
	\|JSON\|\|<code>"~~PropertyMAK~~":"'''''string'''''"</code>		\|JSON\|\|<code>"MAK":"'''''string'''''"</code>
	\|}		\|}

Line 274:		Line 276:

	<h3 style="background-color:rgb(240,240,240);">PropertyZip</h3>		<h3 style="background-color:rgb(240,240,240);">PropertyZip</h3>
	:The ~~postal~~ code containing the property.		:The Zip code containing the property.

	:{\| class="alternate01"		:{\| class="alternate01"
Line 280:		Line 282:
	\|-		\|-
	\|JSON\|\|<code>"PropertyZip":"'''''string'''''"</code>		\|JSON\|\|<code>"PropertyZip":"'''''string'''''"</code>
			\|}


			<h3 style="background-color:rgb(240,240,240);">PropertyPlus4</h3>
			:The plus 4 of the zip code containing the property.

			:{\| class="alternate01"
			!Protocol !! Syntax
			\|-
			\|JSON\|\|<code>"PropertyPlus4":"'''''string'''''"</code>
	\|}		\|}

Admin: Created page with "{{PropertyV4Nav |InputOutputCollapse= }} {{CustomTOC}} The LookupHomesByOwner endpoint returns an array of homes owned by a homeowner based on their address (MAK). =Reques..."

2017-11-27T21:40:27Z

Created page with "{{PropertyV4Nav |InputOutputCollapse= }} {{CustomTOC}} The LookupHomesByOwner endpoint returns an array of homes owned by a homeowner based on their address (MAK). =Reques..."

New page

{{PropertyV4Nav
|InputOutputCollapse=
}}

{{CustomTOC}}

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.

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

{| class="alternate01 sortable"
!Field Name !! Level !! REST
|-
|Transmission Reference||rowspan="3" valign="center"|Request||t
|-
|License Key||id
|-
|Format||format
|-
|Owner MAK||rowspan="2" valign="center"|Record||mak
|-
|Free Form||ff
|}

==Minimum Inputs==
The following are the possible minimum input requirements.

#Owner MAK
#Free Form

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

<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
:''Optional.''

:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||<code>?t = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">License Key</h3>
:''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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||<code>&id = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Format</h3>
:''Optional.''

:The desired format of the response. Possible values are json or xml.

:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||<code>&format = '''''string'''''</code>
|}

==Request Record Elements==
REST will only contain the Records element.

{| class="alternate01"
!Protocol !! Definition
|-
|REST||The REST interface only allows a single record per request.
|}

<h3 style="background-color:rgb(240,240,240);">Owner MAK</h3>
:''Optional.''

:A propietary unique key identifier for an address. This is derived from Address Checking.

:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||<code>&mak = '''''string'''''</code>
|}

<h3 style="background-color:rgb(240,240,240);">Free Form</h3>
:''Optional.''

:The free form address.

:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||<code>&ff = '''''string'''''</code>
|}

=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.

{| class="alternate01 sortable"
!Field Name !! Group
|-
|Version||rowspan="13"|'''[DEFAULT]'''
Always return in the output structure.
|-
|TransmissionReference
|-
|TranmissionResults
|-
|TotalRecords
|-
|Records
|-
|PropertyMAK
|-
|BaseMAK
|-
|FIPS
|-
|APN
|-
|PropertyAddress
|-
|PropertyCity
|-
|PropertyState
|-
|PropertyZip
|}

==[DEFAULT]==
<h3 style="background-color:rgb(240,240,240);">Version</h3>
:The current web service version.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Version":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
:A pass-through of the input Transmission Reference.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">TransmissionResults</h3>
:Returns the generic web service level result/error codes. For more information, see [[Property V4:Result Codes|Property V4 Result Codes]].

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionResults":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">TotalRecords</h3>
:The total number of records returned in the records array.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TotalRecords":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">Records</h3>
:This is the returned array of records.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Records":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">PropertyMAK</h3>
:(Melissa Address Key) A unique key assigned to the address record.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PropertyMAK":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">BaseMAK</h3>
:A unique key assigned to the base address of a complex with apartments or suites.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"BaseMAK":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">FIPS</h3>
:The six-digit Federal Information Processing Standard (FIPS) code for the county containing the property.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"FIPS":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">APN</h3>
:The Assessor's Parcel Number (APN).

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"APN":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">PropertyAddress</h3>
:The address of the property.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PropertyAddress":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">PropertyCity</h3>
:The city containing the property.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PropertyCity":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">PropertyState</h3>
:The state containing the property.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PropertyState":"'''''string'''''"</code>
|}

<h3 style="background-color:rgb(240,240,240);">PropertyZip</h3>
:The postal code containing the property.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PropertyZip":"'''''string'''''"</code>
|}

[[Category:Property V4]]
[[Category:Reference]]

Property V4:LookupHomesByOwner - Revision history

Admin at 19:34, 7 December 2018

Admin at 20:26, 11 December 2017

Admin at 23:25, 27 November 2017

Admin: Created page with "{{PropertyV4Nav |InputOutputCollapse= }} {{CustomTOC}} The LookupHomesByOwner endpoint returns an array of homes owned by a homeowner based on their address (MAK). =Reques..."