Express Entry:GlobalExpressAddress - Revision history

Admin at 23:04, 15 March 2024

2024-03-15T23:04:31Z

← Older revision		Revision as of 23:04, 15 March 2024
Line 109:		Line 109:
	:;&cols=		:;&cols=
	:*When set to <code>gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.		:*When set to <code>gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.
	:*(U.S. Only) When set to <code>results</code> this will return the ~~AS##~~ Result Codes for each address in the Extras field. For example, a USPS only address will return <code>"AddrObjectResultCode": "AS01"</code>.		:*(U.S. Only) When set to <code>results</code> this will return the Address and GeoCoding Result Codes for each address in the Extras field. For example, a USPS only address with a rooftop geocode will return <code>"AddrObjectResultCode": "AS01,GS05"</code>. You can see a full list of the Address and GeoCoding result codes and their definitions here: [[Result Code Details#Global Express Entry\|Global Express Entry Result Code Details]].

Admin at 23:58, 11 August 2023

2023-08-11T23:58:11Z

← Older revision		Revision as of 23:58, 11 August 2023
Line 70:		Line 70:
	\|-		\|-
	\|results		\|results
	\|Return Address Object ~~result codes for each address in the Extras field~~.		\|US Only: Return AS## result codes ([[Result Code Details#Address Object\|see Result Code Details]].)
	\|}		\|}

Line 109:		Line 109:
	:;&cols=		:;&cols=
	:*When set to <code>gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.		:*When set to <code>gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.
	:*When set to <code>results</code> this will return the ~~Address Object result codes~~ for each address in the Extras field. For example, a USPS only address will return <code>"AddrObjectResultCode": "AS01"</code>.		:*(U.S. Only) When set to <code>results</code> this will return the AS## Result Codes for each address in the Extras field. For example, a USPS only address will return <code>"AddrObjectResultCode": "AS01"</code>.

Admin at 23:50, 12 August 2022

2022-08-12T23:50:34Z

← Older revision		Revision as of 23:50, 12 August 2022
Line 113:		Line 113:

	<h3 class="h3grey">Extras</h3>		<h3 class="h3grey">Extras</h3>
	:If you specify <code>~~column:~~gbextras</code> in the request options, we will return additional outputs. These outputs are presented in a different format. They will look like this below.		:If you specify <code>&cols=gbextras</code> in the request options, we will return additional outputs. These outputs are presented in a different format. They will look like this below.

	<pre style="margin-left:14px;"><Extras>		<pre style="margin-left:14px;"><Extras>

Admin at 19:04, 5 August 2022

2022-08-05T19:04:04Z

← Older revision		Revision as of 19:04, 5 August 2022
Line 109:		Line 109:
	:;&cols=		:;&cols=
	:*When set to <code>gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.		:*When set to <code>gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.
	:*When set to <code>results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>AddrObjectResultCode": "AS01"</code>.		:*When set to <code>results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>"AddrObjectResultCode": "AS01"</code>.

Admin at 18:57, 5 August 2022

2022-08-05T18:57:03Z

← Older revision		Revision as of 18:57, 5 August 2022
Line 17:		Line 17:
	<h3 class="h3grey">Example Call</h3>		<h3 class="h3grey">Example Call</h3>
	<pre>		<pre>
	http://expressentry.melissadata.net/web/GlobalExpressAddress?format={FORMAT}&id={ID}&address1={ADDRESS1}&locality={LOCALITY}&administrativearea={ADMINISTRATIVEAREA}&postalcode={POSTALCODE}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&opt={~~column~~:gbextras~~;column:~~results}		http://expressentry.melissadata.net/web/GlobalExpressAddress?format={FORMAT}&id={ID}&address1={ADDRESS1}&locality={LOCALITY}&administrativearea={ADMINISTRATIVEAREA}&postalcode={POSTALCODE}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&opt={poboxes:true}&cols={gbextras,results}
	</pre>		</pre>

Line 61:		Line 61:
	\|Optional. Return results in the native character set for the country.		\|Optional. Return results in the native character set for the country.
	\|-		\|-
	\|rowspan="3"\|~~Opt~~		\|Opt
	\|~~column:~~gbextras		\|poboxes:true
			\|US Only: Return P.O. Boxes and military addresses
			\|-
			\|rowspan="2"\|Cols
			\|gbextras
	\|GB Only: Return UPRN (SourceID) and UDPRN (SupplierID) values for each address.		\|GB Only: Return UPRN (SourceID) and UDPRN (SupplierID) values for each address.
	\|-		\|-
	\|~~column:~~results		\|results
	\|Return Address Object result codes for each address in the Extras field.		\|Return Address Object result codes for each address in the Extras field.
	\|-
	~~\|poboxes:true~~
	~~\|US Only: Return P.O. Boxes and military addresses~~
	\|}		\|}

