Przeglądaj źródła

Update documentation

Matt Coles 9 lat temu
rodzic
commit
88eb851548
1 zmienionych plików z 35 dodań i 0 usunięć
  1. 35 0
      README.md

+ 35 - 0
README.md

@@ -121,6 +121,41 @@ that a society with that name already exists, and `3` indicates that the user
121 121
 does not have authorisation to create that society. (Note that the admin list
122 122
 must contain the username that is creating it.)
123 123
 
124
+### /society/view/
125
+To view a list of all the societies, a `GET` request should be sent with no data
126
+to this route with no parameter. The response will be formed as follows:
127
+```javascript
128
+{
129
+    "societies": [
130
+        {
131
+            "name": "TestSociety",
132
+            "admins": [
133
+                "test1",
134
+                "test2"
135
+            ],
136
+            "description": "This is a test",
137
+            "users": [
138
+                "test1",
139
+                "test2"
140
+            ]
141
+        },
142
+        {
143
+            "name": "TestSociety2",
144
+            "admins": [
145
+                "test1",
146
+                "test2"
147
+            ],
148
+            "description": "This is a test",
149
+            "users": [
150
+                "test1",
151
+                "test2"
152
+            ]
153
+        }
154
+    ]
155
+}
156
+```
157
+There are no error codes for this route.
158
+
124 159
 ### /society/view/:society\_name
125 160
 To view a created society, :society\_name, a `GET` request should be sent with
126 161
 no data. The response will then be formed as follows: