Client API - Revision history

DaveSanderman at 19:29, 9 March 2023

2023-03-09T19:29:33Z

DaveSanderman at 19:28, 9 March 2023

2023-03-09T19:28:02Z

DaveSanderman at 18:47, 9 March 2023

2023-03-09T18:47:38Z

DaveSanderman at 18:45, 9 March 2023

2023-03-09T18:45:39Z

DaveSanderman at 18:44, 9 March 2023

2023-03-09T18:44:27Z

DaveSanderman: /* Gage Status and Metadata */

2023-03-09T18:43:34Z

Gage Status and Metadata

DaveSanderman: /* Gage Status and Metadata */

2023-03-09T18:31:40Z

Gage Status and Metadata

DaveSanderman at 18:08, 9 March 2023

2023-03-09T18:08:38Z

DaveSanderman: Created page with "== Floodzilla Client API =="

2023-03-09T17:55:27Z

Created page with "== Floodzilla Client API =="

New page

== Floodzilla Client API ==

@@ Line 33: / Line 33: @@
 Returns: Array of ApiLocationInfo objects:
+<pre>
      public string Id { get; set; }
      public string LocationName { get; set; }
@@ Line 62: / Line 61: @@
      public List<string> LocationImages { get; set; }
      public List<ApiFloodEvent> FloodEvents { get; set; }    // The list of historical floods that this gage has data for.
-</code>
+</pre>
 ====GetMetagages====
@@ Line 71: / Line 70: @@
 Returns: Array of MetagageInfo objects:
+<pre>
      public string Id;
      public string SiteId;
@@ Line 79: / Line 77: @@
      public double StageOne;
      public double StageTwo;
-</code>
+</pre>
 ====GetLocations====

@@ Line 1: / Line 1: @@
-==Gage Status and Metadata==
+== Overview ==
-All object definitions below are in C#, but mapping them to other languages should be straightforward.
+All object payloads are in JSON format.
 All date/time fields are in UTC.
@@ Line 8: / Line 9: @@
 All water discharge numbers are in CFS (Cubic Feet per Second).
 "Stage One" and "Stage Two" refer to flood warning stages.  Stage One is the level at which we consider the gage "Near Flooding".  Stage Two is Flooding.
 Yellow and Red are legacy names to refer to Stage One and Stage Two respectively.
 ===Methods===
@@ Line 29: / Line 34: @@
 Returns: Array of ApiLocationInfo objects:
-<code>public class ApiLocationInfo {
+<code>
      public string Id { get; set; }
      public string LocationName { get; set; }
@@ Line 58: / Line 62: @@
      public List<string> LocationImages { get; set; }
      public List<ApiFloodEvent> FloodEvents { get; set; }    // The list of historical floods that this gage has data for.
-}</code>
+</code>
 ====GetMetagages====
@@ Line 68: / Line 72: @@
 Returns: Array of MetagageInfo objects:
-<code>public class MetagageInfo {
+<code>
      public string Id;
      public string SiteId;
@@ Line 75: / Line 79: @@
      public double StageOne;
      public double StageTwo;
-}</code>
+</code>
 ====GetLocations====

@@ Line 28: / Line 28: @@
 Returns: Array of ApiLocationInfo objects:
 <code>public class ApiLocationInfo
 <code>public class ApiLocationInfo {
      // Id corresponds to SensorLocationBase.PublicLocationId
      public string Id { get; set; }
@@ Line 67: / Line 67: @@
 Returns: Array of MetagageInfo objects:
 <code>public class MetagageInfo
 <code>public class MetagageInfo {
      public string Id;
      public string SiteId;

@@ Line 28: / Line 28: @@
 Returns: Array of ApiLocationInfo objects:
-<code>
+<code>public class ApiLocationInfo
-    public class ApiLocationInfo
+    // Id corresponds to SensorLocationBase.PublicLocationId
-        // Id corresponds to SensorLocationBase.PublicLocationId
+    public string Id { get; set; }
-        public string Id { get; set; }
+    public string LocationName { get; set; }
-        public string LocationName { get; set; }
+    public string ShortName { get; set; }
-        public string ShortName { get; set; }
+    public double? Latitude { get; set; }
-        public double? Latitude { get; set; }
+    public double? Longitude { get; set; }
-        public double? Longitude { get; set; }
+    public bool IsOffline { get; set; }
-        public bool IsOffline { get; set; }
+    public double? Rank { get; set; }
-        public double? Rank { get; set; }
+    public double? MaxChangeThreshold { get; set; }
-        public double? MaxChangeThreshold { get; set; }
+    public double? YMin { get; set; }
-        public double? YMin { get; set; }
+    public double? YMax { get; set; }
-        public double? YMax { get; set; }
+    public double? DischargeMin { get; set; }
-        public double? DischargeMin { get; set; }
+    public double? DischargeMax { get; set; }
-        public double? DischargeMax { get; set; }
+    public double? DischargeStageOne { get; set; }
-        public double? DischargeStageOne { get; set; }
+    public double? DischargeStageTwo { get; set; }
-        public double? DischargeStageTwo { get; set; }
+    public double? GroundHeight { get; set; }
-        public double? GroundHeight { get; set; }
+    public double? YellowStage { get; set; }
-        public double? YellowStage { get; set; }
+    public double? RedStage { get; set; }
-        public double? RedStage { get; set; }
+    public double? RoadSaddleHeight { get; set; }
-        public double? RoadSaddleHeight { get; set; }
+    public string RoadDisplayName { get; set; }
-        public string RoadDisplayName { get; set; }
+    public string DeviceTypeName { get; set; }
-        public string DeviceTypeName { get; set; }
+    public string TimeZoneName { get; set; }
-        public string TimeZoneName { get; set; }
+    public bool HasDischarge { get; set; }
-        public bool HasDischarge { get; set; }
+    public int UsgsSiteId { get; set; }
-        public int UsgsSiteId { get; set; }
+    public string NoaaSiteId { get; set; }
-        public string NoaaSiteId { get; set; }
+    public bool IsCurrentlyOffline { get; set; }            // DEPRECATED: true if either IsOffline or no recent readings have come in
-        public bool IsCurrentlyOffline { get; set; }            // DEPRECATED: true if either IsOffline or no recent readings have come in
+    public List<string> LocationImages { get; set; }
-        public List<string> LocationImages { get; set; }
+    public List<ApiFloodEvent> FloodEvents { get; set; }    // The list of historical floods that this gage has data for.
-        public List<ApiFloodEvent> FloodEvents { get; set; }    // The list of historical floods that this gage has data for.
+}</code>
 ====GetMetagages====
@@ Line 68: / Line 67: @@
 Returns: Array of MetagageInfo objects:
-<code>
+<code>public class MetagageInfo
-    public class MetagageInfo
+    public string Id;
-        public string Id;
+    public string SiteId;
-        public string SiteId;
+    public string Name;
-        public string Name;
+    public string ShortName;
-        public string ShortName;
+    public double StageOne;
-        public double StageOne;
+    public double StageTwo;
-        public double StageTwo;
+}</code>
 ====GetLocations====

@@ Line 56: / Line 56: @@
          public int UsgsSiteId { get; set; }
          public string NoaaSiteId { get; set; }
+         public bool IsCurrentlyOffline { get; set; }            // DEPRECATED: true if either IsOffline or no recent readings have come in
          public List<string> LocationImages { get; set; }
+         public List<ApiFloodEvent> FloodEvents { get; set; }    // The list of historical floods that this gage has data for.
 </code>

@@ Line 1: / Line 1: @@
 ==Gage Status and Metadata==
 ===Methods===
 ====APIGetLocationInfo====
 ====GetMetagages====
@@ Line 9: / Line 69: @@
 A "Metagage" is a list of gages that we sometimes show aggregated data for. The primary use is for the "Sum of the 3 forks" gage on the Forecasts page, which is the sum of readings and forecasts for three separate gages at the three forks of the river.
