Changes for page Методы API для работы с ГЛОНАССSoft

Last modified by Андрей Калиновский on 2025/03/19 14:01

From version < 28.9 >

edited by Артем Шемяков
on 2022/09/22 10:20

To version < 21.10 >

edited by Артем Шемяков
on 2022/09/02 09:45

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Tags

...	...	@@ -1,1 +1,0 @@
1		-Public API\|API

Content

@@ -10,7 +10,7 @@
  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
--(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
++(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
@@ -20,27 +20,20 @@
  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
  )))
--(% class="box successmessage" %)
++(% class="box infomessage" %)
  (((
-- (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
++ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
  )))
  (% style="color:#000000" %)          Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
--(% style="color:#000000" %)Метод запроса: **POST**
++(% style="color:#000000" %)Метод запроса: **GET**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
--(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
++(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
--
--(% style="color:#000000" %){
--    "login": "testuser",
--    "password": "testuser"
--}(%%)
--
--
++(% lang="en-US" %)
  (% style="color:#000000" %)**Ответ:**
  (% lang="en-US" %)
@@ -47,11 +47,11 @@
  (% style="color:#000000" %){
  (% lang="en-US" %)
--(% style="color:#000000" %)    "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" ,  ~/~/ токен авторизации
--    "User": "testuser" ,  ~/~/ имя пользователя
++(% style="color:#000000" %)    "AuthId": "" ,  ~/~/ токен авторизации
++    "User": "" ,  ~/~/ имя пользователя
  (% lang="en-US" %)
--}
++    }
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
@@ -61,7 +61,7 @@
  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
  )))
--(% style="color:#000000" %)          Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -83,19 +83,19 @@
  (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
  )))
--(% style="color:#000000" %)          Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)          Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
  (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
--(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
++(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
  (% style="color:#000000" %)Метод запроса: **GET**
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
--(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
++(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -106,11 +106,14 @@
      "parentId": "",  ~/~/ идентификатор клиента-родителя
      "name": "",  ~/~/ наименование клиента
      "fullName": "",  ~/~/ полное наименование клиента
--    "agentInfoType": "",  ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
--    "status": "",  ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
--}
++    "agentInfoType": "",  ~/~/ тип клиента1
++    "status": "",  ~/~/ статус клиента
++    }
++(% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
++
++
  (% class="box" style="text-align: center;" %)
  (((
  (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
@@ -121,7 +121,7 @@
  (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
  )))
--(% style="color:#000000" %)          Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -149,7 +149,7 @@
      "kind": "",  ~/~/ тип аутентификации (None - выключена, Email - по email)
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
      "groups": "" ,  ~/~/ группы пользователя, названия групп
--}
++    }
  (% style="text-align:left" %)
  (% style="color:#000000; font-weight:normal" %)Ответ:
@@ -177,7 +177,7 @@
      "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
  (% style="text-align:left" %)
--(% style="color:#000000; font-weight:normal" %)}
++(% style="color:#000000; font-weight:normal" %)    }
  (% class="box successmessage" %)
@@ -187,16 +187,14 @@
  (% style="color:#000000" %)          Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
--(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
++(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
  (% style="color:#000000" %)Метод запроса: **POST**
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
--(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
++(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
--
  (% style="color:#000000" %){
    "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303",  ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
@@ -204,7 +204,7 @@
    "login": "qqqqqq",  ~/~/ Логин пользователя, по которому фильтруется, null - неважно
    "email": "eee",  ~/~/ Email пользователя, по которому фильтруется, null - неважно
--(% style="color:#000000" %)}
++(% style="color:#000000" %)  }
  (% style="color:#000000" %)Ответ:
@@ -224,7 +224,7 @@
      "status": "1",  ~/~/ статус пользователя
      "astLogged": "", ~/~/ дата/время последней авторизации
--(% style="color:#000000" %)}
++(% style="color:#000000" %)    }
  (% class="box warningmessage" %)
@@ -232,7 +232,7 @@
  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
  )))
--(% style="color:#000000" %)          Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -267,16 +267,16 @@
      "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//    //__}__
  (% lang="en-US" style="text-align:left" %)
  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//{     //
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ идентификатор пользователя
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//    "id": "" ,  ~/~/ идентификатор пользователя
      "lastName": "" ,  ~/~/ фамилия
      "firstName": "" ,  ~/~/ имя
      "position": "" ,  ~/~/ должность
