# U.S. EPA Enforcement and Compliance History Online (ECHO) - Clean Water Act (CWA) Rest Services ## API Docs - Facility Information [Clean Water Act (CWA) Download Data Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502972.md): Based on the QID obtained from a get_facilities or get_facility_info query, return a comma separated value (CSV) file of the facilities found. - Facility Information [Clean Water Act (CWA) Download Data Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502955.md): Based on the QID obtained from a get_facilities or get_facility_info query, return a comma separated value (CSV) file of the facilities found. - Facility Information [Clean Water Act (CWA) Facility Search Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502959.md): Validates query search parameters and returns query identifier. Use the responseset parameter to set the page size - Facility Information [Clean Water Act (CWA) Facility Search Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502958.md): Validates query search parameters and returns query identifier. Use the responseset parameter to set the page size - Facility Information [Clean Water Act (CWA) Facility Enhanced Search Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502957.md): Returns either an array of Facilities or an array of Clusters that meet the specified search criteria. - Facility Information [Clean Water Act (CWA) Facility Enhanced Search Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502963.md): Returns either an array of Facilities or an array of Clusters that meet the specified search criteria. - Facility Information [Clean Water Act (CWA) GeoJSON Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502970.md): Based on the QID obtained from a get_facilities or get_facility_info query, return GeoJSON of the facilities found. - Facility Information [Clean Water Act (CWA) GeoJSON Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502973.md): Based on the QID obtained from a get_facilities or get_facility_info query, return GeoJSON of the facilities found. - Facility Information [Clean Water Act (CWA) Info Clusters Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502954.md): Based on the QID obtained from a clustered get_facility_info query, download cluster facility information as either a CSV or GEOJSON file. - Facility Information [Clean Water Act (CWA) Info Clusters Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502956.md): Based on the QID obtained from a clustered get_facility_info query, download cluster facility information as either a CSV or GEOJSON file. - Facility Information [Clean Water Act (CWA) Map Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502971.md): The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_facilities facility query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned. - Facility Information [Clean Water Act (CWA) Map Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502960.md): The purpose of the GET_MAP service is to display facility coordinates and facility clusters related to a get_facilities facility query. Currently, the maximum number of coordinates returned is 500. GET_MAP performs automatic clustering at the state, county, and zip code levels to maximize the number of coordinates returned. - Facility Information [Clean Water Act (CWA) Paginated Results Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502961.md): GET_QID is passed with a query ID corresponding to a previously run get_facilities query. It then returns a Facility object containing all matching facilities. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns. - Facility Information [Clean Water Act (CWA) Paginated Results Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502962.md): GET_QID is passed with a query ID corresponding to a previously run get_facilities query. It then returns a Facility object containing all matching facilities. The main purpose of GET_QID is for large querysets that contain multiple pages (responsesets) of output. GET_QID allows for pagination and for the selection and sorting of columns. - Story [Story: Get List of User Stories](https://share.apidog.com/apidoc/docs-site/345500/api-3529319.md): Returns a list of stories for this user identifie via the access token presentated to the api - Story [Story: Upload](https://share.apidog.com/apidoc/docs-site/345500/api-3529315.md): Upload new story to presalytics api - Story [Story: Upload a File](https://share.apidog.com/apidoc/docs-site/345500/api-3529311.md): Upload new story to presalytics api via an Open Office Xml file - Story [Story: Upload a File (base64)](https://share.apidog.com/apidoc/docs-site/345500/api-3529314.md): Upload new story to presalytics api via an Open Office Xml file - Story [Story: Delete by Id](https://share.apidog.com/apidoc/docs-site/345500/api-3529330.md): Remove a story and dependant data. - Story [Story: Get by Id](https://share.apidog.com/apidoc/docs-site/345500/api-3529317.md): Returns story metadata, inlcuding json object with story outline - Story [Story: Modify](https://share.apidog.com/apidoc/docs-site/345500/api-3529320.md): Update story metadata, including story outline - Story [Story: View Analytics](https://share.apidog.com/apidoc/docs-site/345500/api-3529316.md): returns an html document containing session and event metrics for the story - Story [Story: Upload a File To Existing Story](https://share.apidog.com/apidoc/docs-site/345500/api-3529326.md): Upload a file to an existing story - Story [Story: Delete Subdocument](https://share.apidog.com/apidoc/docs-site/345500/api-3529322.md): Deletes a subdcoument of this story (e.g., .pptx, .docx, .xlsx) - Story [Story: Download Updated File](https://share.apidog.com/apidoc/docs-site/345500/api-3529318.md): Redtreives updated story as open office xml file (e.g., .pptx, .docx, .xlsx) - Story [Story: Get Story Outline](https://share.apidog.com/apidoc/docs-site/345500/api-3529329.md): Returns Story's outline - Story [Story: Post Story Outline](https://share.apidog.com/apidoc/docs-site/345500/api-3529323.md): Update a story outline. - Story [Story: Public Link to Story Reveal.js Document](https://share.apidog.com/apidoc/docs-site/345500/api-3529313.md): returns an html document containing a reveal.js epresentation of the story, if the story if set to is_public = True - Story [Story: Get Story at Reveal.js Document](https://share.apidog.com/apidoc/docs-site/345500/api-3529325.md): returns an html document containing a reveal.js epresentation of the story - Story [Story: Get Story Status](https://share.apidog.com/apidoc/docs-site/345500/api-3529327.md): Returns code indicating whether story has active running background and is healthy (e.g., the latest outline is valid) - Metadata [Clean Water Act (CWA) Metadata Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502964.md): Returns the JSON Object Name and ColumnId for usage with the qcolumns parameter for get_qid, get_facility_info and other service endpoints. - Metadata [Clean Water Act (CWA) Metadata Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502965.md): Returns the JSON Object Name and ColumnId for usage with the qcolumns parameter for get_qid, get_facility_info and other service endpoints. - Cache [Cache: Store Subdocument](https://share.apidog.com/apidoc/docs-site/345500/api-3529328.md): An endpoint for Presalytics Renderers to cache html subdocuments for subsequent retrieval by the browser. Documents Are retrieved via token expire after 1 minute. - Cache [Cache: Get Subdocument](https://share.apidog.com/apidoc/docs-site/345500/api-3529324.md): An endpoint for broswer retreive html documents that were cached durin the rendering process via a nonce (token) - Lookups [ECHO BP Tribes Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502966.md): Returns the EPA Standard Indian Tribes and Native Alaskan Villages tribal_id and tribe_name. - Lookups [ECHO BP Tribes Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502967.md): Returns the EPA Standard Indian Tribes and Native Alaskan Villages tribal_id and tribe_name. - Lookups [ECHO CWA Parameter Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502968.md): Look up Clean Water Act parameter codes and descriptions in the Integrated Compliance Information System - National Pollutant Discharge Elimination System (ICIS-NPDES) by code or term. - Lookups [ECHO CWA Parameter Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502969.md): Look up Clean Water Act parameter codes and descriptions in the Integrated Compliance Information System - National Pollutant Discharge Elimination System (ICIS-NPDES) by code or term. - Lookups [ECHO CWA Pollutants Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502975.md): Look up Clean Water Act pollutants by name - Lookups [ECHO CWA Pollutants Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502974.md): Look up Clean Water Act pollutants by name - Lookups [ECHO Federal Agency Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502976.md): Look up Federal Agency Code - Lookups [ECHO Federal Agency Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502977.md): Look up Federal Agency Code - Lookups [ECHO ICIS NPDES Inspection Types Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502978.md): Returns the ICIS NPDES Compliance Monitoring Type Code and Description. - Lookups [ECHO ICIS NPDES Inspection Types Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502979.md): Returns the ICIS NPDES Compliance Monitoring Type Code and Description. - Lookups [ECHO ICIS NPDES Law Sections Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502980.md): Returns the ICIS NPDES Law Section Descriptions. - Lookups [ECHO ICIS NPDES Law Sections Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502982.md): Returns the ICIS NPDES Law Section Descriptions. - Lookups [ECHO NAICS Codes Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502988.md): - Lookups [ECHO NAICS Codes Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502981.md): - Lookups [ECHO NPDES Parameters Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502983.md): ICIS Limit Parameter Code and Name lookup based on the supply of a partial parameter name. (NPDES = National Pollutant Discharge Elimination System) - Lookups [ECHO NPDES Parameters Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502989.md): ICIS Limit Parameter Code and Name lookup based on the supply of a partial parameter name. (NPDES = National Pollutant Discharge Elimination System) - Lookups [ECHO WBD Code Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502984.md): USGS Watershed Boundary Dataset (WBD) Name lookup based on a supplied WBD Code and Watershed Level - Lookups [ECHO WBD Code Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502985.md): USGS Watershed Boundary Dataset (WBD) Name lookup based on a supplied WBD Code and Watershed Level - Lookups [ECHO WBD Name Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502986.md): USGS Watershed Boundary Dataset (WBD) Code lookup based on a supplied WBD Name and Watershed Level - Lookups [ECHO WBD Name Lookup Service](https://share.apidog.com/apidoc/docs-site/345500/api-3502987.md): USGS Watershed Boundary Dataset (WBD) Code lookup based on a supplied WBD Name and Watershed Level - Restricted [Collborators: Bulk Update (Admin Only)](https://share.apidog.com/apidoc/docs-site/345500/api-3529321.md): Allows for bulk updates on collaborator metadata. Restricted to internal admins - Schemas [Story Outline Schema](https://share.apidog.com/apidoc/docs-site/345500/api-3529332.md): Json Schema for validating Story Outline objects - Permissions [Permissions: List Permission Types](https://share.apidog.com/apidoc/docs-site/345500/api-3529333.md): Returns a list of possible user permission types - Permissions [Permissions: Story Authorization for a User](https://share.apidog.com/apidoc/docs-site/345500/api-3529334.md): Check whether user have certain types of permissions. Use http status codes to understand if permission is granted - 204 = Granted, 403 = Forbidden - Sessions [Sessions: Delete by Id](https://share.apidog.com/apidoc/docs-site/345500/api-3529335.md): Remove a session and dependant data. - Sessions [Sessions: Get](https://share.apidog.com/apidoc/docs-site/345500/api-3529336.md): Get session metadata - Sessions [Sessions: List Story Sessions](https://share.apidog.com/apidoc/docs-site/345500/api-3529343.md): Get a list of sessions asscoaited with this story - Sessions [Sessions: Create a Session](https://share.apidog.com/apidoc/docs-site/345500/api-3529340.md): Create a new session - Views [Views: List Session Views](https://share.apidog.com/apidoc/docs-site/345500/api-3529338.md): Get data for all views in a session - Views [Views: Create A Session View](https://share.apidog.com/apidoc/docs-site/345500/api-3529341.md): Create a page view object for a viewing session - Views [Views: Delete by Id](https://share.apidog.com/apidoc/docs-site/345500/api-3529344.md): Remove a view and dependant data. - Views [Views: Get View](https://share.apidog.com/apidoc/docs-site/345500/api-3529337.md): Get view meta data - Story Collaborators [Story Collaborators: List](https://share.apidog.com/apidoc/docs-site/345500/api-3529339.md): Gets a list users that can read or edit this story - Story Collaborators [Story Collaborators: Add New User](https://share.apidog.com/apidoc/docs-site/345500/api-3529342.md): Add a colloborator to this story - Story Collaborators [Story Collaborators: Edit Inactive User Permission](https://share.apidog.com/apidoc/docs-site/345500/api-3529348.md): Edit story permissions for inactive users. Requires admin rights. - Story Collaborators [Story Collaborators: Remove User](https://share.apidog.com/apidoc/docs-site/345500/api-3529350.md): Remove a collaborator from this story - Story Collaborators [Story Collaborators: Access Permissions](https://share.apidog.com/apidoc/docs-site/345500/api-3529346.md): Data to help you understand the access rights of a particular collaborator on this story - Story Collaborators [Story Collaborators: Edit Access Rights](https://share.apidog.com/apidoc/docs-site/345500/api-3529347.md): Modify a user's access right to this story (e.g., grant edit permissions) - Events [Events: List Events](https://share.apidog.com/apidoc/docs-site/345500/api-3529345.md): Get a list of Events available to users of this story - Events [Events: Manage Events](https://share.apidog.com/apidoc/docs-site/345500/api-3529349.md): Add a message to the Story's conversation - Conversation [Conversation: List Conversation Messages](https://share.apidog.com/apidoc/docs-site/345500/api-3529351.md): Get a list of messages that have been send in this story - Conversation [Conversation: Send a Message](https://share.apidog.com/apidoc/docs-site/345500/api-3529352.md): Add a message to the Story's conversation - [Environment: Get](https://share.apidog.com/apidoc/docs-site/345500/api-3529312.md): pass rendering metadata to the client-side scripts - [Specification: No tags](https://share.apidog.com/apidoc/docs-site/345500/api-3529331.md): json-formatted version of this spec with the tags removed to help with codegen processes ## Schemas - Schemas [cwa01](https://share.apidog.com/apidoc/docs-site/345500/schema-391321.md): - Schemas [Collaborator permission data](https://share.apidog.com/apidoc/docs-site/345500/schema-434939.md): - Schemas [cwa02](https://share.apidog.com/apidoc/docs-site/345500/schema-391313.md): - Schemas [BaseModel](https://share.apidog.com/apidoc/docs-site/345500/schema-434940.md): - Schemas [cwa03](https://share.apidog.com/apidoc/docs-site/345500/schema-391314.md): - Schemas [Cache Post Request body](https://share.apidog.com/apidoc/docs-site/345500/schema-434941.md): - Schemas [cwa04](https://share.apidog.com/apidoc/docs-site/345500/schema-391316.md): - Schemas [Collaborator data to change](https://share.apidog.com/apidoc/docs-site/345500/schema-434942.md): - Schemas [cwa05](https://share.apidog.com/apidoc/docs-site/345500/schema-391315.md): - Schemas [session-create](https://share.apidog.com/apidoc/docs-site/345500/schema-434944.md): - Schemas [cwa06](https://share.apidog.com/apidoc/docs-site/345500/schema-391317.md): - Schemas [Event](https://share.apidog.com/apidoc/docs-site/345500/schema-434943.md): - Schemas [cwa07](https://share.apidog.com/apidoc/docs-site/345500/schema-391320.md): - Schemas [File Upload](https://share.apidog.com/apidoc/docs-site/345500/schema-434945.md): - Schemas [cwa08](https://share.apidog.com/apidoc/docs-site/345500/schema-391318.md): - Schemas [Event Actions](https://share.apidog.com/apidoc/docs-site/345500/schema-434946.md): - Schemas [cwa09](https://share.apidog.com/apidoc/docs-site/345500/schema-391319.md): - Schemas [Message](https://share.apidog.com/apidoc/docs-site/345500/schema-434949.md): - Schemas [cwa10](https://share.apidog.com/apidoc/docs-site/345500/schema-391325.md): - Schemas [Collaborator permission data](https://share.apidog.com/apidoc/docs-site/345500/schema-434948.md): - Schemas [cwa11](https://share.apidog.com/apidoc/docs-site/345500/schema-391328.md): - Schemas [Ooxml Document](https://share.apidog.com/apidoc/docs-site/345500/schema-434958.md): - Schemas [cwa12](https://share.apidog.com/apidoc/docs-site/345500/schema-391322.md): - Schemas [Story Outline](https://share.apidog.com/apidoc/docs-site/345500/schema-434950.md): - Schemas [cwa13](https://share.apidog.com/apidoc/docs-site/345500/schema-391323.md): - Schemas [Permission Type](https://share.apidog.com/apidoc/docs-site/345500/schema-434952.md): - Schemas [geo](https://share.apidog.com/apidoc/docs-site/345500/schema-391326.md): - Schemas [Problem Detail](https://share.apidog.com/apidoc/docs-site/345500/schema-434951.md): - Schemas [meta1](https://share.apidog.com/apidoc/docs-site/345500/schema-391324.md): - Schemas [Session](https://share.apidog.com/apidoc/docs-site/345500/schema-434947.md): - Schemas [meta3](https://share.apidog.com/apidoc/docs-site/345500/schema-391327.md): - Schemas [Status](https://share.apidog.com/apidoc/docs-site/345500/schema-434953.md): - Schemas [qp0](https://share.apidog.com/apidoc/docs-site/345500/schema-391329.md): - Schemas [Story](https://share.apidog.com/apidoc/docs-site/345500/schema-434954.md): - Schemas [rlup01](https://share.apidog.com/apidoc/docs-site/345500/schema-391330.md): - Schemas [Story Collaborator](https://share.apidog.com/apidoc/docs-site/345500/schema-434955.md): - Schemas [rlup20](https://share.apidog.com/apidoc/docs-site/345500/schema-391331.md): - Schemas [Story Outline History](https://share.apidog.com/apidoc/docs-site/345500/schema-434956.md): - Schemas [rlup23](https://share.apidog.com/apidoc/docs-site/345500/schema-391332.md): - Schemas [View](https://share.apidog.com/apidoc/docs-site/345500/schema-434957.md): - Schemas [rlup24](https://share.apidog.com/apidoc/docs-site/345500/schema-391333.md): - Schemas [rlup54](https://share.apidog.com/apidoc/docs-site/345500/schema-391334.md): - Schemas [rlup58](https://share.apidog.com/apidoc/docs-site/345500/schema-391335.md): - Schemas [rlup59](https://share.apidog.com/apidoc/docs-site/345500/schema-391340.md): - Schemas [rlup61](https://share.apidog.com/apidoc/docs-site/345500/schema-391336.md): - Schemas [rlup65](https://share.apidog.com/apidoc/docs-site/345500/schema-391338.md): - Schemas [rlup75](https://share.apidog.com/apidoc/docs-site/345500/schema-391337.md): - Schemas [rlup77](https://share.apidog.com/apidoc/docs-site/345500/schema-391339.md): - Response [accepted](https://share.apidog.com/apidoc/docs-site/345500/schema-434959.md): - Response [badrequest](https://share.apidog.com/apidoc/docs-site/345500/schema-434960.md): - Response [forbidden](https://share.apidog.com/apidoc/docs-site/345500/schema-434961.md): - Response [notfound](https://share.apidog.com/apidoc/docs-site/345500/schema-434962.md): - Response [outline](https://share.apidog.com/apidoc/docs-site/345500/schema-434965.md): - Response [unauthorized](https://share.apidog.com/apidoc/docs-site/345500/schema-434963.md): - Response [unprocessable_entity](https://share.apidog.com/apidoc/docs-site/345500/schema-434964.md): - Response [unsupported_media_type](https://share.apidog.com/apidoc/docs-site/345500/schema-434966.md):