Documentation for "/api/v1/csw/permit":

Documentation score: Route: 0% Fields: 58%

Description:

TODO

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
active TODO
activityId The construction stormwater permit number
activitySysId The construction stormwater system generated unique ID.
activityType TODO
activityTypeCode TODO (Ref:/api/doc/v1/csw/permit-types)
city The city of the street address
contractorName the name of the contractor responsible for the construction work
countyName The county the project resides in
coverageDate TODO
ownerName The construction site owner's name
projectName TODO
terminationDate TODO

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
active TODO
activityId The construction stormwater permit number
activitySysId The construction stormwater system generated unique ID.
activityType TODO
activityTypeCode TODO
address The street name and number of the street address
altMethod TODO
city The city of the street address
contractorName the name of the contractor responsible for the construction work
countyName The county the project resides in
coverageDate TODO
estimatedEndDate TODO
estimatedStartDate TODO
lat The latitude of the project's center or on-site office
locationDesc description of the project location
long The longitude of the project's center or on-site office
newImpArea The area of impervious surface after construction in acres
oldImpArea The area of impervious surface before construction in acres
onlineSubmittal y/n flag identifies if the applicant applied online
otherPrjTypeDesc TODO
ownerName The construction site owner's name
ownerOrgType TODO
permitSysId The construction 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.
projectName TODO
projectSize Construction project size in acres
siteName TODO
stateCode The state code of the street address
terminationDate TODO
zipCode The zip code of the street address

Example Queries: