C1CTYLKx Call Area - Code-1_Plus - 5.0

CODE-1 Plus Reference for all Platforms

Product type
Software
Portfolio
Verify
Product family
Data Quality - Postals
Product
CODE-1 Plus
Version
5.0
Language
English
Product name
CODE-1 Plus
Title
CODE-1 Plus Reference for all Platforms
Copyright
2024
First publish date
1998
ft:lastEdition
2024-05-15
ft:lastPublication
2024-05-15T00:07:55.920704

The following table provides a map of the 14,523-byte C1CTYLKx call area.

Note: iA copybook (CSPRM) for this area is included with your installation in the sample library.

Position

Name

Length

Contents

1-5

CS-PRM-ZIPI

5

Input ZIP Code.

6-105

CS-PRM-CSTI

100

Input city and state.

106

CS-PRM-FNC

1

Input function code. Leave this blank for a match call, set this to E for the final call.

107

CS-PRM-VANITY-CTY

1

Vanity city name flag. If you want C1CTYLKx to return vanity city names, set this to X. Otherwise, when C1CTYLKx matches a vanity city, it will return the primary or secondary city name.

108-117

CS-PRM-DBL

10

Database library name (IBM i specific).

118-150

Reserved

33

 

151

CS-PRM-GRC

1

General return codes for the match attempt:

  • Blank — Match was successful.

  • A — Original ZIP Code was altered to match a single-ZIP city.

  • B — Insufficient information for a match.

  • D — City-state mismatch (different spelling found, or city-state was a vanity name and vanity matching was not allowed, or city-state did not match ZIP Code).

  • E — End of job encountered, so the job was terminated.

  • L — Original ZIP Code was altered to be the lowest ZIP Code of the matched city's ZIP Code range. This is an unreliable answer.

  • M — Multiple matches on city-state.

  • X — CODE-1 Plus master file has expired; processing aborted.

  • Z — ZIP Code not found in the database.

152

CS-PRM-INPUT-ZIP-RC

1

Input ZIP Code return code:

  • Blank — Match was successful.

  • B — Original ZIP Code not valid or blank.

  • Z — ZIP Code not found in database.

153

CS-PRM-OUTPUT-ZIP-RC

1

Output ZIP Code return code:

  • A — Original ZIP Code was altered to match a single-ZIP city.

  • B — Original ZIP Code no good, or blank.

  • C — Original ZIP Code was confirmed.

  • L — Original ZIP Code was altered to be the lowest ZIP Code of the matched city's ZIP Code range. This is an unreliable answer.

  • Z — ZIP Code was not found in the database.

154

CS-PRM-INPUT-CITY-RC

1

Input city return code:

  • Blank — Match was successful.

  • B — Input city was blank, or no match found.

155

CS-PRM-OUTPUT-CITY-RC

1

Output city return code:

  • Blank — Match was successful.

  • B — Input city was blank, or no match found.

  • D — City-state mismatch (different spelling found, or city-state was a vanity name and vanity matching was not allowed, or city-state did not match ZIP Code).

  • M — Multiple matches on city-state.

156-170

Reserved

15

 

171-198

CS-PRM-CITYO

28

Output USPS full city name

199-211

CS-PRM-SHORT-CITYO

13

Output USPS short city name.

212-213

CS-PRM-STATEO

2

Output USPS state abbreviation.

214

CS-PRM-CTYPEO

1

Output city type for the matched city name. One of the following codes is stored:

  • P — Primary

  • S — Secondary

  • V — Vanity

215-220

CS-PRM-FINO

6

Output USPS finance number for the matched city name.

221-226

CS-PRM-LL-LBO

6

USPS last line number for the output city/state/ZIP Code combination.

227-231

CS-PRM-ZIPO

5

Output USPS ZIP Code.

232

CS-PRM-SZIP

1

Indicates whether there is more than one ZIP Code in the input city. If a successful match based on the input ZIP Code is obtained, this code will not be set. One of the following codes is stored:

  • Blank — This city has more than one ZIP Code.

  • S — This city has only a single ZIP Code.

233-235

CS-PRM-NUM-ZIP-ENTRIES

3

Number of ZIP Codes in the output table of ZIP Codes for the input city/state.

The following CSP-ZIP CODE field occurs 999 times.

The previous CS-PRM-NUM-ZIP-ENTRIES field indicates the number of occurrences that are non-blank.

236-240 (1st occurrence)

CSP-ZIP-CODE

5

Output USPS ZIP Code.

5231-5233

CS-PRM-NUM-CITY-ENTRIES

3

Number of cities that are in the output table of cities for the input ZIP Code. The maximum is 150 times.

The following fields occur 150 times.

The previous CS-PRM-NUM-CITY-ENTRIES field indicates the number of occurrences that are non-blank.

5234 (1st occurrence)

CSP-CITYO

28

Output USPS city name.

5262 (1st occurrence)

CSP-SHORT-CITYO

13

Output USPS short city name.

5275 (1st occurrence)

CSP-STATEO

2

Output USPS state name.

5277 (1st occurrence)

CSP-CTYPEO

1

Output city type:

  • P — Primary

  • S — Secondary

  • V — Vanity

5278 (1st occurrence)

CSP-FINO

6

Output USPS finance number.

5284 (1st occurrence)

CSP-LL-LBO

6

Output USPS last line number.

5290 (1st occurrence)

CSP-ZIP-TABLE

5

Output USPS ZIP Code.

14384-14433

Reserved

50

 

The following fields are statistical fields for the audit trail.

14,434 -14,442

CS-PRM-READ-CTY

9

Number of times a read request was made for the cities in a ZIP Code logical file.

14,443 -14,451

CS-PRM-READ-ZPX

9

Number of times a read request was made for the ZIP Codes in a city logical file.

14,452 -14,460

CS-PRM-READ-LCL

9

Number of times a read request was made for the locality street directory logical file.

14,461 - 14,478

Reserved

18

 

14,479 - 14,487

CS-PRM-IO-CTY

9

Number of actual I/O calls that were made to the cities in a ZIP Code logical file.

14,488 - 14,496

CS-PRM-IO-ZPX

9

Number of actual I/O calls that were made to the ZIP Codes in a City logical file.

14,497 - 14,505

CS-PRM-IO-LCL

9

Number of actual I/O calls that were made to the locality street directory logical file.

14,506 - 14,523

Reserved

18