{ "openapi": "3.0.1", "info": { "title": "FRS Query API", "description": "The FRS Intergovernmental APIs expose several RESTful web services for querying or submitting FRS data. This web page is intended for a technical government audience and describes the content and purpose of each API service available. These endpoints are secured via NAAS accounts. To request access, refer to [https://www.epa.gov/frs/facility-registry-service-frs-api](https://www.epa.gov/frs/facility-registry-service-frs-api). Additionally, refer to that page for further API details, to ask questions, request new features, or give feedback.\n\nThe available sets of APIs are:\n* [Production - Query API Swagger page](https://frsqueryprd-api.epa.gov/facilityiptqueryprd/swagger-ui/index.html)\n* [Production - Submit API Swagger page](https://frssubmitprd-api.epa.gov/facilityiptsubmitprd/swagger-ui/index.html)\n* [Pre-production - Query API Swagger page](https://frsquerypre-api.epa.gov/facilityiptquery/swagger-ui/index.html)\n* [Pre-production - Submit API Swagger page](https://frssubmitpre-api.epa.gov/facilityiptsubmit/swagger-ui/index.html)", "version": "1.10.01" }, "servers": [ { "url": "/facilityiptquery/v1/FRS" } ], "tags": [ { "name": "FRS" } ], "paths": { "/QueryRegistry": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for facility data in FRS.", "description": "This service is used to search for facility data in FRS.", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "registryId", "in": "query", "description": "The identification number assigned by the EPA Facility Registry System to uniquely identify an object of interest.", "schema": { "maxLength": 12, "type": "string" } }, { "name": "primaryName", "in": "query", "description": "The primary name. Max 150 characters.", "schema": { "maxLength": 150, "type": "string" } }, { "name": "locationAddress", "in": "query", "description": "The location address. Max 100 characters.", "schema": { "maxLength": 100, "type": "string" } }, { "name": "cityName", "in": "query", "description": "The city name. Max 60 characters.", "schema": { "maxLength": 60, "type": "string" } }, { "name": "countyName", "in": "query", "description": "The county name. Max 35 characters.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "fipsCode", "in": "query", "description": "The alphanumeric FIPS code. Max 5 characters.", "schema": { "maxLength": 5, "type": "string" } }, { "name": "stateCode", "in": "query", "description": "The state code/abbreviation. Max 5 characters.", "schema": { "maxLength": 5, "type": "string" } }, { "name": "stateName", "in": "query", "description": "The state name. Max 35 characters.", "schema": { "maxLength": 35, "type": "string" } }, { "name": "countryName", "in": "query", "description": "The country name. Max 44 characters.", "schema": { "maxLength": 44, "type": "string" } }, { "name": "postalCode", "in": "query", "description": "The numeric postal code, dashes allowed. Max 14 characters.", "schema": { "maxLength": 14, "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Registry" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryRegistryGis": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for facility GIS data in FRS.", "description": "This service is used to search for facility GIS data in FRS.", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "registryId", "in": "query", "description": "The identification number assigned by the EPA Facility Registry System to uniquely identify an object of interest.", "schema": { "maxLength": 12, "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegistryGis" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryProgramFacility": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for program facility data in FRS.", "description": "This service is used to search for program facility data in FRS.", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "registryId", "in": "query", "description": "The identification number assigned by the EPA Facility Registry System to uniquely identify an object of interest.", "schema": { "maxLength": 12, "type": "string" } }, { "name": "programSystemAcronym", "in": "query", "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramFacility" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryProgramGis": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Program Facility GIS data in FRS.", "description": "Users can search for Program Facility GIS in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramGIS" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryInterest": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Interest data in FRS.", "description": "Users can search for Interest in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Interest" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryContact": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Contact data in FRS.", "description": "Users can search for Contact in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryOrganization": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Organization data in FRS.", "description": "Users can search for Organization in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryMail": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Mailing Address data in FRS.", "description": "Users can search for Mailing Address in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Mail" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QuerySic": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for SIC data in FRS.", "description": "Users can search for SIC in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sic" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryNaics": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for NAICs data in FRS.", "description": "Users can search for NAICs in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Naics" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryAlternativeName": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Alternative Name data in FRS.", "description": "Users can search for Alternative Name in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "registryId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlternativeName" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryAlternativeId": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Alternative ID data in FRS.", "description": "Users can search for Alternative ID in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlternativeId" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryTribe": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Tribe data in FRS.", "description": "Users can search for Tribe in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tribe" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryEmissionsUnit": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Emissions Unit data in FRS.", "description": "Users can search for Emissions Unit in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Unit" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryReleasePoint": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Release Point data in FRS.", "description": "Users can search for Release Point in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReleasePoint" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryAssociation": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Sub-facility Association data in FRS.", "description": "Users can search for Sub-facility Association in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Association" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryEmissionsProcess": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Emissions Process data in FRS.", "description": "Users can search for Emissions Process in the FRS system, based on a variety of search criteria.", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Process" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryEmissionsControl": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Emissions Control data in FRS.", "description": "Users can search for Emissions Control in the FRS system, based on a variety of search criteria.", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Control" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QuerySupplementalInterest": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Supplemental Interest data in FRS.", "description": "Users can search for Supplemental Interest in the FRS system, based on a variety of search criteria.", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplementalInterest" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryPollutant": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Pollutant data in FRS.", "description": "Users can search for Pollutant data in the FRS system, based on a variety of search criteria.", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Pollutant" } } } } }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QuerySitePath": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Site Path data in FRS.", "description": "Users can search for Site Paths in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SitePath" } } } } }, "400": { "description": "Missing required programSystemAcronym or programSystemId parameters.", "content": {} }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryAltSitePath": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Alt Site Path data in FRS.", "description": "Users can search for Alt Site Paths in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AltSitePath" } } } } }, "400": { "description": "Missing required programSystemAcronym or programSystemId parameters.", "content": {} }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryPathAssignment": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Path Assignment data in FRS.", "description": "Users can search for Path Assignments in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PathAssignment" } } } } }, "400": { "description": "Missing required programSystemAcronym or programSystemId parameters.", "content": {} }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryReleasePointApportionment": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Release Point Apportionment data in FRS.", "description": "Users can search for Release Point Apportionments in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReleasePointApportionment" } } } } }, "400": { "description": "Missing required programSystemAcronym or programSystemId parameters.", "content": {} }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } }, "/QueryAlternativeControlId": { "get": { "tags": [ "FRS" ], "summary": "This service is used to search for Alternative Control Identification data in FRS.", "description": "Users can search for Alternative Control Identification in the FRS system, based on a variety of search criteria", "parameters": [ { "name": "UserId", "in": "header", "description": "User ID", "required": true, "schema": { "type": "string" } }, { "name": "Password", "in": "header", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "programSystemAcronym", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "programSystemId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records to return. Max 50 records.", "schema": { "type": "string", "default": "50" } }, { "name": "offSet", "in": "query", "description": "Record number to start at. Use together with pageSize to query multiple pages of larger data sets.", "schema": { "type": "string", "default": "0" } } ], "responses": { "200": { "description": "Successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlternativeControlId" } } } } }, "400": { "description": "Missing required programSystemAcronym or programSystemId parameters.", "content": {} }, "401": { "description": "Invalid username and/or password combination. NAAS authentication has failed.", "content": {} }, "500": { "description": "An error has occurred during processing.", "content": {} } } } } }, "components": { "schemas": { "SupplementalInterest": { "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "supplementalProgramSystemAcronym": { "type": "string", "description": "The abbreviated name that represents the name of a supplemental information management system. For the purposes of FRS, supplemental systems include state program systems, compliance and enforcement systems, and program systems that include general permits.", "example": "RI-PLOVER" }, "supplementalProgramSystemId": { "type": "string", "description": "The unique identification number assigned to a judicial or formal administrative enforcement action, a compliance monitoring activity, a general permit, or a state environmental program.", "example": "123" }, "supplementalInterestType": { "type": "string", "description": "The supplemental environmental permit or regulatory program that applies to the facility site or the environmental interest at the facility site. For the purposes of FRS, supplemental program interests include state programs, compliance and enforcement programs, and general permits. Refer to https://www.epa.gov/sites/production/files/2015-09/documents/standard_interests.pdf for list of supplemental interest types FRS accepts currently - this list can be added to.", "example": "CONCENTRATED ANIMAL FEEDING OPERATION" } } }, "ProgramFacility": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "registryId": { "maxLength": 40, "type": "string", "description": "The identification number assigned by the EPA Facility Registry System to uniquely identify an object of interest.", "example": "" }, "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "primaryName": { "maxLength": 150, "type": "string", "description": "The public or commercial name of a facility site (i.e., the full name that commonly appears on invoices, signs, or other business documents, or as assigned by the state when the name is ambiguous).", "example": "RHODE ISLAND STATE HOUSE" }, "locationAddress": { "maxLength": 100, "type": "string", "description": "The address that describes the physical (geographic) location of the front door or main entrance of a facility site, including urban-style street address or rural address.", "example": "82 SMITH ST" }, "supplementalLocation": { "maxLength": 100, "type": "string", "description": "The text that provides additional information about a place, including a building name with its secondary unit and number, an industrial park name, an installation name, or descriptive text where no formal address is available.", "example": "SUITE 45" }, "cityName": { "maxLength": 60, "type": "string", "description": "The name of the city, town, village or other locality, when identifiable, within whose boundaries (the majority of) the facility site is located. This is not always the same as the city used for USPS mail delivery.", "example": "PROVIDENCE" }, "countyName": { "maxLength": 35, "type": "string", "description": " The name of the U.S. county or county equivalent in which the facility site is physically located.", "example": "PROVIDENCE COUNTY" }, "countyFIPSCode": { "maxLength": 5, "type": "string", "description": "The code that represents the county or county equivalent and the state or state equivalent of the United States.", "example": "44007" }, "stateCode": { "maxLength": 5, "type": "string", "description": "The U.S. Postal Service abbreviation that represents the state or state equivalent for the U.S. and Canada.", "example": "RI" }, "stateName": { "maxLength": 35, "type": "string", "description": "The name of a principal administrative subdivision of the United States, Canada, or Mexico.", "example": "RHODE ISLAND" }, "countryName": { "maxLength": 44, "type": "string", "description": "The name that represents a primary geopolitical unit of the world.", "example": "UNITED STATES" }, "postalCode": { "maxLength": 14, "type": "string", "description": "The combination of the 5-digit Zone Improvement Plan (ZIP) code and the four-digit extension code (if available) that represents the geographic segment that is a subunit of the ZIP Code, assigned by the U.S. Postal Service to a geographic location; or the postal zone specific to the country, other than the U.S., where the facility site is located.", "example": "2903.0" }, "isFederalFacilityFlag": { "maxLength": 1, "type": "string", "description": "Code indicating whether or not the facility site is the property of the federal government.", "example": "Y" }, "agencyId": { "maxLength": 5, "type": "string", "description": "The Federal Agency/Bureau code. The five character code consists of a letter followed by four numbers. There are four possible letters that can occupy the first character position: C for Civilian Federal Agency; D for Department of Defense; E for Department of Energy; X for Unknown. The second and third characters represent the agency code, while the fourth and fifth characters represent the bureau code.", "example": "D000" }, "siteTypeName": { "maxLength": 40, "type": "string", "description": "The descriptive name for the type of facility. Allowable Values (example):POTENTIALLY CONTAMINATED SITE, NETWORK, MONITORING STATION, STATIONARY, WATER SYSTEM, MOBILE, FACILITY, PIPELINE, CONTAMINATION ADDRESSED, CONTAMINATED SITE, BROWNFIELDS SITE, PORTABLE, OFF-SHORE PLATFORM.", "example": "STATIONARY" }, "isSmallBusinessFlag": { "maxLength": 1, "type": "string", "description": "Y/N code indicating whether or not a business is requesting relief under EPA Small Business Policy, which applies to businesses having less than 100 employees.", "example": "Y" }, "HUCCode8": { "maxLength": 8, "type": "string", "description": "The HUC 8 Code for the registry item.", "example": "17060102" }, "HUCCode12": { "maxLength": 12, "type": "string", "description": "The HUC 12 Code for the registry item.", "example": "170601020101" }, "IsPOTWFlag": { "maxLength": 1, "type": "string", "description": "Indicates whether this registry item is of POTW.", "example": "" }, "countryISO31661Alpha2": { "maxLength": 2, "type": "string", "description": "The country code is ISO 3166 1 Alpha 2 format.", "example": "" }, "facilityManagementTypeCode": { "maxLength": 20, "type": "string", "description": "The type of facility management performed for the registry item.", "example": "" }, "facilityOwnerType": { "maxLength": 40, "type": "string", "description": "The type of facility owner for the registry id. Allowable Values (xample): BANK/LOAN COMPANY, BROWNFIELDS/PUBLIC, COUNTY OWNED, DISTRICT OWNED, FEDERALLY OWNED, NEITHER, FORMERLY FEDERALLY OWNED OR OPERATED, GOVERNMENT OWNED / CONTRACTOR OPERATED, MIXED OWNERSHIP, MUNICIPALITY, PRIVATE, PRIVATELY OWNED / GOVERNMENT OPERATED, PROPERTY DEFAULTED BACK TO GOVERNMENT, STATE OWNED, TRIBAL GOVERNMENT, TRUSTEE, FEDERAL, TRUSTEE, STATE, FEDERAL, OTHER, UNKNOWN, GOCO ", "example": "BROWNFIELDS/PUBLIC" }, "legislativeDistrictNumber": { "maxLength": 2, "type": "string", "description": "The legislative district number for the registry item.", "example": "10" }, "locationDescription": { "maxLength": 256, "type": "string", "description": "A location description for the registry item.", "example": "Part of an EPA Superfund site." }, "operatingStatus": { "maxLength": 100, "type": "string", "description": "The operating status of the registry item.", "example": "SEASONAL" }, "operatingStatusDate": { "maxLength": 30, "type": "string", "description": "The last date the operating status was collected.", "example": "2012-04-21T23:25:43.000Z" }, "operatingStatusYear": { "type": "string", "description": "The last year the operating status was collected.", "example": "1991" }, "isPortableSourceFlag": { "maxLength": 1, "type": "string", "description": "Indicates if this is a portable registry item.", "example": "N" }, "isSensitiveFlag": { "maxLength": 1, "type": "string", "description": "Indicates whether or not the associated data is enforcement sensitive.", "example": "N" }, "isPublicFlag": { "maxLength": 1, "type": "string", "description": "Indicates whether or not the associated data is accessible by the public on the Internet.", "example": "Y" }, "userId": { "type": "string", "description": "The user ID of the person who entered the data or the method by which the data was entered into the system.", "example": "JOHN_DOE" }, "startDate": { "maxLength": 30, "type": "string", "description": "The date this data started to be of interest in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" }, "endDate": { "maxLength": 30, "type": "string", "description": "The date this data is no longer of interest in ISO 8601 format", "example": "2012-04-21T00:00:00.000Z" }, "lastReportedDate": { "maxLength": 30, "type": "string", "description": "The most recent date the corresponding data was reported to the Source of Data in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" }, "FacilitySourceSystemProgramCode": { "maxLength": 20, "type": "string", "description": "The code that represents the information management system which has responsibility for the data in a linked or interrelated information management system.", "example": "RI-PLOVER" } } }, "Registry": { "type": "object", "properties": { "registryId": { "maxLength": 40, "type": "string", "description": "The identification number assigned by the EPA Facility Registry System to uniquely identify an object of interest.", "example": "999983143090" }, "primaryName": { "maxLength": 150, "type": "string", "description": "The public or commercial name of a facility site (i.e., the full name that commonly appears on invoices, signs, or other business documents, or as assigned by the state when the name is ambiguous).", "example": "RHODE ISLAND STATE HOUSE" }, "locationAddress": { "maxLength": 100, "type": "string", "description": "The address that describes the physical (geographic) location of the front door or main entrance of a facility site, including urban-style street address or rural address.", "example": "82 SMITH ST" }, "supplementalLocation": { "maxLength": 100, "type": "string", "description": "The text that provides additional information about a place, including a building name with its secondary unit and number, an industrial park name, an installation name, or descriptive text where no formal address is available.", "example": "SUITE 45" }, "cityName": { "maxLength": 60, "type": "string", "description": "The name of the city, town, village or other locality, when identifiable, within whose boundaries (the majority of) the facility site is located. This is not always the same as the city used for USPS mail delivery.", "example": "PROVIDENCE" }, "countyName": { "maxLength": 35, "type": "string", "description": " The name of the U.S. county or county equivalent in which the facility site is physically located.", "example": "PROVIDENCE COUNTY" }, "countyFIPSCode": { "maxLength": 5, "type": "string", "description": "The code that represents the county or county equivalent and the state or state equivalent of the United States.", "example": "44007" }, "stateCode": { "maxLength": 5, "type": "string", "description": "The U.S. Postal Service abbreviation that represents the state or state equivalent for the U.S. and Canada.", "example": "RI" }, "stateName": { "maxLength": 35, "type": "string", "description": "The name of a principal administrative subdivision of the United States, Canada, or Mexico.", "example": "RHODE ISLAND" }, "countryName": { "maxLength": 44, "type": "string", "description": "The name that represents a primary geopolitical unit of the world.", "example": "UNITED STATES" }, "postalCode": { "maxLength": 14, "type": "string", "description": "The combination of the 5-digit Zone Improvement Plan (ZIP) code and the four-digit extension code (if available) that represents the geographic segment that is a subunit of the ZIP Code, assigned by the U.S. Postal Service to a geographic location; or the postal zone specific to the country, other than the U.S., where the facility site is located.", "example": "2903.0" }, "isFederalFacilityFlag": { "maxLength": 1, "type": "string", "description": "Code indicating whether or not the facility site is the property of the federal government.", "example": "Y" }, "agencyId": { "maxLength": 5, "type": "string", "description": "The Federal Agency/Bureau code. The five character code consists of a letter followed by four numbers. There are four possible letters that can occupy the first character position: C for Civilian Federal Agency; D for Department of Defense; E for Department of Energy; X for Unknown. The second and third characters represent the agency code, while the fourth and fifth characters represent the bureau code.", "example": "D000" }, "siteTypeName": { "maxLength": 40, "type": "string", "description": "The descriptive name for the type of facility. Allowable Values (example):POTENTIALLY CONTAMINATED SITE, NETWORK, MONITORING STATION, STATIONARY, WATER SYSTEM, MOBILE, FACILITY, PIPELINE, CONTAMINATION ADDRESSED, CONTAMINATED SITE, BROWNFIELDS SITE, PORTABLE, OFF-SHORE PLATFORM.", "example": "STATIONARY" }, "isSmallBusinessFlag": { "maxLength": 1, "type": "string", "description": "Y/N code indicating whether or not a business is requesting relief under EPA Small Business Policy, which applies to businesses having less than 100 employees.", "example": "Y" }, "HUCCode8": { "maxLength": 8, "type": "string", "description": "The HUC 8 Code for the registry item.", "example": "17060102" }, "HUCCode12": { "maxLength": 12, "type": "string", "description": "The HUC 12 Code for the registry item.", "example": "170601020101" }, "IsPOTWFlag": { "maxLength": 1, "type": "string", "description": "Indicates whether this registry item is of POTW.", "example": "" }, "countryISO31661Alpha2": { "maxLength": 2, "type": "string", "description": "The country code is ISO 3166 1 Alpha 2 format.", "example": "" }, "facilityManagementTypeCode": { "maxLength": 20, "type": "string", "description": "The type of facility management performed for the registry item.", "example": "" }, "facilityOwnerType": { "maxLength": 40, "type": "string", "description": "The type of facility owner for the registry id. Allowable Values (xample): BANK/LOAN COMPANY, BROWNFIELDS/PUBLIC, COUNTY OWNED, DISTRICT OWNED, FEDERALLY OWNED, NEITHER, FORMERLY FEDERALLY OWNED OR OPERATED, GOVERNMENT OWNED / CONTRACTOR OPERATED, MIXED OWNERSHIP, MUNICIPALITY, PRIVATE, PRIVATELY OWNED / GOVERNMENT OPERATED, PROPERTY DEFAULTED BACK TO GOVERNMENT, STATE OWNED, TRIBAL GOVERNMENT, TRUSTEE, FEDERAL, TRUSTEE, STATE, FEDERAL, OTHER, UNKNOWN, GOCO ", "example": "BROWNFIELDS/PUBLIC" }, "legislativeDistrictNumber": { "maxLength": 2, "type": "string", "description": "The legislative district number for the registry item.", "example": "10" }, "locationDescription": { "maxLength": 256, "type": "string", "description": "A location description for the registry item.", "example": "Part of an EPA Superfund site." }, "operatingStatus": { "maxLength": 100, "type": "string", "description": "The operating status of the registry item.", "example": "SEASONAL" }, "operatingStatusDate": { "maxLength": 30, "type": "string", "description": "The last date the operating status was collected.", "example": "2012-04-21T23:25:43.000Z" }, "operatingStatusYear": { "type": "string", "description": "The last year the operating status was collected.", "example": "1991" }, "isPortableSourceFlag": { "maxLength": 1, "type": "string", "description": "Indicates if this is a portable registry item.", "example": "N" }, "startDate": { "maxLength": 30, "type": "string", "description": "The date this data started to be of interest in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" }, "endDate": { "maxLength": 30, "type": "string", "description": "The date this data is no longer of interest in ISO 8601 format", "example": "2012-04-21T00:00:00.000Z" }, "lastReportedDate": { "maxLength": 30, "type": "string", "description": "The most recent date the corresponding data was reported to the Source of Data in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" }, "FacilitySourceSystemProgramCode": { "maxLength": 20, "type": "string", "description": "The code that represents the information management system which has responsibility for the data in a linked or interrelated information management system.", "example": "RI-PLOVER" }, "isSensitiveFlag": { "maxLength": 1, "type": "string", "description": "Indicates whether or not the associated data is enforcement sensitive.", "example": "N" }, "isPublicFlag": { "maxLength": 1, "type": "string", "description": "Indicates whether or not the associated data is accessible by the public on the Internet.", "example": "Y" }, "userId": { "type": "string", "description": "The user ID of the person who entered the data or the method by which the data was entered into the system.", "example": "JOHN_DOE" } } }, "RegistryGis": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "registryId": { "maxLength": 40, "type": "string", "description": "The identification number assigned by the EPA Facility Registry System to uniquely identify an object of interest.", "example": "999983143090" }, "latitude": { "type": "string", "description": "The measure of the angular distance on a meridian north or south of the equator, as reported by the data source.", "example": "41.803432" }, "longitude": { "type": "string", "description": "The measure of the angular distance on a meridian east or west of the prime meridian, as reported by the data source.", "example": "-71.405394" }, "accuracyValue": { "type": "string", "description": "The measure of the accuracy (in meters) of the latitude and longitude coordinates.", "example": "150" }, "collectionMethodCode": { "maxLength": 3, "type": "string", "description": "The code that represents the method used to determine the latitude and longitude coordinates for a point on the earth.", "example": "" }, "scale": { "type": "string", "description": "The number that represents the proportional distance on the ground for one unit of measure on the map or photo. Remarks: Mandatory for all horizontal data collection methods except for methods using Global Positioning System (GPS).", "example": "100" }, "heightDatumCode": { "maxLength": 3, "type": "string", "description": "The code that represents the reference datum used in determining latitude and longitude coordinates. Allowable Values: Value Meaning 001 NAD27 002 NAD83 003 WGS84.", "example": "002" }, "refPointCode": { "maxLength": 3, "type": "string", "description": "The code that represents the place for which geographic coordinates were established.", "example": "" } } }, "Interest": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "interestType": { "maxLength": 60, "type": "string", "description": "The type of interest.", "example": "CRITERIA AND HAZARDOUS AIR POLLUTANT INVENTORY" }, "federalStateCode": { "maxLength": 1, "type": "string", "description": "Indicator if the interest is a federal, state, or tribal code. Acceptable values are F (Federal), S (State), and T (Tribal).", "example": "F" }, "startDate": { "maxLength": 30, "type": "string", "description": "The date this data started to be of interest in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" }, "startDateQualifier": { "type": "string", "description": "A qualifier for what the startDate value means.", "example": "FIRST NOTIFICATION DATE" }, "endDate": { "maxLength": 30, "type": "string", "description": "The date this data is no longer of interest in ISO 8601 format", "example": "2012-04-21T00:00:00.000Z" }, "endDateQualifier": { "type": "string", "description": "A qualifier for what the endDate value means.", "example": "FIRST NOTIFICATION DATE" } } }, "Sic": { "required": [ "SICCode", "primaryIndicator", "programSystemAcronym", "programSystemId", "sourceOfData" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "SICCode": { "maxLength": 4, "type": "string", "description": "The code that represents the economic activity of a company (four-digits).", "example": "3087" }, "primaryIndicator": { "maxLength": 10, "type": "string", "description": "Indicates whether this SIC is the primary for the registry item. Acceptable values are: PRIMARY, SECONDARY, UNKNOWN.", "example": "PRIMARY" }, "sourceOfData": { "maxLength": 10, "type": "string", "description": "Indicates the originating system for this information.", "example": "RI-PLOVER" }, "lastReportedDate": { "maxLength": 30, "type": "string", "description": "The most recent date the corresponding data was reported to the Source of Data in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" } } }, "Mail": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "affiliationType": { "maxLength": 40, "type": "string", "description": "The name that describes the capacity or function that an organization or individual serves for a facility site. Allowable Values (examples): Organization Individual Legally Responsible Entity Report Certifier Legal Operator Regulatory Contact Waste Treater Public Contact Waste Handler Technical Contact Land Owner Owner Parent Corporation Operator Owner/Operator.", "example": "MAILING ADDRESS" }, "mailingAddress": { "maxLength": 100, "type": "string", "description": "The street address of the data.", "example": "123 MAIN STREET" }, "supplementalAddress": { "maxLength": 100, "type": "string", "description": "The supplemental address of the data.", "example": "APT 123" }, "cityName": { "maxLength": 30, "type": "string", "description": "The name of the city.", "example": "PROVIDENCE" }, "stateCode": { "maxLength": 5, "type": "string", "description": "The state code for the address.", "example": "RI" }, "stateName": { "maxLength": 35, "type": "string", "description": "The state name for the mailing address.", "example": "RHODE ISLAND" }, "postalCode": { "maxLength": 14, "type": "string", "description": "The postal code for the mailing address.", "example": "12345" }, "countryName": { "maxLength": 44, "type": "string", "description": "The country name for the mailing address.", "example": "USA" }, "countryFIPSCode": { "maxLength": 2, "type": "string", "description": "The FIPS code for the country.", "example": "US" }, "countyFIPSCode": { "maxLength": 5, "type": "string", "description": "The FIPS code for the county.", "example": "12345" }, "countryISO31661Alpha2": { "maxLength": 2, "type": "string", "description": "The ISO 3166 1 Alpha 2 representation of the country.", "example": "US" }, "startDate": { "maxLength": 30, "type": "string", "description": "The date this data started to be of interest in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" }, "endDate": { "maxLength": 30, "type": "string", "description": "The date this data is no longer of interest in ISO 8601 format", "example": "2012-04-21T00:00:00.000Z" }, "lastReportedDate": { "maxLength": 30, "type": "string", "description": "The most recent date the corresponding data was reported to the Source of Data in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" } } }, "Contact": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "affiliationType": { "maxLength": 40, "type": "string", "description": "The name that describes the capacity or function that an organization or individual serves for a facility site. Allowable Values (examples): Organization Individual Legally Responsible Entity Report Certifier Legal Operator Regulatory Contact Waste Treater Public Contact Waste Handler Technical Contact Land Owner Owner Parent Corporation Operator Owner/Operator.", "example": "APPLICANT" }, "fullName": { "maxLength": 150, "type": "string", "description": "The full name of the contact.", "example": "JOHN DOE" }, "title": { "maxLength": 40, "type": "string", "description": "The contact's title.", "example": "PRESIDENT" }, "divisionName": { "maxLength": 50, "type": "string", "description": "The division name for the contact.", "example": "HQ DIVISION" }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "The phone number for the contact.", "example": "111-222-3333" }, "phoneNumberExtension": { "maxLength": 30, "type": "string", "description": "The phone number extension for the contact.", "example": "1234" }, "alternatePhone": { "maxLength": 30, "type": "string", "description": "The alternate phone number for the contact.", "example": "111-222-3334" }, "faxNumber": { "maxLength": 30, "type": "string", "description": "The fax number for the contact.", "example": "111-222-3335" }, "emailAddress": { "maxLength": 120, "type": "string", "description": "The email address for the contact.", "example": "TEST@EPA.GOV" }, "mailingAddress": { "maxLength": 100, "type": "string", "description": "The mailing address of the contact.", "example": "123 MAIN STREET" }, "supplementalAddress": { "maxLength": 100, "type": "string", "description": "The supplemental address of the data.", "example": "SUITE 123" }, "cityName": { "maxLength": 30, "type": "string", "description": "The name of the city.", "example": "PROVIDENCE" }, "stateCode": { "maxLength": 5, "type": "string", "description": "The state code for the address.", "example": "RI" }, "postalCode": { "maxLength": 14, "type": "string", "description": "The postal code for the contact.", "example": "RI" }, "countryName": { "maxLength": 44, "type": "string", "description": "The country name for the contact.", "example": "USA" }, "startDate": { "maxLength": 30, "type": "string", "description": "The date this data started to be of interest in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" }, "endDate": { "maxLength": 30, "type": "string", "description": "The date this data is no longer of interest in ISO 8601 format", "example": "2012-04-21T00:00:00.000Z" }, "lastReportedDate": { "maxLength": 30, "type": "string", "description": "The most recent date the corresponding data was reported to the Source of Data in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" }, "contactId": { "maxLength": 12, "type": "string", "description": "The identification number assigned by the EPA Facility Registry System to uniquely identify a Contact person.", "example": "1234" }, "countyFips": { "maxLength": 5, "type": "string", "description": "The county FIPs for the Contact person.", "example": "1234" } } }, "Organization": { "required": [ "orgName", "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "orgName": { "maxLength": 150, "type": "string", "description": "The legal, formal name of an organization that is affiliated with the facility site.", "example": "ABC COMPANY" }, "affiliationType": { "maxLength": 40, "type": "string", "description": "The name that describes the capacity or function that an organization or individual serves for a facility site. Allowable Values (examples): Organization Individual Legally Responsible Entity Report Certifier Legal Operator Regulatory Contact Waste Treater Public Contact Waste Handler Technical Contact Land Owner Owner Parent Corporation Operator Owner/Operator.", "example": "OWNER" }, "startDate": { "maxLength": 30, "type": "string", "description": "The date this data started to be of interest in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" }, "endDate": { "maxLength": 30, "type": "string", "description": "The date this data is no longer of interest in ISO 8601 format", "example": "2012-04-21T00:00:00.000Z" }, "orgType": { "maxLength": 40, "type": "string", "description": "The type of organization. Allowable Values (examples): Federal Private GOCO County District Tribal Municipal Other State.", "example": "GOCO" }, "dunsNumber": { "maxLength": 9, "type": "string", "description": "The Data Universal Numbering System (DUNS) number assigned by Dun and Bradstreet to identify unique business establishments.", "example": "123" }, "divisionName": { "maxLength": 50, "type": "string", "description": "The name of a division or a department of a company.", "example": "HQ" }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "The primary telephone number for an organization.", "example": "123-456-7899" }, "alternatePhone": { "maxLength": 30, "type": "string", "description": "An alternate telephone number for an organization.", "example": "123-456-8888" }, "faxNumber": { "maxLength": 30, "type": "string", "description": "The telephone number to which a facsimile can be sent to an organization.", "example": "123-456-9999" }, "emailAddress": { "maxLength": 120, "type": "string", "description": "The text that describes an electronic mail address of an organization.", "example": "TEST@EPA.GOV" }, "ein": { "maxLength": 14, "type": "string", "description": "The unique tax identification number issued by the Internal Revenue Service to the employer.", "example": "1234" }, "stateBusinessId": { "maxLength": 30, "type": "string", "description": "The uniform business number assigned to an official business by a state.", "example": "5678" }, "mailingAddress": { "maxLength": 100, "type": "string", "description": "The street address of the data.", "example": "123 MAIN STREET" }, "supplementalAddress": { "maxLength": 100, "type": "string", "description": "The supplemental address of the data.", "example": "APT 123" }, "cityName": { "maxLength": 30, "type": "string", "description": "The name of the city.", "example": "PROVIDENCE" }, "stateCode": { "maxLength": 5, "type": "string", "description": "The state code for the address.", "example": "RI" }, "stateName": { "maxLength": 35, "type": "string", "description": "The state name for the mailing address.", "example": "RHODE ISLAND" }, "postalCode": { "maxLength": 14, "type": "string", "description": "The postal code for the mailing address.", "example": "12345" }, "countryName": { "maxLength": 44, "type": "string", "description": "The country name for the mailing address.", "example": "USA" }, "lastReportedDate": { "maxLength": 7, "type": "string", "description": "The most recent date the corresponding individual data was reported to the Source of Data.", "example": "2017-10-08T00:00:00.000Z" }, "ownerPercent": { "maxLength": 22, "type": "string", "description": "The percentage of the facility the company owns.", "example": "100" }, "countryFipsCode": { "maxLength": 2, "type": "string", "description": "Two-character codes developed to represent countries.", "example": "US" }, "phoneNumExtension": { "maxLength": 30, "type": "string", "description": "The phone number extension.", "example": "1234" }, "comments": { "maxLength": 1000, "type": "string", "description": "The organization comments.", "example": "ORGANIZATION COMMENTS TESTING" }, "employeeCount": { "maxLength": 22, "type": "string", "description": "The employee count of the organization.", "example": "123" }, "websiteUrl": { "maxLength": 200, "type": "string", "description": "The URL of the organization website.", "example": "https://www.epa.gov" } } }, "Naics": { "required": [ "primaryIndicator", "programSystemAcronym", "programSystemId", "sourceOfData" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "naicsCode": { "maxLength": 6, "type": "string", "description": "The code that represents a subdivision of an industry that accommodates user needs in the United States (six-digits).", "example": "22132" }, "primaryIndicator": { "maxLength": 10, "type": "string", "description": "Indicates whether this SIC is the primary for the registry item. Acceptable values are: PRIMARY, SECONDARY, UNKNOWN.", "example": "PRIMARY" }, "sourceOfData": { "maxLength": 10, "type": "string", "description": "Indicates the originating system for this information.", "example": "RI-PLOVER" }, "lastReportedDate": { "maxLength": 30, "type": "string", "description": "The most recent date the corresponding data was reported to the Source of Data in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" } } }, "Association": { "required": [ "programSystemAcronym", "programSystemId", "subComponentId1", "subComponentId2" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "subComponentId1": { "maxLength": 30, "type": "string", "description": "the sub-component ID to be associated with subComponentId2.", "example": "R80307-DEMO" }, "subComponentId2": { "maxLength": 30, "type": "string", "description": "the sub-component ID to be associated with subComponentId1.", "example": "P57394-DEMO" }, "subAssociationAveragePercent": { "type": "string", "description": "The average percent of subAssociationInternalId1/subAssociationProgramSystemId1 as it relates to subAssociationInternalId2/subAssociationProgramSystemId2. For example, the average percent of emissions vented through a release point. ", "example": "100" }, "controlOrder": { "maxLength": 3, "type": "string", "description": "stores the order a control variable is in the chain of the specified relationship", "example": "2" }, "seriesParallelInd": { "maxLength": 3, "type": "string", "description": "denotes if a component is in a parallel sequence (or order) with another component", "example": "Y" } } }, "Unit": { "required": [ "programSystemAcronym", "programSystemId", "unitAlternateID", "unitDescription", "unitId", "unitTypeCode", "unitTypeDescription" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "unitId": { "maxLength": 20, "type": "string", "description": "An identifier by which the unit is referred to by the primary EPA environmental information system that collects air emission information.", "example": "" }, "unitAlternateID": { "maxLength": 150, "type": "string", "description": "An alternative identification number maintained by an information management system for an environmental program.", "example": "54765765" }, "unitAlternateName": { "maxLength": 150, "type": "string", "description": "An alternative, historic or program specific name for the sub-component.", "example": "YTUTYU" }, "unitDescription": { "maxLength": 255, "type": "string", "description": "Text description of the emissions unit.", "example": "YTUTYU" }, "unitTypeCode": { "maxLength": 20, "type": "string", "description": "Code that identifies the type of emissions unit activity.", "example": "100" }, "unitTypeDescription": { "maxLength": 100, "type": "string", "description": "The description of the unit type code, which identifies the type of emissions unit activity.", "example": "BOILER - FUEL COMB. EQUIPMENT" }, "unitDesignCapacity": { "type": "string", "description": "The measure of the size of the unit based on the maximum continuous throughput capacity of the unit.", "example": "24.8" }, "unitDesignCapacityUomCode": { "maxLength": 20, "type": "string", "description": "Unit of measure code for the design capacity of the emissions unit.", "example": "" }, "unitOfMeasureDescription": { "maxLength": 200, "type": "string", "description": "Description of the unit of measure code.", "example": "" }, "unitOperationDate": { "maxLength": 20, "type": "string", "description": "The date on which unit activity became operational.", "example": "01-Nov-2017" }, "unitComment": { "maxLength": 400, "type": "string", "description": "Any comments regarding the emissions unit activity.", "example": "" }, "unitOperatingStatus": { "maxLength": 100, "type": "string", "description": "The operating status of the object of interest. Acceptable values are PLANNED, UNDER CONSTRUCTION, OPERATING, TEMPORARILY CLOSED, PERMANENTLY CLOSED, SEASONAL.", "example": "OPERATING" }, "unitOperatingStatusYear": { "maxLength": 4, "type": "string", "description": "The operating status year.", "example": "2010" }, "unitPermitStatus": { "maxLength": 100, "type": "string", "description": " The permitting status of the object of interest.", "example": "" }, "unitPermitStartYear": { "maxLength": 4, "type": "string", "description": "The start year of the permitting status of the object.", "example": "2010" }, "unitPermitEndYear": { "maxLength": 4, "type": "string", "description": "The end year of the permitting status of the object.", "example": "2015" }, "unitSourceSystemProgramCode": { "maxLength": 20, "type": "string", "description": "The code that represents the information management system which has responsibility for the data in a linked or interrelated information management system.", "example": "RI-PLOVER" } } }, "Process": { "required": [ "processAlternateID", "processId", "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "processId": { "maxLength": 20, "type": "string", "description": "An identifier by which the Process is referred to by the primary EPA environmental information system that collects air emission information.", "example": "" }, "processAlternateID": { "maxLength": 150, "type": "string", "description": "An alternative identification number maintained by an information management system for an environmental program.", "example": "ASDFSDAF" }, "processSccCode": { "maxLength": 20, "type": "string", "description": "EPA Source Classification Code that identifies an emissions process.", "example": "41000132" }, "processDescription": { "maxLength": 756, "type": "string", "description": "A text description of the emissions process.", "example": "CHEMICAL EVAPORATION - DRY CLEANING - PETROLEUM SOLVENT - INDUSTRIAL - DRYER: DRYING CYCLE" }, "processOperatingStatus": { "maxLength": 100, "type": "string", "description": "The operating status of the object of interest. Acceptable values are PLANNED, UNDER CONSTRUCTION, OPERATING, TEMPORARILY CLOSED, PERMANENTLY CLOSED, SEASONAL.", "example": "OPERATING" }, "processOperatingStatusYear": { "maxLength": 4, "type": "string", "description": "The operating status year.", "example": "2010" }, "processSourceSystemProgramCode": { "maxLength": 20, "type": "string", "description": "The code that represents the information management system which has responsibility for the data in a linked or interrelated information management system.", "example": "RI-PLOVER" }, "processAircraftEngineTypeCode": { "maxLength": 20, "type": "string", "description": "Identifies the combination of aircraft and engine type for airport emissions.", "example": "1234" } } }, "Control": { "required": [ "controlAlternateID", "controlId", "controlMeasureType", "controlOperatingMonthsNumber", "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "controlId": { "maxLength": 20, "type": "string", "description": "An identifier by which the control measure is referred to by the information system that collected the air emission information.", "example": "" }, "controlAlternateID": { "maxLength": 150, "type": "string", "description": "An alternative identification number maintained by an information management system for an environmental program.", "example": "ASDFSDAF" }, "controlCaptureEfficiencyPercent": { "type": "string", "description": "An estimate of that portion of an affected emission stream that is collected and routed to the control measures when the capture or collection system is operating as designed, reported as a percent.", "example": "50" }, "controlEffectivenessPercent": { "type": "string", "description": "An estimate of the portion of the reporting period's activity for which the overall control system or approach (including both capture and control measures) were operating as designed (regardless of whether the control measure is due to rule or voluntary).", "example": "50" }, "controlFirstInventoryYear": { "type": "string", "description": "The inventory year for which the controls were implemented.", "example": "1980" }, "controlLastInventoryYear": { "type": "string", "description": "The last inventory year for which the controls were active.", "example": "2009" }, "controlOperatingMonthsNumber": { "type": "string", "description": "Number of months the control measure is being operated.", "example": "12" }, "controlMeasureType": { "maxLength": 20, "type": "string", "description": "The code that indicates the type of control measure.", "example": "112" }, "controlMeasureTypeDesc": { "maxLength": 200, "type": "string", "description": "The description of the code about the control measure.", "example": "AFTERBURNER - DEVICE" }, "controlOperatingStatus": { "maxLength": 100, "type": "string", "description": "The operating status of the object of interest. Acceptable values are PLANNED, UNDER CONSTRUCTION, OPERATING, TEMPORARILY CLOSED, PERMANENTLY CLOSED, SEASONAL.", "example": "OPERATING" }, "controlOperatingStatusYear": { "maxLength": 4, "type": "string", "description": "The operating status year.", "example": "2010" }, "controlSourceSystemProgramCode": { "maxLength": 20, "type": "string", "description": "The code that represents the information management system which has responsibility for the data in a linked or interrelated information management system.", "example": "RI-PLOVER" }, "controlEquipmentType": { "maxLength": 100, "type": "string", "description": "Name that identifies the piece of equipment or practice that is used to reduce one or more pollutants.", "example": "TEST" } } }, "Pollutant": { "required": [ "controlPollutantName", "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "controlId": { "maxLength": 20, "type": "string", "description": "An identifier by which the control measure is referred to by the information system that collected the air emission information.", "example": "" }, "unitId": { "maxLength": 20, "type": "string", "description": "An identifier by which the unit is referred to by the information system that collected the air emission information.", "example": "" }, "processId": { "maxLength": 20, "type": "string", "description": "An identifier by which the processis referred to by the information system that collected the air emission information.", "example": "" }, "controlPollutantName": { "maxLength": 200, "type": "string", "description": "The name of the pollutant which is controlled by the control measure.", "example": "PROPIONALDEHYDE" }, "controlReductionEfficiencyPercent": { "type": "string", "description": "The reduction efficiency (in %) of the associated control measure for this pollutant.", "example": "50" }, "pollutantCode": { "maxLength": 50, "type": "string", "description": "The code for the pollutant which is controlled by the control measure.", "example": "123386" }, "sitePathId": { "maxLength": 20, "type": "string", "description": "The identification number for the site path record.", "example": "1" } } }, "ReleasePoint": { "required": [ "programSystemAcronym", "programSystemId", "releasePointAlternateID", "releasePointId", "releasePointLatitude", "releasePointLongitude", "releasePointTypeName" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "releasePointId": { "maxLength": 20, "type": "string", "description": "An identifier by which the release point is referred to by the environmental system.", "example": "" }, "releasePointAlternateID": { "maxLength": 150, "type": "string", "description": "An alternative identification number maintained by an information management system for an environmental program.", "example": "ASDFSDAF" }, "releasePointTypeName": { "maxLength": 30, "type": "string", "description": "Name that identifies the type of release point. Permitted values include Goose Neck, Downward-facing Vent, Vertical, Vertical with Rain Cap, Horizontal, etc.", "example": "VERTICAL STACK" }, "releasePointExitGasVelocityMeasure": { "type": "string", "description": "The velocity of an exit gas stream.", "example": "12" }, "releasePointExitGasFlowRateMeasure": { "type": "string", "description": "The value of stack gas flow rate.", "example": "2.2" }, "releasePointExitTemperatureMeasure": { "type": "string", "description": "The temperature of an exit gas stream (measured in degrees Fahrenheit).", "example": "1231" }, "releasePointFugitiveHeightMeasure": { "type": "string", "description": "The fugitive release height above terrain of fugitive emissions.", "example": "10" }, "releasePointFugitiveWidthMeasure": { "type": "string", "description": "The width of the fugitive release in the East-West direction as if the angle is zero degrees.", "example": "10" }, "releasePointFugitiveLengthMeasure": { "type": "string", "description": "The length of the fugitive release in the North-South direction as if the angle is zero degrees.", "example": "50" }, "releasePointFugitiveAngleMeasure": { "type": "string", "description": "The orientation angle for the area in degrees from North, measured positive in the clockwise direction.", "example": "20" }, "releasePointLatitude": { "type": "string", "description": "The measure of the angular distance on a meridian north or south of the equator, as reported by the data source. ", "example": "30.199608" }, "releasePointLongitude": { "type": "string", "description": "The measure of the angular distance on a meridian east or west of the prime meridian, as reported by the data source", "example": "-92.394333" }, "releasePointFugitiveLinePt1Latitude": { "type": "string", "description": "The measure of angular distance on a meridian north or south of the equator for a two-dimensional fugitive release.", "example": "30.199608" }, "releasePointFugitiveLinePt1Longitude": { "type": "string", "description": "The measure of angular distance on a meridian east or west of the prime meridian for a two-dimensional fugitive release.", "example": "-92.394333" }, "releasePointFugitiveLinePt2Latitude": { "type": "string", "description": "The measure of angular distance on a meridian north or south of the equator for a two-dimensional fugitive release.", "example": "30.199608" }, "releasePointFugitiveLinePt2Longitude": { "type": "string", "description": "The measure of angular distance on a meridian east or west of the prime meridian for a two-dimensional fugitive release.", "example": "-92.394333" }, "releasePointStackDiameterMeasure": { "type": "string", "description": "The internal diameter of the stack at the release height.", "example": "0.56" }, "releasePointStackHeightMeasure": { "type": "string", "description": "The height of the stack from the ground.", "example": "1" }, "releasePointStackHeightUomCode": { "maxLength": 20, "type": "string", "description": "The stack height unit of measure.", "example": "FEET" }, "releasePointStackDiameterUomCode": { "maxLength": 20, "type": "string", "description": "The stack diameter unit of measure.", "example": "FEET" }, "releasePointExitGasVelocityUomCode": { "maxLength": 20, "type": "string", "description": "The unit of measure for the velocity of an exit gas stream value.", "example": "FPS" }, "releasePointExitGasFlowRateUomCode": { "maxLength": 20, "type": "string", "description": "The unit of measure for the stack gas flow rate value.", "example": "ACFS" }, "releasePointFugitiveHeightUomCode": { "maxLength": 20, "type": "string", "description": "The fugitive release height unit of measure.", "example": "FEET" }, "releasePointFugitiveWidthUomCode": { "maxLength": 20, "type": "string", "description": "The fugitive width unit of measure code. Default is 'feet'.", "example": "FEET" }, "releasePointFugitiveLengthUomCode": { "maxLength": 20, "type": "string", "description": "The fugitive length unit of measure code. Default is 'feet'.", "example": "FEET" }, "releasePointFugitiveAngleMsrUomCode": { "maxLength": 20, "type": "string", "description": "The fugitive angle unit of measure code", "example": "FEET" }, "releasePointReferenceCode": { "maxLength": 3, "type": "string", "description": "The code that determines the location of the release point.", "example": "006" }, "releasePointDataCollectionDate": { "maxLength": 11, "type": "string", "description": "The calendar date when data were collected.", "example": "01-Nov-2017" }, "releasePointFugitiveDiameter": { "type": "string", "description": "The diameter of the fugitive release.", "example": "1.2" }, "releasePointFugitiveDiameterUomCode": { "maxLength": 20, "type": "string", "description": "The fugitive diameter unit of measure code", "example": "FEET" }, "releasePointCollectionMthCode": { "maxLength": 3, "type": "string", "description": "The code that represents the method used to determine the latitude and longitude coordinates for a point on the earth.", "example": "003" }, "releasePointCollectionMthComment": { "maxLength": 50, "type": "string", "description": "The description of the code that represents the method used to determine the latitude and longitude coordinates for a point on the earth.", "example": "INHERITED FROM FACILITY" }, "releasePointTypeCode": { "maxLength": 3, "type": "string", "description": "The release point type code.", "example": "123" }, "releasePointOperatingStatus": { "maxLength": 100, "type": "string", "description": "The operating status of the object of interest. Acceptable values are PLANNED, UNDER CONSTRUCTION, OPERATING, TEMPORARILY CLOSED, PERMANENTLY CLOSED, SEASONAL.", "example": "OPERATING" }, "releasePointOperatingStatusYear": { "maxLength": 4, "type": "string", "description": "The operating status year.", "example": "2010" }, "releasePointSourceSystemProgramCode": { "maxLength": 20, "type": "string", "description": "The code that represents the information management system which has responsibility for the data in a linked or interrelated information management system.", "example": "RI-PLOVER" }, "releasePointFenceLineDistanceMeasure": { "type": "string", "description": "", "example": "500" }, "releasePointFenceLineDistanceUomCode": { "maxLength": 20, "type": "string", "description": "", "example": "FEET" }, "releasePointComment": { "maxLength": 400, "type": "string", "description": "", "example": "" } } }, "AlternativeName": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "alternativeName": { "maxLength": 150, "type": "string", "description": "An alternative, historic or program specific name for the facility site.", "example": "ALT NAME 1" }, "alternativeNameType": { "maxLength": 100, "type": "string", "description": "The type of the alternative, historical, or program-specific name for the registry object (e.g., primary, legal, historical, local).", "example": "PLOVER ALT NAME" }, "lastReportedDate": { "maxLength": 7, "type": "string", "description": "The most recent date the corresponding individual data was reported to the Source of Data.", "example": "2017-10-08T00:00:00.000Z" } } }, "ProgramGIS": { "required": [ "latitude", "longitude", "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "latitude": { "type": "string", "description": "The measure of the angular distance on a meridian north or south of the equator, as reported by the data source.", "example": "41.803432" }, "longitude": { "type": "string", "description": "The measure of the angular distance on a meridian east or west of the prime meridian, as reported by the data source.", "example": "-71.405394" }, "accuracyValue": { "type": "string", "description": "The measure of the accuracy (in meters) of the latitude and longitude coordinates.", "example": "150" }, "verticalMeasure": { "type": "string", "description": "The measure of elevation (i.e., the altitude), in meters, above or below a reference datum.", "example": "250" }, "verticalMethodCode": { "maxLength": 3, "type": "string", "description": "The code that represents the method used to collect the vertical measure (i.e., the altitude) of a reference point.", "example": "" }, "verticalDatumCode": { "maxLength": 3, "type": "string", "description": "The code that represents the reference datum used to determine the vertical measure (i.e., the altitude). Allowable Values: Value Meaning 001 NAVD88 002 NGVD29 003 MEAN SEA-LEVEL 004 LOCAL TIDAL DATUM.", "example": "001" }, "verticalAccuracy": { "type": "string", "description": "The measure of the accuracy (in meters) of the vertical measure (i.e., the altitude) of a reference point.", "example": "0" }, "collectionMethodCode": { "maxLength": 3, "type": "string", "description": "The code that represents the method used to determine the latitude and longitude coordinates for a point on the earth.", "example": "" }, "scale": { "type": "string", "description": "The number that represents the proportional distance on the ground for one unit of measure on the map or photo. Remarks: Mandatory for all horizontal data collection methods except for methods using Global Positioning System (GPS).", "example": "100" }, "heightDatumCode": { "maxLength": 3, "type": "string", "description": "The code that represents the reference datum used in determining latitude and longitude coordinates. Allowable Values: Value Meaning 001 NAD27 002 NAD83 003 WGS84.", "example": "002" }, "collectionDate": { "maxLength": 30, "type": "string", "description": "The calendar data when data were collected.", "example": "2012-04-21T00:00:00.000Z" }, "commentText": { "maxLength": 150, "type": "string", "description": "The text that provides additional information about the geographic coordinates.", "example": "TEST GIS COMMENTS" }, "geometricTypeCode": { "maxLength": 3, "type": "string", "description": "The code that represents the geometric entity represented by one point or a sequence of latitude and longitude points. Allowable Values: Value Meaning 001 POINT 002 LINE 003 AREA 004 REGION 005 ROUTE.", "example": "001" }, "refPointCode": { "maxLength": 3, "type": "string", "description": "The code that represents the place for which geographic coordinates were established.", "example": "" } } }, "AlternativeId": { "required": [ "alternativeId", "alternativeIdType", "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "alternativeId": { "maxLength": 150, "type": "string", "description": "An alternative identification number maintained by an information management system for an environmental program.", "example": "1A" }, "alternativeIdType": { "maxLength": 250, "type": "string", "description": "The type of alternative identification number (for example, STATE PERMIT NUMBER), or the abbreviated name of the environmental information system that references the alternative identification number (for example, TRIS, PCS).", "example": "PLOVER ALT ID" }, "lastReportedDate": { "maxLength": 7, "type": "string", "description": "The most recent date the corresponding individual data was reported to the Source of Data.", "example": "2017-10-08T00:00:00.000Z" }, "responsibleAgency": { "maxLength": 200, "type": "string", "description": "The agency or bureau name (e.g., state DEQ) associated with the facility.", "example": "GEORGIA DEPARTMENT OF NATURAL RESOURCES" } } }, "Tribe": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "EPAId": { "type": "string", "description": "The EPA internal identifier of the tribe.", "example": "406" }, "BIACode": { "maxLength": 3, "type": "string", "description": "The code that represents the American Indian tribe, band, or Alaskan Native entity. Permissible values for the Tribal Code data element are based on the BIA official list of tribal codes, e.g., 007 (St. Regis Band of Mohawk Indians of New York) or F09 (Birch Creek Tribe).", "example": "162" }, "tribeName": { "maxLength": 350, "type": "string", "description": "The name of the American Indian tribe, band, or Alaskan Native entity. Permissible values for the Tribal Name data element are based on the BIA federally recognized tribal list, e.g., St. Regis Band of Mohawk Indians of New York.", "example": "NATIVE VILLAGE OF FORT YUKON" }, "lastReportedDate": { "maxLength": 30, "type": "string", "description": "The most recent date the corresponding data was reported to the Source of Data in ISO 8601 format.", "example": "2012-04-21T00:00:00.000Z" } } }, "SitePath": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "sitePathId": { "maxLength": 20, "type": "string", "description": "The identification number for this record.", "example": "1" }, "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "RI-PLOVER" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "3977" }, "eisPathId": { "maxLength": 20, "type": "string", "description": "The identification number for the associated Environmental Information System record.", "example": "1" }, "pathName": { "maxLength": 20, "type": "string", "description": "The site path.", "example": "Path" }, "pathDescription": { "maxLength": 200, "type": "string", "description": "A description of the site path.", "example": "Description" }, "createDate": { "maxLength": 30, "type": "string", "description": "The date the record was created.", "example": "18-SEP-20" }, "refreshDate": { "maxLength": 30, "type": "string", "description": "The date the record was refreshed.", "example": "18-SEP-20" }, "userId": { "maxLength": 160, "type": "string", "description": "The user ID of the person who entered the data or the method by which the data was entered into the system.", "example": "JOHNDOE" } } }, "AltSitePath": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "altPathId": { "maxLength": 20, "type": "string", "description": "The identification number for the alt site path record.", "example": "1" }, "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "CEDRI" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "CEDRI10000483" }, "sitePathId": { "maxLength": 20, "type": "string", "description": "The identification number for the site path record.", "example": "1" }, "altAgencyPathId": { "maxLength": 20, "type": "string", "description": "The identification number for the alt site path agency.", "example": "1" }, "effectiveDate": { "maxLength": 30, "type": "string", "description": "The date the record takes effect.", "example": "18-SEP-20" }, "endDate": { "maxLength": 30, "type": "string", "description": "The record's end date.", "example": "18-SEP-20" }, "createDate": { "maxLength": 30, "type": "string", "description": "The date the record was created.", "example": "18-SEP-20" }, "refreshDate": { "maxLength": 30, "type": "string", "description": "The date the record was refreshed.", "example": "18-SEP-20" }, "userId": { "maxLength": 160, "type": "string", "description": "The user ID of the person who entered the data or the method by which the data was entered into the system.", "example": "JOHNDOE" } } }, "PathAssignment": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "assignedControlId": { "maxLength": 20, "type": "string", "description": "The identification number for assigned control.", "example": "1" }, "assignedPathId": { "maxLength": 20, "type": "string", "description": "The identification number for the assigned path.", "example": "1" }, "avgPctApprt": { "maxLength": 4, "type": "string", "description": "The average apportionment.", "example": "1" }, "createDate": { "maxLength": 30, "type": "string", "description": "The date the record was created.", "example": "18-SEP-20" }, "pathAssignmentId": { "maxLength": 20, "type": "string", "description": "The identification number for the path assignment.", "example": "1" }, "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "CEDRI" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "CEDRI10000483" }, "refreshDate": { "maxLength": 30, "type": "string", "description": "The date the record was refreshed.", "example": "18-SEP-20" }, "sequenceNum": { "maxLength": 4, "type": "string", "description": "The sequence of the path assignment.", "example": "1" }, "sitePathId": { "maxLength": 20, "type": "string", "description": "The identification number for the site path record.", "example": "1" }, "userId": { "maxLength": 160, "type": "string", "description": "The user ID of the person who entered the data or the method by which the data was entered into the system.", "example": "JOHNDOE" } } }, "ReleasePointApportionment": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "avgPctEmissions": { "maxLength": 4, "type": "string", "description": "Average emissions for the Release Point Apportionment.", "example": "1" }, "createDate": { "maxLength": 30, "type": "string", "description": "The date the record was created.", "example": "18-SEP-20" }, "eisComment": { "maxLength": 400, "type": "string", "description": "A comment added in the EIS system associated to the Release Point Apportionment.", "example": "COMMENT" }, "emissionsProcessId": { "maxLength": 20, "type": "string", "description": "The identification number for the emissions process associated to the Release Point Apportionment.", "example": "PGM-537343" }, "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "CEDRI" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "CEDRI10000483" }, "refreshDate": { "maxLength": 30, "type": "string", "description": "The date the record was refreshed.", "example": "18-SEP-20" }, "releasePointApportionmentId": { "maxLength": 20, "type": "string", "description": "The identification number of the Release Point Apportionment.", "example": "1" }, "releasePointId": { "maxLength": 20, "type": "string", "description": "The identification number of the associated Release Point.", "example": "1" }, "sitePathId": { "maxLength": 20, "type": "string", "description": "The identification number for the site path record.", "example": "1" }, "userId": { "maxLength": 160, "type": "string", "description": "The user ID of the person who entered the data or the method by which the data was entered into the system.", "example": "JOHNDOE" } } }, "AlternativeControlId": { "required": [ "programSystemAcronym", "programSystemId" ], "type": "object", "properties": { "programSystemAcronym": { "maxLength": 20, "type": "string", "description": "The abbreviated name that represents the name of an information management system for an environmental program.", "example": "EIS" }, "programSystemId": { "maxLength": 30, "type": "string", "description": "The identification number, such as the permit number, assigned by an information management system that represents a facility site, waste site, operable unit, or other feature tracked by that Environmental Information System.", "example": "13607811" }, "programControlId": { "maxLength": 36, "type": "string", "description": "The program control identification number.", "example": "CNTL62360" }, "altAgencyControlID": { "maxLength": 150, "type": "string", "description": "The alternative agency control identification number.", "example": "1115" }, "effectiveDate": { "maxLength": 30, "type": "string", "description": "The date the record became effective.", "example": "2020-10-21T10:20:36.000Z" }, "endDate": { "maxLength": 30, "type": "string", "description": "The end date for the record.", "example": "2020-10-21T10:20:36.000Z" } } } } } }