From a22b108845119c5b31029e2918311dabd9cfbaa3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=A8=E5=B8=86?= Date: Wed, 25 Oct 2023 16:03:19 +0800 Subject: [PATCH 1/4] APIproposal RegionUserCount ChinaUnicom --- .../APIproposal_RegionUserCount_ChinaUnicom.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md diff --git a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md new file mode 100644 index 00000000..70b1ac2f --- /dev/null +++ b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md @@ -0,0 +1,12 @@ +| **Field** | Description | +| ---- | ----- | +| API family name | Region User Count | +| API family owner | China Unicom | +| API summary | This API allows for the API Consumer to Query the number of users in the specified area.The query area can be a circle or a polygon composed of longitude and latitude points.
Input:areaType,circleCenter,circleRadius,pointListStr.
Output:userNum| +| Technical viability | This API is based on real-time location information expansion,obtains the number of users in a certain area based on their real-time location | +| Commercial viability | For use in emergency rescue, disaster relief, intelligent transportation, smart tourism and other scenarios| +| YAML code available? | NO
To be provided | +| Validated in lab/productive environments? | YES
Available in China UniCom test environment | +| Validated with real customers? | YES
For emergency rescue use by the Blue Eye Emergency Rescue Platform | +| Validated with operators? | YES
Available for China Unicom in China | +| Supporters in API Backlog Working Group | China Unicom | \ No newline at end of file From 1fdcfafae0801bf53a87cf9d9c75937243d86b35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=A8=E5=B8=86?= Date: Tue, 7 Nov 2023 10:45:11 +0800 Subject: [PATCH 2/4] add initial contributer --- .../API proposals/APIproposal_RegionUserCount_ChinaUnicom.md | 1 + 1 file changed, 1 insertion(+) diff --git a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md index 70b1ac2f..4a7e1b3a 100644 --- a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md +++ b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md @@ -2,6 +2,7 @@ | ---- | ----- | | API family name | Region User Count | | API family owner | China Unicom | +| Initial API Contributors | Fan Yang - China Unicom , Jin Xu - Huawei | | API summary | This API allows for the API Consumer to Query the number of users in the specified area.The query area can be a circle or a polygon composed of longitude and latitude points.
Input:areaType,circleCenter,circleRadius,pointListStr.
Output:userNum| | Technical viability | This API is based on real-time location information expansion,obtains the number of users in a certain area based on their real-time location | | Commercial viability | For use in emergency rescue, disaster relief, intelligent transportation, smart tourism and other scenarios| From 379474f0c97908bcebbd1a1ac7d7a19b32d907ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=A8=E5=B8=86?= Date: Fri, 10 Nov 2023 17:47:39 +0800 Subject: [PATCH 3/4] Region User Count API prposal update --- .../API proposals/APIproposal_RegionUserCount_ChinaUnicom.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md index 4a7e1b3a..2170e14a 100644 --- a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md +++ b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md @@ -3,7 +3,7 @@ | API family name | Region User Count | | API family owner | China Unicom | | Initial API Contributors | Fan Yang - China Unicom , Jin Xu - Huawei | -| API summary | This API allows for the API Consumer to Query the number of users in the specified area.The query area can be a circle or a polygon composed of longitude and latitude points.
Input:areaType,circleCenter,circleRadius,pointListStr.
Output:userNum| +| API summary | **Description**
This API allows for the API Consumer to Query the number of switch on users in the specified area .The query area can be a circle or a polygon composed of longitude and latitude points.
**Use Cases**
User Story 1 : Emergency Response Planning
Role: Emergency Response Coordinator
Context: During a natural disaster, such as a hurricane or earthquake, understanding the population density and distribution in affected areas is crucial for effective response planning.
Goal: As an advertising platform administrator, I want to utilize the API to obtain the user count in a specific region, allowing me to enhance targeted advertising by tailoring campaigns to the user demographics in that area.By accessing the API, I can retrieve real-time user counts in these regions, allowing us to estimate the potential number of individuals affected and the resources needed for evacuation, medical aid, and support services.
User Story 2 : Targeted Advertising
Role: Advertising Platform Administrator
Goal: As an advertising platform administrator, I want to utilize the API to obtain the user count in a specific region, allowing me to enhance targeted advertising by tailoring campaigns to the user demographics in that area.
**Input/Output**
**Input**
**areaType** :Enumeration value: circle,Polygon
**circleCenter** :The format is: longitude, latitude
Required when type is circle
**circleRadius** :Unit: m
Required when type is circle
**pointListStr** :The format is: Longitude 1, Latitude 1; Longitude 2, Latitude 2 @ Longitude 3, Latitude 3; Longitude 4 , Latitude 4. Longitude and Latitude are separated by English commas, multiple longitudes and latitudes are separated by English semicolons, and multiple regions are separated by the @ symbol
**Output**
**userNum** :the number of switch on users in the area
| | Technical viability | This API is based on real-time location information expansion,obtains the number of users in a certain area based on their real-time location | | Commercial viability | For use in emergency rescue, disaster relief, intelligent transportation, smart tourism and other scenarios| | YAML code available? | NO
To be provided | From e8787232846e69917fed93bc2213ebf41284b5a2 Mon Sep 17 00:00:00 2001 From: Jose Ordonez-Lucena <85119563+jordonezlucena@users.noreply.github.com> Date: Thu, 23 Nov 2023 14:32:23 +0100 Subject: [PATCH 4/4] Update APIproposal_RegionUserCount_ChinaUnicom.md Clarifying: 1) that the number provided in the API output is per operator 2) that only active users are counted (idle mode user does not compute). --- .../APIproposal_RegionUserCount_ChinaUnicom.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md index 2170e14a..badd14cd 100644 --- a/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md +++ b/APIBacklog/documentation/SupportingDocuments/API proposals/APIproposal_RegionUserCount_ChinaUnicom.md @@ -3,11 +3,11 @@ | API family name | Region User Count | | API family owner | China Unicom | | Initial API Contributors | Fan Yang - China Unicom , Jin Xu - Huawei | -| API summary | **Description**
This API allows for the API Consumer to Query the number of switch on users in the specified area .The query area can be a circle or a polygon composed of longitude and latitude points.
**Use Cases**
User Story 1 : Emergency Response Planning
Role: Emergency Response Coordinator
Context: During a natural disaster, such as a hurricane or earthquake, understanding the population density and distribution in affected areas is crucial for effective response planning.
Goal: As an advertising platform administrator, I want to utilize the API to obtain the user count in a specific region, allowing me to enhance targeted advertising by tailoring campaigns to the user demographics in that area.By accessing the API, I can retrieve real-time user counts in these regions, allowing us to estimate the potential number of individuals affected and the resources needed for evacuation, medical aid, and support services.
User Story 2 : Targeted Advertising
Role: Advertising Platform Administrator
Goal: As an advertising platform administrator, I want to utilize the API to obtain the user count in a specific region, allowing me to enhance targeted advertising by tailoring campaigns to the user demographics in that area.
**Input/Output**
**Input**
**areaType** :Enumeration value: circle,Polygon
**circleCenter** :The format is: longitude, latitude
Required when type is circle
**circleRadius** :Unit: m
Required when type is circle
**pointListStr** :The format is: Longitude 1, Latitude 1; Longitude 2, Latitude 2 @ Longitude 3, Latitude 3; Longitude 4 , Latitude 4. Longitude and Latitude are separated by English commas, multiple longitudes and latitudes are separated by English semicolons, and multiple regions are separated by the @ symbol
**Output**
**userNum** :the number of switch on users in the area
| -| Technical viability | This API is based on real-time location information expansion,obtains the number of users in a certain area based on their real-time location | +| API summary | **Description**
This API allows for the API Consumer to query the number of active users (i.e., excluding idle mode users). lin the specified area. The query area can be a circle or a polygon composed of longitude and latitude points.
**Use Cases**
User Story 1 : Emergency Response Planning
- Role: Emergency Response Coordinator
- Context: During a natural disaster, such as a hurricane or earthquake, understanding the population density and distribution in affected areas is crucial for effective response planning.
- Goal: As an advertising platform administrator, I want to utilize the API to obtain the user count in a specific region, allowing me to enhance targeted advertising by tailoring campaigns to the user demographics in that area. By accessing the API, I can retrieve real-time user counts in these regions, allowing us to estimate the potential number of individuals affected and the resources needed for evacuation, medical aid, and support services.
User Story 2 : Targeted Advertising
- Role: Advertising Platform Administrator
Goal: As an advertising platform administrator, I want to utilize the API to obtain the user count in a specific region, allowing me to enhance targeted advertising by tailoring campaigns to the user demographics in that area.
**Input**
- areaType :Enumeration value: circle,Polygon
- circleCenter :The format is: longitude, latitude
Required when type is circle
- circleRadius :Unit: m. It is Required when type is circle
- pointListStr:The format is: Longitude 1, Latitude 1; Longitude 2, Latitude 2 @ Longitude 3, Latitude 3; Longitude 4 , Latitude 4. Longitude and Latitude are separated by English commas, multiple longitudes and latitudes are separated by English semicolons, and multiple regions are separated by the @ symbol
**Output**
- userNum :the number of active users in the specified area. This number is provided is per serving operator in the area.
| +| Technical viability | This API is based on real-time location information expansion. It allows obtaining, on a per operator basis, the number of active users in a certain area based on their real-time location. | | Commercial viability | For use in emergency rescue, disaster relief, intelligent transportation, smart tourism and other scenarios| | YAML code available? | NO
To be provided | | Validated in lab/productive environments? | YES
Available in China UniCom test environment | | Validated with real customers? | YES
For emergency rescue use by the Blue Eye Emergency Rescue Platform | | Validated with operators? | YES
Available for China Unicom in China | -| Supporters in API Backlog Working Group | China Unicom | \ No newline at end of file +| Supporters in API Backlog Working Group | China Unicom |