Creates a Qualification Report from a saved presort.
This request generates a qualification report.
This request generates a qualification report for each batch of a batch presort.
{
"$schema":"http://json-schema.org/draft-04/schema#",
"title":"Qualification Report",
"type":"object",
"properties":{
"addressTable":{
"title":"Address Table",
"description":"Group of records used for processing.",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
},
"absoluteContainerNumbers":{
"title":"Absolute Container Numbers",
"description":"Uses continuous container numbers (i.e, does not reset to 1 at the beginning of each stream)",
"default":false,
"type":"boolean"
},
"allBatches":{
"title":"All Batches",
"description":"Sequentially generates output (tags, reports, labels) for all saved presorts associated with the batch presort.",
"default":false,
"type":"boolean"
},
"collate":{
"title":"Collate",
"description":"Collates multiple copies.",
"default":false,
"type":"boolean"
},
"condensed":{
"title":"Condensed",
"description":"Prints a condensed Qualification Report. The condensed report will not display details for Package Destination, Zone Information, Number of Pieces, Sack Level, Sack ZIP®, or the Package Numbers.",
"default":false,
"type":"boolean"
},
"consecutiveBatchNumbers":{
"title":"Consecutive Batch Numbers",
"description":"Maintains the container numbers across all batches in a Batch presort",
"default":false,
"type":"boolean"
},
"containerPieceLimit":{
"title":"Container Piece Limit",
"description":"Specifies the number of pieces within a container to use as a threshold or ceiling.",
"default":null,
"type":"integer",
"minimum":0
},
"containerThreshold":{
"title":"Container Threshhold",
"description":"Specifies how the value specified for the Container Piece Limit value is interpreted. A value of true will treat the Container Piece Limit value as a threshold and a value of false will treat the Container Piece Limit value as a ceiling. The value DEFAULT is interpreted as true.",
"default":false,
"type":"boolean"
},
"copies":{
"title":"Copies",
"description":"Number of copies of the Qualification Report to output.",
"default":1,
"type":"integer",
"minimum":0
},
"defOrder":{
"title":"Def Order",
"description":"Allows a custom DEFORDER.TXT file.",
"default":"",
"type":"string",
"pattern":"^.*\\.(txt)$"
},
"destinationSummaryTotalsOnly":{
"title":"Destination Summary Totals Only",
"description":"Includes a summary at the end of the Qualification Report, listed by destination rather than stream. (Y/N).",
"default":false,
"type":"boolean"
},
"fileName":{
"title":"File Name",
"description":"Path and filename for qualification report output to disk file.",
"default":"",
"type":"string"
},
"fileType":{
"title":"File Type",
"description":"File type for qualification report output to disk file.",
"default":"",
"type":"string",
"enum":[
"TEXT",
"PDF"
],
"enumValues":[
{
"value":"TEXT",
"displayValue":"Text",
"description":"Text"
},
{
"value":"PDF",
"displayValue":"PDF",
"description":"PDF"
}
]
},
"firstContainer":{
"title":"First Container",
"description":"Specifies the first container within the first stream selected. The DEFAULT value will select the first container within the first stream selected.",
"default":1,
"type":"integer",
"minimum":1
},
"fromPage":{
"title":"From Page",
"description":"Page of Qualification Report to begin printing from, when printing a range of pages.",
"default":1,
"type":"integer"
},
"includeBatchCode":{
"title":"Include Batch Code",
"description":"Batch Code data is printed on all presort documentation.",
"default":false,
"type":"boolean"
},
"includeSelectivity":{
"title":"Include Selectivity",
"description":"If the address table was presorted using a selection set, the Selectivity Description is shown in the title area of the Qualification Report.",
"default":false,
"type":"boolean"
},
"lastContainer":{
"title":"Last Container",
"description":"Specifies the last container within the last stream selected. The DEFAULT value will select the last container within the last stream selected. The container number is with respect to the last stream selected.",
"default":null,
"type":"integer",
"minimum":1
},
"mailId":{
"title":"Mail ID",
"description":"Mail ID",
"default":"",
"type":"string"
},
"manifestGrpByRate":{
"title":"Manifest Group by Rate",
"description":"Shows the weight summary for Manifest pieces by rate.",
"default":false,
"type":"boolean"
},
"mppParcelsOnly":{
"title":"MPP Parcels Only",
"description":"Includes only multipiece parcels on the Qualification Report",
"default":false,
"type":"boolean"
},
"news":{
"title":"News",
"description":"Indicates the publication is published weekly or more often and should receive newspaper treatment by the USPS.",
"default":false,
"type":"boolean"
},
"nonProfit":{
"title":"Nonprofit",
"description":"Indicates if the presort qualifies for Nonprofit rates.",
"default":false,
"type":"boolean"
},
"nonSimplifiedOnly":{
"title":"Non Simplified Only",
"description":"Includes only non-simplified containers. Valid only with ECR presorts.",
"default":false,
"type":"boolean"
},
"overwrite":{
"title":"Overwrite",
"description":"Overwrites existing file if the same filename is used",
"default":true,
"type":"boolean"
},
"palletSackOrder":{
"title":"Pallet Sack Order",
"description":"Produces output with records on pallets first, followed by records in sacks.",
"default":false,
"type":"boolean"
},
"pcWt":{
"title":"Piece Weight",
"description":"Mailpiece weight.",
"default":0.0,
"type":"number"
},
"presortName":{
"title":"Presort Name",
"description":"Description of the saved presort file.",
"default":"",
"type":"string"
},
"publicationNumber":{
"title":"Publication Number",
"description":"Publication number for Periodical presorts.",
"default":"",
"type":"string"
},
"publicationTitle":{
"title":"Publication Title",
"description":"Publication title for Periodical presorts",
"default":"",
"type":"string"
},
"simplifiedOnly":{
"title":"Simplified Only",
"description":"Includes only simplified containers. Valid only with ECR presorts.",
"default":false,
"type":"boolean"
},
"streamList":{
"title":"Stream List",
"description":"Mail streams to use for the job. It is displayed as Stream, NDC, NDC Number. The stream name may be specified without a destination or with a destination and ZIP Code™. Additionally, any word of the stream name may be specified as ALL or omitted to indicate that all streams present in the presort, that match other specified criteria, should be selected. When using the command ALL;ALL ALL, presort streams will be processed in the order: Destination (alphabetical) / ZIP (3-digit followed by 5-digit) / Stream (by type).",
"default":"ALL;ALL ALL",
"type":"string"
},
"streamOrder":{
"title":"Stream Order",
"description":"Defines the order streams are output.",
"default":"",
"type":"string",
"enum":[
"CONTAINERS",
"DESTINATION",
"LASTSAVED",
"PIECES",
"STREAM",
"ZIP"
],
"enumValues":[
{
"value":"CONTAINERS",
"displayValue":"Containers",
"description":"Containers"
},
{
"value":"DESTINATION",
"displayValue":"Destination",
"description":"Destination"
},
{
"value":"LASTSAVED",
"displayValue":"Last Saved",
"description":"Last Saved"
},
{
"value":"PIECES",
"displayValue":"Pieces",
"description":"Pieces"
},
{
"value":"STREAM",
"displayValue":"Stream",
"description":"Stream"
},
{
"value":"ZIP",
"displayValue":"ZIP",
"description":"ZIP"
}
]
},
"subset":{
"title":"Filter for creating a subset of the presort",
"description":"Creates a subset of the presorted items for Containers, Pallets, or Streams. Must be prefaced with a single character ((C)ontainers), (P)allets, (S)treams). Containers are either sacks or trays, Pallets are the physical pallets and streams are the presorted streams. May contain multiple values separated by commas. Each value must contain either an integer range specified as 'x-y', or a single integer. (i.e. 'P1-6,10' is pallets 1 thru 6, and 10) If specified the following commands will be ignored: firstContainer, lastContainer and streamList.",
"default":"",
"type":"string",
"pattern":"((C|P|S)\\d+(-\\d+)?(,\\d+(-\\d+)?)*|^$)"
},
"summaryOnly":{
"title":"Summary Only",
"description":"Prints a summary reporting the number of pieces for each rate, but does not print the detailed report.",
"default":false,
"type":"boolean"
},
"toPage":{
"title":"To Page",
"description":"Page of Qualification Report to end printing on, when printing a range of pages.",
"default":1,
"type":"integer"
},
"useCountyTable":{
"title":"Use County Table",
"description":"Calculates In-County rates for Periodicals.",
"default":false,
"type":"boolean"
},
"versionTotalsSummaryOnly":{
"title":"Version Totals Summary Only",
"description":"Prints a summary of totals by version at the end of the Qualification Report.",
"default":false,
"type":"boolean"
},
"walkSequenceTotals":{
"title":"Walk Sequence Totals",
"description":"Prints the Total Active and Total Residential values on the Qualification Report for Walk Sequence sorts.",
"default":false,
"type":"boolean"
}
},
"required":[
"addressTable",
"fileName",
"fileType",
"presortName"
],
"additionalProperties":false
}
