The following are examples of specifying additional options when using the REST version of the getFileHTTPs.exe utility.
-
To download the REST version of the ascii daily delete
file:
getFileHTTPs.exe <username> <password> dailydelete -ascii -rest
- To download the larger NCOALink databases, you must
provide the product code and product ID. To determine the correct product code and product
ID, refer to the epf-product-codes.pdf in the Utilities folder or use the -listfiles
command. To download a particular database:
-rest <Product Code> <Product ID>
- To download the NCOALink 18-month hash monthly
database:
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H
- To download a database only if that database is new and has not been downloaded before.
This valid example also includes using the "validation" option to run a basic validation
after the file is downloaded and
unzipped.
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H onlynew validate -outdir C:\NCOA
- The following is an invalid example using "validate" to run a basic validation after
the file is downloaded and unzipped. In this case, the option "validate" is specified
outside of the -rest option area and is
ignored.
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H onlynew -outdir C:\NCOA validate
- To download a database only if the status of the database is set to New on the server,
use the key word "onlynew" within the -rest
option:
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H onlynew
- To list available files for download and the fulfilled dates available, use the
-listfiles option. This command behaves similar to the previous release versions.
However, the information provided by the REST service differs from the SOAP version.
This command does not download files but only lists the files available for
download.
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H -listfiles
- To download a database for a specific date, use the fulfilled date option within the
-rest option:
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H 20170120
- To do a base verification of an NCOALink download,
use the key word "validate" within the -rest option. This is not a complete validation.
It only validates files that are unzipped from the main download. The VeriMove explode
process validates the remaining files located in key zip files. In this case, the files
display the status "Skipping". Those files that are available and pass the validation
will show "Good". If a file does not pass, an error has occurred and an error message
displays.
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H validate
- To use a combination of options, keywords can be provided in any order after Product
Code and Product ID. The options must reside within the -rest option area. In the
following valid example only databases marked as new and available are processed with
basic
validation.
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H onlynew validate
- The following is an invalid example of using a combination of options because the
option "validate" is outside the -rest option
area.
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H -outdir C:\NCOA validate
- To obtain information and availability of a specific database, use the -info option.
The -info option does not download files but only provides information on the database
requested.
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H -info
- To list available files for download and the fulfilled dates available, use the
-listfiles option. Although this option behaves similarly to the SOAP version, the
information provided by the newer REST service differs from the SOAP
version.
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H -listfiles
- To download to a specific location, use the -outdir <output directory> option. The
database is unzipped to the specified directory in a folder that is based on the
database
type.
getFileHTTPs.exe <username> <password> NCOAData -rest NCAWN NCL18H -outdir:C:\MyNCOA