This request encodes an entire table, using the specified selectivity.
{
"$schema":"http://json-schema.org/draft-04/schema#",
"type":"object",
"title":"encodeTable Request",
"description":"Encodes multiple records in an address table to USPS standards, using CASS-certified software.",
"properties":{
"addressTable":{
"title":"Address Table",
"description":"The group of records used for processing.",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
},
"selectivity":{
"title":"Selectivity",
"default":null,
"oneOf":[
{
"description":"Resource item identifying the selectivity to use.",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+|default\\$)$"
},
{
"description":"Indicates that no selectivity is to be used.",
"type":"null"
},
{
"description":"Defines a selectivity to use by its object representation, excluding the 'id' and 'name' properties.",
"type":"object",
"properties":{
"expression":{
"title":"Expression",
"description":"Expression defining the condition that a record must satisfy to be sampled.",
"default":null,
"oneOf":[
{
"type":"string",
"minLength":1
},
{
"type":"null"
}
]
},
"sampleInterval":{
"title":"Interval Sample",
"description":"Interval at which to sample records; if negative, the sample is inverted.",
"default":null,
"oneOf":[
{
"type":"integer"
},
{
"type":"null"
}
]
},
"sampleRandom":{
"title":"Random Sample",
"description":"Probability of a record being sampled at random.",
"default":null,
"oneOf":[
{
"type":"number",
"minimum":0,
"maximum":1
},
{
"type":"null"
}
]
},
"sampleMaximum":{
"title":"Maximum Sample",
"description":"The maximum number of records to be sampled.",
"default":null,
"oneOf":[
{
"type":"integer",
"minimum":0
},
{
"type":"null"
}
]
}
},
"additionalProperties":false
}
]
},
"overwrite":{
"title":"Overwrite",
"description":"Indicates whether or not to overwrite an existing reports file.",
"default":false,
"type":"boolean"
},
"mailerName":{
"title":"Mailer Name",
"description":"Mailer's name printed on PS Form 3553 (CASS Summary Report).",
"type":"string"
},
"mailerAltAddress":{
"title":"Mailer Alternate Address",
"description":"Mailer's Alternate Address printed on PS Form 3553 (CASS Summary Report).",
"type":"string"
},
"mailerAddress":{
"title":"Mailer Address",
"description":"Mailer's Alternate Address printed on PS Form 3553 (CASS Summary Report).",
"type":"string"
},
"mailerCity":{
"title":"Mailer City",
"description":"Mailer's City printed on PS Form 3553 (CASS Summary Report).",
"type":"string"
},
"mailerState":{
"title":"Mailer State",
"description":"Mailer's two-character State printed on PS Form 3553 (CASS Summary Report).",
"type":"string"
},
"mailerZIP":{
"title":"Mailer ZIP Code",
"description":"Mailer's ZIP Code printed on PS Form 3553 (CASS Summary Report).",
"type":"string"
},
"mailerCountry":{
"title":"mailerCountry",
"description":"Mailer's Country printed on PS Form 3553 (CASS Summary Report).",
"type":"string"
},
"reportOutputFolder":{
"title":"Report Output Folder",
"description":"The destination folder for reports generated as the result of encoding.",
"type":"string"
},
"reportFileName":{
"title":"Report File Name",
"description":"Report name, without a file extension.",
"type":"string"
},
"returnCase":{
"title":"Return Case",
"description":"Case of the address information returned as a result of encoding.",
"type":"string",
"enum":[
"UPPER",
"LOWER",
"MIXED",
"AUTO"
],
"enumValues":[
{
"value":"UPPER",
"displayValue":"Upper case",
"description":"Formats text as capital letters."
},
{
"value":"LOWER",
"displayValue":"Lower case",
"description":"Formats text as lowercase letters."
},
{
"value":"MIXED",
"displayValue":"Mixed case",
"description":"Formats text so that the first letter of each word is capitalized."
},
{
"value":"AUTO",
"displayValue":"Auto",
"description":"Returns the encoded address information in the same case as the original data."
}
]
},
"firmAsIs":{
"title":"Firm As-Is",
"description":"Leaves the case of the Company name unchanged during encoding.",
"default":true,
"type":"boolean"
},
"useCapitalizationTable":{
"title":"Use Capitalization Table",
"description":"Entries in the Capitalization Table determine which words remain in all caps when a Mixed Case conversion is performed.",
"default":true,
"type":"boolean"
},
"swapAddressLines":{
"title":"Swap Address Lines",
"description":"Places primary street address in the Delivery Address line; adds secondary address information such as Ste., Apt., etc. to the Secondary Address line.",
"default":true,
"type":"boolean"
},
"standardizeDeliveryAddress":{
"title":"Standardize Delivery Address",
"description":"Converts primary address to postal abbreviation standards.",
"default":true,
"type":"boolean"
},
"standardizeCity":{
"title":"Standardize City",
"description":"Converts city names to postal abbreviation standards.",
"default":true,
"type":"boolean"
},
"abbreviateCity":{
"title":"Abbreviate City",
"description":"Abbreviates city name if it is longer than 13 characters. Nonencoded and non-standardized city names are not abbreviated.",
"default":false,
"type":"boolean"
},
"extendedMatching":{
"title":"Extended Matching",
"description":"Attempts to return an exact match (Return code = 31) by searching for suite/apartment information in the alternate address lines when a default match (Return code = 32) is found.",
"default":true,
"type":"boolean"
},
"hyphenateZIPCode":{
"title":"Hyphenate ZIP Code",
"description":"Includes a hyphen in a 9-digit ZIP Code",
"default":true,
"type":"boolean"
},
"ignoreNonUSPS":{
"title":"Ignore NonUSPS",
"description":"Skips records with non-USPS ZIP codes when encoding. A non-USPS ZIP Code is defined as any of the following: 5-digit or 9-digit ZIP Code with alpha characters or with a length other than 0, 5, or 9-digits; a 5-digit ZIP Code of '99999' or 9-digit ZIP Code of '99999-9999'; invalid or missing data in the State, or a country code other than blank or US.",
"default":false,
"type":"boolean"
},
"standardizeCountry":{
"title":"Standardize Country",
"description":"Converts country names to postal abbreviation standards.",
"default":true,
"type":"boolean"
},
"geoCodeAddress":{
"title":"GeoCode Address",
"description":"Returns the Lattitude and Longitude of the encoded address.",
"default":true,
"type":"boolean"
},
"returnZIP5GeoCodes":{
"title":"Return ZIP5 GeoCodes",
"description":"Returns the Lattitude and Longitude of the encoded address having a 5-digit ZIP Code.",
"default":true,
"type":"boolean"
},
"rdiLookup":{
"title":"RDI Lookup",
"description":"Determines if the address is business or residential.",
"default":false,
"type":"boolean"
},
"addCountryInformation":{
"title":"Add Country information",
"description":"Returns the standardized country name, and two-digit code of the address.",
"default":true,
"type":"boolean"
},
"returnZIP5CheckDigit":{
"title":"Return ZIP5 Check Digit",
"description":"Returns the check digit for the 5-digit ZIP Code, for addresses without the +4 add-on.",
"default":false,
"type":"boolean"
},
"noDPVCMRA":{
"title":"No DPV CMRA",
"description":"Do not perform DPV CMRA lookup. CMRA Provides information about whether or not the address is associated with a Commercial Mail Receiving Agent, such as Mail Boxes Etc.",
"default":false,
"type":"boolean"
},
"noDPVNoStat":{
"title":"No DPV NoStat",
"description":"Returned by the DPV API to more fully describe the results of the DPV lookup. Indicates whether the address is a vacant property, it receives mail as a part of a drop, or it does not have an established delivery yet.",
"default":false,
"type":"boolean"
},
"noDPVVacant":{
"title":"No DPV Vacant",
"description":"Do not perform DPV Vacant lookup. DPV Vacant is returned by the DPV API to more fully describe the results of the DPV lookup. USPS records indicate that although this may be a valid address, the residence or business is vacant.",
"default":false,
"type":"boolean"
},
"abbreviateAddress":{
"title":"Abbreviate Address",
"description":"Abbreviates the returned address whenever possible.",
"default":false,
"type":"boolean"
},
"userCASSCertification":{
"type":"object",
"title":"CASS stage mode",
"description":"Activate to encode in stage mode for certification purposes.",
"required":[
"stageFile"
],
"properties":{
"stageFile":{
"title":"CASS stage file path",
"description":"USPS raw stage file with path.",
"type":"string",
"minLength":1,
"maxLength":150
}
}
},
"ncoaLink":{
"type":"object",
"title":"NCOALink Configuration",
"description":"The configuration for NCOALink.",
"required":[
"ncoaLinkDataPath",
"reportPath",
"licenseeName",
"buyerCompanyName",
"listID",
"listName",
"mailingZIPCode",
"ncoaLinkProductType",
"processingCategory",
"matchingOption",
"resultsReturned",
"outputFolder",
"ncoaLinkMonths",
"classOfMail",
"dateListFromCustomer",
"PAF"
],
"properties":{
"ncoaLinkDataPath":{
"title":"NCOALink Data Path",
"description":"Directory location of NCOALink data.",
"type":"string",
"minLength":1,
"maxLength":150
},
"ncoaLinkAuxDataPath":{
"title":"NCOALink Auxiliary Path",
"description":"Directory location of auxiliary data(if applicable).",
"type":"string",
"minLength":1,
"maxLength":150
},
"reportPath":{
"title":"Report Path",
"description":"Directory where the USPS NCOALink logs are saved.",
"type":"string",
"minLength":1,
"maxLength":150
},
"licenseeName":{
"title":"Licensee Name",
"description":"NCOALink licensee name.",
"type":"string",
"minLength":1,
"maxLength":150
},
"buyerCompanyName":{
"title":"Buyer Company Name",
"description":"Name of the company purchasing the list.",
"type":"string",
"minLength":1,
"maxLength":150
},
"operatorID":{
"title":"Operator ID",
"description":"Identification code for the operator processing the list.",
"type":"string",
"minLength":1,
"maxLength":50
},
"listID":{
"title":"List ID",
"description":"Identification code for the list.",
"type":"string",
"minLength":1,
"maxLength":50
},
"listName":{
"title":"List Name",
"description":"List name.",
"type":"string",
"minLength":1,
"maxLength":50
},
"mailingZIPCode":{
"title":"Mailing ZIP Code",
"description":"ZIP Code of business or post office for mail submission.",
"type":"string",
"minLength":5,
"maxLength":10
},
"ncoaLinkProductType":{
"title":"Product Type",
"description":"NCOALink license type for processing.",
"type":"string",
"enum":[
"FSP",
"LSP",
"LSPANK",
"EU",
"EUANK"
],
"enumValues":[
{
"value":"FSP",
"displayValue":"FSP",
"description":"Full Service Provider license."
},
{
"value":"LSP",
"displayValue":"LSP",
"description":"Limited Service Provider license."
},
{
"value":"LSPANK",
"displayValue":"LSPANK",
"description":"Limited Service Provider with ANK Link."
},
{
"value":"EU",
"displayValue":"EU",
"description":"End User license."
},
{
"value":"EUANK",
"displayValue":"EUANK",
"description":"End User license with ANK Link."
}
]
},
"processingCategory":{
"title":"Processing Category",
"description":"NCOALink processing category.",
"type":"string",
"enum":[
"EMPLOYEE TRAINING",
"INTERNAL DATABASE TEST",
"MARKETING TEST",
"NORMAL",
"STAGE I",
"STAGE II",
"SYSTEM TEST"
],
"enumValues":[
{
"value":"EMPLOYEE TRAINING",
"displayValue":"Employee Training",
"description":"Employee training category, Results are discarded; data updates are not performed."
},
{
"value":"INTERNAL DATABASE TEST",
"displayValue":"Internal Database Test",
"description":"Category for testing proprietary licensee database. Results are discarded; data updates are not performed."
},
{
"value":"MARKETING TEST",
"displayValue":"Marketing Test",
"description":"Category for testing external customer lists. Results are discarded; data updates are not performed."
},
{
"value":"NORMAL",
"displayValue":"NORMAL",
"description":"Normal NCOALink processing."
},
{
"value":"STAGE I",
"displayValue":"Stage I",
"description":"Process the Stage I file received from USPS."
},
{
"value":"STAGE II",
"displayValue":"Stage II",
"description":"Process the Stage II file received from USPS."
},
{
"value":"SYSTEM TEST",
"displayValue":"System Test",
"description":"Category for system testing. Results are discarded; data updates are not performed."
}
]
},
"matchingOption":{
"title":"Matching Option",
"description":"Move types to lookup.",
"type":"string",
"enum":[
"STANDARD",
"BUSINESS",
"INDIVIDUAL",
"INDIVIDUAL AND BUSINESS",
"RESIDENTIAL"
],
"enumValues":[
{
"value":"STANDARD",
"displayValue":"Standard",
"description":"Returns all move types."
},
{
"value":"BUSINESS",
"displayValue":"Business",
"description":"Returns only business moves."
},
{
"value":"INDIVIDUAL",
"displayValue":"Individual",
"description":"Returns only individual moves."
},
{
"value":"INDIVIDUAL AND BUSINESS",
"displayValue":"Individual and Business",
"description":"Returns individual and business moves."
},
{
"value":"RESIDENTIAL",
"displayValue":"Residential",
"description":"Returns only residential moves."
}
]
},
"resultsReturned":{
"title":"Results Returned",
"description":"Specify the type of results needed from the NCOALink lookup.",
"type":"string",
"enum":[
"COA DATA",
"FOOTNOTES",
"FOOTNOTES AND STATISTICS",
"STATISTICS"
],
"enumValues":[
{
"value":"COA DATA",
"displayValue":"COA Data",
"description":"Returns change of address data."
},
{
"value":"FOOTNOTES",
"displayValue":"Footnotes",
"description":"Returns only footnotes."
},
{
"value":"FOOTNOTES AND STATISTICS",
"displayValue":"Footnotes and Statistics",
"description":"Returns footnotes along with statistics."
},
{
"value":"STATISTICS",
"displayValue":"Statistics",
"description":"Returns only statistics."
}
]
},
"outputFolder":{
"title":"Output Folder",
"description":"Directory where the processing summary report is saved.",
"type":"string",
"minLength":1,
"maxLength":150
},
"logFolder":{
"title":"Log Folder",
"description":"Directory where the NCOALink log is saved.",
"type":"string",
"minLength":1,
"maxLength":150
},
"ncoaLinkMonths":{
"title":"NCOALink Months",
"description":"Number of months for NCOALink lookup.",
"type":"integer",
"minimum":6,
"maximum":48
},
"classOfMail":{
"title":"Class Of Mail",
"description":"Class/type of mail in the list.",
"type":"string",
"enum":[
"A",
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J",
"K",
"L",
"M",
"N",
"O"
],
"enumValues":[
{
"value":"A",
"displayValue":"A",
"description":"First-Class Mail."
},
{
"value":"B",
"displayValue":"B",
"description":"Periodicals."
},
{
"value":"C",
"displayValue":"C",
"description":"Standard Mail."
},
{
"value":"D",
"displayValue":"D",
"description":"Package Services."
},
{
"value":"E",
"displayValue":"E",
"description":"First-Class Mail and Periodicals."
},
{
"value":"F",
"displayValue":"F",
"description":"First-Class Mail and Standard Mail."
},
{
"value":"G",
"displayValue":"G",
"description":"First-Class Mail and Package Services."
},
{
"value":"H",
"displayValue":"H",
"description":"Periodicals and Standard Mail."
},
{
"value":"I",
"displayValue":"I",
"description":"Periodicals and Package Services."
},
{
"value":"J",
"displayValue":"J",
"description":"Standard Mail and Package Services."
},
{
"value":"K",
"displayValue":"K",
"description":"First-Class Mail, Periodicals and Standard Mail."
},
{
"value":"L",
"displayValue":"L",
"description":"First-Class Mail, Periodicals and Package Services."
},
{
"value":"M",
"displayValue":"M",
"description":"First-Class Mail, Standard Mail and Package Services."
},
{
"value":"N",
"displayValue":"N",
"description":"Periodicals, Standard Mail and Package Services."
},
{
"value":"O",
"displayValue":"O",
"description":"First-Class Mail, Periodicals, Standard Mail and Package Services."
}
]
},
"preProcessesPerformed":{
"title":"Pre-Processes Performed",
"description":"Indicator for pre-processing the address.",
"type":"string",
"default":"N",
"enum":[
"N",
"Y",
"D",
"P",
"B"
],
"enumValues":[
{
"value":"N",
"displayValue":"N",
"description":"No pre-processing."
},
{
"value":"Y",
"displayValue":"Y",
"description":"Pre-processing without data modifications."
},
{
"value":"D",
"displayValue":"D",
"description":"Pre-processing with data modifications from sources other than postal data."
},
{
"value":"P",
"displayValue":"P",
"description":"Pre-processing with data modifications from postal data."
},
{
"value":"B",
"displayValue":"B",
"description":"Pre-processing with data modifications from postal data and other data sources."
}
]
},
"concurrentProcessesPerformed":{
"title":"Concurrent Processes Performed",
"description":"Indicator for concurrent processing on an address.",
"type":"string",
"default":"P",
"enum":[
"N",
"Y",
"D",
"P",
"B"
],
"enumValues":[
{
"value":"N",
"displayValue":"N",
"description":"No Concurrent processing."
},
{
"value":"Y",
"displayValue":"Y",
"description":"Concurrent processing without data modifications."
},
{
"value":"D",
"displayValue":"D",
"description":"Concurrent processing with data modifications from sources other than postal data."
},
{
"value":"P",
"displayValue":"P",
"description":"Concurrent processing with data modifications from postal data."
},
{
"value":"B",
"displayValue":"B",
"description":"Concurrent processing with data modifications from postal data and other data sources."
}
]
},
"postProcessesPerformed":{
"title":"Post Processes Performed",
"description":"Indicator for post processing on an address.",
"type":"string",
"default":"N",
"enum":[
"N",
"Y",
"D",
"P",
"B"
],
"enumValues":[
{
"value":"N",
"displayValue":"N",
"description":"No post processing."
},
{
"value":"Y",
"displayValue":"Y",
"description":"Post processing without data modifications."
},
{
"value":"D",
"displayValue":"D",
"description":"Post processing with data modifications from sources other than postal data."
},
{
"value":"P",
"displayValue":"P",
"description":"Post processing with data modifications from postal data."
},
{
"value":"B",
"displayValue":"B",
"description":"Post processing with data modifications from postal data and other data sources."
}
]
},
"dateListFromCustomer":{
"title":"Date List Received From Customer",
"description":"Date on which the list was received from the customer in mm/dd/yy format.",
"type":"string",
"minLength":8,
"maxLength":8,
"pattern":"^[0-9]{2}\/[0-9]{2}\/[0-9]{2}$"
},
"standardOutputReturned":{
"title":"Standard Output Returned",
"description":"Type of standard output to be returned.",
"type":"string",
"default":"Y",
"enum":[
"Y",
"N",
"B"
],
"enumValues":[
{
"value":"Y",
"displayValue":"Y",
"description":"NCOALink output."
},
{
"value":"N",
"displayValue":"N",
"description":"Post-process output."
},
{
"value":"B",
"displayValue":"B",
"description":"Post-process along with the required output data."
}
]
},
"PAF":{
"type":"object",
"title":"PAF Configuration",
"description":"The PAF configuration for NCOALink.",
"required":[
"PAFLicenseePlatformID",
"PAFMailOwnerNAICS",
"PAFFrequencyOfProcessing",
"PAFListID",
"PAFCompanyName",
"PAFAddress",
"PAFCity",
"PAFState",
"PAFZIPCode",
"PAFPlus4Code",
"PAFTelephoneNumber",
"PAFNameOfPersonSigning",
"PAFTitleOfPersonSigning",
"PAFDateSignedByCustomer",
"PAFType",
"PAFListName",
"PAFParentCompanyName",
"PAFDateSignedByLicensee"
],
"dependencies":{
"PAFBrokerAgentListID":[
"PAFBrokerAgentNAICS",
"PAFDateSignedByBroker",
"balaCompanyName",
"balaAddress",
"balaCity",
"balaState",
"balaZIPCode",
"balaPlus4Code",
"balaTelephoneNumber",
"balaType"
],
"PAFListAdministratorListID":[
"PAFListAdministratorNAICS",
"PAFDateSignedByListAdministrator",
"balaCompanyName",
"balaAddress",
"balaCity",
"balaState",
"balaZIPCode",
"balaPlus4Code",
"balaTelephoneNumber",
"balaType"
]
},
"properties":{
"PAFLicenseePlatformID":{
"title":"PAF Licensee Platform ID",
"description":"PAF licensee platform ID received from post office.",
"type":"string",
"minLength":4,
"maxLength":4
},
"PAFMailOwnerNAICS":{
"title":"PAF Mail Owner NAICS",
"description":"PAF mail owner's NAICS code.",
"type":"string",
"minLength":6,
"maxLength":6
},
"PAFFrequencyOfProcessing":{
"title":"PAF Frequency of Processing",
"description":"PAF processing frequency.",
"type":"string",
"pattern":"^[0-9]{2}$"
},
"PAFListID":{
"title":"PAF List ID",
"description":"PAF list ID.",
"type":"string",
"minLength":6,
"maxLength":6
},
"PAFCompanyName":{
"title":"PAF Company Name",
"description":"PAF owner's company name.",
"type":"string",
"minLength":1,
"maxLength":50
},
"PAFAddress":{
"title":"PAF Address",
"description":"PAF owner's address.",
"type":"string",
"minLength":1,
"maxLength":50
},
"PAFCity":{
"title":"PAF City",
"description":"PAF owner's city name.",
"type":"string",
"minLength":1,
"maxLength":28
},
"PAFState":{
"title":"PAF State",
"description":"PAF owner's state abbreviation.",
"type":"string",
"minLength":2,
"maxLength":2
},
"PAFZIPCode":{
"title":"PAF ZIP Code",
"description":"PAF owner's 5-digit ZIP Code.",
"type":"string",
"minLength":5,
"maxLength":5
},
"PAFPlus4Code":{
"title":"PAF Plus4 Code",
"description":"PAF owner' ZIP+4 Code.",
"type":"string",
"minLength":4,
"maxLength":4
},
"PAFTelephoneNumber":{
"title":"PAF Telephone Number",
"description":"PAF owner's telephone number.",
"type":"string",
"minLength":10,
"maxLength":10
},
"PAFNameOfPersonSigning":{
"title":"PAF Name of Person Signing",
"description":"Name of the person signing the PAF.",
"type":"string",
"minLength":1,
"maxLength":50
},
"PAFTitleOfPersonSigning":{
"title":"PAF Title of Person Signing",
"description":"Title of the person signing the PAF.",
"type":"string",
"minLength":1,
"maxLength":50
},
"PAFDateSignedByCustomer":{
"title":"PAF Date Signed By Customer",
"description":"Date PAF was signed by the customer in mm/dd/yy format.",
"type":"string",
"minLength":8,
"maxLength":8,
"pattern":"^[0-9]{2}\/[0-9]{2}\/[0-9]{2}$"
},
"PAFType":{
"title":"PAF Type",
"description":"Type of PAF record.",
"type":"string",
"enum":[
"I",
"R",
"M"
],
"enumValues":[
{
"value":"I",
"displayValue":"I",
"description":"Individual PAF."
},
{
"value":"R",
"displayValue":"R",
"description":"Renewal of PAF."
},
{
"value":"M",
"displayValue":"M",
"description":"Modification in PAF."
}
]
},
"PAFListName":{
"title":"PAF List Name",
"description":"PAF list name.",
"type":"string",
"minLength":1,
"maxLength":30
},
"PAFMailerID":{
"title":"PAF Mailer ID",
"description":"PAF owner's mailer ID",
"type":"string",
"minLength":1,
"maxLength":15
},
"PAFParentCompanyName":{
"title":"PAF Parent Company Name",
"description":"PAF owner's parent company name.",
"type":"string",
"minLength":1,
"maxLength":50
},
"PAFAlternateCompanyName":{
"title":"PAF Alternate Company Name",
"description":"PAF owner's alternate company name.",
"type":"string",
"minLength":1,
"maxLength":50
},
"PAFBrokerAgentListID":{
"title":"PAF Broker Agent List ID",
"description":"PAF owner's broker agent list ID.",
"type":"string",
"minLength":6,
"maxLength":6
},
"PAFBrokerAgentNAICS":{
"title":"PAF Broker Agent NAICS code",
"description":"PAF owner's broker agent NAICS code.",
"type":"string",
"minLength":6,
"maxLength":6
},
"PAFDateSignedByBroker":{
"title":"PAF Date Signed By Broker",
"description":"Date PAF was signed by the broker in mm/dd/yy format.",
"type":"string",
"minLength":8,
"maxLength":8,
"pattern":"^[0-9]{2}\/[0-9]{2}\/[0-9]{2}$"
},
"PAFListAdministratorListID":{
"title":"PAF List Administrator List ID",
"description":"PAF list owner's list ID.",
"type":"string",
"minLength":6,
"maxLength":6
},
"PAFListAdministratorNAICS":{
"title":"PAF List Administrator NAICS code",
"description":"PAF list owner's NAICS code.",
"type":"string",
"minLength":6,
"maxLength":6
},
"PAFDateSignedByListAdministrator":{
"title":"PAF Date Signed By List Administrator",
"description":"Date PAF was signed by list administrator in mm/dd/yy format.",
"type":"string",
"minLength":8,
"maxLength":8,
"pattern":"^[0-9]{2}\/[0-9]{2}\/[0-9]{2}$"
},
"PAFDateSignedByLicensee":{
"title":"PAF Date Signed By Licensee",
"description":"Date PAF was signed by the licensee in mm/dd/yy format.",
"type":"string",
"minLength":8,
"maxLength":8,
"pattern":"^[0-9]{2}\/[0-9]{2}\/[0-9]{2}$"
},
"PAFEmailOfPersonSigning":{
"title":"PAF Email Of Person Signing",
"description":"The e-mail address of the person signing the PAF.",
"type":"string",
"minLength":1,
"maxLength":64
},
"PAFCompanyWebsite":{
"title":"PAF Company Website",
"description":"PAF owner's company website.",
"type":"string",
"minLength":1,
"maxLength":40
},
"PAFAlternateIndicator":{
"title":"PAF Alternate Indicator",
"description":"PAF Alternate Indicator.",
"type":"string",
"minLength":1,
"maxLength":1
},
"PAFCooperativeDatabaseIndicator":{
"title":"PAF Cooperative Database Indicator",
"description":"PAF Cooperative Database Indicator.",
"type":"string",
"minLength":1,
"maxLength":1
},
"balaCompanyName":{
"title":"BALA CompanyName",
"description":"Broker agent/list administrator company name.",
"type":"string",
"minLength":1,
"maxLength":50
},
"balaAddress":{
"title":"BALA Address",
"description":"Broker agent/list administrator address.",
"type":"string",
"minLength":1,
"maxLength":50
},
"balaCity":{
"title":"BALA City",
"description":"Broker agent/list administrator city.",
"type":"string",
"minLength":1,
"maxLength":28
},
"balaState":{
"title":"BALA State",
"description":"Broker agent/list administrator state abbreviation.",
"type":"string",
"minLength":2,
"maxLength":2
},
"balaZIPCode":{
"title":"BALA ZIP Code",
"description":"Broker agent/list administrator ZIP code.",
"type":"string",
"minLength":5,
"maxLength":5
},
"balaPlus4Code":{
"title":"BALA Plus4 Code",
"description":"Broker agent/list administrator ZIP+4 code.",
"type":"string",
"minLength":4,
"maxLength":4
},
"balaTelephoneNumber":{
"title":"BALA Telephone Number",
"description":"Broker agent/list administrator telephone number.",
"type":"string",
"minLength":10,
"maxLength":10
},
"balaType":{
"title":"BALA Type",
"description":"Type of BALA.",
"type":"string",
"enum":[
"B",
"L"
],
"enumValues":[
{
"value":"B",
"displayValue":"B",
"description":"Broker Agent."
},
{
"value":"L",
"displayValue":"L",
"description":"List Administrator."
}
]
},
"balaCompanyWebsite":{
"title":"BALA Company Website",
"description":"Broker agent/list administrator company website.",
"type":"string",
"minLength":1,
"maxLength":40
}
}
},
"ncoaLinkLogEnabled":{
"title":"NCOALink Log Enabled",
"description":"Enable/disable the NCOALink lookup log.",
"type":"boolean",
"default":false
}
},
"additionalProperties":false
},
"generateStageOutput":{
"type":"object",
"title":"Generate stage output file",
"description":"Generate a USPS approved stage file format output file.",
"required":[
"stageFileName",
"outputFileFolder"
],
"properties":{
"stageFileName":{
"title":"NCOALink Stage file path and name",
"description":"USPS NCOALink raw stage file name with full path.",
"type":"string",
"minLength":1,
"maxLength":150
},
"outputFileFolder":{
"title":"NCOALink stage output folder path",
"description":"Output folder path for the NCOALink stage answer file.",
"type":"string",
"minLength":1,
"maxLength":150
}
}
}
},
"additionalProperties":false,
"oneOf":[
{
"required":[
"addressTable"
]
},
{
"required":[
"generateStageOutput"
]
}
]
}
