diff --git a/documentation/API_documentation/Population-Density-Data_User_Story.md b/documentation/API_documentation/Population-Density-Data_User_Story.md new file mode 100644 index 0000000..c88e267 --- /dev/null +++ b/documentation/API_documentation/Population-Density-Data_User_Story.md @@ -0,0 +1,10 @@ +# PopulationDensityData API User Story + + Items | Details | +|---|---| +| **Summary** | The API provides estimation of Population Density for a specific area at a future period time, considering historical anonymized information of the network connected devices in the requested area.| +| **Actors and scope** | **Scope:** Retrieve predicted population density for a defined polygonal area and time interval; provide insights into population patterns to support strategic planning.

**Use Case 1 — Drone Route Planning:** Identify zones to avoid due to high population-related risk; determine optimal time window to fly between two points (A–B) minimizing population exposure.

**Use Case 2 — Urban Planning:** Data-driven optimization of public services/resource allocation; support simulation and impact assessment for urban mobility and infrastructure planning.| +| **Pre-conditions** | The client must provide:
- **Requested Area (Required):** Polygonal area defined by coordinates forming a closed loop.
- **Start Time (Required):** Future controlled time of departure.
- **End Time (Required):** Future controlled time of arrival.
- **Precision (Optional):** Geohash precision level.
- **Sink (Optional):** Destination system/endpoint for delivery.
- **Sink Credentials (Optional):** AuthN/AuthZ details to access the sink.| +| **Activities / Steps** | 1) The client submits a request including the inputs above.
2) The API responds **synchronously** (response body) or **asynchronously** (delivered to sink), including:
- **a) Cell Coordinates:** Geohash string representing the cell.
- **b) Population Density Metrics:** per cell in **1-hour intervals** with **min / avg / max** population.
- **c) Data Type (k-anonymity):** `Low_Density` (below threshold, cannot disclose) or `Density_Estimation` (values available and disclosed).| +| **Post-conditions** | The requester can assess population-related information for drone flight operations or urban planning by using forecasted population density derived from network-connected devices within the requested area.| +| **Exceptions** | - **Invalid input:** missing required fields or incorrect format (e.g., malformed polygon, missing Start/End Time, invalid precision).
- **Unsupported values:** parameters outside supported limits (e.g., time interval out of supported range, unsupported precision).
- **Unavailable data:** requested area/time/params not available or cannot be provided due to data protection constraints (e.g., k-anonymity).|