Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create Device Identifier User Story.md #59

Merged
merged 3 commits into from
Jun 7, 2024
Merged

Create Device Identifier User Story.md #59

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
042911c
Create Device Identifier User Story.md
eric-murray May 2, 2024
c05a6d6
Merge branch 'camaraproject:main' into eric-murray-patch-2
eric-murray May 14, 2024
0b417eb
Update Device Identifier User Story.md
eric-murray Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions documentation/API_documentation/Device Identifier User Story.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Device Identifier API User Story

| **Item** | **Details** |
| ---- | ------- |
| ***Summary*** | As an application developer belonging to an enterprise, I want my application server to be able to request the identity of the mobile device (represented by the IMEI) currently being used by a given mobile network subscriber (identified by MSISDN, IP address or, when supported by network operators, a Network Access Identifier). Optionally, I'd like to know the make and model of that device. |
| ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Application Service Providers, Hyperscalers, Application Developers, End Users<br> **Scope:** *Order To Activate (OTA)* \- Retrieve device identifier details |
| ***Pre-Conditions*** |The preconditions are listed below:<br><ol><li>The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.</li><li>The Customer:BusinessManager has successfully subscribed to the Device Identifier product from the product catalog.</li><li>The Customer:Administrator has onboarded the Customer:User to the platform.</li><li>The Customer:BusinessManager has agreed to the terms and conditions of the CSP for managing consent of mobile subscription owners.</li><li>The means to get the access token are known to the Customer:User to ensure secure access of the API.|
| ***Activities/Steps*** | **Starts when:** The Customer:User's application server makes a POST request to the Device Identifier API containing the end user's subscription information in the request body in order to retrieve the device identifier plus any optional device information.<br>**Ends when:** The Device Identifier API returns the requested information, or an error message |
| ***Post-Conditions*** | None |
| ***Exceptions*** | Several exceptions might occur after a request to the Device Identifier API<br>- **Unauthorized**: Invalid credentials (e.g. use of already expired access token).<br>- **Invalid Input**: Invalid input data to retrieve device details (e.g. MSISDN format not as expected, or MSISDN not associated with a customer of the CSP).<br>- **Forbidden**: End user has not consented to device identifier information being provided to the Customer:User|

# Device Type API User Story

| **Item** | **Details** |
| ---- | ------- |
| ***Summary*** | As an application developer belonging to an enterprise, I want my application server to be able to request details about the type of the mobile device (represented by the Type Approval Code - TAC) currently being used by a given mobile network subscriber (identified by MSISDN, IP address or, when supported by network operators, a Network Access Identifier). Optionally, I'd like to know the make and model of that device. |
| ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Application Service Providers, Hyperscalers, Application Developers, End Users<br> **Scope:** *Order To Activate (OTA)* \- Retrieve device type details |
| ***Pre-Conditions*** |The preconditions are listed below:<br><ol><li>The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.</li><li>The Customer:BusinessManager has successfully subscribed to the Device Type product from the product catalog.</li><li>The Customer:Administrator has onboarded the Customer:User to the platform.</li><li>The Customer:BusinessManager has agreed to the terms and conditions of the CSP for managing consent of mobile subscription owners.</li><li>The means to get the access token are known to the Customer:User to ensure secure access of the API.|
| ***Activities/Steps*** | **Starts when:** The Customer:User's application server makes a POST request to the Device Type API containing the end user's subscription information in the request body in order to retrieve the device TAC plus any optional device information.<br>**Ends when:** The Device Type API returns the requested information, or an error message |
| ***Post-Conditions*** | None |
| ***Exceptions*** | Several exceptions might occur after a request to the Device Type API<br>- **Unauthorized**: Invalid credentials (e.g. use of already expired access token).<br>- **Invalid Input**: Invalid input data to retrieve device details (e.g. MSISDN format not as expected, or MSISDN not associated with a customer of the CSP).<br>- **Forbidden**: End user has not consented to device TAC information being provided to the Customer:User|