Add clans-summary docs.

topfreegames · Jul 26, 2016 · 6445565 · 6445565
1 parent b8aceee
commit 6445565
Showing 1 changed file with 72 additions and 0 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -752,6 +752,78 @@ Khan API
       }
       ```
 
+  * Error Response
+
+    * Code: `500`
+    * Content:
+      ```
+      {
+        "success": false,
+        "reason": [string]
+      }
+      ```
+
+  ### Clans Summary
+  `GET /games/:gameID/clans-summary?clanPublicIds=clan1,clan2,clan3`
+
+  Returns a summary of the details for each one of the clans with the given publicIDs.
+
+  * Success Response
+    * Code: `200`
+    * Content:
+      ```
+      {
+        "success": true,
+        clans: [
+          {
+            "publicID": [string],
+            "name": [string],
+            "metadata": [JSON],
+            "allowApplication": [bool],
+            "autoJoin": [bool],
+            "membershipCount": [int]
+          },
+          {
+            "publicID": [string],
+            "name": [string],
+            "metadata": [JSON],
+            "allowApplication": [bool],
+            "autoJoin": [bool],
+            "membershipCount": [int]
+          },
+          ...    
+        ]
+      }
+      ```
+
+  If no clanPublicIDs are provided:
+
+  * Error Response
+
+    * Code: `400`
+    * Content:
+      ```
+      {
+        "success": false,
+        "reason": [string]
+      }
+      ```
+
+  If at least one of the clan was not found:
+
+  * Error Response
+
+    * Code: `404`
+    * Content:
+      ```
+      {
+        "success": false,
+        "reason": [string]
+      }
+      ```
+
+  In case of other errors:
+
   * Error Response
 
     * Code: `500`