Collect – API: Depth to Water Report

<< Click to Display Table of Contents >>

Navigation:  EQuIS Library > Reports > EarthSoft Standard Reports by Product > Standard with Collect >

Collect – API: Depth to Water Report

Report Name: Collect – API: Depth to Water (example)

File Name: EarthSoft.Reports.Library.149680.dll

Dependencies: Licensed Collect Module

Software: EQuIS Collect, EQuIS Enterprise

Source: EQuIS Collect install

Language: English

Output Type: Report Grid1; JSON if used as a service


Description: The Depth to Water report is designed to provide water level data via Application Programming Interface (API) requests over HTTPS using EQuIS Authentication.


Installation Instructions: This report requires a licensed EQuIS Collect module and the Collect Schema applied to the database. For use, this report should be published to the database. Download the EQuIS Collect xcopy zip from the community center, unblock the *.zip file, and extract the EarthSoft.Reports.Library.149680.dll files to the EQuIS Professional installation folder. For default installations, this directory is C:\Program Files\EarthSoft\EQuIS\. The report will be available for selection once it has been published.



The report can be utilized in the Collect mobile app by setting up a “Service” field in a Form Template. This field calls the API and returns a JSON file that includes location, unit, and depth to water range (max and min). The JSON also includes a set of coordinates (GEO_LOCATION) that enables the plotting of the location on a map within Collect. The data returned are found based on the date range and percentage outlier settings specified in the report parameters.


This report requires that more than one record per location in the DT_WATER_LEVEL table; DT_COORDINATE.COORD_TYPE_CODE set to ‘%LAT%LON%’ and .IDENTIFIER matching the Coordinate Identifier parameter required to export coordinates.




Report Parameters


Parameter for selecting the facility.



Parameter for selecting individual locations.


Parameter for selecting location groups.

Coordinate Identifier

Parameter for selecting the coordinate identifier.


Water Levels

Years back

HIstorical range outlier

The percent of outlier data that will be excluded from the minimum and maximum range used to check new depth to water values.



Report Output







Configure as Webservice: Follow the steps in Collect Enterprise Setup for Internal Service from API Service Fields in Collect to setup the API to be used in Collect mobile.


1The Report Grid provides additional export options to Excel, Google Earth, Outlook, Shapefile, PDF, Text, Access, XML, or a printer.