Line 104:		Line 105:

	:;&opt=		:;&opt=
	~~:*When set to <code>column:gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.~~
	:*When set to <code>column:results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>AddrObjectResultCode": "AS01"</code>.
	:*When set to <code>poboxes:true</code>, U.S. Addresses will return P.O. Boxes and military addresses along with the usual address results. Multiple options for &opt can be delimited by semicolon.		:*When set to <code>poboxes:true</code>, U.S. Addresses will return P.O. Boxes and military addresses along with the usual address results. Multiple options for &opt can be delimited by semicolon.

			:;&cols=
			:*When set to <code>gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.
			:*When set to <code>results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>AddrObjectResultCode": "AS01"</code>.

Admin at 00:30, 27 July 2022

2022-07-27T00:30:16Z

← Older revision		Revision as of 00:30, 27 July 2022
Line 17:		Line 17:
	<h3 class="h3grey">Example Call</h3>		<h3 class="h3grey">Example Call</h3>
	<pre>		<pre>
	http://expressentry.melissadata.net/web/GlobalExpressAddress?format={FORMAT}&id={ID}&address1={ADDRESS1}&locality={LOCALITY}&administrativearea={ADMINISTRATIVEAREA}&postalcode={POSTALCODE}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&opt={column:gbextras}		http://expressentry.melissadata.net/web/GlobalExpressAddress?format={FORMAT}&id={ID}&address1={ADDRESS1}&locality={LOCALITY}&administrativearea={ADMINISTRATIVEAREA}&postalcode={POSTALCODE}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&opt={column:gbextras;column:results}
	</pre>		</pre>

Admin at 00:28, 23 July 2022

2022-07-23T00:28:47Z

← Older revision		Revision as of 00:28, 23 July 2022
Line 61:		Line 61:
	\|Optional. Return results in the native character set for the country.		\|Optional. Return results in the native character set for the country.
	\|-		\|-
	\|rowspan="2"\|Opt		\|rowspan="3"\|Opt
	\|column:gbextras		\|column:gbextras
	\|GB Only: Return UPRN (SourceID) and UDPRN (SupplierID) values for each address.		\|GB Only: Return UPRN (SourceID) and UDPRN (SupplierID) values for each address.
Line 67:		Line 67:
	\|column:results		\|column:results
	\|Return Address Object result codes for each address in the Extras field.		\|Return Address Object result codes for each address in the Extras field.
			\|-
			\|poboxes:true
			\|US Only: Return P.O. Boxes and military addresses
	\|}		\|}

Line 103:		Line 106:
	:*When set to <code>column:gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.		:*When set to <code>column:gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.
	:*When set to <code>column:results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>AddrObjectResultCode": "AS01"</code>.		:*When set to <code>column:results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>AddrObjectResultCode": "AS01"</code>.
			:*When set to <code>poboxes:true</code>, U.S. Addresses will return P.O. Boxes and military addresses along with the usual address results. Multiple options for &opt can be delimited by semicolon.

Admin at 00:22, 21 July 2022

2022-07-21T00:22:54Z

← Older revision		Revision as of 00:22, 21 July 2022
Line 101:		Line 101:

	:;&opt=		:;&opt=
	::When set to <code>column:gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.		:*When set to <code>column:gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.
	::When set to <code>column:results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>AddrObjectResultCode": "AS01"</code>.		:*When set to <code>column:results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>AddrObjectResultCode": "AS01"</code>.

Admin at 00:22, 21 July 2022

2022-07-21T00:22:19Z

← Older revision		Revision as of 00:22, 21 July 2022
Line 61:		Line 61:
	\|Optional. Return results in the native character set for the country.		\|Optional. Return results in the native character set for the country.
	\|-		\|-
	\|Opt		\|rowspan="2"\|Opt
	\|column:gbextras		\|column:gbextras
	\|GB Only: Return UPRN (SourceID) and UDPRN (SupplierID) values for each address.		\|GB Only: Return UPRN (SourceID) and UDPRN (SupplierID) values for each address.
			\|-
			\|column:results
			\|Return Address Object result codes for each address in the Extras field.
	\|}		\|}

Line 99:		Line 102:
	:;&opt=		:;&opt=
	::When set to <code>column:gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.		::When set to <code>column:gbextras</code> this will return UPRN and UDPRN values for each address. These will be in the <code>Extras</code> element.
			::When set to <code>column:results</code> this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return <code>AddrObjectResultCode": "AS01"</code>.

Admin at 22:47, 10 June 2022

2022-06-10T22:47:30Z

← Older revision		Revision as of 22:47, 10 June 2022
Line 55:		Line 55:
	\|Maxrecords		\|Maxrecords
	\|Number		\|Number
	\|The maximum number of records to return (required).		\|The maximum number of records to return (required). (Default 10, Maximum 100)
	\|-		\|-
	\|Nativecharset		\|Nativecharset