Facility Registry System (FRS) FRS REST Services December, 2012


FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

Facility Registry System (FRS)

FRS REST Services

December, 2012

Prepared for:

Prepared by:

Environmental Protection Agency

INDUS Corporation
1951 Kidweli Drive
Vienna, Virginia 22182

INDUS

CHALLENGE US

i

-------
FRS	FRS REST Services

Version 1.0

	Date: 12/12/2012

Table of Contents

Prepared for:	I

Table of Contents	n

Revision History	in

A.	Introduction - FRS REST Services	4

B.	Get Facilities	4

B. 1 Service Specifications	4

B.2 Base URL:	4

B. 3 Selection Criteria:	4

B.4 Outputs:	6

B.5	Example:	6

C.	Get Facilities Watershed Boundary Dataset	10

C.	1 Service Specifications	10

C.2 Base URL:	10

C. 3 Selection Criteria:	10

C.4 Outputs:	10

C.5	Example:	11

D.	Get 111™ Congress Identifier	12

D.	1 Service Specification	12

D.2 Base URL:	12

D. 3 Selection Criteria:	12

D.4 Outputs:	12

D.5 Example:	12

E.	Appendix A	13

F.	Appendix B - Examples	14

ii

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

Revision History

Version Number

Date

Description of Changes

1.0

12/12/2012

Initial creation.

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

A. Introduction - FRS REST Services

The following FRS REST Services allow developers to design custom applications utilizing a live feed of
data from the FRS database.

This is a collection of query-only or "GET" web services, that are available through a simple URL http link
and provide output in either XML, JSON, or JSONP formats. Currently three services are available:

1.	get facilities provides multiple selection criteria against FRS Facilities Data and their
associated Program Facility Data.

2.	get facilities wbd returns USGS Watershed Boundary Dataset information for a passed FRS
Facility or Program Facility Identifier.

3.	get cd 111 returns the 111th Congress Identifier based on passed latitude/longitude
geographic coordinates.

B. Get Facilities

B. 1 Service Specifications

get_facilities Service Specifications

B.2 Base URL:

http://ofmpub.epa.gov/frs_rest_services.get_facilities/enviro/

B.3 Selection Criteria:

Of the selection criteria listed below, those that have an "Equal" value under the Search Operator
column will provide the best performance. Examples are provided at the end of the section to illustrate
how selection criteria can be combined.

Search Term

Variable Name

Search
Operator

Other

Facility
Registry Id

registry_id

Equal,
Optional



FRS Facility
Name

facility_name

Contains,
Optional

Full text search on Program Name

Program

program_name

Contains,

Full text search on Program Name

4

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

Search Term

Variable Name

Search
Operator

Other

Facility Name



Optional



Street Address

street_address

Contains,
Optional

Because of the many variabilities involved with street
address it is hard to use an address as a search criteria.
May be able to provide an address parser to validate
address if needed. Suggest you limit to street base
name if you want to do a search on street address.

City

city_name

Equal,
Optional



County

county_name

Equal,
Optional



Zip Code

zip_code

Equal,
Optional

Will use only first 5 digits of zip code only

State

Abbreviation

state_abbr

Equal,
Optional



Program
Acronym

pgm_sys_acrnm

Equal,
Optional

See Appendix A for list of Acronyms

Program
System Id

pgm_sys_id

Equal,
Optional



Program
Output

program_output

Yes/No,
Optional

Default is no. Controls whether or not the Program
Facility object is output

Output
Format

output

XML, JSON,

JSONP

Optional

Default is XML.

Call back

JSONP

Function

callback

Optional

Default is callback. Can only be used when the output
value is JSONP

Latitude
(NAD83)

Iatitude83

Equal,
Optional

The latitude coordinate, in decimal degrees format,
using the US Standard NAD83 horizontal Datum. Used
in conjunction with Search Radius and Longitude
(NAD83) to restrict facility selection to a spatial circle of
the provide search radius around the provided spatial
coordinate. All 3 selection criteria are required.

Longitude
(NAD83)

longitude83

Equal,
Optional

The longitude coordinate, in decimal degrees format,
using the US Standard NAD83 horizontal datum. See
Latitude (NAD83) description.

Search Radius
(Miles)

search_radius

Maximum,
Optional

The maximum search radius is 25 miles. See Latitude
(NAD83).

5

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

B.4 Outputs:

An XML, JSON, or JSONP formatted document with the following output:

For each facility returned there will be a FRSFacility complex object comprised of the following simple
and complex objects.

OBJECT NAME

Object Type

Registryld

Simple

FacilityName

Simple

LocationAddress

Simple

SupplementalLocation

Simple

CityName

Simple

CountyName

Simple

StateAbbr

Simple

ZipCode

Simple

FlPSCode

Simple

Latitude83

Simple

Longitude83

Simple

ProgramFacilities

Complex (optional output)

Program Facility

Complex (child of ProgramFacilities - one for each program facility
comprised of the following simple elements listed below.

ProgramSystemAcronym

Simple

ProgramSystemld

Simple

ProgramFacilityName

Simple

B.5 Example:

URL for Facility Name Search containing "Mobil Oil" in State of Virginia, City of Newport
News:

http://ofmpub.epa.gov/enviro/frs_rest_services.get_facilities?state_abbr=VA&city_name=New
port%20News&facility_name=mobil%20oil

URL Results (since no output format was specified, XML results are returned):

6

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012





11003 8 914 654

EXXON MOBIL OIL CORP 20428

1233 0 TaTARTaTICK BLVD



<:CityName:>NETaTPORT NEWS

<:CountyName:>NETaTPORT NEWS CITY

VA

23 60 6

517 00

37 . 0 647 81<:/Latitude83:>

-7 6.4 9083 6





URL for searching CERCLIS (Superfund) facilities in zip code 60085 with a program name
containing "scrap", with the Program Facility Output turned on and JSON output.

http://of mpub. epa.gov/enviro/frs_rest_services.get_facil ities?pgm_sys_acrnm=CERCLIS&zip_c
ode=60085&program_name=scrap&program_output=yes&output=JSON

URL Results in specified JSON Format:

{

"Results": {

"FRSFacility": [

{

"Registryld": "110 0 0 9327246",

"FacilityName": "DIAMOND SCRAP YARD",
"LocationAddress": "MARKET STREET AND ELGIN",

"Supp 1 ernentalLocation": "MARKET STREET AND ELGIN",
"CityName" : "TaTAUKEGAN" ,

" CountyName " : " LAKE ",

"StateAbbr": "IL",

"ZipCode": "60085",

"FlPSCode": "17097",

"Latitude83": "42 . 3524 9",

"Longitude83": "-87.8285",

"ProgramFacilities": [

{

"ProgramSystemAcronym": "CERCLIS",

"Progr amSysternld" : "IL0 0 010 9350 9 ",
"ProgramFacilityName": "EiIAMONEi SCRAP YAREi"

},

{

7

-------
FRS	FRS REST Services

Version 1.0

	Date: 12/12/2012

"ProgramSystemAcronym": "NCDB",

"ProgramSystemld": "I05#15510625IL005 2",

"PrograrriFaci 1 ityName" : "DIAMOND SCRAP YARDS INC"

URL for searching CERCLIS (Superfund) facilities within a 3 mile radius of latitude 38.8/longitude -
77.01.

http://ofmpub.epa.gov/enviro/frs_rest_services.get_facilities?latitude83=38.8&longitude83=-
77.01&search_radius=3&pgm_sys_acrnm=CERCLIS

URL Results:





110 0 0 9347 616<:/Registryld:>

ALEXANDRIA TOWN GAS & ORONOCO OUTFALL
ORONOCO S TREE T 
ORONOCO STREETc/SupplementalLocation>
ALEXANDRIA

ALEXANERIA CITY

VA

<	Z i p C o d e :> 2 2 314 <: / Z i p C o d e >

51510c/FIPSCode>

38 . 8097 6<:/Latitude83:>
-77.04712





110002500133

BALLOU SENIOR HIGH SCHOOL

CLocationAddress>34 01 4TH STREET SOUTHEAST



WASHINGTON

DISTRICT OF COLUMBIA

<	Stat e Abb r :>E)C<: /Stat e Abb r >

20 032-540 6

11001

3 8 . 83 972
-77.00167





8

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

110 013 8 0193 9<:/Regis tryl d:>

FORT FOOTE

8900 FORT FOOTE ROAD

ACROSS FROM JESSICA DRIVEc/SupplementalLocation>

FORT WASHINGTON

PRINCE GEORGE'S

<	Stat e Abb r :>MD<: /Stat e Abb r >

2 07 4 4

2 4033c/FIPSCode>

38 . 7 6771<:/Latitude83:>

-77 . 025261<:/Longitude83:>





1100157 7 817 6

OXON COVE LANDFILLC/Fa c i1i tyName>

OXON HILL ROAD



OXON HILL

PRINCE GEORGE'S

<	Stat e Abb r :>MD<: /Stat e Abb r >

2 07 45

2 4033c/FIPSCode>

38.7 917 9

-77.00412





110 0 0 931557 0 <:/Regis tryl d:>

RICHMOND, FREDRICLCSBURG & POTOMAC RAILRD

JEFFERSON EAVIS & HTJME

JEFFERSON EAVIS & HLMEc/SupplementalLocation>

ALEXANDRIA

ALEXANE)RIA CITY

VA

22301

51510c/FIPSCode>

3 8 . 82 607<:/Latitude83:>

-77 . 0504 6<:/Longitude83:>





9

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

C. Get Facilities Watershed Boundary Dataset

C. 1 Service Specifications

get_facilities_wbd Service Specifications test

C.2 Base URL:

http://ofmpub.epa.gov/frs_rest_services.get_facilities_wbd/enviro/

C.3 Selection Criteria:

Of the selection criteria listed below, those that have an "Equal" value under the Search Operator
column will provide the best performance. Examples are provided at the end of the section to illustrate
how selection criteria can be combined.

Search Term

Variable Name

Search
Operator

Other

Registry ID

registry_id

Equal, Optional

The facility's FRS Registry ID

Program Acronym

pgm_sys_acrnm

Equal, Optional See Appendix A for list of Acronyms

Program System Id pgm sys id

Equal, Optional The program facility system identifier

C.4 Outputs:

An XML, JSON, or JSONP formatted document with the following output:

Object Name

Object Type

Comments

Registryld

Simple

The facility's FRS Registry Identifier

ChesapeakeBay Simple

A Y value indicates the facility is within the Chesapeake Bay watershed

Region

Complex

Lists the HUC 2 USGS Hydroregion number and name for the facility

Subregion

Complex

Lists the HUC 4 USGS Sub-hydroregion number and name for the
facility

Basin

Complex

Lists the HUC 6 USGS Basin number and name for the facility

Subbasin

Complex

Lists the HUC 8 USGS Sub-basin number and name for the facility

Watershed

Complex

Lists the HUC 10 USGS Watershed number and name for the facility

10

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

Object Name

Object Type

Comments

Subwatershed

Complex

Lists the HUC 12 USGS Sub-watershed number and name for the
facility

C.5 Example:

URL for a FRS Registry ID:

http://ofmpub.epa.gov/enviro/frs_rest_services.get_facility_wbd7registry_ichll0015778176
URL Results:



1100157 7 817 6

<	C h e s a p e a J: e B a y > Y e s < / C h e s a p e a J: e B a y >



 0 2 < / HUC_2 >

Mid Atlantic Region





 02 07 

<	HU_ 4 _NAME > P o t o m a c < / HU_ 4 _NAME >





 02 07 0 0 < / HUC_ 6 >

 Po t oma c < / HU_ 6_NAME >





 02 07 0 01 (3 

Middle Potomac-Anacostia-Occoquan





 02 07 0 010 03 





<	S ubwa t e r s h ed>

 02 07 0 010 03 03 

Henson Cree}:<:/HU_ 12_NAME>





11

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

D. Get ill™ Congress Identifier

D. 1 Service Specification

get_cd_lll Service Specification

D.2 Base URL:

http://ofmpub.epa.gov/frs_rest_services.get_cd_lll/enviro/

D.3 Selection Criteria:

Of the selection criteria listed below, those that have an "Equal" value under the Search Operator
column will provide the best performance. Examples are provided at the end of the section to illustrate
how selection criteria can be combined.

Latitude

latitude

Equals, In decimal degrees





Required

Latitude

latitude

Equal, Optional In decimal degrees

Longitude

longitude

Equals, Required In decimal degrees

Horizontal Datum

hdatum

Equal, Optional Default is NAD83, WGS84 is also accepted

D.4 Outputs:

An XML, JSON, or JSONP formatted document with the following output:

Object Name

Object Type

Comment

State

Simple



CD

Simple

Congressional District Number

CDName

Simple

Congressional District Name

D.5 Example:

Example URL:

12

-------
FRS	FRS REST Services

Version 1.0

	Date: 12/12/2012

http://ofmpub.epa.gov/enviro/frs_rest_services.get_cd_lll?latitude=38.8&longitude=-
77.01&hdatum=wgs84

URL Results:



 Successc/Messaqe>
estate :>MD<: / S t a t e >

04

Congressional District 4



E. Appendix A

PGM_SYS_ACRNM

ACES

ACRES

AIRS/AFS

AIRS/AQS

AZURITE

BIA INDIAN SCHOOL

BOILER

BR

BR AC

CAM DBS

CASWIS

CDAFLP

CEDS

CERCLIS

CIM

CNFRS

CWNS

DTSC-ENVIROSTOR

ECOMAP

ECRM

EGRID

EIA-860

EIS

FDM

FIS

FRP

FRS

GEIMS

GNIS

HWTS-DATAMART
ICIS

PGM_SYS_ACRNM

MO-DNR

MS-ENSITE

T-CEDARS

NC-FITS

NCDB

NCES

ND-FP

NE-IIS

NEI

NEPT

NH-DES

NJ-NJEMS

NM-TEMPO

NNEMS

NPDES

NV-FP

OH-CORE

OK-FMS

OR-DEQ

OTAQREG

PA-E FACTS

PCS

PDS

PERMIT TRACKING
RAD INFO
RBLC

RCRAINFO
RFS

RI-PLOVER

RMP

SC-EFIS

13

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

IDNR_EFD

IN-FRS

ISD

KS-FP

LA-TEMPO

LANDFILL

LUST-ARRA

MA-EPICS

MD-EPSC

MD-PEMIS

MD-RCRA

ME-EFIS

MN-DELTA

TX-TCEQ ACR

SSTS

STATE

TBA

TRIS

TSCA

WA-FSIS
WI-ESR

SDWIS
SIMS

SRPMICEMS

UORS
UST

F. Appendix B - Examples

URL for Facility Name Search containing "Mobil Oil" in State of Virginia, City of Newport News:

http://ofmpub.epa.gov/enviro/frs_rest_services.get_facilities?state_abbr=VA&city_name=Newport%20
News&facility_name=mobil%20oil

URL Results:





11003 8 914 654

EXXON MOBIL OIL CORP 20428

1233 0 WARWICK BLVD



NEWPORT NEWS

NEWPORT NEWS CITY

VA

23 60 6

517 00

37 . 0 647 81<:/Latitude83:>

-7 6.4 9083 6





URL for searching CERCLIS (Superfund) facilities in zip code 60085 with a program name containing
"scrap" and with the Program Facility Output turned on.

http://ofmpub.epa.gov/enviro/frs_rest_services.get_facilities?pgm_sys_acrnm=CERCLIS&zip_code=600
85&program_name=scrap&program_output=yes

14

-------
FRS

FRS REST Services
Version 1.0
Date: 12/12/2012

URL Results:

CResults>

CFRSFacility>

1100 0 9327 2 4 6

CFacilityName>DIAMOND SCRAP YARDc/FacilityName>

CLocationAddress>MARKET STREET AND ELGIN

cSupplementalLocation>MARKET STREET ANE) ELGINc/SupplementalLocation>

c C i t y N a m e :>TaTAUKE GANC / C i t y N a m e :>

LAKE 

IL

< Zip.Code>60 085

17057

42 . 3524 9c/Latitude83>

-87 . 8285c/Longitude83>





cProgramSystemAcronym>CERCLIS

ILO 0 010 9350 9< / Progr amSysteml d:>

CProgramFacilityName>DIAMOND SCRAP YAREK/ProgramFacilityName>

c / P r o g r a m F a c i 1 i t y >



CProgramSystemAcronym>NCDB

I05#19 910 625IL0 05 2 <:/Progr amSys teml d:>

CProgramFacilityName>DIAMOND SCRAP YAREiS INCc/ProgramFacilityName>

<:/ProgramFacility>

<:/ProgramFacilities>

c/FRSFacility>

c/Results>

15

-------