Documentation for "/api/v1/isw/permits":

Documentation score: Route: 0% Fields: 100%

Description:

TODO

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
active The facility has permit coverage
activityId The industrial stormwater permit number
activitySysId A system generated unique ID for the ISW activity
cityName The city name from the facility's street address
countyCode The FIPS county code
countyName The name of the county that the facility resides in
effectiveEnd Permit coverage end date
effectiveStart Permit coverage start date
facilityName The name of the facility
ownerName The facility owner's name
permitSysId The industrial stormwater permit's system generated unique ID. An activityId can have many permitSysIds if the permit was reissued. This route only returns the most recent, active permitSysId.
permitType The type of ISW coverage (Ref:/api/doc/v1/isw/permits/types)
sectorCode The code for the industrial sector for the facility. (Ref:/api/doc/v1/isw/industrial-sectors)
zipCode The zip code from the facility's street address

Additional parameters:

The following, optional, parameters may be specified:
Parameter nameDescription
format The desired return format. Valid formats are: {json, jsonp, text, csv, xls, ods, and tab}. The default is json.
callback The JSONP callback function name (Note that format needs to be "jsonp").
fields The comma-separated-list of the field names to return from the query. The default is to return all available fields.
nullValue Value to substitute in place of null values. The default is to return null values as "null" (per JSON.org).
limit The number of records to limit the result set to. Behaves like the SQL standard LIMIT clause.
offset Used with Limit-- the record number to start retrieving from. Behaves like the SQL standard OFFSET clause.

Result Set Definitions:

Field nameDescription
acres Site size in acres
active The facility has permit coverage
activityDescription Description of the ISW activity
activityId The industrial stormwater permit number
activitySysId A system generated unique ID for the ISW activity
address The street name and number from the facility's street address
cityName The city name from the facility's street address
countyCode The FIPS county code
countyName The name of the county that the facility resides in
effectiveEnd Permit coverage end date
effectiveStart Permit coverage start date
facilityName The name of the facility
lat The latitude of the facility's approximate center
location Description of the facility's location
long The longitude of the facility's approximate center
noExposure Facility has no materials or acticities exposed to stormwater. These facilities are excluded from permit requiremnts.
oneMile Indicates that the facility is within one mile of a surfacewater
onlineApplication Identifies if the applicant applied online
ownerName The facility owner's name
permitSysId The industrial stormwater permit's system generated unique ID. An activityId can have many permitSysIds if the permit was reissued. This route only returns the most recent, active permitSysId.
permitType The type of ISW coverage
sectorList List of industrial sectors at the facility
stateCode The state code from the facility's street address
zipCode The zip code from the facility's street address

Example Queries: