Skip to content

NovaStar Data / Service / novascores

Overview

NovaScores are an area of active development

The novascores service queries NovaStar NovaScores, which are used with alarm triggers to indicate the severity of conditions for each point.

Service Editor

The api-ui service can be used to edit a service request.

Service Syntax

The service syntax is as follows:

  • https is typically used for public servers and http may be used in private networks
  • filter parameters are AND'ed unless otherwise noted
https://server/novastar/data/api/v1/novascores?param1=value1&param2=value2,...

Service Parameters

Type Parameter                           Description Default                  
Filter description NovaScore description. Use * at front or back to match a substring.
name NovaScore name. Use * at front or back to match a substring.
Output format Format for output: csv, json, or xml. See format in the Service Parameter Reference. json
formatPrettyPrint Indicate whether json formatting should be pretty: false or true. See formatPrettyPrint in the Service Parameter Reference. true
jsonFormat Indicate the json format: bare, full, or named. See jsonFormat in the Service Parameter Reference. full
Developer debug Indicate whether additional debug messages should be printed to the log file, used for troubleshooting: false or true. false

Examples

https://server/novastar/data/api/v1/novascores

{
  "apiVersion" : {
    "apiVersionMajor" : "1",
    "apiVersionMinor" : "4",
    "apiVersionMicro" : "6",
    "apiVersionModifier" : "dev",
    "apiVersionDate" : "2020-02-27",
    "apiVersionTime" : "",
    "apiDotDelimitedVersion" : "1.4.6.dev"
  },
  "resourceRequestInfo" : {
    "uri" : "https://192.168.1.7:8080/novastar-rest/api/v1/novascores",
    "uriEncoded" : "https://192.168.1.7:8080/novastar-rest/api/v1/novascores",
    "periodStart" : null,
    "periodEnd" : null,
    "size" : 18,
    "queryMs" : 137,
    "isCached" : false,
    "cacheExpirationTime" : null
  },
  "novaScores" : [ {
    "id" : 1,
    "name" : "1",
    "shortDisplayName" : "Normal",
    "description" : "No or insignificant hydrologic activity",
    "scoreGroup" : "*",
    "standard" : "NWS E19",
    "groupScoreOrder" : 1
  }, {
    "id" : 2,
    "name" : "2",
    "shortDisplayName" : "Minor activity",
    "description" : "Minor hydrologic activity (Rain Alarm 0.5\" / 10 min)",
    "scoreGroup" : "Stage",
    "standard" : "NWS E19",
    "groupScoreOrder" : 2
  }, {
    "id" : 3,
    "name" : "3",
    "shortDisplayName" : "Major activity",
    "description" : "Significant hydrologic activity (Rain Alarm 1.0\" / 1 hour)",
    "scoreGroup" : "Stage",
    "standard" : "NWS E19",
    "groupScoreOrder" : 3
  }, {
    "id" : 4,
    "name" : "4",
    "shortDisplayName" : "Flood threat",
    "description" : "Serious Flood Threat (Rain Alarm 3.0\" / 2 hour)",
    "scoreGroup" : "Stage",
    "standard" : "NWS E19",
    "groupScoreOrder" : 4
  }, {
    "id" : 5,
    "name" : "5",
    "shortDisplayName" : "Flooding",
    "description" : "Flooding in progress (Rain Alarm 5.0\" / 6 hour)",
    "scoreGroup" : "Stage",
    "standard" : "NWS E19",
    "groupScoreOrder" : 5
  }, ...
]

Troubleshooting

See Also