APPENDIX 19: WORK AREA LAYOUTS (COWs)

Character-Only Work Areas

(as of Geosupport System Software Version 9.7.0)

This appendix contains layouts of all of the work areas used with the Geosupport System’s API. These layouts are current as of the Geosupport software version indicated above. The layouts are in the Character-Only Work Area format4

Some Geosupport functions can only be called using one work area, Work Area 1 (WA1). Other functions can be called using two work areas, WA1 and Work Area 2 (WA2). WA1 contains both input fields (fields used to pass data from the application to Geosupport) and output fields (fields used to pass data from Geosupport to the application). WA1 is organized so that all the input fields occur first, followed by all the output fields. WA2 contains output fields only.

All functions use the same WA1 layout, but the set of WA1 fields that are used depends on the function. In the layout of WA1 in this appendix, the column labeled ‘Functions’ indicates which functions use each field.

The functions that can be called using two work areas use various WA2 layouts of various lengths. In some cases, several functions share a single WA2 layout. For functions 1A and BL, the user has a choice of two WA2 layouts, a ‘regular’ WA2 and a ‘long’ WA2.

The following is a list of all of the Geosupport work areas, indicating the length of each in bytes. Functions that are listed together share a single Work Area 2 layout.

Work Area Length
WA1, all functions 1200
WA2, Function 1 300
Regular WA2, Functions 1A, BL, BN 1,363
Long WA2, Functions 1A and BL 17,750
WA2, Function 1E 300
WA2, Function 2 200
WA2, Function 3 450
WA2, Function 3C 300
WA2, Function 3S 19,274

Appendix 3 consists of a data item dictionary describing the fields that occur in the work areas.

Work Area 1 (COW) - All Functions

Field Size Position Functions5
INPUT FIELDS:
Geosupport Function Code 2 1 2 All
House Number - Display Format (HND) 16 3 18 1, 1A, 1E
House Number - Sort Format (HNS) 11 19 29 1, 1A, 1E, D *
Low House Number - Display Format (HND) 16 30 45 Internal Use
Low House Number - Sort Format (HNS) 2 1 2 All
Geosupport Function Code 11 46 56 D* , Internal Use
Borough Code-1 1 57 57 All but BL & BN
10SC 6-1 10 58 67 All but BL & BN
Street Name-1 32 68 99 All but BL,BN & D *
Borough Code7-2 1 100 100 All but 1* & B*
10SC-2 10 101 110 All but 1* & B*
Street Name-2 32 111 142 All but 1* & B*
Borough Code-3 1 143 143 D* , 3*
10SC-3 10 144 153 D* , 3*
Street Name-3 32 154 185 D* , 3*
BOROUGH BLOCK LOT (BBL) 11 186 196 BL
Borough Code 1 186 186 BL
Tax Block 5 187 191 BL
Tax Lot 4 192 195 BL
Filler for Tax Lot Version Number 1 196 196 Not Implemented
Building Identification Number (BIN) 7 197 203 BN
Compass Direction 1 204 204 2, 3C, 3S
Compass Direction for 2nd Intersection 1 205 205 3S
Filler 7 206 212
Work Area Format Indicator8 1 213 213 All
Filler 101 214 314
Long Work Area 2 Flag9 1 315 315 1A, BL
House Number Justification Flag10 1 316 316 Not Implemented
House Number Normalization Length11 2 317 318 Not Implemented
House Number Normalization Override Flag 1 319 319 Internal Use
Street Name Normalization Length Limit 2 320 321 All
Street Name Normalization Format Flag12 1 322 322 All
Cross Street Names Flag13 1 323 323 1, 1E, 2, 3, 3C
Filler 37 324 360
OUTPUT Fields:
First Borough Name 9 361 369 All but D*
First Borough Name 9 361 369 All but D*
House Number - Sort Format 11 386 396 1, 1A, 1E
B10SC - First Borough and Street Code 11 397 407 1* , 2, 3*
First Street Name Normalized 32 408 439 All but B*
B10SC - Second Borough and Street Code 11 440 450 2,3*
Second Street Name Normalized 32 451 482 2,3* ,D*
B10SC - Third Borough and Street Code 11 483 583 3*
Third Street Name Normalized 32 494 525 3* ,D*
BOROUGH BLOCK LOT (BBL) 10 526 535 BL
Borough Code 1 526 526 BL
Tax Block 5 527 535 BL
Tax Lot 4 532 535 BL
Filler for Tax Lot Version Number 1 536 536 Not Implemented
Low House Number - Display Format 16 537 552 Internal Use
Low House Number - Sort Format 11 553 563 Internal Use
Building Identification Number 7 564 570 1, 1E, BN
Attribute Bytes - Internal Use Only 3 571 573 Internal Use
Filler 132 574 705
NIN14 6 706 711 Not Implemented
Street Attribute Indicator 1 712 712 Internal Use
Reason Code 1 713 713 All
Reason Code Qualifier 1 714 714 Not Implemented
Filler 2 715 716
Geosupport Return Code 2 717 718 All
Message 80 719 798 All
Number of Street Codes and Names in List (up to 10) 2 799 800 1* ,2,3*
10 B7SC's 80 801 880 1* ,2,3*
List of Street Names(10 Street Name Fields, 32 Bytes Each) 320 881 660 1* ,2,3*

