Core Permits Dataset Requirements

Mark Headd edited this page Apr 1, 2016 · 11 revisions

The following provides the required, recommended and optional fields for the core permits dataset.

Required

Field DataType Description
PermitNum TEXT Permit number
Description TEXT Detailed description of work permitted
AppliedDate1 TEXT (YYYY-MM-DD) Date on which the permit was applied
IssuedDate1 TEXT (YYYY-MM-DD) Date on which the permit was issued
CompletedDate2 TEXT (YYYY-MM-DD) Date on which the permit was completed.
StatusCurrent2 TEXT Raw values indicating current status of permit
OriginalAddress1 TEXT Original property street address (line 1), as stored by the jurisdiction
OriginalAddress23 TEXT Original property street address (line 2), as stored by the jurisdiction
OriginalCity TEXT Original property city, as stored by the jurisdiction
OriginalState TEXT Original property state, as stored by the jurisdiction
OriginalZip TEXT Original property zip code, as stored by the jurisdiction

Recommended

Field DataType Description
Jurisdiction TEXT Unique ID of jurisdiction
PermitClass TEXT Raw values indicating property type (e.g. Commercial or Residential)
PermitClassMapped TEXT PermitClass mapped to standardized values:
  • Residential (Single Family/Duplex)
  • Non-Residential (Commercial, Industrial, Institutional)
StatusCurrentMapped TEXT StatusCurrent mapped to standardized values:
  • Application Accepted
  • Fees/Payment
  • In Review
  • Permit Issued
  • Inspection Phase
  • Permit Finaled
  • Permit Finaled with Conditions
  • Occupancy
  • Appeal
  • Permit Cancelled
WorkClass TEXT Raw values indicating whether a property is new or existing
WorkClassMapped TEXT WorkClass mapped to standardized values:
  • New
  • Existing
PermitType TEXT Raw values indicating type of permit in abbreviated/shorthand format
PermitTypeMapped TEXT PermitType mapped to standardized values:
  • Building
  • Demolition
  • Electrical
  • Mechanical
  • Plumbing
  • Roof
  • Fence
  • Grading
  • Pool/Spa
PermitTypeDesc TEXT Longer description of permit type
StatusDate TEXT (YYYY-MM-DD) Indicates the last time a permit was updated in the jurisdiction’s database
TotalSqFt INTEGER Total square footage relevant to the permit
Link TEXT This field should provide a web URL to where the permit data is hosted online.4
Latitude NUMERIC Latitude of property in decimal format using geographic coordinates
Longitude NUMERIC Longitude of property in decimal format using geographic coordinates
EstProjectCost NUMERIC Estimated value of the project.
HousingUnits INTEGER Number of household units for a given building
PIN TEXT Primary unique identifier for a land parcel within a jurisdiction used for tax assessment purposes. The identifier may be colloquially referred to as assessor's ID, tax ID, parcel number, etc.
ContractorCompanyName TEXT Primary company name of the contractor
ContractorTrade TEXT Raw values indicating contractor trade
ContractorTradeMapped TEXT Trade mapped to standardized values:
  • General
  • Electrical
  • Mechanical
  • Plumbing
  • Architecture
  • Engineering
  • Masonry
  • Sign
  • Tent
ContractorLicNum TEXT Contractor license number
ContractorStateLic TEXT Indicates the state the contractor is licensed to

Optional

Field DataType Description
ProposedUse TEXT Provides a description of the use of the property (land use or otherwise) for the permitted work
AddedSqFt INTEGER The square footage the project will add to property
RemovedSqFt INTEGER The square footage the project will remove from the property
MasterPermitNum TEXT Master Use Permit number
ExpiresDate TEXT (YYYY-MM-DD) Date on which the permit will/would have expire(d)
COIssuedDate TEXT (YYYY-MM-DD) Date on which the related certificate of occupancy was issued
HoldDate TEXT (YYYY-MM-DD) Date on which the permit was last put on hold
VoidDate TEXT (YYYY-MM-DD) Date on which the permit was voided
ProjectName TEXT Name of the project related to the permit
ProjectID TEXT ID within the jurisdiction’s database of the project related to the permit
TotalFinishedSqFt TEXT Total finished square footage relevant to the permit
TotalUnfinishedSqFt TEXT Total unfinished square footage relevant to the permit
TotalHeatedSqFt TEXT Total heated square footage relevant to the permit
TotalUnHeatedSqFt TEXT Total unheated square footage relevant to the permit
TotalAccSqFt TEXT Total accessory square footage relevant to the permit
TotalSprinkledSqFt TEXT Total sprinkled square footage relevant to the permit
ExtraFields JSON Source fields that could not logically map to one of the above fields.
Publisher TEXT The name of the data publisher/authority (county, city)
Fee INTEGER The fee for the permit (in any currency)
ContractorFullName TEXT Full name of the contractor (Individual or Company)
ContractorCompanyDesc TEXT Company description
ContractorPhone TEXT Contractor phone number
ContractorAddress1 TEXT Contractor street address line 1
ContractorAddress2 TEXT Contractor street address line 2
ContractorCity TEXT Contractor city
ContractorState TEXT Contractor state
ContractorZip TEXT Contractor zip
ContractorEmail TEXT Contractor email address
  1. Either of AppliedDate or IssuedDate is required. If both are available, both should be provided.
  2. Either of CompletedDate or StatusCurrent must be provided. If both are available, both should be provided.
  3. If system of record used by jurisdiction makes this address component available.
  4. Ideally there should be no login. Users should be able to click on the link and be taken straight to all the online information regarding the permit.