@@ -292,10 +292,10 @@
      "doubleAuth": "" ,  ~/~/ параметры двухфакторной аутентификации
      "kind": "" ,  ~/~/ тип аутентификации
      "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
--    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
++    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя//
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//    //}
  (% class="box warningmessage" %)
@@ -303,13 +303,13 @@
  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
  )))
--(% style="color:#000000" %)          Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
--(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
++(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -321,7 +321,7 @@
      "description": "" ,  ~/~/ описание
      "data": "" ,  ~/~/ данные, связанные со сменой статуса
--(% style="color:#000000" %)}
++    (% style="color:#000000" %)}
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
@@ -332,13 +332,13 @@
  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
  )))
--(% style="color:#000000" %)          Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **DELETE**
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
--(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
++(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -358,17 +358,17 @@
  (% style="color:#000000" %)          Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
--(% style="color:#000000" %)          Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)          Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
--(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
++(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
  (% style="color:#000000" %)Метод запроса: **GET**
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
--(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
++(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -389,7 +389,7 @@
      "unitName": "" ,  ~/~/ наименование подразделения
      "status": "" ,  ~/~/ статус объекта
--}
++    }
  (% style="text-align:left" %)
  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
@@ -403,7 +403,7 @@
  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
  )))
--(% style="color:#000000" %)          Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
++(% style="color:#000000" %)          Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
  (% style="color:#000000" %)Метод запроса: **POST**
@@ -425,23 +425,13 @@
      "sim2": "" ,  ~/~/ Номер SIM2
      "consumptionPer100Km": "" ,  ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
      "consumptionPerHour": "" ,  ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
--    "consumptionIdle": "" ,  ~/~/ Расход топлива на холостом ходу
--    "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
--    "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
--     "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
--     "consumptionPer100KmSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
--     "consumptionPer100KmSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
--     "consumptionPerHourSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
--     "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
--     "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
--     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
--     "counters":  ~/~/ счетчики
--      {
--     "mileage": "" ,  ~/~/ пробег
--     "mileageEnabled": true,  ~/~/ флаг активности счётчика "пробег"
--     "motohours": "" ,  ~/~/ моточасы
--     "motohoursEnabled": true  ~/~/ флаг активности счётчика "моточасы"
--      },
++    "consumptionIdle": "" ,  ~/~/ Расход топлива на холостом ходу
++    "counters": {
++      "mileage": "" ,  ~/~/ пробег
++      "mileageEnabled": true,  ~/~/ флаг активности счётчика "пробег"
++      "motohours": "" ,  ~/~/ моточасы
++      "motohoursEnabled": true  ~/~/ флаг активности счётчика "моточасы"
++    },
      "cmsv6Parameters": { ~/~/ параметры CMSv6
        "enabled": true,  ~/~/ флаг включения
        "id": "" ,  ~/~/ идентификатор
@@ -448,7 +448,7 @@
        "host": "" ,  ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
        "login": "" ,  ~/~/ имя учетной записи
        "password": ""   ~/~/ пароль учетной записи
--      },
++     },
      "inspectionTasks":  ~/~/ задания на ТО
        {
        "enabled": "" ,  ~/~/ Признак включения
@@ -486,7 +486,7 @@
      "motohoursEnabled": true,
      "mileage": "",
      "motohours": 345.0
--    },
++  },
   "cmsv6Parameters": { ~/~/Параметры CmsV6
      "id": null,
      "enabled": true, ~/~/флаг включения
@@ -493,7 +493,7 @@
      "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
      "login": "", ~/~/ имя учетной записи
      "password": "" ~/~/ пароль учетной записи
--    },
++  },
    "inspectionTasks": { ~/~/ задания на ТО
      "id": "", ~/~/ ID задачи
      "enabled": false, ~/~/ Признак включения
@@ -506,17 +506,12 @@
      "periodicCondition": "", ~/~/ Условие периодичности по времени
      "kind": "", ~/~/ Вид периодичности по времени
      "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
--    }
++     }
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
--**Валидация:**
--- сезонный параметр может быть задан только если задана соответствующая обычная норма;
--- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
--- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--
  (% class="box successmessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
@@ -524,7 +524,7 @@
  (% style="color:#000000" %)          Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
--(% style="color:#000000" %)          Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
++(% style="color:#000000" %)          Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
  (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
@@ -542,26 +542,24 @@
  (% style="color:#000000" %)В заголовках запроса:
--(% style="color:#000000" %)− Content-Type: __**application/json**__
++(% style="color:#000000" %)− Content-Type: application/json
  (% style="color:#000000" %)− X-Auth: Токен авторизации
--(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
++(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
--
  (% class="western" style="color:#000000" %)##{##
--(% class="western" style="color:#000000" %)    "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
++(% class="western" style="color:#000000" %)##    "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
      "name": null, ~/~/ Имя ТС (string, опционально)
      "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
      "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
      "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
      "parentId": null, ~/~/ ID клиента (Guid, опционально)
--    "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
++    "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%)
  (% style="color:#000000" %)}
--(% style="color:#000000" %)          Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
++(% style="color:#000000" %)          Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
  (% style="color:#000000" %)Ответ:
@@ -580,27 +580,27 @@
      "modelName": "" ~/~/ наименование модели объекта
      "unitId": "" ~/~/ идентификатор подразделения
      "unitName": "" ~/~/ наименование подразделения
--    "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
--                                                           ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
--                                                          ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
--(% style="color:#000000" %)    "createdAt": "" ~/~/ дата создания объектов  (%%)
++    "status": "" ~/~/ статус объекта
++    "createdAt": "" ~/~/ дата создания объектов  (%%)
  (% style="color:#000000" %)}
--(% style="color:#000000" %)          Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
++(% style="color:#000000" %)          Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
++0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
++
  (% class="box successmessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
  )))
