Service module to handle Web Accounts interactions.
Syntax
Response = WebAccounts_Services(@Service, @Params) |
Returns
The meaning of the response value depends on the service.
Parameters
| Parameter | Description |
|---|
| @Service | The name of the service being requested. Required. |
| @Params | Generic parameters. Refer to a specific service to determine the actual parameters used. |
Remarks
This module provides several useful services for high level interaction with database tables and rows.
Services
| Service | Description |
|---|
GetWebAccounts | Usage:
WebAccounts_Services('GetWebAccounts', AccountID, ReturnJSON) Comments:
Returns the database row from the WebAccounts table for the indicated Account ID. The default format is MultiValue. Returns:
See comments. |
SetWebAccounts | Usage:
WebAccounts_Services('SetWebAccounts', AccountID, WebAccountsRow) Comments:
Updates the WebAccounts database row for the indicated Account ID. Returns:
N/A |
ConvertMVWebAccountsToJSON | Usage:
WebAccounts_Services('ConvertMVWebAccountsToJSON', AccountID, mvWebAccounts, itemURL) Comments:
Converts a MultiValue formatted WebAccounts row into a serialized JSON object and returns the result. If the mvWebAccounts argument is empty, the service will attempt to get it from the WebAccounts table. If the itemURL argument is not empty, HAL+JSON properties will be added to the JSON object. Returns:
The indicated WebAccount in JSON format. |
ConvertJSONWebAccountsToMV
| Usage:
WebAccounts_Services('ConvertJSONWebAccountsToMV', jsonWebAccounts) Comments:
Converts a serialized JSON WebAccounts object into a MultiValue formatted WebAccounts row and returns the result. Returns:
The indicated WebAccount in MultiValue format. |
Params
The proper use of the generic arguments are defined in the definition of each service above.