Reverse GeoCoder:Request - Revision history

Admin at 16:10, 25 March 2021

2021-03-25T16:10:48Z

← Older revision		Revision as of 16:10, 25 March 2021
Line 13:		Line 13:
	==URL==		==URL==
	{{URL-ReverseGeoCoder}}		{{URL-ReverseGeoCoder}}


			==Header==
			HTTP headers need to match the protocols and formats being used.

			Reverse GeoCoder requires the values of <code>Content-Type</code> and <code>Accept</code>.

			===Example JSON Request Header===
			<pre>{
			"Content-Type": "application/json; charset=utf-8",
			"Accept": "application/json"
			}</pre>

Admin at 17:42, 20 July 2020

2020-07-20T17:42:26Z

← Older revision		Revision as of 17:42, 20 July 2020
Line 156:		Line 156:


	:List options in the following format, with multiple options delimited with a ",".		:List options in the following format, with multiple options delimited with a ";".

	:{\| class="alternate01"		:{\| class="alternate01"
	!Syntax		!Syntax
	\|-		\|-
	\|<code>''OptionName'':''Parameter'',''OptionName'':''Parameter''</code>		\|<code>''OptionName'':''Parameter'';''OptionName'':''Parameter''</code>
	\|}		\|}

Line 204:		Line 204:
	:''Optional.''		:''Optional.''

	:The desired format of the response. Possible values for this option are "json" or "xml".		:The desired format of the response. Possible values for this option are "json" or "xml". The default value is "xml".

	:{\| class="alternate01"		:{\| class="alternate01"

Admin at 17:23, 20 July 2020

2020-07-20T17:23:30Z

Admin at 23:35, 17 July 2020

2020-07-17T23:35:24Z

@@ Line 32: / Line 32: @@
 |-
 |MaxRecords||recs||MaxRecords
 |-
 |Format||format||
@@ Line 135: / Line 137: @@
 |-
 |XML||<code><MaxRecords>'''''string'''''</MaxRecords></code>
 |}

Admin at 19:26, 8 March 2019

2019-03-08T19:26:56Z

← Older revision		Revision as of 19:26, 8 March 2019
Line 1:		Line 1:
	{{ReverseGeoCoderNav		{{ReverseGeoCoderNav
	\|~~RequestCollapse~~=		\|InputOutputCollapse=
	}}		}}

Admin at 19:18, 8 March 2019

2019-03-08T19:18:03Z

Admin at 19:15, 8 March 2019

2019-03-08T19:15:25Z

← Older revision		Revision as of 19:15, 8 March 2019
Line 40:		Line 40:
	The following elements set the basic options for each request. These apply to the entire request, not the individual records.		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>		<h3 class="h3grey">Transmission Reference</h3>
	:''Optional.''		:''Optional.''

Line 56:		Line 56:


	<h3 ~~style~~="~~background-color:rgb(240,240,240);~~">License Key</h3>		<h3 class="h3grey">License Key</h3>
	:''Required.''		:''Required.''

Line 74:		Line 74:


	<h3 ~~style~~="~~background-color:rgb(240,240,240);~~">Latitude</h3>		<h3 class="h3grey">Latitude</h3>
	:''Required.''		:''Required.''

Line 90:		Line 90:


	<h3 ~~style~~="~~background-color:rgb(240,240,240);~~">Longitude</h3>		<h3 class="h3grey">Longitude</h3>
	:''Required.''		:''Required.''

Line 106:		Line 106:


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

Line 122:		Line 122:


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

Line 138:		Line 138:


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

Admin at 22:27, 7 March 2019

2019-03-07T22:27:51Z

Show changes

Admin at 19:43, 7 December 2018

2018-12-07T19:43:11Z

← Older revision		Revision as of 19:43, 7 December 2018
Line 11:		Line 11:

	Reverse GeoCoder supports multiple protocols to access the service, including SOAP, JSON, REST, and XML.		Reverse GeoCoder supports multiple protocols to access the service, including SOAP, JSON, REST, and XML.


			==URL==
			{{URL-ReverseGeoCoder}}


	[[Category:Reverse GeoCoder]]		[[Category:Reverse GeoCoder]]
	[[Category:Reference]]		[[Category:Reference]]

Admin at 17:12, 23 December 2016

2016-12-23T17:12:39Z

← Older revision		Revision as of 17:12, 23 December 2016
Line 8:		Line 8:
	==Request==		==Request==

	A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your ~~Customer ID~~ and at least one set of geo-coordinates.		A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your License Key and at least one set of geo-coordinates.

	Reverse GeoCoder supports multiple protocols to access the service, including SOAP, JSON, REST, and XML.		Reverse GeoCoder supports multiple protocols to access the service, including SOAP, JSON, REST, and XML.

← Older revision		Revision as of 17:23, 20 July 2020
Line 166:		Line 166:

	:<h4 style="border-bottom:1px solid black;">IncludeApartments</h4>		:<h4 style="border-bottom:1px solid black;">IncludeApartments</h4>
	::This options allows you ~~to specify if you want~~ to include ~~apartments in your search~~.		::This options allows you to include records with a non-null baseMAK.

	::{\| class="alternate01 sortable"		::{\| class="alternate01 sortable"
	!Option Name !! Parameter !! Description		!Option Name !! Parameter !! Description
	\|-		\|-
	\|rowspan="2"\|'''IncludeApartments'''\|\|<code>Off</code>\|\|'''''Default.''''' ~~Apartments~~ are not included.		\|rowspan="2"\|'''IncludeApartments'''\|\|<code>Off</code>\|\|'''''Default.''''' Non-null baseMAK records are not included.
	\|-		\|-
	\|<code>On</code>\|\|~~Apartments are~~ included in your search.		\|<code>On</code>\|\|Records with a non-null baseMAK will be included in your search.
	\|}		\|}


	:<h4 style="border-bottom:1px solid black;">IncludeUndeliverable</h4>		:<h4 style="border-bottom:1px solid black;">IncludeUndeliverable</h4>
	::This options allows you to specify if you want to include ~~undeliverable~~ addresses ~~in your search~~.		::This options allows you to specify if you want to include addresses we have identified as unable to deliver mail to.

	::{\| class="alternate01 sortable"		::{\| class="alternate01 sortable"
	!Option Name !! Parameter !! Description		!Option Name !! Parameter !! Description
	\|-		\|-
	\|rowspan="2"\|'''IncludeUndeliverable'''\|\|<code>Off</code>\|\|~~'''''Default.'''''~~ Undeliverable addresses are not included.		\|rowspan="2"\|'''IncludeUndeliverable'''\|\|<code>Off</code>\|\|Undeliverable addresses are not included.
	\|-		\|-
	\|<code>On</code>\|\|Undeliverable addresses are included in your search.		\|<code>On</code>\|\|'''''Default.''''' Undeliverable addresses are included in your search.
	\|}		\|}


	:<h4 style="border-bottom:1px solid black;">IncludeEmptyLots</h4>		:<h4 style="border-bottom:1px solid black;">IncludeEmptyLots</h4>
	::This options allows you to specify if you want to include empty lots in your search.		::This options allows you to specify if you want to include addresses that are empty lots in your search.

	::{\| class="alternate01 sortable"		::{\| class="alternate01 sortable"

← Older revision		Revision as of 19:18, 8 March 2019
Line 8:		Line 8:
	A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your License Key and at least one set of geo-coordinates.		A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your License Key and at least one set of geo-coordinates.

	Reverse GeoCoder supports multiple protocols to access the service, including ~~SOAP,~~ JSON, REST, and XML.		Reverse GeoCoder supports multiple protocols to access the service, including JSON, REST, and XML.


Line 52:		Line 52:
	\|REST\|\|<code>?t = '''''string'''''</code>		\|REST\|\|<code>?t = '''''string'''''</code>
	\|-		\|-
	\|~~SOAP/~~XML\|\|<code><TransmissionReference>'''''string'''''</TransmissionReference></code>		\|XML\|\|<code><TransmissionReference>'''''string'''''</TransmissionReference></code>
	\|}		\|}

Line 70:		Line 70:
	\|REST\|\|<code>&id = '''''string'''''</code>		\|REST\|\|<code>&id = '''''string'''''</code>
	\|-		\|-
	\|~~SOAP/~~XML\|\|<code><CustomerID>'''''string'''''</CustomerID></code>		\|XML\|\|<code><CustomerID>'''''string'''''</CustomerID></code>
	\|}		\|}

Line 86:		Line 86:
	\|REST\|\|<code>&lat = '''''string'''''</code>		\|REST\|\|<code>&lat = '''''string'''''</code>
	\|-		\|-
	\|~~SOAP/~~XML\|\|<code><Latitude>'''''string'''''</Latitude></code>		\|XML\|\|<code><Latitude>'''''string'''''</Latitude></code>
	\|}		\|}

Line 102:		Line 102:
	\|REST\|\|<code>&long = '''''string'''''</code>		\|REST\|\|<code>&long = '''''string'''''</code>
	\|-		\|-
	\|~~SOAP/~~XML\|\|<code><Longitude>'''''string'''''</Longitude></code>		\|XML\|\|<code><Longitude>'''''string'''''</Longitude></code>
	\|}		\|}

Line 118:		Line 118:
	\|REST\|\|<code>&dist = '''''string'''''</code>		\|REST\|\|<code>&dist = '''''string'''''</code>
	\|-		\|-
	\|~~SOAP/~~XML\|\|<code><MaxDistance>'''''string'''''</MaxDistance></code>		\|XML\|\|<code><MaxDistance>'''''string'''''</MaxDistance></code>
	\|}		\|}

Line 134:		Line 134:
	\|REST\|\|<code>&recs = '''''string'''''</code>		\|REST\|\|<code>&recs = '''''string'''''</code>
	\|-		\|-
	\|~~SOAP/~~XML\|\|<code><MaxRecords>'''''string'''''</MaxRecords></code>		\|XML\|\|<code><MaxRecords>'''''string'''''</MaxRecords></code>
	\|}		\|}