Add comments, query parameters

Author: MichaelElmore1

CSAPI-lib/CSAPI-lib.vcxproj

@@ -181,6 +181,8 @@
     <ClInclude Include="ObservationsAPI.h" />
     <ClInclude Include="Query\DataStreamsOfSystemQuery.h" />
     <ClInclude Include="Query\DataStreamsQuery.h" />
+    <ClInclude Include="Query\ObservationsOfDataStreamQuery.h" />
+    <ClInclude Include="Query\ObservationsQuery.h" />
     <ClInclude Include="Query\QueryParameters.h" />
     <ClInclude Include="Query\SystemsQuery.h" />
     <ClInclude Include="RegistryInit.h" />

CSAPI-lib/CSAPI-lib.vcxproj.filters

@@ -195,5 +195,11 @@
     <ClInclude Include="DataModels\ObservationBuilder.h">
       <Filter>Header Files\DataModels</Filter>
     </ClInclude>
+    <ClInclude Include="Query\ObservationsQuery.h">
+      <Filter>Header Files\Query</Filter>
+    </ClInclude>
+    <ClInclude Include="Query\ObservationsOfDataStreamQuery.h">
+      <Filter>Header Files\Query</Filter>
+    </ClInclude>
   </ItemGroup>
 </Project>

CSAPI-lib/ObservationsAPI.h

@@ -5,6 +5,8 @@
 #include "APIRequest.h"
 #include "APIResponse.h"
 #include "DataModels/Observation.h"
