Skip to content

NovaStar Data Web Services / Release Notes / Version 1

Version 1.14.0

Feature release to improve services for source line numbers and plots and enable the tslist service

  • change [#399] Add the GroupMode configuration property to control when user group filter is required for services, used with NovaStarCloud and multi-tenant systems.
  • change Update the checkDatabase service:
    • [#394] Update the outputResourceGroups=true format to fix formatting issues for some checks. Add relatedData elements to output to better describe some checks.
    • [#401] Change the default output format to be similar to outputResourceGroups=true using a top-level list of resources.
  • change [#377] Update the dataSources service:
    • Search the scheduler items for known programs that implement the -S command parameter.
  • change Update the dataTypes service:
    • Enable the Precip (SHEF PP, precipitation increment) data type by default for Operator output, which enables the time series in the stationSummaries service.
  • change [#377] Update the tscatalog service:
    • The pointTypeId value is now included in output to facilitate relating to point types.
    • The valueDigits value has been added to facilitate review of handling display digits.
    • Add the tsid output element to replace timeSeriesIdentifier element. The tsid name is consistent with other services. Both values will be included for some time to allow transition to tsid.
  • change Update the tsproduct service:
    • [#378] Enable multiple tsid and handle for alarm time series as a point graph.
    • [#377] Populate the yaxes properties with basic information.
  • new [#377] Add the stationDataSources service:
    • This service provides a list of source line numbers used with a station.
  • new [#396] Add the tslist service:
    • Enable the service with initial CSV, JSON and GeoJSON output formats.

Version 1.13.1

Maintenance release to fix issues with new features in the previous release.

  • bug [#373] Fix the dataReports service:
    • Was not allowing single character flag filters due to adding support for multi-character source lines.
  • new [#374] Add the pointFlags and pointStatuses services.

Version 1.13.0

** Feature release to provide data for source line numbers.**

  • new [#366] Add the dataSources service:
    • List data source line number and other data from the configuration table and data imports.
    • Update the data, dataReports, and ts services so that sourceLineNumber filters the data report flags format using:
      • merged line numbers (current design)
      • proposed new format VE,1,3,3, where line numbers are separated by commas
  • change Update the checkDatabase service:
    • [#361] Add User resource type and check for empty full name.
    • [#368] Add the outputResourceGroups query parameter to output a format used by the Administrator application's troubleshooting page.
  • change Update the ts service:
    • Time series for data source line can now be queried, with 1Hour count currently supported.

Version 1.12.1

Maintenance release to improve the checkDatabase service.

  • change Update the checkDatabase service:
    • [#361] Add checks for users, including a check for empty user full name,
  • change Update the dataTypes service:
    • [#365] Change ALERT2 Type5 message data types and Apduid to use Alert2 in front of the data type. This groups the data types when sorted and makes them easier to distinguish from other data.
    • [#367] Add built-in data type DataReport to use with source line number data report counts.
  • change Update the data service:
    • [#367] Add sourceLineNumber filter on data report flags.
  • change Update the dataReports service:
    • [#367] Add sourceLineNumber filter on data report flags.
  • change Update the ts service:
    • [#367] Add sourceLineNumber filter on data report flags.

Version 1.12.0

Feature release including enhancements to the plots and checkDatabase services.

  • Update the user documentation:
    • Services are now grouped into major categories to facilitate use. A service may be listed in more than one group. The groups are consistent with the api-ui page.
    • The documentation for each service groups parameters info "Filter", "Output", etc., to improve usability of the documentation.
    • Improve the troubleshooting documentation to include more examples of errors.
    • Add a discussion of results components.
  • bug Update the dataTypes service:
    • [#327] Fix the SHEF physical element HJ so that the data type is HeightSpillwayGate (had a typo)
    • [#341] Add standard built-in non-SHEF data types so that they do not need to be configured as custom data types. Additional built-in types will be added over time to encourage consistency.
  • bug Update the ts service:
    • [#349] Fix so that Count statistic time series have units of Count.
  • change [#358] Enhance data caching integration with the Administrator:
    • Saving data from the Administrator causes data caches to be invalidated in web services.
    • When retrieving data, the data are internally handled so that caches are refreshed in the appropriate order to ensure that materialized data are correctly updated.
  • change [#349] Handle HTTP headers to improve the responseInfo so that the original URL is shown and should be a valid user-facing URL:
    • Use X-Original-URL if provided.
    • Or, use X-Forwarded-Host if provided.
    • Or, use X-Forwarded-For if provided.
  • change [#331] Remove installing chromium, since it is not needed for web services to function and chromium may not be used on systems without a desktop GUI installed. It is still installed in the development environment.
  • change [#314,#317] Update the alarmTriggers service:
    • Add pointId and pointNumId parameters to filter alarm triggers for a point.
    • Add alarmGroupId and alarmGroupName parameters to filter alarm triggers for a group.
    • Add description, message, name, novaScore, and type parameters to filter alarm triggers.
  • Update the api-ui service:
  • change Update the checkDatabase service:
    • [#312] Add a check for null station numerical identifier, which should not happen but was found in one system.
    • [#336] Check that scheduler items do not have empty description.
    • [#338] Check that rating assign SHEF parameter code is valid as a data type.
    • [#345] Check that if a point has rating assigns defined, the rated value should be true, indicating that computations should occur.
    • [#347] Problems for a resource are now output with the specific resource (previously were only output at station and point level). Summary problems are added in higher-level objects and detailed problems are added with the specific object.
    • [#347] Problems at the highest level now list the number of problems for a resource but do not include object information.
    • [#347] Add the checkAlarms, checkPoints, etc. query parameters to control which data resources are checked.
    • [#347] Add the alarmId, pointNumId, etc. query parameters to specify specific objects to check.
    • [#347] Add the forceOutput query parameter to cause details to be output even if no problems.
    • [#348] Change the default to not process retired points and stations. Add the includeRetiredPoints and includeRetiredStations parameter to enable checking retired data.
    • [#351] Add a check for VoltageBattery points for no report alarm. Also add a check that all stations have at least one point with a no report alarm. These are best practices and are indicated as suggestions.
    • [#353] Change resource to resourceType, clarify the resource count properties, add problemType to the problem object.
    • [#354] Add a check for PrecipAccum points that don't have rated values for incremental precipitation and storm total.
    • [#355] Check ALERT2 protocol stations for points that have sensorId=null if a sensor ID=0 is also used for any point.
    • [#360] Add the problemType query parameter to filter the types of checks that are output.
  • change [#333] Update the data service:
    • Add the count parameter to limit the number of records in output.
    • Add the sort parameter to sort output.
  • change [#333] Update the dataReports service:
    • Add the count parameter to limit the number of records in output.
    • Add the sort parameter to sort output.
  • change [#315] Update the equations service:
    • Add filter parameters.
  • change [#358] Update the invalidateCache service:
    • Dependencies are checked so that invaliding a resource also invalidates related resources, such as relation data.
  • change [#335] Update the points service:
    • Add the stationTypeName and stationTypeProtocol query parameters to filter stations.
  • change [#335] Update the stations service:
    • Add the stationTypeName and stationTypeProtocol query parameters to filter stations.
  • change [#335] Update the tscatalog service:
    • Add the stationTypeName and stationTypeProtocol query parameters to filter stations.
    • Do not add a problem to the problems list if it has already been added.
  • new [#316] Add the equationImports service for equation imports. Equation imports provide input input for equations.
  • new [#339] Add the tsproduct service to provide time series product configurations.

Version 1.11.5

Maintenance release to improve the plots service.

  • Update the plots service:
    • bug [#305] Fix the bug where default plots were causing an error when calculating point.override.*Count output properties.
    • bug [#307] Fix the bug where a retired point resulted in an error when requesting the time using the point tag name (necessary to uniquely identify the time series).
  • change Update the ts service:
    • [#306] Output station description properties using station.Property=Value and point description properties using point.Property=value.

Version 1.11.4

Maintenance release to enable the ts readData query parameter.

  • bug Update many services that use a boolean query parameter. The check for valid values was not being performed so invalid values always used false.
  • change Update the ts service:
    • Add the readData parameter, which allows reading time series metadata without reading the data. This feature simplifies listing available time series.

Version 1.11.3

Maintenance release to improve the plots handling of data analysis.

  • change Update the plots service:
    • [#297] Add the ui.point.options.analysis.displayInterval query parameter to provide granular control of the display interval from the Administrator.
    • [#298] Add the tsServiceParameters query parameter for use with format=tspjson to faciliate creating the ts service request for the time series, needed to duplicate NovaStar analysis (statparm) analysis for plots. The query parameters handle analysis flags, etc.
  • change Update the ts service:
    • [#296] Change the add query parameter to analysisFlagAdd be consistent with the NovaStar analysis flag add parameter.
    • [#296] Change the multiply query parameter to analysisFlagMult be consistent with the NovaStar analysis flag mult parameter.

Version 1.11.2

Maintenance release to enhance the reports service, other maintenance.

  • bug Fix the alarms service:
    • [#276] The service was not properly handling point and station filters, resulting in null values for pointNumId, stationId, and stationNumId. This has been fixed and the dataType filter also now works.
    • [#283] Fix so that the alarmState=Ack query parameter value is allowed.
    • [#289] Fix so that querying a long period for a point works. Previously did not detect when a point was specified, resulting in a warning.
  • bug Fix the plots service:
    • [#285] Fix so that text annotations are included in format=tspjson output.
  • bug Fix the tscatalog service:
    • [#281] Fix so that the stationOutOfService query parameter works.
  • bug Fix the dataReports service:
    • [#280] The format=csv output column order was not conducive to visual review and use. The order now puts the most important columns on the left. Consuming applications should determine the column order from the headers.
  • change Update the nsdataws script to call the installer. This program is available for system administration.
  • change Update the alarms service:
    • [#284] Add the includeRelatedObjects=true query parameter to output related point and station objects in JSON output.
  • change Update the plots service:
    • [#287] Change the ui.point.options.analysis query parameter to ui.point.analysis to be consistent with the database.
    • [#287] Change the default statistic from Near to Last to be consistent with command line programs and the Administrator default UI choice.
    • [#287] The ui* query parameters are now output as uiProperties for the time series product to facilitate troubleshooting. Several additional properties are output to help troubleshoot analysis strings, including point.analysis.dbcparm.isAnalysisValid.
  • change Update the reports service:
    • [#286] Implement initial format=tspjson output.
  • change Update the tscatalog service:
    • [#282] Add the pointDescription, pointName, and pointOutOfService query parameters

Version 1.11.1

Maintenance release to enhance the plots service.

  • change Update the data service:
    • [#271] Enhance the flag query parameter to accept or, and, and not syntax, to facilitate data review.
    • [#274] Change so that by default, data records with V that do not have M are returned.
  • change Update the dataReports service:
    • [#271] Enhance the flag query parameter to accept or, and, and not syntax, to facilitate data review.
    • [#274] Change so that by default, data records with V that do not have M are returned.
  • change [#257] Update the plots service:
    • Add a POST HTTP method to allow the Administrator to override database plot properties and create plots without being saved in the database. Full functionality is not yet implemented.
    • Add pointId and pointNumId query parameter for default point plot configuration.
    • Add stationId query parameter for default station plot configuration and allow stationNumId to be used for this purpose.
    • Add tspRequestType query parameter to allow more control over how to create time series products. Full functionality is not yet implemented.
  • change Update the stationStatistics service:
    • [#271] Enhance the flag query parameter to accept or, and, and not syntax, to facilitate data review.
    • [#274] Change so that by default, data records with V that do not have M are returned.
  • change Update the ts service:
    • [#271] Enhance the flag query parameter to accept or, and, and not syntax, to facilitate data review.
    • [#274] Change so that by default, data records with V that do not have M are returned.

Version 1.11.0

Feature release to add the maps service.

  • new [#258] Add the initial maps service for map data.
  • new [#263] Add the initial checkDatabase service to check the database.

Version 1.10.1

Maintenance release to enhance the plots and ts services.

  • change Update the documentation to use underline for links to comply with web accessibility best practices.
  • change Change station data dashboardUrl to use Operator station dashboard without hash.
  • change [#220] Update the plots service:
    • Related to format=tspjson:
      • Add the novastarProperties element to format=tspjson output to keep separate from standard properties.
      • Add the problems element to format=tspjson novastarProperties output to help troubleshoot unsupported plot properties and data issues (such as missing SHEF parameter code) that will impact plot configurations.
      • Add support for raw, scaled, and rated time series in the analysis string, although not all computations (statistics) are yet implemented in ts service). The analysis string is handled better by using legacy Administrator code.
      • Add query parameters test.annotation.number, test.annotation.options.limit, test.annotation.options.limitScale, test.annotation.options.orientation to provide test data that overrides a saved annotation.
      • Add query parameter ui.endingTime to provide the ending time used to expand the _ENDINGTIME in plot panel title and annotation text.
      • Add query parameters ui.point.options.analysis and ui.plot.options.plotOrientation to allow the properties to be specified by the Adminstrator to override the saved plot configuration.
      • Don't limit time series in plots to the tscatalog time series list (tscatalog does not include all permutations of time series data type, statistic, and interval, and therefore is a smaller subset of possible time series).
      • Handle multiple right y-axes based on plot point options scale and time series product axes list. Left and right y-axis precision and direction are now handled. Plot points (time series) and annotations are associated with a y-axis and some options like rangeLimits for points are set at the y-axis level.
      • Handle y-axis limits specified as fixed or point data.
      • Handle horizontal and vertical annotations.
      • The time series product MainTitleString is set to the plot name. If the name is null, an empty string is output.
  • change Update the ts service:
    • Add the add and multiply service parameters to support the Administrator software.
    • Add new statistics: Count, Last, Near.
  • new Add the statisticTypes service to list statistic types.

Version 1.10.0

Feature release including Swagger/OpenAPI documentation and Debian Bullseye support.

  • bug [#219] Fix bug where newline in descriptions caused a line break when format=csv is requested. The newlineReplacement service parameter can now be specified and defaults to a space for the following services:
  • bug Fix bug in the ratingTables service:
    • the description was not being included in output
  • bug [#218] Fix bug in the ts service where the time series description property was not set for interval time series calculated from the scaled value time series.
  • change The nsdataws program has been updated:
    • [#191] Add a help command to the interactive menu.
    • [#224] Update the installer to remove old versions. Also add a menu command and --tomcat-version command parameter to set the Tomcat major version, which allows old versions to be managed during updates. For example use sudo nsdataws stop --tomcat-version=8.
    • Fix a bug where editing log files mixed up the file order when selecting.
  • change Statistics output now includes sampleSize, which is the number of values used to compute the statistic (does not count null, NaN, or missing values).
  • change Update the data service:
    • [#231] Add format=datadisp to mimic the NovaStar command line datadisp program.
    • [#231] Add format=datadisp_q to mimic the NovaStar datadisp_q cgi-bin program used to format data for legacy web applications.
    • [#235] Add flag=* to return all records without having to provide a list of flags.
  • change [#235] Update the dataReports service:
    • Add flag=* to return all records without having to provide a list of flags.
  • change Update the plots service:
    • [#220] The format=tspjson parameter has been added, which will output an array of time series product configurations, suitable for display by charting applications.
    • [#236] The format=e19json and stationNumId parameters have been added, which will output of station E19 plot configurations, suitable for display by charting applications. The initial implementation will be enhanced in later software releases.
  • change [#228] Update the points service:
    • By default, don't return points that have Status=Retired or Test=True.
    • Add the includeRetiredPoints=true parameter to enable output of retired points.
    • Add the includeTestPoints=true parameter to enable output of test points.
  • change [#228] Update the stationSummaries service:
    • Add the includeRetiredPoints=true parameter to enable output of retired points (default is don't output).
    • Add the includeTestPoints=true parameter to enable output of test points (default is don't output).
  • change [#235] Update the ts service:
    • Add flag=* to return all records without having to provide a list of flags.
  • change Update the tscatalog service:
    • Add the includeProblemTs query parameter to allow filtering the catalog based on whether a time series has configuration problems. This is useful for troubleshooting data issues.
  • new Add the ratingAssignComputationTypes service to list computation type number and name.
  • new Add the stationE19s service to provide station E19 data for flood levels.
  • new [#61] Enable the Swagger/OpenAPI interactive query builder tool:
    • Use the api-ui service to access the interactive URL builder.
    • The api-ui service provides the editor for services and is referenced in service documentation.
    • Due to this change, web services are now case-specific, whereas previously they were case-independent. Refer to the api-ui service and documentation to confirm URL syntax. Some applications may need to be updated.

Version 1.9.2

Maintenance release to fix bug in parsing descriptions with embedded properties.

  • bug [#215] Fix bug where station, point and other descriptions that accept embedded Property=Value strings were not handling properties with spaces around the equals sign. Embedded properties must not have spaces around the equals sign and equals with space on either side is now handled as a normal description.

Version 1.9.1

Maintenance release to fix bug in custom data types.

  • bug [1.9.1] Fix bug where the custom data types file was only handling one custom type.

Version 1.9.0

Feature release to improve handling of time series and statistic value digits in output.

  • new [1.9.0] Add the pointProperties service to provide point properties from the point description.
  • new [1.9.0] Add the stationProperties service to provide station properties from the station description.
  • change [1.9.0] Update the points service:
    • The pointTypeId parameter has been added to match points for a point type.
  • change [1.9.0] Update the ratingAssigns service:
    • The pointNumId parameter has been added to match rating assigns for a point numerical identifier.
  • change [1.9.0] Update the stationStatistics service:
    • The number of digits for statistic values is now consistent with the number of digits used to format time series values.
    • The valueDigits parameter has been added to override the default number of digits used for output.
    • The statisticValueName parameter now accepts tilde-delimited values to avoid the need to URL-encode properties identified with ${ } syntax.
  • change [1.9.0] Update the stationSummaries service:
    • The number of digits for time series data and statistic values is now consistent with the digits specified in the point type for scaled value time series.
    • The number of digits for time series data and statistic values is now consistent with the digits specified in the rating table output for rated value time series.
    • The valueDigits parameter has been added to override the default number of digits used for output.
  • change [1.9.0] Update the ts service:
    • The number of digits for data values is now consistent with the digits specified in the point type for scaled value time series.
    • The number of digits for data values is now consistent with the digits specified in the rating table output for rated value time series.
    • The valueDigits parameter has been added to override the default number of digits used for output.

Version 1.8.0

Feature release to improve the performance of services that read data reports, and includes a number of maintenance updates.

  • bug [1.8.0] Fix bugs in the tscatalog service:
    • Fixed bug where the service generated a parameter check error if the dataType included a statistic, such as used with interval time series. This limited the ability to filter the catalog.
    • Fixed bugs where requesting a catalog list for interval time series using specific dataType and dataInterval values returned nothing. The service now always queries IrregSecond interval first and then applies interval statistic to output when the original query returns results. Interval time series stored in the database, such as with SHEF E duration may not be listed - this will be addressed in the future.
  • new [1.8.0] Add the dataReports service to read data reports using the database data_select function and return results in flattened form, which is particularly useful when querying a short data period.
  • new [1.8.0] Release the initial version of the nsdataws-cli command line interface to data web services, useful for automating time series downloads.
  • change [1.8.0] Improve the documentation for tools to facilitate using web services.
  • change [1.8.0] The stations data cache used to improve performance now includes retired stations by default. Services that use stations typically omit retired stations for real-time data and include retired stations if historical data queries. See the includeRetiredStations parameter for services.
  • change [1.8.0] Update the following services to internally use the new dataReports service to improve performance when querying short data periods, and add the dataService query parameter to allow control of how data reports are queried:
  • change [1.8.0] Improve performance profile output controlled with the includeProfile query parameter for the following services:
  • change [1.8.0] Update the data service as follows:
    • Add flag parameter to allow filtering based on data flag.
  • change [1.8.0] Update the pointTypes service as follows:
    • Add pointNumId parameter to match point types for a point.
    • Add stationNumId parameter to match point types for a station.
  • change [1.8.0] Update the stationSummaries service as follows:
    • Precipitation total statistic for 14Day and 21Day intervals have been removed since the values are seldom used and add processing time.
  • change [1.8.0] Update the ts service as follows:
    • Add flag parameter to allow filtering based on data flag.

Version 1.7.2

Maintenance release to fix specific issues discovered in using web services.

  • bug [1.7.2] Fixed bugs in the ts service:
    • Requesting a locId with a point tag name part caused an error when searching points that have null point tag name in the database.
    • Specifying a locId with point tag name part when not needed did not match time series - both forms of locId are now supported.
  • bug [1.7.2] Fixed a bug in the following services where groupId and groupName filters were ignored:
  • change [1.7.2] Update the stationStatistics service:
    • Enhanced statisticValueName to allow !{Property} notation in addition to ${Property}, to facilitate use with software that also uses the latter notation and might be in conflict during processing.
    • Change the default value of statisticValueName to ${dataType}-${statistic}.${interval}, which works better with geojson format given that each unique name corresponds to an attribute table property (if necessary, consuming applications can request the old format in the query string).
    • Enable the includeProfile functionality for JSON default format, to help evaluate performance.
    • Fix the typo in the station property dashboadUrl to be dashboardUrl.

Version 1.7.1

Maintenance release to fix issues in the previous version and implement changes to support automated testing.

  • change [1.7.1] Move documentation appropriate for system administrators into separate "for Administrators" documentation. This documentation now focuses on web services users.
  • change [1.7.1] Update the echo service to return a response format similar to other services.
  • change [1.7.1] Change the stations service:
    • Add the dataType and locId query parameters to allow easier query of data corresponding to time series data types.
    • Add station and point data to the response to facilitate understanding checking and using the data records.
  • change [1.7.1] Change the stations service:
    • Change the operatorStationDashboardUrl output property to dashboardUrl to facilitate use.
    • Add includeRetiredStations and includeTestStations query parameters to control handling of stations (default is to not return retired or test stations).
  • change [1.7.1] Change the stations service:
    • Add includeRetiredStations and includeTestStations query parameters to control handling of stations (default is to not return retired or test stations).
    • Sort statistics and data types alphabetically by default to facilitate automated testing.
  • change [1.7.1] Change the stations service:
    • Add includeRetiredStations and includeTestStations query parameters to control handling of stations (default is to not return retired or test stations).
    • Fix bug where station type identifier was not being set.
    • Fix bug where rated value time series were not being handled correctly for statistic calculations.

Version 1.7.0

Feature release to address issues with rating assigns that change data table slots over time, and implements additional changes to support web services administration.

  • bug [1.7.0] Fix the point service to include station identifier data - previously was always null.
  • bug [1.7.0] Fix the ts and stationSummaries services to handle rating assigns that change the data table array position of rated values.
  • bug [1.7.0] Fix the ts service to set data flags from the rated values.
  • change [1.7.0] The points service has been updated as follows:
    • Points allow additional properties in the description.
    • Now includes descriptionText property.
  • change [1.7.0] The stationSummaries service has been updated as follows:
    • Rating assign and rating tables data are now cached to improve performance.
    • Only read rating assign data for the query period to improve processing performance.
    • Add includeTestStations query parameter to handle test stations.
  • change [1.7.0] The tscatalog service has been updated as follows:
    • Allows * wildcard in the dataType query parameter. This is useful for specifying Precip* to see which rated value time series are defined for a station.
    • Add pointId query parameter.
  • new [1.7.0] Add experimental values queryTargetMs and queryTargetMet to the reponseInfo included in JSON, to begin phasing in performance analytics.

Version 1.6.1

Maintenance release to enhance tscatalog service for data troubleshooting.

  • bug [1.6.1] The tscatalog service has been updated to be more precise in handling cases where point tag name warnings are generated in cases where time series identifiers are not unique.
  • change [1.6.1] The tscatalog service now has locId query parameter, useful to match identifiers where POINTTAG is in the locId due to a non-unique identifier.
  • change [1.6.1] The following services have been updated to provide groupId parameter to optionally limit results to the specified group identifier(s). Additional support has also been added to filter results based on station, point, and data type.

Version 1.6.0

Feature release focusing on the new stationStatistics service.

  • change [1.6.0] The following services have been updated to provide groupName parameter to optionally limit results to the specified group name(s):
  • change [1.6.0] The dataTypes service has been updated:
    • sort parameter allows sorting the results. Results can now also be filtered by displayName and shefPhysicalElement.
    • Filters now ignore case.
    • The nsdataws-datatypes.json file has been implemented for custom data types. The nsdataws-datatypes.csv file will be phased out and is not used if the JSON file is found.
    • The isValid output now checks whether first 2 characters are uppercase (invalid because conflicts with SHEF parameter code). The new isValidError value is output if isValid=false.
  • change [1.6.0] The stations service now returns GeoJSON, which includes station type protocol to allow filtering.
  • change [1.6.0] The stationSummaries service statistics are now calculated using a sample window > the start time and <= the end time. Previously the window was >= the start time and <= the end time. This may have impacted a small number of calculations.
  • new [1.6.0] The stationStatistics service has been added to return multiple statistics for stations, for example Last for last value in an interval.

Version 1.5.5

This patch release focuses on fixes to support MeanArealPrecip data type processing, and other minor feature fixes.

  • bug [1.5.5] Fix a bug where the stationSummaries did not handle data types with inadvertent space in data type name. White space is now removed.
  • change [1.5.5] The stationSummaries and ts services have been updated to include noReportInterval in output, which is used to indicate how the last report will persist prior to another reading
  • change [1.5.5] The previous stationSummaries included a work-around includeAllDataTypes query parameter to control whether multiple time series of the same data type are returned (because not unique). The work-around parameter has been removed. Multiple time series of the same data type can be returned, and the associated point ID, point tag, etc. can be used to differentiate between time series. Consuming software must be able to handle and not assume that data type alone is unique at a station.
  • change [1.5.5] The stationSummaries service now automatically uses statistics data type MeanArealPrecip as follows: Total .
  • change [1.5.5] Add built-in SHEF parameter physical element codes MI, ML, MU, and MV.
  • change [1.5.5] The stationSummaries and tscatalog services now have groupName parameter to limit results to stations associated with a group.
  • new [1.5.5] The groups service has been added to return NovaStar group data.

Version 1.5.4

This patch release focuses on fixes to have better control of interval time series calculations.

  • bug [1.5.4] Fix a bug where the stationSummaries service request could fail if any point or any station query had an error. The service will now always return data for stations and points that have no errors.
  • bug [1.5.4] Fix a bug where the stationSummaries service could have an error for a rating assign that is defined but has no data.
  • bug [1.5.4] Fix a bug where the stationSummaries did not include point properties with time series.
  • change [1.5.4] Change the ts service so that interval time series by default only return intervals that include data reports. Query parameters includeReports, includeEstimates, and includeMissing have been added to control how many values are returned. Experience has shown that returning estimates and missing can greatly increase the size of the response and in some cases cause out of memory errors. Implement logic to use last value in no report interval if value for an interval with no other data report. The defaults may change as additional access control features are added. Also enable the TimeWeightedMean statistic.
  • change [1.5.4] Improve handling of query period. Services now share common features. See the period documentation.

Version 1.5.3

This patch release focuses on fully-enabling custom data types in addition to built-in SHEF data types that use SHEF parameter code physical element.

  • bug [1.5.3] Fix a number of issues that were impacting the ts and tscatalog service, including retrieval of interval data stored in NovaStar. The services were not consistent with recent addition of custom data types. Issues have been fixed.
  • bug [1.5.3] Fix issue related to SHEF to data type conversion due to uppercase comparison issue. This resulted in some time series not being found.
  • bug [1.5.3] Fix bug in some queries where a requested period of record using full period indicator (*) was being interpreted as the default period (last month).
  • bug [1.5.3] Fix bug where ts comma-separated output headings were abbreviated. Data values are now also output to the number of digits configured for the data type in NovaStar.
  • bug [1.5.3] Fix bug introduced in 1.5.2 where tscatalog request could get into a race condition because internal cache of tscatalog results was regenerated multiple times. A cached catalog is used to check for uniqueness of the output list records.
  • change [1.5.3] The stationSummaries includeAllDataTypes parameter now has a default value of true. This parameter will be removed in the future because it was implemented to help as a transition in design.

Version 1.5.2

This patch release focuses on returning multiple same data types at a station.

  • bug [1.5.2] Fix the pointTypes id query, useful for troubleshooting.
  • bug [1.5.2] The stationSummaries service now returns all data types and time series - previously multiple same data types would only return the first match. The service now also returns correct rated data type rather than defaulting to DischargeRiver. The includeAllDataTypes parameter has been added as a work-around to evaluate returning multiple same data types in the summary, with default value of false.
  • change [1.5.2] The statistic data has been updated to include the associated point identifier to allow unique association with time series and triggers, necessary because stationSummaries?forOperatorStationDashboard=true now returns multiple same data types if found for a station.
  • change [1.5.2] The dataTypes service now provides query parameters. The DepthOfReading data type (equivalent to HB SHEF physical element) is now configured by default to be returned for stationSummaries service for Operator.
  • change [1.5.2] The ratingAssigns service now allows queries by id and pointId.
  • change [1.5.2] Improve the tscatalog service checks to determine whether a time series is a forecast. Also improve setting the locId to unique value. If necessary, the point tag name is used in the locId to ensure a unique time series identifier. A cached version of tscatalog results are used to look up whether duplicate time series would otherwise result.

Versions 1.5.0 - 1.5.1

  • bug [1.5.1] Installer was not properly setting file ownership and permission for a new install, causing web services to not find configuration and other files. This has been fixed.
  • bug [1.5.0] Data resource caching was not working properly and has been fixed. The default expiration on cached data is now set to 1 hour.
  • change [1.5.0] All services now include attributionAndUsage element when format=json, which allows organizations to indicate disclaimer, license, attribution, and usage guidelines.
  • change [1.5.0] The data, ts, and stationSummaries services now provide timezone query parameter to indicate the output time zone. This is useful when the NovaStar database stores data from multiple time zones or the server uses a different time zone from the local time zone.
  • change [1.5.0] The stations service has been updated to include descriptionText, which is the same as description but without additional station properties.
  • new [1.5.0] Add nsdataws program to manage web services.
  • new [1.5.0] Web services are now implemented as full Linux service - use the nsdataws program to manage.
  • new [1.5.0] Online user documentation for data web services is available.
  • new [1.5.0] Add alarmStates service.
  • new [1.5.0] Add alarmTriggerTypes service.
  • new [1.5.0] Add dataTypes service to list built-in data types from SHEF parameter codes and custom data types. Also add nsdataws-datatypes.csv configuration file for custom data types, for cases when SHEF parameter codes are not available.
  • new [1.5.0] Add ratingRows service for rating rows (used for ratings).
  • new [1.5.0] Add ratingShifts service for rating shifts (used for ratings).
  • new [1.5.0] Add ratingTables service for rating tables (used for ratings).
  • new [1.5.0] Add stationTypes service for station types.