Integratec API Platform
installReferenceData

Description

Installs USPS Reference Data for use by the opAddrStd Module. Includes support for 4 NCOALink data types, along with NCOALink Daily Delete data:

  • ZIP4
  • DPV
  • LLK
  • SLK
  • RDI
  • LATLON
  • FSP
  • LSP
  • ANK
  • EU
  • DD

Remarks

  • If you want to install multiple types of NCOALink data with a single request, you must create a Persist job and run it.
  • You may populate the installDirs property array with 1 or 2 directories, to split the installed files. If using two directories, the header files are saved to the first directory and the data files in the second directory.

Example

Request

{
"dataType": "FSP",
"installDirs": [
"C:\\ReferenceData\\NCOALink1",
"C:\\ReferenceData\\NCOALink2"
],
"sourceDir": "C:\\SourceData"
}

Reply

{}

Request Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"definitions":{
"NCOALink":{
"type":"object",
"required":[
"dataType",
"installDirs",
"sourceDir"
],
"additionalProperties":false,
"properties":{
"dataType":{
"title":"Data Type",
"description":"The type of reference data to be installed.",
"type":"string",
"enum":[
"FSP",
"LSP",
"ANK",
"EU",
"DD",
"ZIP4",
"DPV",
"LLK",
"SLK",
"RDI",
"LATLON"
],
"enumValues":[
{
"value":"FSP",
"displayValue":"NCOALink FSP",
"description":"Specify NCOALink FSP as the data type to be installed."
},
{
"value":"LSP",
"displayValue":"NCOALink LSP",
"description":"Specify NCOALink LSP as the data type to be installed."
},
{
"value":"ANK",
"displayValue":"NCOALink ANK",
"description":"Specify NCOALink ANK as the data type to be installed."
},
{
"value":"EU",
"displayValue":"NCOALink EU",
"description":"Specify NCOALink EU as the data type to be installed."
},
{
"value":"DD",
"displayValue":"NCOALink DD",
"description":"Specify NCOALink DD (Daily Delete) as the data type to be installed"
},
{
"value":"ZIP4",
"displayValue":"ZIP+4",
"description":"Specify ZIP+4 as the data type to be installed"
},
{
"value":"DPV",
"displayValue":"DPV",
"description":"Specify DPV (Delivery Point Validation) as the data type to be installed"
},
{
"value":"LLK",
"displayValue":"LACSLink",
"description":"Specify LACSLink as the data type to be installed"
},
{
"value":"SLK",
"displayValue":"SUITELink",
"description":"Specify SUITELink as the data type to be installed"
},
{
"value":"RDI",
"displayValue":"RDI",
"description":"Specify RDI (Residential Delivery Indicator) as the data type to be installed"
},
{
"value":"LATLON",
"displayValue":"Tiger Geoencoding data",
"description":"Specify Lattitude and Longitude as the data type to be installed"
}
]
},
"installDirs":{
"title":"Install Directories",
"description":"Installed data will be distributed across this array of up to 2 directories.",
"type":"array",
"minItems":1,
"maxItems":2,
"items":{
"type":"string",
"minLength":1,
"maxLength":150
}
},
"sourceDir":{
"title":"Source Directory",
"description":"The directory of the source data to be installed.",
"type":"string",
"minLength":1,
"maxLength":150
}
}
}
},
"oneOf":[
{
"$ref":"#/definitions/NCOALink"
}
]
}

Reply Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"type":"object",
"properties":{
"errorCode":{
"type":"integer"
},
"errorMessage":{
"type":"string",
"minLength":1
}
}
}