+#include "Query/ObservationsQuery.h"
+#include "Query/ObservationsOfDataStreamQuery.h"
 
 namespace ConnectedSystemsAPI {
 	class ObservationsAPI {
@@ -18,28 +20,61 @@ namespace ConnectedSystemsAPI {
 			: apiRoot(apiRoot), authHeader(authHeader) {
 		}
 
-		APIResponse<DataModels::Observation> getObservations() {
+		/// <summary>
+		/// List or search all observations available from this server endpoint.
+		/// </summary>
+		/// <param name="query">The query string parameters.</param>
+		/// <returns>A response object containing a list of observations.</returns>
+		APIResponse<DataModels::Observation> getObservations(const Query::ObservationsQuery& query) {
+			return getObservations(query.toString());
+		}
+
+		/// <summary>
+		/// List or search all observations available from this server endpoint.
+		/// </summary>
+		/// <param name="query">The query string.</param>
+		/// <returns>A response object containing a list of observations.</returns>
+		APIResponse<DataModels::Observation> getObservations(std::string queryString = "") {
 			auto response = APIRequest::Builder()
 				.setApiRoot(apiRoot)
 				.setMethod("GET")
 				.setAuthHeader(authHeader)
-				.setResourcePath("/observations")
+				.setResourcePath("/observations" + queryString)
 				.build()
 				.execute<DataModels::Observation>();
 			return response;
 		}
 
-		APIResponse<DataModels::Observation> getObservationsOfDataStream(const std::string& dataStreamId) {
+		/// <summary>
+		/// List or search all observations available from a datastream.
+		/// </summary>
+		/// <param name="query">The query string parameters.</param>
+		/// <returns>A response object containing a list of observations.</returns>
+		APIResponse<DataModels::Observation> getObservationsOfDataStream(const std::string& dataStreamId, const Query::ObservationsOfDataStreamQuery& query) {
+			return getObservationsOfDataStream(dataStreamId, query.toString());
+		}
+
+		/// <summary>
+		/// List or search all observations available from a datastream.
+		/// </summary>
+		/// <param name="query">The query string.</param>
+		/// <returns>A response object containing a list of observations.</returns>
+		APIResponse<DataModels::Observation> getObservationsOfDataStream(const std::string& dataStreamId, std::string queryString = "") {
 			auto response = APIRequest::Builder()
 				.setApiRoot(apiRoot)
 				.setMethod("GET")
 				.setAuthHeader(authHeader)
-				.setResourcePath("/datastreams/" + dataStreamId + "/observations")
+				.setResourcePath("/datastreams/" + dataStreamId + "/observations" + queryString)
 				.build()
 				.execute<DataModels::Observation>();
 			return response;
 		}
 
+		/// <summary>
+		/// Get a specific observation by its ID.
+		/// </summary>
+		/// <param name="observationId">The ID of the observation to retrieve.</param>
+		/// <returns>A response object containing the requested observation.</returns>
 		APIResponse<DataModels::Observation> getObservationById(const std::string& observationId) {
 			auto response = APIRequest::Builder()
 				.setApiRoot(apiRoot)
@@ -51,6 +86,12 @@ namespace ConnectedSystemsAPI {
 			return response;
 		}
 
+		/// <summary>
+		/// Add a new observation to an existing data stream.
+		/// </summary>
+		/// <param name="dataStreamId">The local identifier of the data stream.</param>
+		/// <param name="observation">The observation to create.</param>
+		/// <returns>A response object indicating success or failure.</returns>
 		APIResponse<void> createObservation(const std::string& dataStreamId, const DataModels::Observation& observation) {
 			nlohmann::ordered_json j;
 			ConnectedSystemsAPI::DataModels::to_json(j, observation);
@@ -66,6 +107,12 @@ namespace ConnectedSystemsAPI {
 			return response;
 		}
 
+		/// <summary>
+		/// Update an existing observation.
+		/// </summary>
+		/// <param name="observationId">The ID of the observation to update.</param>
+		/// <param name="observation">The updated observation.</param>
+		/// <returns>A response object indicating success or failure.</returns>
 		APIResponse<void> updateObservation(const std::string& observationId, const DataModels::Observation& observation) {
 			nlohmann::ordered_json j;
 			ConnectedSystemsAPI::DataModels::to_json(j, observation);
@@ -81,6 +128,11 @@ namespace ConnectedSystemsAPI {
 			return response;
 		}
 
+		/// <summary>
+		/// Delete an observation by its ID.
+		/// </summary>
+		/// <param name="observationId">The ID of the observation to delete.</param>
+		/// <returns>A response object indicating success or failure.</returns>
 		APIResponse<void> deleteObservation(const std::string& observationId) {
 			auto response = APIRequest::Builder()
 				.setApiRoot(apiRoot)

CSAPI-lib/Query/ObservationsOfDataStreamQuery.h

@@ -0,0 +1,68 @@
+#pragma once
+
+#include <string>
+#include "QueryParameters.h"
+#include "..\DataModels\TimeExtent.h"
+
+namespace ConnectedSystemsAPI {
+	namespace Query {
+		class ObservationsOfDataStreamQuery : public QueryParameters {
+		public:
+			/// <summary>
+			/// List of resource local IDs or unique IDs (URI).
+			/// Only resources that have one of the provided identifiers are selected.
+			/// </summary>
+			ObservationsOfDataStreamQuery& setId(const std::string& id) {
+				addParameter("id", id);
+				return *this;
+			}
+
+			/// <summary>
+			/// Either a date-time or an interval.
+			/// Date and time expressions adhere to RFC 3339.
+			/// Intervals may be bounded or half-bounded (double-dots at start or end).
+			/// </summary>
+			ObservationsOfDataStreamQuery& setPhenomenonTime(DataModels::TimeExtent phenomenonTime) {
+				addParameter("phenomenonTime", phenomenonTime);
+				return *this;
+			}
+
+			/// <summary>
+			/// Either a date-time or an interval.
+			/// Date and time expressions adhere to RFC 3339.
+			/// Intervals may be bounded or half-bounded (double-dots at start or end).
+			/// </summary>
+			ObservationsOfDataStreamQuery& setResultTime(DataModels::TimeExtent resultTime) {
+				addParameter("resultTime", resultTime);
+				return *this;
+			}
+
+			/// <summary>
+			/// List of feature local IDs or unique IDs (URI).
+			/// Only resources that are associated with a feature of interest that has one of the provided identifiers are selected.
+			/// </summary>
+			ObservationsOfDataStreamQuery& setFoi(const std::string& foi) {
+				addParameter("foi", foi);
+				return *this;
+			}
+
+			/// <summary>
+			/// List of property local IDs or unique IDs (URI).
+			/// Only resources that are associated with an observable property that has one of the provided identifiers are selected.
+			/// </summary>
+			ObservationsOfDataStreamQuery& setObservedProperty(const std::string& observedProperty) {
+				addParameter("observedProperty", observedProperty);
+				return *this;
+			}
+
+			/// <summary>
+			/// Limits the number of items that are presented in the response document.
+			/// Default: 100
+			/// </summary>
+			ObservationsOfDataStreamQuery& setLimit(int limit) {
+				addParameter("limit", limit);
+				return *this;
+			}
+		};
+	}
+}

CSAPI-lib/Query/ObservationsQuery.h

@@ -0,0 +1,86 @@
+#pragma once
+
+#include <string>
+#include "QueryParameters.h"
+#include "..\DataModels\TimeExtent.h"
+
+namespace ConnectedSystemsAPI {
+	namespace Query {
+		class ObservationsQuery : public QueryParameters {
+		public:
+			/// <summary>
+			/// List of resource local IDs or unique IDs (URI).
+			/// Only resources that have one of the provided identifiers are selected.
+			/// </summary>
+			ObservationsQuery& setId(const std::string& id) {
+				addParameter("id", id);
+				return *this;
+			}
+
+			/// <summary>
+			/// Either a date-time or an interval.
+			/// Date and time expressions adhere to RFC 3339.
+			/// Intervals may be bounded or half-bounded (double-dots at start or end).
+			/// </summary>
+			ObservationsQuery& setPhenomenonTime(DataModels::TimeExtent phenomenonTime) {
+				addParameter("phenomenonTime", phenomenonTime);
+				return *this;
+			}
+
+			/// <summary>
+			/// Either a date-time or an interval.
+			/// Date and time expressions adhere to RFC 3339.
+			/// Intervals may be bounded or half-bounded (double-dots at start or end).
+			/// </summary>
+			ObservationsQuery& setResultTime(DataModels::TimeExtent resultTime) {
+				addParameter("resultTime", resultTime);
+				return *this;
+			}
+
+			/// <summary>
+			/// List of system local IDs or unique IDs (URI).
+			/// Only resources that are associated with a data stream that has one of the provided identifiers are selected.
+			/// </summary>
+			ObservationsQuery& setDataStream(std::vector<std::string>& dataStream) {
+				addParameter("dataStream", dataStream);
+				return *this;
+			}
+
+			/// <summary>
+			/// List of system local IDs or unique IDs (URI).
+			/// Only resources that are associated with a System that has one of the provided identifiers are selected.
+			/// </summary>
+			ObservationsQuery& setSystem(std::vector<std::string>& system) {
+				addParameter("system", system);
+				return *this;
+			}
+
+			/// <summary>
+			/// List of feature local IDs or unique IDs (URI).
+			/// Only resources that are associated with a feature of interest that has one of the provided identifiers are selected.
+			/// </summary>
+			ObservationsQuery& setFoi(const std::string& foi) {
+				addParameter("foi", foi);
+				return *this;
+			}
+
+			/// <summary>
+			/// List of property local IDs or unique IDs (URI).
+			/// Only resources that are associated with an observable property that has one of the provided identifiers are selected.
+			/// </summary>
+			ObservationsQuery& setObservedProperty(const std::string& observedProperty) {
+				addParameter("observedProperty", observedProperty);
+				return *this;
+			}
+
+			/// <summary>
+			/// Limits the number of items that are presented in the response document.
+			/// Default: 100
+			/// </summary>
+			ObservationsQuery& setLimit(int limit) {
+				addParameter("limit", limit);
+				return *this;
+			}
+		};
+	}
+}