generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
605e168
commit d2cf6fe
Showing
1 changed file
with
10 additions
and
0 deletions.
There are no files selected for viewing
10 changes: 10 additions & 0 deletions
10
documentation/API_documentation/RDC_User_Story_Outdoor Live Streaming.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# RegionDeviceCount API User Story - Outdoor Live Streaming | ||
|
||
| **Item** | **Details** | | ||
| ---- | ------- | | ||
| ***Summary*** | As an outdoor anchor and plan to conduct outdoor live streaming activities in different regions. In order to estimate the possible number of viewers and effectively choose a live streaming location, I need to understand the potential number of viewers in different area.Here is my requirements.<br>• I hope to obtain the number of users in a specific area through an API, so that I can choose locations with high audience potential for live streaming based on this data.<br>• I need an API that can provide information on the activity level of users in the area, in order to determine the activity time of users in that area and arrange the best live broadcast time.<br>• I hope the response time of the API is fast, so that decisions can be made quickly before planning and actual live broadcasts.| | ||
| ***Roles, Actors and Scope*** | **Roles:** End User:Outdoor anchor<br> API Customer: Live Streaming Application. <br> API Provider:Communication Service Provider (CSP). <br> **Scope:** Returns the number of users in a specific area during a certain time interval through an API | | ||
| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The Customer has been onboarded to the CSP's API platform.</li><li>The Customer has successfully subscribed to the RegionDeviceCount product from the product catalog.</li><li>The outdoor anchor has been onboarded to the live streaming application.</li><li>The means to get the access token are known to the API Customer to ensure secure access of the API.| | ||
| ***Activities/Steps*** | **Starts when:** Outdoor anchors initiate requests through live streaming application to query the number of devices in a certain area at a certain time interval<br>**Ends when:** CSP returns the number of devices in the area to the live streaming app, and the live streaming app presents the results to the anchors. | | ||
| ***Post-conditions*** | CSP returns accurate statistical results, and users can choose suitable live streaming areas based on the query results | | ||
| ***Exceptions*** | Several exceptions might occur during the RegionDeviceCount API operations<br>- Unauthorized: Not valid credentials (e.g. use of already expired access token).<br>- Invalid input: Not valid input data to invoke operation (e.g.Area format error, or inability to obtain valid data within the area).<br>| |