Browse Source

Added an example of an answer

Dmitry Yu Okunev 10 months ago
parent
commit
efa4725f63
1 changed files with 40 additions and 0 deletions
  1. 40 0
      doc/API.md

+ 40 - 0
doc/API.md

@@ -15,6 +15,46 @@
 
 Пример запроса: GET [https://api.cps.mephi.ru/events?event.PersonId=123456&startDate=2018-01-01+00:00:00](https://api.cps.mephi.ru/events?event.PersonId=123456&startDate=2018-01-01)
 
+Пример ответа:
+```
+{
+  "DevMode": true,
+  "RunMode": "dev",
+  "arg": [
+    {
+      "DtDate": "2018-11-15 07:53:13",
+      "PersonId": 123456,
+      "EmpGUID": 12345,
+      "Direction": 1
+    },
+    {
+      "DtDate": "2018-11-15 18:43:05",
+      "PersonId": 123456,
+      "EmpGUID": 12345,
+      "Direction": 0
+    },
+    {
+      "DtDate": "2018-11-16 10:51:42",
+      "PersonId": 123456,
+      "EmpGUID": 12345,
+      "Direction": 1
+    },
+    {
+      "DtDate": "2018-11-16 18:27:38",
+      "PersonId": 123456,
+      "EmpGUID": 12345,
+      "Direction": 0
+    }
+  ],
+  "currentLocale": "",
+  "errors": {},
+  "flash": {},
+  "session": {},
+  "status": "OK",
+  "username": ""
+}
+```
+
 Для выгрузки событий можно использовать следующие фильтры (см. [исходный файл](https://devel.mephi.ru/dyokunev/cps-api/src/master/app/controllers/events.go)) в качестве GET-параметров:
 * event (фильтрация по равенству любого поля из структуры event [например «event.PersonId=123456»]);
 * startDate (в формате: «YYYY-mm-dd»);