mirror of
https://github.com/cgrates/cgrates.git
synced 2026-02-20 22:58:44 +05:00
Formatting SetAccountActions api documentation
This commit is contained in:
56
docs/api_accounts.rst
Normal file
56
docs/api_accounts.rst
Normal file
@@ -0,0 +1,56 @@
|
||||
Apier.SetAccountActions
|
||||
+++++++++++++++++++++++
|
||||
|
||||
|
||||
Process dependencies and load a specific AccountActions profile from storDb into dataDb.
|
||||
|
||||
**Request**:
|
||||
|
||||
Data:
|
||||
::
|
||||
|
||||
type AttrSetAccountActions struct {
|
||||
TPid string
|
||||
AccountActionsId string
|
||||
}
|
||||
|
||||
Mandatory parameters: ``[]string{"TPid", "AccountActionsId"}``
|
||||
|
||||
*JSON sample*:
|
||||
::
|
||||
|
||||
{
|
||||
"id": 0,
|
||||
"method": "Apier.SetAccountActions",
|
||||
"params": [
|
||||
{
|
||||
"AccountActionsId": "SAMPLE_AA_1",
|
||||
"TPid": "SAMPLE_TP_1"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
**Reply**:
|
||||
|
||||
Data:
|
||||
::
|
||||
|
||||
string
|
||||
|
||||
Possible answers:
|
||||
``OK`` - Success.
|
||||
|
||||
*JSON sample*:
|
||||
::
|
||||
|
||||
{
|
||||
"error": null,
|
||||
"id": 0,
|
||||
"result": "OK"
|
||||
}
|
||||
|
||||
**Errors**:
|
||||
|
||||
``MANDATORY_IE_MISSING`` - Mandatory parameter missing from request.
|
||||
|
||||
``SERVER_ERROR`` - Server error occurred.
|
||||
@@ -344,63 +344,8 @@ Example
|
||||
AddAccount(attr \*AttrAccount, reply \*float64)
|
||||
|
||||
|
||||
Apier.SetAccountAction
|
||||
++++++++++++++++++++++
|
||||
|
||||
|
||||
Process dependencies and load a specific account action from storDb into dataDb.
|
||||
|
||||
**Request**:
|
||||
|
||||
Data:
|
||||
::
|
||||
|
||||
type AttrSetAccountAction struct {
|
||||
TPid string
|
||||
AccountActionId string
|
||||
}
|
||||
|
||||
Mandatory parameters: ``[]string{"TPid", "AccountActionId"}``
|
||||
|
||||
*JSON sample*:
|
||||
::
|
||||
|
||||
{
|
||||
"id": 0,
|
||||
"method": "Apier.SetAccountAction",
|
||||
"params": [
|
||||
{
|
||||
"AccountActionId": "ACC_SAMPLE_1",
|
||||
"TPid": "TPID_SAMPLE_1"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
**Reply**:
|
||||
|
||||
Data:
|
||||
::
|
||||
|
||||
string
|
||||
|
||||
Possible answers:
|
||||
``OK`` - Success.
|
||||
|
||||
*JSON sample*:
|
||||
::
|
||||
|
||||
{
|
||||
"error": null,
|
||||
"id": 0,
|
||||
"result": "OK"
|
||||
}
|
||||
|
||||
**Errors**:
|
||||
|
||||
``MANDATORY_IE_MISSING`` - Mandatory parameter missing from request.
|
||||
|
||||
``SERVER_ERROR`` - Server error occurred.
|
||||
|
||||
RatingProfiles
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
@@ -409,5 +354,15 @@ RatingProfiles
|
||||
|
||||
api_ratingprofiles
|
||||
|
||||
Accounts
|
||||
~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api_accounts
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user