Express Entry:GlobalExpressFreeForm - Revision history

Admin at 23:59, 11 August 2023

2023-08-11T23:59:48Z

← Older revision		Revision as of 23:59, 11 August 2023
Line 56:		Line 56:
	\|-		\|-
	\|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 86:		Line 86:
	:;&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, 14 July 2023

2023-07-14T23:50:25Z

← Older revision		Revision as of 23:50, 14 July 2023
Line 49:		Line 49:
	\|Opt		\|Opt
	\|poboxes:true		\|poboxes:true
	\|US Only: Return P.O. Boxes ~~and military addresses~~		\|US Only: Return P.O. Boxes (default is to exclude P.O. Boxes from the response)
	\|-		\|-
	\|rowspan="2"\|Cols		\|rowspan="2"\|Cols
Line 82:		Line 82:

	:;&opt=		:;&opt=
	:*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 along with the usual address results. Multiple options for &opt can be delimited by semicolon.

	:;&cols=		:;&cols=

Admin at 23:50, 12 August 2022

2022-08-12T23:50:51Z

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

	<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:08, 5 August 2022

2022-08-05T19:08:57Z

← Older revision		Revision as of 19:08, 5 August 2022
Line 15:		Line 15:
	<h3 class="h3grey">Example Call</h3>		<h3 class="h3grey">Example Call</h3>
	<pre>		<pre>
	http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&opt={~~column~~:gbextras~~;column:~~results}		http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&opt={poboxes:true}&cols={gbextras,results}
	</pre>		</pre>

Line 47:		Line 47:
	\|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 81:		Line 82:

	:;&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:31, 27 July 2022

2022-07-27T00:31:27Z

← Older revision		Revision as of 00:31, 27 July 2022
Line 15:		Line 15:
	<h3 class="h3grey">Example Call</h3>		<h3 class="h3grey">Example Call</h3>
	<pre>		<pre>
	http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&opt={column:gbextras}		http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&opt={column:gbextras;column:results}
	</pre>		</pre>

Admin at 00:33, 23 July 2022

2022-07-23T00:33:45Z

← Older revision		Revision as of 00:33, 23 July 2022
Line 47:		Line 47:
	\|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 53:		Line 53:
	\|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 80:		Line 83:
	:*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:28, 21 July 2022

2022-07-21T00:28:10Z

← Older revision		Revision as of 00:28, 21 July 2022
Line 47:		Line 47:
	\|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 75:		Line 78:

	:;&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:58Z

← Older revision		Revision as of 22:47, 10 June 2022
Line 41:		Line 41:
	\|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
Line 69:		Line 69:
	:;&maxrecords=		:;&maxrecords=
	::Maxrecords is provided to control the number of results returned from a request to the service.		::Maxrecords is provided to control the number of results returned from a request to the service.
			::The default value is 10 and the maximum is 100 records.

	:;&nativecharset=		:;&nativecharset=

Admin at 02:13, 12 March 2022

2022-03-12T02:13:19Z

← Older revision		Revision as of 02:13, 12 March 2022
Line 15:		Line 15:
	<h3 class="h3grey">Example Call</h3>		<h3 class="h3grey">Example Call</h3>
	<pre>		<pre>
	http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&~~options~~={column:gbextras}		http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True\|False\|(blank)}&opt={column:gbextras}
	</pre>		</pre>

Line 47:		Line 47:
	\|Optional. Return results in the native character set for the country.		\|Optional. Return results in the native character set for the country.
	\|-		\|-
	\|~~Options~~		\|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 73:		Line 73:
	::When set to true, return results in the native character set for the country. When set to false, return transliterated results in the Latin character set. When set to blank (‘&nativecharset=’) return results in the input character set.		::When set to true, return results in the native character set for the country. When set to false, return transliterated results in the Latin character set. When set to blank (‘&nativecharset=’) return results in the input character set.

	:;&~~options~~=		:;&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.

Admin at 02:08, 12 March 2022

2022-03-12T02:08:21Z

@@ Line 15: / Line 15: @@
 <h3 class="h3grey">Example Call</h3>
 <pre>
-http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True|False|(blank)}
+http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}&nativecharset={True|False|(blank)}&options={column:gbextras}
 </pre>
@@ Line 46: / Line 46: @@
 |True/False/Blank
 |Optional. Return results in the native character set for the country.
 |}
@@ Line 68: / Line 72: @@
 :;&nativecharset=
 ::When set to true, return results in the native character set for the country.  When set to false, return transliterated results in the Latin character set.  When set to blank (‘&nativecharset=’) return results in the input character set.
 [[Category:Cloud Services]]
 [[Category:Express Entry]]