Read Account
Basic Flow
| Step | Actor | Action | Description |
|---|---|---|---|
1. |
CSR / Back-Office Department User |
Search Account |
Customer Sales Representative or Back-Office User via CRM GUI searches for an Account. |
2. |
CRM |
Display Search Account |
CRM System displays result of Search Account to the User. |
3. |
CSR / Back-Office Department User |
Request for Read Account Details |
Customer Sales Representative or Back-Office User via CRM GUI requests for 'Read Account Details'. |
4. |
CRM |
Call readAccount API |
CRM System calls Read Account 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 readAccount Response |
OCS.io returns Response to the CRM System. |
8. |
CRM |
Result of Read Account Details |
CRM system displays result of 'Read Account Details' to the User. |
Request Validations
The following validations are performed when reading an Account:
-
Account must exist in the system.