-Endpoint: GET <code>floodzilla.com/api/client/GetMetagages</code>
+Endpoint: <code>GET floodzilla.com/api/client/GetMetagages?regionId=1</code>
 ====GetLocations====
@@ Line 15: / Line 88: @@
 ====GetGageReadingsUTC====
 Deprecated.
 ==Authentication==

@@ Line 1: / Line 1: @@
-== Gage Status and Metadata ==
+==Gage Status and Metadata==
-=== Methods ===
+===Methods===
-==== GetLocations ====
+====APIGetLocationInfo====
-Deprecated.
+====GetMetagages====
-==== GetMetagages ====
+A "Metagage" is a list of gages that we sometimes show aggregated data for. The primary use is for the "Sum of the 3 forks" gage on the Forecasts page, which is the sum of readings and forecasts for three separate gages at the three forks of the river.
-==== GetGageReadingsUTC ====
+Endpoint: GET <code>floodzilla.com/api/client/GetMetagages</code>
 Deprecated.
-== Authentication ==
+==Authentication==
 Floodzilla has its own AuthZ/AuthN API; it does not use a third party service like Auth0.  The primary reason is integration with
@@ Line 22: / Line 24: @@
 [Full documentation will be added eventually]
-=== Methods ===
+===Methods===
-==== Authenticate ====
+====Authenticate====
-==== Reauthenticate ====
+====Reauthenticate====
-==== CreateAccount ====
+====CreateAccount====
-==== APIForgotPassword ====
+====APIForgotPassword====
-==== APISetPassword ====
+====APISetPassword====
-==== APICreatePassword ====
+====APICreatePassword====
-==== APIResetPassword ====
+====APIResetPassword====
-==== SendVerificationEmail ====
+====SendVerificationEmail====
-==== VerifyEmail ====
+====VerifyEmail====
-==== SendPhoneVerificationSMS ====
+====SendPhoneVerificationSMS====
-==== VerifyPhone ====
+====VerifyPhone====
-==== UpdateAccount ====
+====UpdateAccount====
-==== AuthenticateWithGoogle ====
+====AuthenticateWithGoogle====
-== Subscription ==
+==Subscription==
 The Subscription API allows clients to subscribe to various kinds of notifications (currently just email and SMS) for gages and forecast data.
-=== Methods ===
+===Methods===
 [Documentation to come]

← Older revision		Revision as of 18:08, 9 March 2023
Line 1:		Line 1:
−	== Floodzilla ~~Client~~ API ==	+	== Gage Status and Metadata ==
		+
		+	=== Methods ===
		+
		+	==== GetLocations ====
		+
		+	Deprecated.
		+
		+	==== GetMetagages ====
		+
		+	==== GetGageReadingsUTC ====
		+
		+	Deprecated.
		+
		+	==== APIGetLocationInfo ====
		+
		+	== Authentication ==
		+
		+	Floodzilla has its own AuthZ/AuthN API; it does not use a third party service like Auth0. The primary reason is integration with
		+	ASP.NET's built-in authentication and identity services, which the existing back end and admin tools use.
		+
		+	[Full documentation will be added eventually]
		+
		+	=== Methods ===
		+
		+	==== Authenticate ====
		+
		+	==== Reauthenticate ====
		+
		+	==== CreateAccount ====
		+
		+	==== APIForgotPassword ====
		+
		+	==== APISetPassword ====
		+
		+	==== APICreatePassword ====
		+
		+	==== APIResetPassword ====
		+
		+	==== SendVerificationEmail ====
		+
		+	==== VerifyEmail ====
		+
		+	==== SendPhoneVerificationSMS ====
		+
		+	==== VerifyPhone ====
		+
		+	==== UpdateAccount ====
		+
		+	==== AuthenticateWithGoogle ====
		+
		+	== Subscription ==
		+
		+	The Subscription API allows clients to subscribe to various kinds of notifications (currently just email and SMS) for gages and forecast data.
		+
		+	=== Methods ===
		+
		+	[Documentation to come]