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

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
activityId The construction stormwater permit number
activitySysId The construction stormwater system generated unique ID.

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
activityId The construction stormwater permit number
activitySysId The construction stormwater system generated unique ID.
permitSysId The construction stormwater permit's system generated unique ID. An activityId can have many permitSysIds if the permit was reissued. This route returns all permitSysIds.
docSysId The Tempo system generated unique document id.
documentTypeId The type of document.
documentTitle The title of the document.
documentId The onbase document id.
documentDate The date of the document.

Example Queries: