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

Last modified by Андрей Калиновский on 2025/03/12 10:28

From version < 6.1 >

edited by Андрей Калиновский
on 2022/08/31 14:13

To version < 8.1 >

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.Gadmin
++XWiki.Artem

Content

@@ -1,285 +1,356 @@
--== Описание ГЛОНАССSoft Public API ==
++(% class="western" %)
++== Описание ГЛОНАССSoft Public API
++  ==
--==   ==
++(% class="box" %)
++(((
++**Действующие ограничения**
++)))
--     **Действующие ограничения**
++(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
++
++(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
++
++Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
--- Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Клиенты**
++)))
--- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
++(% class="box infomessage" %)
++(((
++(% style="color:#000000" %)**Получение основных параметров клиента — (% lang="en-US" %)GET (%%)/(% lang="en-US" %)api/v3/agents(%%)**
++)))
--Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
--\\
++(% style="color:#000000" %)          Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
--     **Авторизация**
++(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
--Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
++(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
--Метод запроса: GET
++(% 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" %)Метод запроса: **GET**
--В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
++(% 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>
--Ответ: [     {         «AuthId»: «», //токен авторизации         «User»: «», // имя пользователя     },     … ]
--
++(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
--     **Получение списка объектов**
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
++(% style="color:#000000" %)Ответ: [     {         «agentId»: «», //идентификатор клиента         «parentId»: «», //идентификатор клиента-родителя         «name»: «», //наименование клиента         «fullName»: «», //полное наименование клиента         «agentInfoType»: , //тип клиента1         «status»:  //статус клиента     }, … ]
--−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
++(% style="color:#000000" %)Примечание. Возможные значение параметра agentInfoType: (% lang="en-US" %)[(% lang="en-US" style="font-variant: normal; color: rgb(0, 0, 0); font-family: Liberation Serif, serif; font-size: 12pt; font-style: normal; font-weight: normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" lang="en-US" %)]
--−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
--−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Авторизация**
++)))
--−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
++(% class="box infomessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Проверка авторизации — G(% lang="en-US" %)ET /api/v3/auth/check(%%)**
++)))
--−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
++(% style="color:#000000" %)          Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**.
--Метод запроса: POST
++(% style="color:#000000" %)Метод запроса: **GET**
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
--В заголовках запроса:
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--−Content-Type: application/json
++(% lang="en-US" %)
++(% style="color:#000000" %)Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».
--−X-Auth: Токен авторизации
--Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
++(% class="box infomessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Авторизация — GE(% lang="en-US" %)T /api/v3/auth/login(%%)**
++)))
--{{{{"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, опционально)}}}}
++(% style="color:#000000" %)          Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
--Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
++(% style="color:#000000" %)Метод запроса: **GET**
--Ответ: [     {         «vehicleId»: «», //идентификатор объекта         «name»: «», // наименование объекта         «imei»: «», // IMEI объекта         «deviceTypeId»: «», // идентификатор типа устройства         «deviceTypeName»: «», // наименование типа устройства         «sim1»: «», // первый номер телефона         «sim2»: «», //второй номер телефона         «parentId»: «», //идентификатор клиента-родителя         «parentName»: «», //наименование клиента-родителя         «modelId»: «», //идентификатор модели объекта         «modelName»: «», //наименование модели объекта         «unitId»: «», //идентификатор подразделения         «unitName»: «», //наименование подразделения         «status»: «», // статус объекта         //«//createdAt//»: «» дата создания объектов         //},     … ]
++(% 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]]
--Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
++(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
--0 - «Блокировка»
++(% lang="en-US" %)
++(% style="color:#000000" %)Ответ: [     {         «AuthId»: «», //токен авторизации         «User»: «», // имя пользователя     },     … ]
--1 - «Активен»,
--2 - «Отменен»
++(% class="box" lang="en-US" style="text-align: center;" %)
++(((
++(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел (% lang="ru-RU" %)Устройства(%%)**
++)))
--3 - «Оборудован»
++(% class="box infomessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка типов устройств - GE(% lang="en-US" %)T /api/v3/devices/types(%%)**
++)))
--4 - «Диагностика»
++(% style="color:#000000" %)          Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--5 - «Сервис»
++(% style="color:#000000" %)Метод запроса: **GET**
--6 - «Демонтаж»
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
--7 - «Монтаж»
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--8 - «Дозаказ»
++(% style="color:#000000" %)Ответ: [
--9 - «Обслужен»
++(% class="western" %)
++{{{ {
++      "deviceTypeId" : "", // ID типа устройства
++        "deviceTypeName" : "" // Название типа устройства
++    },}}}
--10 - «Списан»
++(% style="text-align:left" %)
++(% style="color:#000000" %)…** **]
--11 - «Неисправен»
--12 - «Проверен»
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Датчики**
++)))
--13 - «Не эксплуатируется»
--
++(% class="box infomessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка типов датчиков - GE(% lang="en-US" %)T /api/v3/sensors/types(%%)**
++)))
--     **Получение списка клиентов.**
++(% style="color:#000000" %)          Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
++(% style="color:#000000" %)Метод запроса: **GET**
--−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
--−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
++(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
--−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
++(% style="color:#000000" %)Ответ: [
--Метод запроса: GET
++(% class="western" style="margin-bottom:19px" %)
++{{{   {}}}
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
++(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
--Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
++(% class="western" %)
++{{{        "description": "" // Описание
++    },}}}
--В заголовках запроса: X-Auth: Токен авторизации
++(% style="text-align:left" %)
++(% style="color:#000000" %)… ]
--Ответ: [     {         «agentId»: «», //идентификатор клиента         «parentId»: «», //идентификатор клиента-родителя         «name»: «», //наименование клиента         «fullName»: «», //полное наименование клиента         «agentInfoType»: , //тип клиента1         «status»:  //статус клиента     }, … ]
--Примечание. Возможные значение параметра agentInfoType:
--
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Пользователи**
++)))
--     **Получение списка пользователей.**
++(% class="box successmessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Добавление пользователя — (% lang="en-US" %)POST /api/v3/users(%%)**
++)))
--Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
++(% style="color:#000000" %)          Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
++(% style="color:#000000" %)Метод запроса: **POST**
--Метод запроса: POST
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
++(% style="color:#000000" %)Параметры в теле запроса (JSON): {   «lastName»: «», // фамилия   «firstName»: «», // имя   «position»: «», // должность   «phone»: «», // телефон   «organization»: «», // организация   «login»: «», // логин   «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)   «email»: «», // email   «description»: «», // описание   «isEnabled»: «», // признак включения   «parentId»: «», // Guid родительского агента   «leaderId»: «», // Guid руководителя (null - не задан)   «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут)   «doubleAuth»: { // параметры двухфакторной аутентификации     «kind»: «», // тип аутентификации (None - выключена, Email - по email)     «target»: «« // в случае аутентификации по email - email-адрес   },   »groups»: [ // группы пользователя     «», //названия групп     «»,     «»   ] }
--{{{  //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
--  //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
--  "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
--  //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
++(% style="text-align:left" %)
++(% style="color: rgb(0, 0, 0); font-weight: normal" %)Ответ: {     «id»: «», //ID пользователя     «lastName»: «», //Фамилия ,     «firstName»: «», //Имя     «position»: «», //Должность     «phone»: «», //Телефон     «organization»: «», //Организация     «login»: «», //Логин     «password»: «», //Пароль     «email»: «», //Email     «description»: «», //Описание     «isEnabled»: «», //Признак включения     «parentId»: «», //Guid родительского агента     «sessionDuration»: «», //Продолжительность сессии, в минутах     «doubleAuth»: { //параметры двухфакторной аутентификации         «kind»: «», //тип аутентификации         «target»: «» //в случае аутентификации по email - email-адрес     },     «groups»: [ // группы пользователя         «user» //названия групп     ] }
--}
--Ответ: [     {         «id»: «», //идентификатор пользователя         «lastName»: «», //фамилия         «firstName»: «», //имя         «position»: «», //должность         «phone»: «», //телефон         «parentId»: «», //идентификатор клиента-родителя         «parentName»: «», //наименование клиента-родителя         «organization»: «», //организация         «login»: «», //логин        «email»: «», //E-mail
++(% class="box warningmessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Редактирование пользователя — (% lang="en-US" %)PUT /api/v3/users(%%)**
++)))
--{{{  "sessionDuration": "", // длительность сессии в минутах}}}
++(% style="color:#000000" %)          Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--        «status»: 1, //статус пользователя         «lastLogged»: «» //дата/время последней авторизации }, … ]
--
++(% style="color:#000000" %)Метод запроса: **PUT**
--     **Получение списка типов устройств**
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
--Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--Метод запроса: GET
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color: rgb(0, 0, 0); font-weight: normal" %)Параметры в теле запроса (JSON): {   «id»: «», // ID пользователя «lastName»: «», // фамилия   «firstName»: «», // имя   «position»: «», // должность   «phone»: «», // телефон   «organization»: «», // организация   «login»: «», // логин   «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)   «email»: «», // email   «description»: «», // описание   «isEnabled»: «», // признак включения   «parentId»: «», // Guid родительского агента   «leaderId»: «», // Guid руководителя (null - не задан)   «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут)   «doubleAuth»: { // параметры двухфакторной аутентификации     «kind»: «», // тип аутентификации (None - выключена, Email - по email)     «target»: «« // в случае аутентификации по email - email-адрес   },   »groups»: [ // группы пользователя     «», //названия групп     «»,     «»   ] } Ответ: {     «id»: «», //ID пользователя     «lastName»: «», //Фамилия ,     «firstName»: «», //Имя     «position»: «», //Должность     «phone»: «», //Телефон     «organization»: «», //Организация     «login»: «», //Логин     «password»: «», //Пароль     «email»: «», //Email     «description»: «», //Описание     «isEnabled»: «», //Признак включения     «parentId»: «», //Guid родительского агента     «sessionDuration»: «», //Продолжительность сессии, в минутах     «doubleAuth»: { //параметры двухфакторной аутентификации         «kind»: «», //тип аутентификации         «target»: «» //в случае аутентификации по email - email-адрес     },     «groups»: [ // группы пользователя         «user» //названия групп     ] }  //
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
--В заголовках запроса:X-Auth: Токен авторизации
++(% class="box warningmessage" %)
++(((
++(% style="color:#000000" %)**Изменить статус пользователя**// //**— (% lang="en-US" %)PUT /api/v3/users/status/{id}(%%)**
++)))
--Ответ: [
++(% style="color:#000000" %)          Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--{{{ {
--      "deviceTypeId" : "", // ID типа устройства
--        "deviceTypeName" : "" // Название типа устройства
--    },}}}
++(% 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 пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
--Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
++(% class="western" %)
++{{{  "description": "", // описание
++  "data": "" // данные, связанные со сменой статуса}}}
--Метод запроса: GET
++(% style="color:#000000" %)}
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
++(% style="text-align:left" %)
++(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
--В заголовках запроса:X-Auth: Токен авторизации
--Ответ: [
++(% class="box successmessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка пользователей — (% lang="en-US" %)POST /api/v3/users/find(%%)**
++)))
--{{{   {}}}
++(% style="color:#000000" %)          Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
--«id»: «», //ID типа датчика «name»: «», //Название
++(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
--{{{        "description": "" // Описание
--    },}}}
++(% 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" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
--Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
++(% class="western" %)
++{{{  //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
++  //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
++  "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
++  //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
--Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
++(% style="color:#000000" %)}
--−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
++(% style="color:#000000" %)Ответ: [     {         «id»: «», //идентификатор пользователя         «lastName»: «», //фамилия         «firstName»: «», //имя         «position»: «», //должность         «phone»: «», //телефон         «parentId»: «», //идентификатор клиента-родителя         «parentName»: «», //наименование клиента-родителя         «organization»: «», //организация         «login»: «», //логин        «email»: «», //E-mail
--Метод запроса: GET
++(% class="western" style="margin-bottom:19px" %)
++{{{  "sessionDuration":"", // длительность сессии в минутах}}}
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
++(% lang="en-US" style="text-align:left" %)
++(% style="color:#000000" %)     **«status»: 1, //статус пользователя         «lastLogged»: «» //дата/время последней авторизации }, … ]**
--Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
--В заголовках запроса: X-Auth: Токен авторизации
++(% class="box errormessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Удаление пользователя — (% lang="en-US" %)DELETE /api/v3/users/{id}(%%)**
++)))
--Ответ:
++(% style="color:#000000" %)          Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--{
++(% style="color:#000000" %)Метод запроса: **DELETE**
--{{{  "vehicleId": “”,         // идентификатор объекта
--  "name": "",   // имя объекта
--  "imei": "",    // IMEI объекта
--  "deviceTypeId": “”,  // идентификатор устройства объекта
--  "deviceTypeName": "" // наименование устройства объекта
--  "parentId": "",   // идентификатор клиента-родителя
--  "parentName": ""  // наименование клиента-родителя,
--  "modelId": "",   // идентификатор модели объекта
--  "modelName": ""  // наименование модели объекта,
--  "unitId": "",   // идентификатор подразделения
--  "unitName": "",   // наименование подразделения
--  "status": “”,   // статус объекта
-- ...
--  },
-- ...}}}
++(% 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 пользователя В заголовках запроса: X-Auth: Токен авторизации
--Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
--
++(% style="text-align:left" %)
++(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--     **Добавление пользователя**
--Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color: rgb(0, 0, 0); font-size: 14pt" %)**Раздел Транспортные средства**
++)))
--Метод запроса: POST
++(% class="box errormessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Удаление объекта — D(% lang="en-US" %)ELETE /api/v3/vehicles/{vehicleId}(%%)**
++)))
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
++(% style="color:#000000" %)          Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %)Метод запроса: **DELETE**
--Параметры в теле запроса (JSON): {   «lastName»: «», // фамилия   «firstName»: «», // имя   «position»: «», // должность   «phone»: «», // телефон   «organization»: «», // организация   «login»: «», // логин   «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)   «email»: «», // email   «description»: «», // описание   «isEnabled»: «», // признак включения   «parentId»: «», // Guid родительского агента   «leaderId»: «», // Guid руководителя (null - не задан)   «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут)   «doubleAuth»: { // параметры двухфакторной аутентификации     «kind»: «», // тип аутентификации (None - выключена, Email - по email)     «target»: «« // в случае аутентификации по email - email-адрес   },   »groups»: [ // группы пользователя     «», //названия групп     «»,     «»   ] }
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
--Ответ: {     «id»: «», //ID пользователя     «lastName»: «», //Фамилия ,     «firstName»: «», //Имя     «position»: «», //Должность     «phone»: «», //Телефон     «organization»: «», //Организация     «login»: «», //Логин     «password»: «», //Пароль     «email»: «», //Email     «description»: «», //Описание     «isEnabled»: «», //Признак включения     «parentId»: «», //Guid родительского агента     «sessionDuration»: «», //Продолжительность сессии, в минутах     «doubleAuth»: { //параметры двухфакторной аутентификации         «kind»: «», //тип аутентификации         «target»: «» //в случае аутентификации по email - email-адрес     },     «groups»: [ // группы пользователя         «user» //названия групп     ] }
--
++(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
--     **Редактирование пользователя**
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
++(% style="text-align:left" %)
++(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--Метод запроса: PUT
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
++(% class="box infomessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение информации об объекте — (% lang="en-US" %)GET /api/v3/vehicles/{vehicleId}(%%)**
++)))
--В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %)          Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
--Параметры в теле запроса (JSON): {   «id»: «», // ID пользователя «lastName»: «», // фамилия   «firstName»: «», // имя   «position»: «», // должность   «phone»: «», // телефон   «organization»: «», // организация   «login»: «», // логин   «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)   «email»: «», // email   «description»: «», // описание   «isEnabled»: «», // признак включения   «parentId»: «», // Guid родительского агента   «leaderId»: «», // Guid руководителя (null - не задан)   «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут)   «doubleAuth»: { // параметры двухфакторной аутентификации     «kind»: «», // тип аутентификации (None - выключена, Email - по email)     «target»: «« // в случае аутентификации по email - email-адрес   },   »groups»: [ // группы пользователя     «», //названия групп     «»,     «»   ] } Ответ: {     «id»: «», //ID пользователя     «lastName»: «», //Фамилия ,     «firstName»: «», //Имя     «position»: «», //Должность     «phone»: «», //Телефон     «organization»: «», //Организация     «login»: «», //Логин     «password»: «», //Пароль     «email»: «», //Email     «description»: «», //Описание     «isEnabled»: «», //Признак включения     «parentId»: «», //Guid родительского агента     «sessionDuration»: «», //Продолжительность сессии, в минутах     «doubleAuth»: { //параметры двухфакторной аутентификации         «kind»: «», //тип аутентификации         «target»: «» //в случае аутентификации по email - email-адрес     },     «groups»: [ // группы пользователя         «user» //названия групп     ] }      **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
++(% style="color:#000000" %)          Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
--{{{  "description": "", // описание
--  "data": "" // данные, связанные со сменой статуса}}}
++(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
--}
++(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
--Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
--
++(% 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>
--Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
++(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
--Метод запроса: DELETE
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
++(% style="color:#000000" %)Ответ:
--Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %){
--Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
--
++(% class="western" %)
++{{{  "vehicleId": “”,         // идентификатор объекта
++  "name": "",   // имя объекта
++  "imei": "",    // IMEI объекта
++  "deviceTypeId": “”,  // идентификатор устройства объекта
++  "deviceTypeName": "" // наименование устройства объекта
++  "parentId": "",   // идентификатор клиента-родителя
++  "parentName": ""  // наименование клиента-родителя,
++  "modelId": "",   // идентификатор модели объекта
++  "modelName": ""  // наименование модели объекта,
++  "unitId": "",   // идентификатор подразделения
++  "unitName": "",   // наименование подразделения
++  "status": “”,   // статус объекта
++ ...
++  },
++ ...}}}
--     **Добавление объекта**
++(% style="color:#000000" %)}
--Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
++(% style="text-align:left" %)
++Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
--Метод запроса: POST
++(% style="text-align:left" %)
++0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
--В заголовках запроса: X-Auth: Токен авторизации
++(% class="box successmessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Добавление объекта — (% lang="en-US" %)POST /api/v3/vehicles(%%)**
++)))
--Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
++(% style="color:#000000" %)          Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
++(% style="color:#000000" %)Метод запроса: **POST**
++
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
++
++(% class="western" %)
  {{{  "parentId": "",  // ID клиента
    "name": "", // имя ТС
    "imei":  "", // IMEI
@@ -320,12 +320,13 @@
        },
     ]}}}
--… }
++(% style="color:#000000" %)… }
--Ответ:
++(% style="color:#000000" %)Ответ:
--{
++(% style="color:#000000" %){
++(% class="western" %)
  {{{  "vehicleId": "", //ID ТС
    "parentId": "", //Guid владельца ТС
    "name": "", //Имя объекта
@@ -360,64 +360,126 @@
            "lastMileage": "", // Пробег (в метрах)
            "motohoursCondition": "", // Условие по моточасам
            "lastMotohours": "", // Моточасы
--          "periodicCondition": "", // Условие периодичности по времени}}}
--
--{{{          "kind": "", // Вид периодичности по времени
++          "periodicCondition": "", // Условие периодичности по времени
++          "kind": "", // Вид периодичности по времени
            "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
        }
    ]}}}
--}
--
++(% style="text-align:left" %)
++(% style="color:#000000" %)}
--     **Удаление объекта**
--Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
++(% class="box warningmessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Редактирование объекта — (% lang="en-US" %)PUT /api/v3/vehicles(%%)**
++)))
--Метод запроса: DELETE
++(% style="color:#000000" %)          Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
++(% style="color:#000000" %)Метод запроса: **PUT**
--Параметр запроса: {id} - Guid объекта
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
--В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
--
++(% style="color:#000000" %)Параметры в теле запроса (JSON):
--     **Редактирование объекта**
++(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {     «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»: «», //Условие по пробегу (в метрах, null - условие не работает)             «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно)             «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает)             «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно)             «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает)             «kind»: «», //Вид периодичности по времени             «maxQuantity»: «» //Сколько раз выполнить задание         }     ] }
--Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
++(% style="color:#000000" %)Ответ:
--Метод запроса: PUT
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color: rgb(0, 0, 0); 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»: «» //Сколько раз выполнить задание         }     ] }
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
--В заголовках запроса: X-Auth: Токен авторизации
++(% class="box successmessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Получение списка объектов — P(% lang="en-US" %)OST /api/v3/vehicles(%%)**
++)))
--Параметры в теле запроса (JSON):
++(% style="color:#000000" %)          Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
--//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {     «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»: «», //Условие по пробегу (в метрах, null - условие не работает)             «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно)             «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает)             «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно)             «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает)             «kind»: «», //Вид периодичности по времени             «maxQuantity»: «» //Сколько раз выполнить задание         }     ] }
++(% style="color:#000000" %)          Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
--Ответ:
++(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
--{     «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»: «» //Сколько раз выполнить задание         }     ] }
--
++(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
--     **Изменение статуса объекта**
++(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
--Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
++(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
--Метод запроса: POST
++(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
++(% style="color:#000000" %)Метод запроса: **POST**
--Параметр запроса: {vehicleId} - ID ТС
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
--В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %)В заголовках запроса:
--Параметры в теле запроса (JSON): {
++(% style="color:#000000" %)− Content-Type: application/json
++(% style="color:#000000" %)− X-Auth: Токен авторизации
++
++(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
++
++(% 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, опционально)##(% style="color:#000000" %)}
++
++(% style="color:#000000" %)          Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
++
++(% style="color:#000000" %)Ответ: [     {         «vehicleId»: «», //идентификатор объекта         «name»: «», // наименование объекта         «imei»: «», // IMEI объекта         «deviceTypeId»: «», // идентификатор типа устройства         «deviceTypeName»: «», // наименование типа устройства         «sim1»: «», // первый номер телефона         «sim2»: «», //второй номер телефона         «parentId»: «», //идентификатор клиента-родителя         «parentName»: «», //наименование клиента-родителя         «modelId»: «», //идентификатор модели объекта         «modelName»: «», //наименование модели объекта         «unitId»: «», //идентификатор подразделения         «unitName»: «», //наименование подразделения         «status»: «», // статус объекта         //«//createdAt//»: «» дата создания объектов         //},     … ]
++
++(% style="color:#000000" %)          Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
++
++(% style="color:#000000" %)0 - «Блокировка»
++
++(% style="color:#000000" %)1 - «Активен»,
++
++(% style="color:#000000" %)2 - «Отменен»
++
++(% style="color:#000000" %)3 - «Оборудован»
++
++(% style="color:#000000" %)4 - «Диагностика»
++
++(% style="color:#000000" %)5 - «Сервис»
++
++(% style="color:#000000" %)6 - «Демонтаж»
++
++(% style="color:#000000" %)7 - «Монтаж»
++
++(% style="color:#000000" %)8 - «Дозаказ»
++
++(% style="color:#000000" %)9 - «Обслужен»
++
++(% style="color:#000000" %)10 - «Списан»
++
++(% style="color:#000000" %)11 - «Неисправен»
++
++(% style="color:#000000" %)12 - «Проверен»
++
++(% style="text-align:left" %)
++(% style="font-weight: normal; color: rgb(0, 0, 0)" %)13 - «Не эксплуатируется»
++
++
++(% class="box successmessage" %)
++(((
++(% style="line-height: 100%; color: rgb(0, 0, 0)" %)**Изменение статуса объекта — (% lang="en-US" %)POST /api/v3/vehicles/changeStatus/{vehicleId}(%%)**
++)))
++
++(% 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" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="color:#000000" %)Параметры в теле запроса (JSON): {
++
++(% class="western" %)
  {{{  "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
    "date": "", // Дата смены статуса (null если сменить немедленно)
    "description": "", // Описание
@@ -425,10 +425,11 @@
    "overwrite": false, // Флаг перезаписи
    "stage": "", // Состояние, может быть null}}}
--}
++(% style="color:#000000" %)}
--Ответ: {
++(% style="color:#000000" %)Ответ: {
++(% class="western" %)
  {{{  "status": "", // значение статуса
    "date": "", // Дата смены статуса
    "description": "", // Описание
@@ -436,19 +436,11 @@
    "overwrite": false, // Флаг перезаписи
    "stage": "", // Состояние}}}
--}
--
++(% style="text-align:left" %)
++(% style="color:#000000" %)}
--     **Проверка авторизации**
--Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
--
--Метод запроса: GET
--
--URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
--
--В заголовках запроса: X-Auth: Токен авторизации
--
--Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
--
--**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
++(% class="box" lang="en-US" style="text-align: center;" %)
++(((
++(% style="color: rgb(0, 0, 0); font-size: 14pt" lang="ru-RU" %)**Расширенное описание PUBLIC API 3.0 доступно по запросу на support@glonasssoft.ru**
++)))

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

Summary

Details

Меню