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

Documentation score: Route: 0% Fields: 82%

Description:

TODO

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
activitySysId A system generated unique ID for the ISW activity
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.

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
activitySysId A system generated unique ID for the ISW activity
addressPersonWork The street name and number from the the contact person's work address
cityPersonWork The city name from the the contact person's work address
comments TODO
contactId TODO
contactTypeDesc TODO
email The contact person's email address
endDate The date the contact is no longer considered a valid or active contact
firstName The contact person's first name
lastName The contact person's last name
midName The contact person's middle name
officePhone The contact person's work phone number
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.
startDate The date the contact is considered a valid or active contact
statePersonWork The state code from the the contact person's work address
suffix Contact's suffix of a name, if applicable
zipPersonWork The zip code from the the contact person's work address

Example Queries: