Report Name: Collect – API: Location Info (example)
File Name: EarthSoft.Reports.Library.149680.dll
Dependencies: Licensed Collect Module
Software: EQuIS Collect, EQuIS Enterprise
Source: EQuIS Collect install
Output Type: Report Grid1; JSON if used as a service
Description: The Location Info report is designed to provide location 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. When publishing the report, the assembly should be stored in the database. First download the EQuIS Collect xcopy zip from the community center, unblock the *.zip file and extract the EarthSoft.Reports.Library.149680.dll file 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. When this field calls the API, the report responds with a JSON file that includes location data such as total depth, depth to top and bottom of screen, coordinates, etc. The JSON also includes a set of coordinates (GEO_LOCATION) that enables the plotting of the location on a map within Collect. The output can optionally include historical water level data for each location.
This report requires DT_COORDINATE.COORD_TYPE_CODE set to ‘%LAT%LON%’ and .IDENTIFIER matching the Coordinate Identifier parameter required to export coordinates; more than one record per location in the DT_WATER_LEVEL table is required for historical water levels.
Tables: DT_LOCATION, DT_COORDINATE, DT_WATER_LEVEL
CUSTOM_FIELDS (1 TO 5)
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.
Copyright © 2020 EarthSoft, Inc • Modified: 14 May 2020