--(% style="color:#000000" %)          Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **POST**
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
--(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
++(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -617,7 +617,7 @@
    "overwrite": false, ~/~/ Флаг перезаписи
    "stage": "", ~/~/ Состояние, может быть null
--(% style="color:#000000" %)}
++  (% style="color:#000000" %)}
  (% style="color:#000000" %)Ответ:
@@ -631,7 +631,7 @@
    "stage": "", ~/~/ Состояние
  (% style="text-align:left" %)
--(% style="color:#000000" %)  }
++(% style="color:#000000" %)}
  (% class="box warningmessage" %)
@@ -639,7 +639,7 @@
  (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
  )))
--(% style="color:#000000" %)          Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **PUT**
@@ -649,9 +649,8 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %){
++(% style="color:#000000" %) {
--(((
  (% style="color:#000000" %)    "vehicleId": "", ~/~/ ID ТС
      "parentId": "", ~/~/ ID клиента
      "name": "", ~/~/ имя ТС
@@ -660,20 +660,10 @@
      "modelId": "", ~/~/ , ID модели
      "unitId": "", ~/~/ подразделения
      "sim1": "", ~/~/ SIM 1
--    "sim2": "", ~/~/ SIM2     (%%)
--    "consumptionPer100Km": "" ,  ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
--    "consumptionPerHour": "" ,  ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
--    "consumptionIdle": "" ,  ~/~/ Расход топлива на холостом ходу
--    "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
--    "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
--     "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
--     "consumptionPer100KmSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
--     "consumptionPer100KmSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
--     "consumptionPerHourSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
--     "consumptionPerHourSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
--     "consumptionIdleSeasonalBegin": "" ,  ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
--     "consumptionIdleSeasonalEnd": "" ,  ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
--(% style="color:#000000" %)         "counters":
++    "sim2": "", ~/~/ SIM2
++    "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
++    "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
++         "counters":
          {
           "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
           "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
@@ -701,8 +701,7 @@
              "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
              "kind": "", ~/~/ Вид периодичности по времени
              "maxQuantity": "", ~/~/ Сколько раз выполнить задание
--            }
--)))
++        }
  (% style="color:#000000" %)}
@@ -709,71 +709,21 @@
  (% style="color:#000000" %)Ответ:
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     «vehicleId»: «», //ID ТС     «parentId»: «», //ID клиента     «name»: «», //имя ТС     «imei»: «», //IMEI     «deviceTypeId»: «», //ID типа устройства     «modelId»: «»,     «unitId»: «», //ID подразделения     «sim1»: «», //SIM 1     «sim2»: «», //SIM2     «consumptionPer100Km»: «», //Расход топлива на 100 км     «consumptionIdle»: «», //Расход топлива на холостом ходу     «counters»: {         «mileageEnabled»: true, //флаг активности счётчика «пробег»         «motohoursEnabled»: true, //флаг активности счётчика «моточасы»         «mileage»: «», //пробег         «motohours»: «» //моточасы     },     «cmsv6Parameters»: { //параметры CMSv6         «id»: «», //идентификатор         «enabled»: true, //флаг включения         «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6         «login»: «», //имя учетной записи         «password»: «» //пароль учетной записи     },     «inspectionTasks»: [ //задания на ТО         {             «id»: «», //ID задания             «enabled»: false, //Признак включения             «name»: «», //Имя задания             «description»: «», //Описание задания             «mileageCondition»: «», //Условие по пробегу             «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО             «motohoursCondition»: «», //Условие по моточасам             «lastMotohours»: «», //Моточасы             «periodicCondition»: «», //Условие периодичности по времени             «kind»: «», //Вид периодичности по времени             «maxQuantity»: «» //Сколько раз выполнить задание         }     ] }
--(% lang="en-US" style="text-align:left" %)
--    "vehicleId": "", ~/~/ ID ТС
--    "parentId": "", ~/~/ ID клиента
--    "name": "", ~/~/ имя ТС
--    "imei": "", ~/~/ IMEI
--    "deviceTypeId": "", ~/~/  типа устройства
--    "modelId": "", ~/~/ ID модели
--    "unitId": "", ~/~/ ID подразделения
--    "sim1": "", ~/~/ SIM 1
--    "sim2": "", ~/~/ SIM2
--    "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
--    "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
--        "counters":
--        {
--        "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
--        "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
--        "mileage": "", ~/~/ пробег
--        "motohours": "", ~/~/ моточасы
--        }
--        "cmsv6Parameters": ~/~/  параметры CMSv6
--        {
--        "id": ~/~/  идентификатор
--        "enabled": true, ~/~/ флаг включения
--        "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
--        "login": "", ~/~/ имя учетной записи
--        "password": "", ~/~/ пароль учетной записи
--        }
--        "inspectionTasks": ~/~/ задания на ТО
--        {
--        "id": "", ~/~/ ID задания
--        "enabled": false, ~/~/ Признак включения
--        "name": "", ~/~/ Имя задания
--        "description": "", ~/~/ Описание задания
--        "mileageCondition": "", ~/~/ Условие по пробегу
--        "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
--        "motohoursCondition": "", ~/~/ Условие по моточасам
--        "lastMotohours": "", ~/~/ Моточасы
--        "periodicCondition": "", ~/~/ Условие периодичности по времени
--        "kind": "", ~/~/ Вид периодичности по времени
--        "maxQuantity": "", ~/~/ Сколько раз выполнить задание
--        }
--(% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--
--**валидация:**
--- сезонный параметр может быть задан только если задана соответствующая обычная норма;
--- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
--- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
--
--
  (% class="box errormessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
  )))
--(% style="color:#000000" %)          Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **DELETE**
  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
--(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
++(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -791,7 +791,7 @@
  (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
  )))
--(% style="color:#000000" %)          Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -799,15 +799,16 @@
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)Ответ:
++(% style="color:#000000" %)Ответ: [
--(% style="color:#000000" %){
++(% class="western" %)
++{{{ {
++      "deviceTypeId" : "", // ID типа устройства
++        "deviceTypeName" : "" // Название типа устройства
++    },}}}
--    "deviceTypeId" : "", ~/~/ ID типа устройства
--    "deviceTypeName" : "" ~/~/ Название типа устройства
--
  (% style="text-align:left" %)
--(% style="color:#000000" %)}
++(% style="color:#000000" %)…** **]
  (% class="box" style="text-align: center;" %)
@@ -820,7 +820,7 @@
  (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
  )))
--(% style="color:#000000" %)          Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
++(% style="color:#000000" %)          Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
  (% style="color:#000000" %)Метод запроса: **GET**
@@ -828,16 +828,19 @@
  (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
--(% style="color:#000000" %)Ответ:
++(% style="color:#000000" %)Ответ: [
--(% style="color:#000000" %){
++(% class="western" style="margin-bottom:19px" %)
++{{{   {}}}
--    "id": "", ~/~/ ID типа датчика
--    "name": "", ~/~/ Название
--    "description": "", ~/~/ Описание
++(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
++(% class="western" %)
++{{{        "description": "" // Описание
++    },}}}
++
  (% style="text-align:left" %)
--(% style="color:#000000" %)}
++(% style="color:#000000" %)… ]
  (% class="box" lang="en-US" style="text-align: center;" %)

Changes for page Методы API для работы с ГЛОНАССSoft

Summary

Details

Меню