Express Entry:ExpressFreeForm - Revision history

Admin at 01:28, 21 December 2023

2023-12-21T01:28:48Z

← Older revision		Revision as of 01:28, 21 December 2023
Line 48:		Line 48:
	\|County		\|County
	\|Return County Name field for CountyName in the Extras Object.		\|Return County Name field for CountyName in the Extras Object.
	\|}
	\|}		\|}

Line 73:		Line 72:
	;&cols=		;&cols=
	: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>.
	::When set to <code>County</code> this will return the county name field for CountyName in the Extras Object.		:When set to <code>County</code> this will return the county name field for CountyName in the Extras Object.


	[[Category:Cloud Services]]		[[Category:Cloud Services]]
	[[Category:Express Entry]]		[[Category:Express Entry]]

Admin at 01:28, 21 December 2023

2023-12-21T01:28:08Z

← Older revision		Revision as of 01:28, 21 December 2023
Line 42:		Line 42:
	\|US Only: Return P.O. Boxes (default is to exclude P.O. Boxes from the response)		\|US Only: Return P.O. Boxes (default is to exclude P.O. Boxes from the response)
	\|-		\|-
	\|Cols		\|rowspan="2"\|Cols
	\|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.
			\|-
			\|County
			\|Return County Name field for CountyName in the Extras Object.
			\|}
	\|}		\|}

Line 69:		Line 73:
	;&cols=		;&cols=
	: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>.
			::When set to <code>County</code> this will return the county name field for CountyName in the Extras Object.


	[[Category:Cloud Services]]		[[Category:Cloud Services]]
	[[Category:Express Entry]]		[[Category:Express Entry]]

Admin at 23:51, 14 July 2023

2023-07-14T23:51:38Z

← Older revision		Revision as of 23:51, 14 July 2023
Line 40:		Line 40:
	\|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)
	\|-		\|-
	\|Cols		\|Cols
Line 65:		Line 65:

	;&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 19:21, 5 August 2022

2022-08-05T19:21:52Z

← Older revision		Revision as of 19:21, 5 August 2022
Line 67:		Line 67:
	: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=		;&cols=
	:*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>.


	[[Category:Cloud Services]]		[[Category:Cloud Services]]
	[[Category:Express Entry]]		[[Category:Express Entry]]

Admin at 19:20, 5 August 2022

2022-08-05T19:20:46Z

← Older revision		Revision as of 19:20, 5 August 2022
Line 14:		Line 14:
	<h3 class="h3grey">Example Call</h3>		<h3 class="h3grey">Example Call</h3>
	<pre>		<pre>
	http://expressentry.melissadata.net/web/ExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&maxrecords={MAXRECORDS}&opt={poboxes:true}		http://expressentry.melissadata.net/web/ExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&maxrecords={MAXRECORDS}&opt={poboxes:true}&cols={results}
	</pre>		</pre>

Line 41:		Line 41:
	\|poboxes:true		\|poboxes:true
	\|US Only: Return P.O. Boxes and military addresses		\|US Only: Return P.O. Boxes and military addresses
			\|-
			\|Cols
			\|results
			\|Return Address Object result codes for each address in the Extras field.
	\|}		\|}

Line 62:		Line 66:
	;&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 and military addresses along with the usual address results. Multiple options for &opt can be delimited by semicolon.

			:;&cols=
			:*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>.


	[[Category:Cloud Services]]		[[Category:Cloud Services]]
	[[Category:Express Entry]]		[[Category:Express Entry]]

Admin at 00:34, 27 July 2022

2022-07-27T00:34:01Z

← Older revision		Revision as of 00:34, 27 July 2022
Line 14:		Line 14:
	<h3 class="h3grey">Example Call</h3>		<h3 class="h3grey">Example Call</h3>
	<pre>		<pre>
	http://expressentry.melissadata.net/web/ExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&maxrecords={MAXRECORDS}		http://expressentry.melissadata.net/web/ExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&maxrecords={MAXRECORDS}&opt={poboxes:true}
	</pre>		</pre>

Admin at 00:53, 23 July 2022

2022-07-23T00:53:35Z

← Older revision		Revision as of 00:53, 23 July 2022
Line 12:		Line 12:
	The ExpressFreeForm endpoint is provided as a means of retrieving all available U.S. address elements with a Free Form query. ExpressFreeForm returns AddressLine1, City, State, PostalCode, AddressKey, SuiteName, and SuiteCount and the SuiteList and PlusFour lists.		The ExpressFreeForm endpoint is provided as a means of retrieving all available U.S. address elements with a Free Form query. ExpressFreeForm returns AddressLine1, City, State, PostalCode, AddressKey, SuiteName, and SuiteCount and the SuiteList and PlusFour lists.

	===Example Call~~===~~		<h3 class="h3grey">Example Call</h3>
	<pre>		<pre>
	http://expressentry.melissadata.net/web/ExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&maxrecords={MAXRECORDS}		http://expressentry.melissadata.net/web/ExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&maxrecords={MAXRECORDS}
	</pre>		</pre>

	===Schema~~===~~		:{\|class="alternate01" cellspacing="0"
			!Requested Field
			!Input
			!style="border-right:0px;"\|Description
			\|-
			\|Format
			\|{XML, JSON}
			\|The return format of the request.
			\|-
			\|ID
			\|Text
			\|The License Key or token
			\|-
			\|ff
			\|Search terms delimited by %20 or space.
			\|The service uses a word-distance algorithm to find and display matches in an intuitive order.
			\|-
			\|Maxrecords
			\|Number
			\|The maximum number of records to return (required). (Default 10, Maximum 100)
			\|-
			\|Opt
			\|poboxes:true
			\|US Only: Return P.O. Boxes and military addresses
			\|}


			<h3 class="h3grey">Schema</h3>
	;?format=		;?format=
	:The response will be formatted according to the value set here.		:The response will be formatted according to the value set here.
Line 26:		Line 53:

	;&ff=		;&ff=
	:The service uses this term to complete addresses in Free Form. The service uses a word-distance algorithm to find and display matches in an intuitive order.		:The service uses this term to complete addresses in Free Form. The service uses a word-distance algorithm to find and display matches in an intuitive order.

	;&maxrecords=		;&maxrecords=
Line 32:		Line 59:

	:The default value is 10 and the maximum is 100 records.		:The default value is 10 and the maximum is 100 records.

			;&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.


	[[Category:Cloud Services]]		[[Category:Cloud Services]]
	[[Category:Express Entry]]		[[Category:Express Entry]]

Admin at 22:43, 10 June 2022

2022-06-10T22:43:47Z

← Older revision		Revision as of 22:43, 10 June 2022
Line 31:		Line 31:
	: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.		:The default value is 10 and the maximum is 100 records.


	[[Category:Cloud Services]]		[[Category:Cloud Services]]
	[[Category:Express Entry]]		[[Category:Express Entry]]

Admin at 19:13, 1 February 2019

2019-02-01T19:13:49Z

← Older revision		Revision as of 19:13, 1 February 2019
Line 4:		Line 4:

	{{CustomTOC}}		{{CustomTOC}}

			==URL==
			{{URL-ExpressFreeForm}}


	==ExpressFreeForm==		==ExpressFreeForm==

Admin at 21:27, 19 December 2016

2016-12-19T21:27:07Z

← Older revision		Revision as of 21:27, 19 December 2016
Line 19:		Line 19:

	;&id=		;&id=
	:The ID element can contain your user ID, a complete ~~license string~~, or a token.		:The ID element can contain your user ID, a complete License Key, or a token.

	;&ff=		;&ff=