Documentation for "/api/v1/wimn/sites/contacts":

Documentation score: Route: 100% Fields: 100%

Description:

MPCA contacts for a site

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
activityTypeCode The code for the MPCA activity type that the contact is associated with. (Ref:/api/doc/v1/wimn/activity-types)
siteId Yes The query id for the site.

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 commonly used ID for the activity.
activityTypeCode The code for the MPCA activity type that the contact is associated with.
activityTypeName The type of activity that the contact is associated with.
contactEmail The email address for the contact.
contactName The name of the MPCA contact.
contactPhone The phone number for the contact.
contactRole Describes what type of contact this is (e.g. the enforcement staff, project manager, etc.).
siteId The query id for the site.

Example Queries: