Changes between Version 9 and Version 10 of WasteCollectionTabletAPI

Timestamp:

Nov 4, 2021 3:59:28 PM (3 years ago)

Author:

tolix

Comment:

--

WasteCollectionTabletAPI

@@ -7 +7 @@
  * Content-Type: text/x-json
 
-HTTP адрес всех веб-сервисов (URL), используемых в данном компоненте, формируется из базовой части http://<server_name>/components/communa/ и имени конкретного сервиса.
+HTTP адрес всех веб-сервисов (URL), используемых в данном компоненте, формируется из базовой части !http://<server_name>/components/communa/ и имени конкретного сервиса.
 
 Все параметры, содержащие время, используют часовой пояс оператора-владельца используемых в запросе объектов (спецавтомобилей, контейнеров и т.д.), т.е. местное время.
@@ -13 +13 @@
 Типичный сценарий работы планшета выглядит следующим образом:
 
- * Планшет запрашивает список сотрудников для простой аутентификации водителя/экспедитора на стороне планшета. В качестве пин-код выступает табельный номер сотрудника (get_personnel)
- * Планшет запрашивает список маршрутов и предлагает на выбор водителю (get_routes)
- * По завершению выбора маршрута планшет отправляет на сервер событие "На маршруте" с указанием маршрута, водителя и грузчика (экспедитора) (register_event ROUTE_START)
- * Водитель приступает к циклу уборки - планшет отправляет событие "На смене". (register_event ON_SHIFT) Цикл уборки состоит из: 
-    * получение траектории до следующей платформы (get_directions)
-    * по приезду и уборке платформы планшет запрашивает у сервера количество сработал датчика поднятий стрелы (get_lifts_count)
-    * отправляет на сервер событие "Погрузка площадки" с указанием количества подгруженных контейнеров и причины непогрузки оставшихся (если имеются) (register_event PLATFORM_LOADED)
- * При заполнении бункера спецавтомобиля он едет выгружаться на полигон - планшет отправляет событие "Еду на полигон" (register_event ...), что дает ему возможность сойти с маршрута. Аналогично работает событие "На техобслуживании"
+ * Планшет запрашивает список сотрудников для простой аутентификации водителя/экспедитора на стороне планшета ([#get_personnel get_personnel]). В качестве пин-код выступает табельный номер сотрудника 
+ * Планшет запрашивает список маршрутов и предлагает на выбор водителю ([#get_routes get_routes])
+ * По завершению выбора маршрута планшет отправляет на сервер событие "На маршруте" с указанием маршрута, водителя и грузчика (экспедитора) ([#ROUTE_START register_event ROUTE_START])
+ * Водитель приступает к циклу уборки - планшет отправляет событие "На смене". ([#ON_SHIFT register_event ON_SHIFT]) Цикл уборки состоит из: 
+    * получение траектории до следующей платформы ([#get_directions get_directions])
+    * по приезду и уборке платформы планшет запрашивает у сервера количество сработал датчика поднятий стрелы ([#get_lifts_count get_lifts_count])
+    * отправляет на сервер событие "Погрузка площадки" с указанием количества подгруженных контейнеров и причины непогрузки оставшихся (если имеются) ([#PLATFORM_LOADED register_event PLATFORM_LOADED])
+ * При заполнении бункера спецавтомобиля он едет выгружаться на полигон - планшет отправляет событие "Еду на полигон" ([#GO_TO_COLLECTION_SITE register_event ...]), что дает ему возможность сойти с маршрута. Аналогично работает событие "На техобслуживании"
  * По завершению маршрута планшет отправляет событие "Еду в гараж"
 
-== Запрос списка водителей/экспедиторов для аутентификации ==
+== Запрос списка водителей/экспедиторов для аутентификации == #get_personnel
 
 Endpoint: http://<server_name>/components/communa/get_personnel
@@ -57 +57 @@
 }}}
 
-== Запрос списка маршрутов полный (с подробной информацией о платформах) ==
+== Запрос списка маршрутов полный (с подробной информацией о платформах) == #get_routes
 
 Endpoint: http://<server_name>/components/communa/get_routes
@@ -183 +183 @@
 }}}
 
-== Запрос списка маршрутов без подробной информации о маршруте ==
+== Запрос списка маршрутов без подробной информации о маршруте == #get_routes_v2
 
 Endpoint: http://<server_name>/components/communa/get_routes_v2
@@ -281 +281 @@
 
 
-== Регистрация событий ==
+== Регистрация событий == #register_event
 
 Endpoint: http://<server_name>/components/communa/register_event
 
-=== Событие "Выход на маршрут" ===
+=== Событие "Выход на маршрут" === #ROUTE_START
 
 Запрос:
@@ -309 +309 @@
 
 
-=== Событие "Приступил к уборке" ===
+=== Событие "Приступил к уборке" === #ON_SHIFT
 
 Запрос:
@@ -325 +325 @@
 }}}
 
-=== Событие "Еду в гараж" ===
+=== Событие "Еду в гараж" === #GO_TO_GARAGE
 
 Запрос:
@@ -341 +341 @@
 }}}
 
-=== Событие "Еду на полигон" ===
+=== Событие "Еду на полигон" === #GO_TO_COLLECTION_SITE
 
 Запрос:
@@ -358 +358 @@
 
 
-=== Событие "Техобслуживание" ===
+=== Событие "Техобслуживание" === #GO_TO_SERVICE
 
 Запрос:
@@ -375 +375 @@
 
 
-=== Событие "Погрузка площадки" ===
+=== Событие "Погрузка площадки" === #PLATFORM_LOADED
 
 Запрос:
@@ -394 +394 @@
 
 
-== Запрос траектории до следующего пункта маршрута ==
+== Запрос траектории до следующего пункта маршрута == #get_directions
 
 Endpoint: http://<server_name>/components/communa/get_directions
@@ -571 +571 @@
 
 
-== Запрос количества поднятых контейнеров ==
+== Запрос количества поднятых контейнеров == #get_lifts_count
 
 Endpoint: http://<server_name>/components/communa/get_lifts_count
@@ -594 +594 @@
 
 
-== Залогировать дебажное сообщение на сервере ==
+== Залогировать дебажное сообщение на сервере == #debug
 
 Endpoint: http://<server_name>/components/communa/debug