Express Entry:GlobalExpressThoroughfare: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
{{CustomTOC}} | {{CustomTOC}} | ||
==URL== | |||
{{URL-GlobalExpressThoroughfare}} | |||
==GlobalExpressThoroughfare== | ==GlobalExpressThoroughfare== | ||
GlobalExpressThroughfare is a means for retrieving the thoroughfares within a Postal Code using the Postal Code and beginning of the thoroughfare name as the | GlobalExpressThroughfare is a means for retrieving the thoroughfares within a Postal Code using the Postal Code and beginning of the thoroughfare name as the inputs. | ||
===Example Call=== | ===Example Call=== | ||
| Line 19: | Line 23: | ||
;&id= | ;&id= | ||
:The ID element can contain your user ID, a complete | :The ID element can contain your user ID, a complete License Key, or a token. | ||
;&thoroughfare= | ;&thoroughfare= | ||
| Line 28: | Line 32: | ||
;&country= | ;&country= | ||
:The country field is used to select the country which will be searched ( | :The country field is used to select the country which will be searched using the ISO2Code or full country name (Default is US). | ||
;&maxrecords= | ;&maxrecords= | ||
:Maxrecords is provided to control the number of results returned from a request to the service. | :Maxrecords (required) 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]] | ||
Latest revision as of 22:53, 10 June 2022
URL
REST
Use URL Standard http://expressentry.melissadata.net/web/GlobalExpressThoroughfare Secure https://expressentry.melissadata.net/web/GlobalExpressThoroughfare
JSON
Use URL Standard http://expressentry.melissadata.net/jsonp/GlobalExpressThoroughfare Secure https://expressentry.melissadata.net/jsonp/GlobalExpressThoroughfare
GlobalExpressThoroughfare
GlobalExpressThroughfare is a means for retrieving the thoroughfares within a Postal Code using the Postal Code and beginning of the thoroughfare name as the inputs.
Example Call
http://expressentry.melissadata.net/web/GlobalExpressThoroughfare?format={FORMAT}&id={ID}&thoroughfare={THOROUGHFARE}&postalcode={POSTALCODE}&maxrecords={MAXRECORDS}&country={COUNTRY}
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.
- &thoroughfare=
- Thoroughfare is used to limit the search to thoroughfares beginning with the specified letters. For example, a thoroughfare parameter of ‘mai’ will return all thoroughfares beginning with ‘mai’ in the specified postal code. This parameter requires a minimum of three characters.
- &postalcode=
- The postal code field is used to narrow the search to the specified postal code.
- &country=
- The country field is used to select the country which will be searched using the ISO2Code or full country name (Default is US).
- &maxrecords=
- Maxrecords (required) 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.