sdwis prime rest api update - the exchange network .pdfswagger demo 10 . facilities search 11 ....
TRANSCRIPT
![Page 1: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/1.jpg)
SDWIS Prime ReST API Update Trang Le, USEPA Office of Water
2015 Exchange Network National Meeting Supporting the Business of Environmental Protection
September 29–October 1, 2015 Sheraton Philadelphia Society Hill Hotel
Philadelphia, Pennsylvania
http://www.exchangenetwork.net/en2015
![Page 2: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/2.jpg)
ABSTRACT
SDWIS Prime is a centralized, cloud-based application that will replace the legacy SDWIS State system. While development is still underway, the project team has deployed the first version of a ReST API for drinking water data in a test environment. This work has also raised questions about implementing reporting services in the cloud.
2
![Page 3: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/3.jpg)
Agenda
• SDWIS Prime Overview
• Current and Future SDWIS Data Exchanges
• SDWIS Prime ReST API Version 1.0
• Cloud Issues with Interfacing Apps
• Reporting Services and the Cloud
3
![Page 4: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/4.jpg)
Current SDWIS “Data Exchanges”
4
FedRep
SDWA 3.5
XML
Interfacing App
Reports/ BI
SQL
ODBC FOIA, Data
Requests
SDWIS Fed Reporting Services
CDX
SQL
APEX
Within Primacy Agency Reporting to EPA
SDWIS State SDWIS Fed
![Page 5: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/5.jpg)
Future SDWIS Data Exchanges
5
![Page 6: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/6.jpg)
SDWIS Prime Cloud Issues
• ODBC security
• Uncertain future of Microsoft Access
• Ad hoc queries using SQL
• Replacing SQL and ODBC with a ReST API
• Centralized database structure & performance
6
![Page 7: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/7.jpg)
SDWIS Prime ReST API v.1.0
• “First draft API” developed winter 2015
• Undergoing state review
– Several state reports modified to use ReST API calls instead of ODBC
– Sample MS Access code for calling ReST API
• Will revise the API based on state feedback
7
![Page 8: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/8.jpg)
ReST API Endpoints (so far)
• Water Systems
– Status, address, contacts, service type, etc.
• Legal Entities
– Lab certifications, addresses, etc.
• Facilities
– Facility type, operating periods, location, etc.
8
![Page 9: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/9.jpg)
Using Swagger
• Open source ReST API framework
• User interface for documenting and demonstrating ReST API calls
https://sdwisprime.induscorp.com/PrimeWebService
• Requires user id and password
9
![Page 10: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/10.jpg)
Swagger Demo
10
![Page 11: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/11.jpg)
Facilities Search
11
![Page 12: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/12.jpg)
PWSID X11050010 Facilities
12
“X1” is a test state located in test EPA “Region 11”
![Page 13: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/13.jpg)
Cloud Issues
• Using SQL for ad hoc queries
– Centralized SDWIS Prime database optimized for transaction processing and not querying
• Replace ODBC calls with ReST API, but…
– ReST API endpoints that “join” data like SQL
• Database performance - TBD
13
![Page 14: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/14.jpg)
Cloud Reporting Services
• Many SDWIS interfacing applications are “canned” reports using database queries
• Option:
– Build an extensive ReST API “mimicking” expected database “joins”, or
– Offload reporting to local data marts
14
![Page 15: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/15.jpg)
Local Data Mart Concept
15
Within Primacy Agency Cloud Hosting Provider
SDWIS Prime
Legacy Interfacing
App
Reports BI Tool Ad Hoc
SQL
ODBC Synch Process SDWIS
Data Mart
ReST API
Interfacing App
• Periodic and on-demand synch • “Real-time” access as required
![Page 16: SDWIS Prime ReST API Update - The Exchange Network .pdfSwagger Demo 10 . Facilities Search 11 . PWSID X11050010 Facilities 12 “X1” is a test state located in test EPA “Region](https://reader035.vdocuments.us/reader035/viewer/2022071110/5fe5f2d0a64dea649166b46d/html5/thumbnails/16.jpg)
Local Data Mart
• Pro – Preserves ODBC investment, ad hoc queries
– Business intelligence (BI) tool selection
– Addresses apps requiring “real time” access to data
• Con – Hosting cost for state
– Velocity of data mart refresh (how fast/slow?)
16