1* = 1, 1A, 1E, 1N
3* = 3, 3C, 3S
B* = BL, BN
D* = D, DG, DN

Work Area 2 (COW) - Functions 1 and 1E

Blockface Defined by Address Range Along a Street
Field Size Position Comments
Internal Use 21 1 21
Continuous Parity Indicator/Duplicate Address Indicator 1 22 22
Low House Number of Block face-Sort Format 11 23 33
High House Number of Block face-Sort Format 11 34 44
DCP Preferred LGC15 2 45 46
Number of Cross Streets at Low Address End 1 47 47
List of Cross Streets at Low Address End (Up to 5 B5SCs) 30 48 77 B5SC - Blank-Filled
Number of Cross Streets at High Address End 1 78 78
List of Cross Streets at High Address End (Up to 5 B5SCs) 30 79 108 B5SC - Blank-Filled
LION KEY 10 109 118
Borough Code 1 109 109
Face Code 4 110 113
Sequence Number 5 114 118
Special Address Generated Record Flag 1 119 119
Side of Street Indicator 1 120 120
Segment Length in Feet 5 121 125
Spatial Coordinates of Address:
X Coordinate 7 126 132
Y Coordinate 7 133 139
Reserved for Possible Z Coordinate 7 140 146
Interim Assistance Eligibility Indicator
Also known as Community Development Eligibility Indicator
1 147 147
Marble Hill/Rikers Island Alternative Borough Flag 1 148 148
DOT Street Light Contractor Area 1 149 149
Community District: 3 150 152
Community District Borough Code 1 150 150
Community District Number 2 151 152
Zip Code 14 158 171
Function 1E Items 14 158 171 Use ONLY for Function 1E
Election District 3 158 160 Invalid for Fn 1
Assembly District 2 161 162 Invalid for Fn 1
Split Election District Flag 1 163 163 Invalid for Fn 1
Congressional District 2 164 165 Invalid for Fn 1
State Senatorial District 2 166 167 Invalid for Fn 1
Civil Court District 2 168 169 Invalid for Fn 1
City Council District 2 170 171 Invalid for Fn 1
Health Center District 2 172 173
Health Area 4 174 177
Sanitation District 3 178 180
Sanitation Collection Scheduling Section and Subsection 2 181 182
Sanitation Regular Collection Schedule 5 183 187
Sanitation Recycling Collection Schedule 3 188 190
Police Patrol Borough Command 1 191 191
Police Precinct 3 192 194
Fire Division 2 195 196
Fire Battalion 2 197 198
Fire Company Type 1 199 199
Fire Company Number 3 200 202
Split Community School District Flag 1 203 203
Community School District 2 204 205
Dynamic Block 3 206 208
Instructional Region 2 209 210
Feature Type Code 1 211 211
Filler 6 212 217
1990 Census Tract 6 218 223
2000 Census Tract 6 224 229
2000 Census Block 4 230 233
Filler 51 234 284
Underlying B7SC 8 285 292
Segment Identifier 7 293 299
Curve Flag 1 300 300

Work Area 2 (COW) - Functions 1A, BL and BN

Property Defined by Address, BBL, or BIN
Field Size Position Comment
Internal Use 21 1 21
Continuous Parity Indicator /Duplicate Address Indicator 1 22 22
Low House Number of Defining Address Range 11 23 33 Sort Format
Borough-Tax Block-Tax Lot (BBL): 10 34 44 Billing BBL if Condo
Borough Code 10 34 44
Tax Block 5 35 39
Tax Lot 4 40 43
Filler for Tax Lot Version Number 1 44 44 Not Implemented
RPAD Self-Check Code (SCC) for BBL 1 45 45
Filler 1 46 46
RPAD Building Classification Code 2 47 48
Corner Code 2 49 50
Number of Existing Structures on Lot 4 51 54
Number of Street Frontages of Lot 2 55 56
Interior Lot Flag 1 57 57
Vacant Lot Flag 1 58 58
Irregularly-Shaped Lot Flag 1 59 59
Marble Hill/Rikers Island Alternate Borough Flag 1 60 60
List of Geographic Identifiers Overflow Flag 1 61 61 When = 'E', there are more than 21 addresses for Fns 1A and BL.
STROLLING KEY: 19 62 80 Not Implemented
Borough 1 62 62
5-Digit Street Code of ‘ON’ Street 5 63 67
Side of Street Indicator 1 68 68
High House Number 11 69 79 Sort Format
Filler 1 80 80
Reserved for Internal Use 1 81 81
Building Identification Number (BIN) of Input Address or NAP 1 82 88
Condominium Flag 1 89 89 If condo, Flag = C
Filler 1 90 90
DOF Condominium Identification Number 4 91 94
Condominium Unit ID Number 7 95 101 Not Implemented
Condominium Billing BBL 10 102 111
Tax Lot Version Number for Billing BBL 1 112 112 Not Implemented
Self-Check Code (SCC) of Billing BBL 1 113 113
Low BBL of this Building’s Condominium Units 10 114 123
Tax Lot Version Number of Low BBL 1 124 124 Not Implemented
High BBL of this Building’s Condominium Units 10 125 134 Not Implemented
Tax Log Version Number of High BBL 1 135 135
Filler 15 136 150
Cooperative ID Number 4 151 154
SBVP (Sanborn Map Identifier): 8 155 162
Sanborn Borough Code 1 155 155
Volume Number 2 156 157
Volume Number Suffix 1 158 158
Page Number 3 159 161
Page Number Suffix 1 162 162
DCP Commercial Study Area 5 163 167
Tax Map Number Section & Volume 5 168 172
Reserved for Tax Map Page Number 4 173 176 Not Implemented
Multiple BBL Flag 1 177 177 These fields will be used with Multiple Entity NAPs
Next BBL 11 178 188
Previous BBL 11 189 199
Spatial Coordinates of Internal Label Point:
X Coordinate 7 200 206
Y Coordinate 7 207 213
Filler 25 214 238
Internal Use 8 239 246
Number of Entries in List of Geographic Identifiers 4 247 250
List of Geographic Identifiers: 1,113 251 1,363
Variable length list of 53-byte entries as follows:
Low House Number 16 Display format(HND)
High House Number 16 Display format(HND)
Borough Code 1
5-Digit Street Code 5
DCP-Preferred Local Group Code (LGC) 2
Building Identification Number 7
Side of Street Indicator 1
Geographic Identifier 1
L - Left, R - Right
N - NAP
G - Generic NAP
X - Part of Generic NAP
B - NAUB
F - Frontage
W - Blank Wall
Q - PseudoAddress
V - Vanity Address
R - Real Street
O - Out-of-Sequence Address
Blank - Normal Filler

Long Work Area 2 (COW) - Functions 1A and BL

Property Defined by Address or BBL
Field Size Position Comment
Same as Regular Work Area 2 - Functions 1A/BL 246 1 246
Number of Buildings on Tax Lot 4 247 250
List of Buildings on Tax Lot 17,500 251 17,750
Variable length list of up to 2,500 entries,
each entry is a 7-byte BIN
7

Work Area 2 (COW) - Function 2

Intersection Defined by Two Intersecting Streets
Field Size Position Comment
Internal Use 21 1 21
Intersection Replication Counter 1 22 22
DCP-Preferred LGC for Street 1 2 23 24
DCP-Preferred LGC for Street 2 2 25 26
Number of Intersecting Streets 1 27 27
List of Intersecting Streets
(Up to five B5SCs, 6 bytes each)
30 28 57
Compass Direction for Intersection Key or
Counter for Multiple Intersections
1 58 58
FillerL 5 59 63
LION Node Number 7 64 70
Spatial Coordinates: 21
X Coordinate 7 71 77
Y Coordinate 7 78 84
Filler 7 85 91
SBVP1 (Sanborn Map Identifier): 8
Borough Code 1 92 92
Volume Number 2 93 94
Volume Number Suffix 1 95 95
Page Number 3 96 98
Page Number Suffix 1 99 99
SBVP2 (Sanborn Map Identifier): 8
Borough Code 1 100 100
Volume Number 2 101 102
Volume Number Suffix 1 103 103
Page Number 3 104 106
Page Number Suffix 1 107 107
Marble Hill/Rikers Island Alternative Borough Flag 1 108 108
DOT Street Light Contractor Area 1 109 109
Community District: 3
Community District Borough Code 1 110 110
Community District Number 2 111 112
Zip Code 5 113 117
Health Area 4 118 121
Police Patrol Borough Command 1 122 122
Fire Division 2 126 127
Fire Battalion 2 128 129
Fire Company Type 1 130 130
Fire Company Number 3 131 133
Community School District 2 134 135
2000 Census Tract 6 136 141
1990 Census Tract 6 142 147
List of Pairs of Level Codes 10 148 157 Not Implemented
Instructional Region 2 158 159
Filler 41 160 200

Work Area 2 (COW) - Function 3

Street Segment Defined by 'ON' Street and Two Cross Streets
Field Size Position Comment
Internal Use 21 1 21
Duplicate Key Flag or Continuous Parity 1 22 22
Locational Status of Segment 1 23 23
County Boundary Indicator 1 24 24
DCP-Preferred LGC for Street 1 2 25 26
DCP-Preferred LGC for Street 2 2 27 28
DCP-Preferred LGC for Street 3 29 30
Number of Cross Streets at Low Address End 1 31 31
List of Cross Streets at Low Address End
(Up to five B5SCs, 6 bytes each)
30 32 61 Blank Filled
Number of Cross Streets at High Address End 1 62 62
List of Cross Streets at High Address End
(Up to five B5SCs, 6 bytes each)
30 63 92 Blank Filled
Cross Street Reversal Flag 1 93 93
LION KEY 10 94 103
LION Borough Code 1 94 94
LION Face Code 4 95 98
LION Sequence Number 5 99 103
Generated Record Flag 1 104 104
Length of Segment in Feet 5 105 109
Segment Azimuth 3 110 112
Segment Orientation 1 113 113
Marble Hill/Rikers Island Alternative Borough Flag 1 114 114
Filler 19 115 133
Segment Identifier 7 134 140
DOT Street Light Contractor Area 1 141 141
Curve Flag 1 142 142
Dog Leg Flag 1 143 143
Feature Type Code 1 144 144
Filler 6 145 150
LEFT SIDE:
Community District: 3
Community District Borough Code 1 151 151
Community District Number 2 152 153
Low House Number 16 154 169 Display Format
High House Number 16 170 185 Display Format
Reserved for Geosupport Use 32 186 217
Interim Assistance Eligibility Indicator 1 218 218
Zip Code 5 219 223
Health Area 4 224 227
Police Patrol Borough Command 1 228 228
Police Precinct 3 229 231
Fire Division 2 232 233
Fire Battalion 2 234 235
Fire Company Type 1 236 236
Fire Company Number 3 237 239
Community School District 2 240 241
Dynamic Block 3 242 244
Instructional Region 2 245 246
Filler 7 247 253
1990 Census Tract 6 252 259
2000 Census Tract 6 260 265
2000 Census Block 4 266 269
Filler 4 374 377
RIGHT SIDE:
Community District: 3
Community District Borough Code 1 301 301
Community District Number 2 302 303
Low House Number 16 304 319 Display Format
High House Number 16 320 335 Display Format
Reserved for Geosupport Use 32 336 367
Interim Assistance Eligibility Indicator 1 368 368
Zip Code 5 369 373
Health Area 4 374 377
Police Patrol Borough Command 1 378 378
Police Precinct 1 379 380
Fire Division 2 382 383
Fire Battalion 2 384 385
Fire Company Type 1 386 386
Fire Company Number 3 387 389
Community School District 2 390 391
Dynamic Block 3 392 394
Instructional Region 2 395 396
Filler 7 397 403
1990 Census Tract 6 404 409
2000 Census Tract 6 410 415
2000 Census Block 4 416 419
Filler 31 420 450

Work Area 2 (COW) - Function 3C

