From 17597375dcc16bf51943d75f6f831ec7ffdd8e32 Mon Sep 17 00:00:00 2001
From: DanB <danb@cgrates.org>
Date: Fri, 19 Jul 2013 10:47:51 +0200
Subject: [PATCH] Adding ActionTimings api documentation

---
 docs/api_tpactiontimings.rst | 215 +++++++++++++++++++++++++++++++++++
 docs/apicalls.rst            |   8 ++
 2 files changed, 223 insertions(+)
 create mode 100644 docs/api_tpactiontimings.rst

diff --git a/docs/api_tpactiontimings.rst b/docs/api_tpactiontimings.rst
new file mode 100644
index 000000000..4371d221e
--- /dev/null
+++ b/docs/api_tpactiontimings.rst
@@ -0,0 +1,215 @@
+Apier.SetTPActionTimings
+++++++++++++++++++++++++
+
+Creates a new ActionTimings profile within a tariff plan.
+
+**Request**:
+
+ Data:
+  ::
+
+   type ApiTPActionTimings struct {
+	TPid            string         // Tariff plan id
+	ActionTimingsId string         // ActionTimings id
+	ActionTimings   []ApiActionTiming // Set of ActionTiming bindings this profile will group
+   }
+
+   type ApiActionTiming struct {
+	ActionsId string  // Actions id
+	TimingId  string  // Timing profile id
+	Weight    float64 // Binding's weight
+   }
+
+ Mandatory parameters: ``[]string{"TPid", "ActionsId", "ActionTimings", "ActionsId", "TimingId", "Weight"}``
+
+ *JSON sample*:
+  ::
+
+   {
+    "id": 7, 
+    "method": "Apier.SetTPActionTimings", 
+    "params": [
+        {
+            "ActionTimings": [
+                {
+                    "ActionsId": "SAMPLE_ACTIONS", 
+                    "TimingId": "ALL_TIME", 
+                    "Weight": 10
+                }, 
+                {
+                    "ActionsId": "SAMPLE_ACTIONS2", 
+                    "TimingId": "ALL_TIME", 
+                    "Weight": 10
+                }
+            ], 
+            "ActionTimingsId": "SAMPLE_AT3", 
+            "TPid": "SAMPLE_TP_1"
+        }
+    ]
+   }
+
+**Reply**:
+
+ Data:
+  ::
+
+   string
+
+ Possible answers:
+  ``OK`` - Success.
+
+ *JSON sample*:
+  ::
+
+   {
+    "error": null, 
+    "id": 7, 
+    "result": "OK"
+   }
+
+**Errors**:
+
+ ``MANDATORY_IE_MISSING`` - Mandatory parameter missing from request.
+
+ ``SERVER_ERROR`` - Server error occurred.
+
+ ``DUPLICATE`` - The specified combination of TPid/ActionTimingsId already present in StorDb.
+
+
+Apier.GetTPActionTimings
+++++++++++++++++++++++++
+
+Queries specific ActionTimings profile on tariff plan.
+
+**Request**:
+
+ Data:
+  ::
+
+   type AttrGetTPActionTimings struct {
+	TPid      string // Tariff plan id
+	ActionTimingsId string // ActionTimings id
+   }
+
+ Mandatory parameters: ``[]string{"TPid", "ActionTimingsId"}``
+
+ *JSON sample*:
+  ::
+
+   {
+    "id": 8, 
+    "method": "Apier.GetTPActionTimings", 
+    "params": [
+        {
+            "ActionTimingsId": "SAMPLE_AT3", 
+            "TPid": "SAMPLE_TP_1"
+        }
+    ]
+   }
+ 
+**Reply**:
+
+ Data:
+  ::
+
+   type ApiTPActionTimings struct {
+	TPid            string         // Tariff plan id
+	ActionTimingsId string         // ActionTimings id
+	ActionTimings   []ApiActionTiming // Set of ActionTiming bindings this profile will group
+   }
+
+   type ApiActionTiming struct {
+	ActionsId string  // Actions id
+	TimingId  string  // Timing profile id
+	Weight    float64 // Binding's weight
+   }
+
+ *JSON sample*:
+  ::
+
+   {
+    "error": null, 
+    "id": 8, 
+    "result": {
+        "ActionTimings": [
+            {
+                "ActionsId": "SAMPLE_ACTIONS", 
+                "TimingId": "ALL_TIME", 
+                "Weight": 10
+            }, 
+            {
+                "ActionsId": "SAMPLE_ACTIONS2", 
+                "TimingId": "ALL_TIME", 
+                "Weight": 10
+            }
+        ], 
+        "ActionTimingsId": "SAMPLE_AT3", 
+        "TPid": "SAMPLE_TP_1"
+    }
+   }
+
+**Errors**:
+
+ ``MANDATORY_IE_MISSING`` - Mandatory parameter missing from request.
+
+ ``SERVER_ERROR`` - Server error occurred.
+
+ ``NOT_FOUND`` - Requested ActionTimings profile not found.
+
+
+Apier.GetTPActionTimingIds
+++++++++++++++++++++++++++
+
+Queries ActionTimings identities on specific tariff plan.
+
+**Request**:
+
+ Data:
+  ::
+
+   type AttrGetTPActionTimingIds struct {
+	TPid string // Tariff plan id
+   }
+
+ Mandatory parameters: ``[]string{"TPid"}``
+
+ *JSON sample*:
+  ::
+
+   {
+    "id": 9, 
+    "method": "Apier.GetTPActionTimingIds", 
+    "params": [
+        {
+            "TPid": "SAMPLE_TP_1"
+        }
+    ]
+   }
+
+**Reply**:
+
+ Data:
+  ::
+
+   []string
+
+ *JSON sample*:
+  ::
+
+   {
+    "error": null, 
+    "id": 9, 
+    "result": [
+        "SAMPLE_AT", 
+        "SAMPLE_AT2", 
+        "SAMPLE_AT3"
+    ]
+   }
+
+**Errors**:
+
+ ``MANDATORY_IE_MISSING`` - Mandatory parameter missing from request.
+
+ ``SERVER_ERROR`` - Server error occurred.
+
+ ``NOT_FOUND`` - There are no ActionTimings profiles defined on the selected TPid.
diff --git a/docs/apicalls.rst b/docs/apicalls.rst
index 4e3781e6b..1c6a95d32 100644
--- a/docs/apicalls.rst
+++ b/docs/apicalls.rst
@@ -191,6 +191,14 @@ Actions
 
    api_tpactions
 
+ActionTimings
+~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   api_tpactiontimings
+
 
 6.1.5. Management API
 ---------------------