Read Subscription Balances
Basic Flow
| Step | Actor | Action | Description |
|---|---|---|---|
1. |
CSR / Back-Office Department User |
Search Offer Subscription |
Customer Sales Representative or Back-Office User via CRM GUI searches for an Offer Subscription. |
2. |
CRM |
Display Search Offer Subscription |
CRM System displays result of Search Offer Subscription to the User. |
3. |
CSR / Back-Office Department User |
Request for Read Offer Subscription Balances Details |
Customer Sales Representative or Back-Office User via CRM GUI requests for 'Read Offer Subscription Balances Details'. |
4. |
CRM |
Call readSubscriptionBalance API |
CRM System calls Read Subscription’s Balances API exposed by OCS.io. |
5. |
OCS.io |
Request Validation |
OCS.io validates Request whether all mandatory attributes are populated, all data types are valid, ENUMs match with definition, etc. Additionally, OCS.io validates Request against Business Logic. This typically includes, that referenced entity exists in the system, entity has proper state, etc. |
6. |
OCS.io |
Perform Business Logic |
OCS.io performs Business Logic implemented for the Use-Case. |
7. |
OCS.io |
Return readSubscriptionBalance Response |
OCS.io returns Response to the CRM System. |
8. |
CRM |
Result of Read Offer Subscription Balances Details |
CRM system displays result of 'Read Offer Subscription Balances Details' to the User. |
Request Validations
The following validations are performed when reading subscription’s balances:
-
Offer Subscription must exist in the system.