Blockface Defined by 'ON' Street, Two Cross Streets and Compass Direction
Field Size Position Comment
Internal Use 21 1 21
Duplicate Key Flag or Continuous Parity 1 22 22
Locational Status of Segment 1 23 23
County Boundary Indicator 1 24 24
DCP-Preferred LGC for Street 1 2 25 26
DCP-Preferred LGC for Street 2 2 27 28
DCP-Preferred LGC for Street 3 2 29 30
Number of Cross Streets at Low Address End 1 31 31
List of Cross Streets at Low Address End
(Up to five B5SCs, 6 bytes each)
30 32 60
Number of Cross Streets at High Address End 1 62 62
List of Cross Streets at High Address End
(Up to five B5SCs, 6 bytes each)
30 63 92
Cross Street Reversal Flag 1 93 93
LION KEY 10 94 103
LION Borough Code 1 94 94
LION Face Code 4 95 98
LION Sequence Number 5 99 103
Generated Record Flag 1 104 104
Length of Segment in Feet 5 105 109
Segment Azimuth 3 110 112
Segment Orientation 1 113 113
Marble Hill/Rikers Island Alternative Borough Flag 1 114 114
Filler 19 155 133
Segment Identifier 7 134 140
DOT Street Light Contractor Area 1 141 141
Side of Street Indicator 1 142 142
Curve Flag 1 143 143
Feature Type Code 1 144 144
Filler 6 145 150
Community District: 3
Community District Borough Code 1 151 151
Community District Number 2 152 153
Low House Number of Block Face 16 154 169 Display Format
High House Number of Block Face 16 170 185 Display Format
Alternate Low House Number 16 186 201 Supplied for Continuous
Alternate High House Number 16 202 217 Parity - Display Format
Interim Assistance Eligibility Indicator 1 218 218
Zip Code 5 219 223
Health Area 4 224 227
Police Patrol Borough Command 1 228 228
Police Precinct 3 229 231
Fire Division 2 232 233
Fire Battalion 2 234 235
Fire Company Type 1 236 236
Fire Company Number 3 237 239
Community School District 2 240 241
Dynamic Block 3 242 244
Instructional Region 2 245 246
Filler 7 247 253
1990 Census Tract 6 254 259
2000 Census Tract 6 260 265
2000 Census Block 4 266 269
Filler 31 270 300

Work Area 2 (COW) - Function 3S

Street Stretch Defined by 'ON' Street and Optionally Two Cross Streets
Field Size Position Comment
Internal Use 2 1 2
Primary/Secondary Street Name Indicator 1 3 3 P=Primary
S = Secondary16
Borough Code 1 4 4
5-Digit Street Code of 'on' Street 5 5 9
LGC 2 10 11 Blank if P in position 3
Filler 10 12 21 Always Blank
NUMBER OF INTERSECTIONS 3 22 24
LIST OF UP TO 350 Intersections
Each List Entry is 55 bytes in length, structured as follows:
19,250 25 19,274
Marble Hill/Rikers Island Flag 1
Distance from previous intersection in list 5
Gap Flag 1
Node Number 7
Number of streets at this intersection 1
B7SC of a street at this intersection (up to 5) 40 DCP Preferred LGC
/*******************************************/*
typedef struct {
  char boro; /* Borough Code char SC10[10]; /*
}
/*******************************************/*

_____________________________

4 Geosupport Desktop Edition supports the Character-Only Work Area format. The mainframe version of Geosupport supports both the Character-Only format (COW) and the Mainframe Specific format (MFS).

5 An asterisk in the second position of a function code is used as a shorthand notation to represent all function codes having the indicated value in the first position, as follows:

6 The user may supply either a 5-Digit, 7-Digit or 10-Digit Street code in this field. The contents are to be left-justified and blank-filled.

7 The second and third borough codes are only required if they differ from the first.

8 When the Work Area Format Indicator (a.k.a. the Platform Indicator) is set to C, Character-Only formats of the work areas (i.e., the formats documented herein) are used. A blank in this indicator means that the mainframe compatible work areas, known as MFS, are used.

9 The Long Work Area 2 Flag is set to L to request the Long Work Area 2. At present it may only be set to L for Functions 1A and BL and means that a list of BINS will be returned in Work Area 2 to the user in place of the list of addresses.

10 If the house number is to be right justified, the House Number Justification Flag is set to R and if the house number is to be left justified, the House Number Justification Flag is set to L or left blank.

11 The House Number Normalization Length field is used to achieve compatibility between the MainFrame Specific (MFS) work areas and the COWs. In the COWs, the House Number is permitted to be 16 characters, but, in the MFS, it is limited to 12 characters. It is not anticipated that users will make use of this field.

12 If the Street Name Normalization Format Flag is set to S or blank, then the street name is returned in sort format. If it is set to C, then the street name is returned in compact format.

13 The Cross Street Names Flag (a.k.a Expanded Format Flag), if set to E, will return the street names in the List of Street Names in the output section of Work Area 1. BBL and BIN are also returned where possible.

14 NAP Identification Number

15 For Function 1E, the Board of Elections preferred LGC is provided.

16 The functionality which creates the street stretches based upon the different LGCs has not been implemented.