Difference between revisions of "Express Entry:GlobalExpressFreeForm"

From Melissa Data Wiki
Jump to navigation Jump to search
(21 intermediate revisions by 2 users not shown)
Line 4: Line 4:


{{CustomTOC}}
{{CustomTOC}}
==URL==
{{URL-GlobalExpressFreeForm}}


==GlobalExpressFreeForm==
==GlobalExpressFreeForm==
The GlobalExpressFreeForm service is provided as a means of retrieving all available address elements using a free form search. GlobalExpressFreeForm returns FormattedAddress, AddressLine1-8, CountryISO3166_1_Alpha2, CountryISO3166_1_Alpha3, CountryISO3166_1_Numeric, SubNationalArea, PremisesNumber, AdministrativeArea, SubadministrativeArea, locality, dependentlocality, doubledependentlocality, thoroughfare, dependentthoroughfare, building, postalcode, and postbox.
The GlobalExpressFreeForm service is provided as a means of retrieving all available address elements using a free form search. GlobalExpressFreeForm returns FormattedAddress, AddressLine1-8, CountryISO3166_1_Alpha2, CountryISO3166_1_Alpha3, CountryISO3166_1_Numeric, SubNationalArea, PremisesNumber, AdministrativeArea, SubadministrativeArea, locality, dependentlocality, doubledependentlocality, thoroughfare, dependentthoroughfare, building, postalcode, and postbox.


===Example Call===
 
<h3 class="h3grey">Example Call</h3>
<pre>
<pre>
http://expressentry.melissadata.net/web/GlobalExpressFreeForm?format={FORMAT}&id={ID}&ff={FF}&country={COUNTRY}&maxrecords={MAXRECORDS}
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>


===Schema===
:{|class="alternate01" cellspacing="0"
;?format=
!Requested Field
:The response will be formatted according to the value set here.
!Input
:Valid values are: XML and JSON.
!style="border-right:0px;"|Description
|-
|Format
|{XML, JSON}
|The return format of the request.
|-
|ID
|Text
|The License Key or token
|-
|FF
|Text
|The Free Form request.
|-
|Country
|Text
|The ISO2Code or country name of the address (required, Default US).
|-
|Maxrecords
|Number
|The maximum number of records to return (required). (Default 10, Maximum 100)
|-
|Nativecharset
|True/False/Blank
|Optional. Return results in the native character set for the country.
|-
|Opt
|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.
|-
|results
|Return Address Object result codes for each address in the Extras field.
|}
 
 
<h3 class="h3grey">Schema</h3>
:;?format=
::The response will be formatted according to the value set here.
::Valid values are: XML and JSON.
 
:;&id=
::The ID element can contain your user ID, a complete License Key, or a token.
 
:;&ff=
::The service uses this term to complete addresses in Free Form. Searches use the allwords search.
 
:;&country=
::The ISO2Code or full country name of the country to search (Default US).
 
:;&maxrecords=
::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=
::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.
 
:;&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.
 
:;&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>.
 


;&id=
<h3 class="h3grey">Extras</h3>
:The ID element can contain your user ID, a complete license string, or a token.
: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.


;&ff=
<pre style="margin-left:14px;"><Extras>
:The FF element performs a “Line1” search. If the search term exceeds seven characters, subsequent searches will use the allwords option.
    <root>
        <extra>
            <key>UDPRN</key>
            <value>25877698</value>
        </extra>
        <extra>
            <key>UPRN</key>
            <value>217122173</value>
        </extra>
    </root>
</Extras></pre>


;&country=
:Here are the possible output and groups:
:The ISO2Code or full country name of the country to search (Default US).


;&maxrecords=
:{| class="alternate01"
:Maxrecords is provided to control the number of results returned from a request to the service.
!Output Name !! Description
|-
|UDPRN||The Unique Delivery Point Reference Number issued by Royal Mail. This is an 8-digit unique number.
|-
|UPRN||The Unique Property Reference Number issued by Royal Mail. This is a number unique to each address in GB. This is a unique number up to 12-digits long.
|}




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

Revision as of 23:50, 12 August 2022

← Global Express Entry

Express Entry Navigation
Introduction
Global Getting Started
Endpoints
ExpressAddress
ExpressCityState
ExpressFreeForm
ExpressPostalCode
ExpressStreet
GlobalExpressAddress
GlobalExpressCountry
GlobalExpressLocalityAdministrativeArea
GlobalExpressFreeForm
  ↳  Filtering Responses
GlobalExpressPostalCode
GlobalExpressThoroughfare
Examples
XML Response
JSON Response
Global XML Response
Global JSON Response
Token Server
Result Codes
Result Code Use
Express Entry Result Codes
Sample Code



URL

REST

Use URL
Standard http://expressentry.melissadata.net/web/GlobalExpressFreeForm
Secure https://expressentry.melissadata.net/web/GlobalExpressFreeForm


JSON

Use URL
Standard http://expressentry.melissadata.net/jsonp/GlobalExpressFreeForm
Secure https://expressentry.melissadata.net/jsonp/GlobalExpressFreeForm


GlobalExpressFreeForm

The GlobalExpressFreeForm service is provided as a means of retrieving all available address elements using a free form search. GlobalExpressFreeForm returns FormattedAddress, AddressLine1-8, CountryISO3166_1_Alpha2, CountryISO3166_1_Alpha3, CountryISO3166_1_Numeric, SubNationalArea, PremisesNumber, AdministrativeArea, SubadministrativeArea, locality, dependentlocality, doubledependentlocality, thoroughfare, dependentthoroughfare, building, postalcode, and postbox.


Example Call

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}
Requested Field Input Description
Format {XML, JSON} The return format of the request.
ID Text The License Key or token
FF Text The Free Form request.
Country Text The ISO2Code or country name of the address (required, Default US).
Maxrecords Number The maximum number of records to return (required). (Default 10, Maximum 100)
Nativecharset True/False/Blank Optional. Return results in the native character set for the country.
Opt poboxes:true US Only: Return P.O. Boxes and military addresses
Cols gbextras GB Only: Return UPRN (SourceID) and UDPRN (SupplierID) values for each address.
results Return Address Object result codes for each address in the Extras field.


Schema

?format=
The response will be formatted according to the value set here.
Valid values are: XML and JSON.
&id=
The ID element can contain your user ID, a complete License Key, or a token.
&ff=
The service uses this term to complete addresses in Free Form. Searches use the allwords search.
&country=
The ISO2Code or full country name of the country to search (Default US).
&maxrecords=
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=
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.
&opt=
  • When set to poboxes:true, 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 gbextras this will return UPRN and UDPRN values for each address. These will be in the Extras element.
  • When set to results this will return the Address Object result codes for each address in the Extras field. For example, a USPS only address will return AddrObjectResultCode": "AS01".


Extras

If you specify &cols=gbextras in the request options, we will return additional outputs. These outputs are presented in a different format. They will look like this below.
<Extras>
    <root>
        <extra>
            <key>UDPRN</key>
            <value>25877698</value>
        </extra>
        <extra>
            <key>UPRN</key>
            <value>217122173</value>
        </extra>
    </root>
</Extras>
Here are the possible output and groups:
Output Name Description
UDPRN The Unique Delivery Point Reference Number issued by Royal Mail. This is an 8-digit unique number.
UPRN The Unique Property Reference Number issued by Royal Mail. This is a number unique to each address in GB. This is a unique number up to 12-digits long.