Manage Control Group
The Customer Sales Representative or Finance Department User wants to via CRM / Finance system GUI add or remove Account to / from Control Group in the OCS.io. This operation is available in the CRM / Finance system GUI for users with correct privileges.
The CRM / Finance system via the RESTful API requests for adding or removing account to / from Control Group in the OCS.io. The request body contains the identification of the Control Group and also identification of the Account which should be added or deleted to / from Control Group.
The OCS.io performs the operation, then returns the result of the operation as a payload of the response.
The CRM / Finance system presents the result of the operation to the User in the GUI.
Basic Flow - Add to Control Group
| Step | Actor | Action | Description |
|---|---|---|---|
1. |
CSR / FIN |
Request for Operation |
Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for Operation. |
2. |
CRM / Finance |
Call addToControlGroup API |
CRM / Finance System calls Add to Control Group API exposed by OCS.io. |
3. |
OCS.io |
Request Validation |
OCS.io validates Request whether all mandatory attributes are populated, all data types are valid, ENUMs match with definition, etc. |
4. |
OCS.io |
Add to Control Group |
OCS.io adds one or more Accounts to Control Group. |
5. |
OCS.io |
Return addToControlGroup Response |
OCS.io returns Response to the CRM / Finance System. |
Basic Flow - Remove from Control Group
| Step | Actor | Action | Description |
|---|---|---|---|
1. |
CSR / FIN |
Request for Operation |
Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for Operation. |
2. |
CRM / Finance |
Call removeFromControlGroup API |
CRM / Finance System calls Remove from Control Group API exposed by OCS.io. |
3. |
OCS.io |
Request Validation |
OCS.io validates Request whether all mandatory attributes are populated, all data types are valid, ENUMs match with definition, etc. |
4. |
OCS.io |
Remove from Control Group |
OCS.io removes one or more Accounts from Control Group. |
5. |
OCS.io |
Return removeFromControlGroup Response |
OCS.io returns Response to the CRM / Finance System. |