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

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

From version < 15.2 >

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

To version < 22.3 >

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1,5 +1,5 @@
  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
--== Описание ГЛОНАССSoft Public API ==
++== Описание ГЛОНАССSoft Public API 3.0 ==
  ==   ==
@@ -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.
@@ -17,40 +17,38 @@
  (% class="box" style="text-align: center;" %)
  (((
--(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
++(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
  )))
  (% class="box infomessage" %)
  (((
--(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
++ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
  )))
--(% style="color:#000000" %)          Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
++(% style="color:#000000" %)          Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
--(% 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" %)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" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
++(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++(% lang="en-US" %)
++(% style="color:#000000" %)**Ответ:**
--(% style="color:#000000" %)Ответ: [     {         «agentId»: «», //идентификатор клиента         «parentId»: «», //идентификатор клиента-родителя         «name»: «», //наименование клиента         «fullName»: «», //полное наименование клиента         «agentInfoType»: , //тип клиента1         «status»:  //статус клиента     }, … ]
++(% lang="en-US" %)
++(% style="color:#000000" %){
--(% 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" %)]
++(% lang="en-US" %)
++(% style="color:#000000" %)    "AuthId": "" ,  ~/~/ токен авторизации
++    "User": "" ,  ~/~/ имя пользователя
++(% lang="en-US" %)
++}
--(% class="box" style="text-align: center;" %)
--(((
--(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
--)))
++**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
++
  (% class="box infomessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
@@ -68,111 +68,158 @@
  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
--(% class="box infomessage" %)
++(% class="box" style="text-align: center;" %)
  (((
--(% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
++(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
  )))
--(% 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" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
--
--(% lang="en-US" %)
--(% style="color:#000000" %)**Ответ: [     {         «AuthId»: «», //токен авторизации         «User»: «», // имя пользователя     },     … ]**
--
--**Примечание: **Время жизни токена авторизации задается через настройки пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
--
--(% class="box" lang="en-US" style="text-align: center;" %)
--(((
--(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
--)))
--
  (% class="box infomessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
++(% 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" %)Метод запроса: **GET**
--(% 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]]
++(% 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" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)Ответ: [
++(% style="color:#000000" %)Ответ:
--(% class="western" %)
--{{{ {
--      "deviceTypeId" : "", // ID типа устройства
--        "deviceTypeName" : "" // Название типа устройства
--    },}}}
++(% style="color:#000000" %){
++    "agentId": "",  ~/~/ идентификатор клиента
++    "parentId": "",  ~/~/ идентификатор клиента-родителя
++    "name": "",  ~/~/ наименование клиента
++    "fullName": "",  ~/~/ полное наименование клиента
++    "agentInfoType": "",  ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
++    "status": "",  ~/~/ статус клиента
++}
--(% style="text-align:left" %)
--(% style="color:#000000" %)…** **]
--
  (% class="box" style="text-align: center;" %)
  (((
--(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
++(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
  )))
--(% class="box infomessage" %)
++(% class="box successmessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
++(% 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" %)Метод запроса: **GET**
++(% style="color:#000000" %)Метод запроса: **POST**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
--(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)Ответ: [
++(% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% class="western" style="margin-bottom:19px" %)
--{{{   {}}}
++(% style="color:#000000" %){
++    "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" %)«id»: «», //ID типа датчика «name»: «», //Название
++(% style="text-align:left" %)
++(% style="color:#000000; font-weight:normal" %)Ответ:
--(% class="western" %)
--{{{        "description": "" // Описание
--    },}}}
++(% style="text-align:left" %)
++(% style="color:#000000; font-weight:normal" %){
  (% style="text-align:left" %)
--(% style="color:#000000" %)… ]
++(% style="color:#000000; 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» названия группы пользователя
++(% style="text-align:left" %)
++(% style="color:#000000; font-weight:normal" %)}
--(% class="box" style="text-align: center;" %)
--(((
--(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
--)))
  (% class="box successmessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
++(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
  )))
--(% style="color:#000000" %)          Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
++(% style="color:#000000" %)          Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
++(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
++
  (% style="color:#000000" %)Метод запроса: **POST**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (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»: [ // группы пользователя     «», //названия групп     «»,     «»   ] }
++(% style="color:#000000" %){
--(% style="text-align:left" %)
--(% style="color:#000000; 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» //названия групп     ] }
++  "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303",  ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
++  "userId": "11111111-c384-43f8-8562-1c3d79a32303",  ~/~/ ID пользователя, по которому фильтруется, null - неважно
++  "login": "qqqqqq",  ~/~/ Логин пользователя, по которому фильтруется, null - неважно
++  "email": "eee",  ~/~/ Email пользователя, по которому фильтруется, null - неважно
++(% style="color:#000000" %)}
++(% style="color:#000000" %)Ответ:
++
++(% style="color:#000000" %){         (%%)
++
++    "id": "" ,  ~/~/ идентификатор пользователя
++    "lastName": "" ,  ~/~/ фамилия
++    "firstName": "" ,  ~/~/ имя
++    "position": "" ,  ~/~/ должность
++    "phone": "" ,  ~/~/ телефон
++    "parentId": "" ,  ~/~/ идентификатор клиента-родителя
++    "parentName": "" ,  ~/~/ наименование клиента-родителя
++    "organization": "" ,  ~/~/ организация
++    "login": "" ,  ~/~/ логин
++    "email": "" ,  ~/~/ E-mail
++    "sessionDuration":"", ~/~/ длительность сессии в минутах
++    "status": "1",  ~/~/ статус пользователя
++    "astLogged": "", ~/~/ дата/время последней авторизации
++
++(% style="color:#000000" %)}
++
++
  (% class="box warningmessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
@@ -187,62 +187,90 @@
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
  (% lang="en-US" style="text-align:left" %)
--(% lang="ru-RU" style="color:#000000; 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» //названия групп     ] }  //
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--(% class="box warningmessage" %)
--(((
--(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
--)))
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ ID пользователя
++    "lastName": "" ,  ~/~/ фамилия
++    "firstName": "" ,  ~/~/ имя
++    "position": "" ,  ~/~/ должность
++    "phone": "" ,  ~/~/ телефон
++    "organization": "" ,  ~/~/ организация
++    "login": "" ,  ~/~/ логин
++    "password": "" ,  ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
++    "email": "" ,  ~/~/ email
++    "description": "" ,  ~/~/ описание
++    "isEnabled": "" ,  ~/~/ признак включения
++    "parentId": "" ,  ~/~/ Guid родительского агента
++    "leaderId": "" ,  ~/~/ Guid руководителя (null - не задан)
++    "sessionDuration": "" ,  ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
++    "doubleAuth": "" ,  ~/~/ параметры двухфакторной аутентификации
++    "kind": "" ,  ~/~/ тип аутентификации
++    "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
++    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
--(% style="color:#000000" %)          Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
--(% style="color:#000000" %)Метод запроса: **PUT**
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
--(% 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} Параметр запроса:
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)    "id": "" ,  ~/~/ идентификатор пользователя
++    "lastName": "" ,  ~/~/ фамилия
++    "firstName": "" ,  ~/~/ имя
++    "position": "" ,  ~/~/ должность
++    "phone": "" ,  ~/~/ телефон
++    "organization": "" ,  ~/~/ организация
++    "login": "" ,  ~/~/ логин
++    "password": "" ,  ~/~/ пароль
++    "email": "" ,  ~/~/ email
++    "description": "" ,  ~/~/ описание
++    "isEnabled": "" ,  ~/~/ признак включения
++    "parentId": "" ,  ~/~/ Guid родительского агента
++    "sessionDuration": "" ,  ~/~/ продолжительность сессии, в минутах
++    "doubleAuth": "" ,  ~/~/ параметры двухфакторной аутентификации
++    "kind": "" ,  ~/~/ тип аутентификации
++    "target": "" ,  ~/~/ в случае аутентификации по email - email-адрес
++    "groups": "" ,  ~/~/ группы пользователя, «user» названия группы пользователя
--(% class="western" %)
--{{{  "description": "", // описание
--  "data": "" // данные, связанные со сменой статуса}}}
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--(% style="color:#000000" %)}
--(% style="text-align:left" %)
--(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
--
--
--(% class="box successmessage" %)
++(% class="box warningmessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
++(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
  )))
--(% style="color:#000000" %)          Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
++(% style="color:#000000" %)          Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
++(% style="color:#000000" %)Метод запроса: **PUT**
--(% style="color:#000000" %)Метод запроса: **POST**
++(% 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" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
++(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
--(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% 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 - неважно}}}
++(% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %)}
++(% style="color:#000000" %){
--(% style="color:#000000" %)Ответ: [     {         «id»: «», //идентификатор пользователя         «lastName»: «», //фамилия         «firstName»: «», //имя         «position»: «», //должность         «phone»: «», //телефон         «parentId»: «», //идентификатор клиента-родителя         «parentName»: «», //наименование клиента-родителя         «organization»: «», //организация         «login»: «», //логин        «email»: «», //E-mail
++    "status": "" ,  ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
++    "description": "" ,  ~/~/ описание
++    "data": "" ,  ~/~/ данные, связанные со сменой статуса
--(% class="western" style="margin-bottom:19px" %)
--{{{  "sessionDuration":"", // длительность сессии в минутах}}}
++(% style="color:#000000" %)}
--(% lang="en-US" style="text-align:left" %)
--(% style="color:#000000" %)     **«status»: 1, //статус пользователя         «lastLogged»: «» //дата/время последней авторизации }, … ]**
++(% style="text-align:left" %)
++(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
  (% class="box errormessage" %)
@@ -256,8 +256,10 @@
  (% 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: Токен авторизации
++(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
@@ -267,25 +267,6 @@
  (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
  )))
--(% 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" %)Метод запроса: **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" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align:left" %)
--(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--
--
  (% class="box infomessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
@@ -311,24 +311,20 @@
  (% style="color:#000000" %){
--(% class="western" %)
--{{{  "vehicleId": “”,         // идентификатор объекта
--  "name": "",   // имя объекта
--  "imei": "",    // IMEI объекта
--  "deviceTypeId": “”,  // идентификатор устройства объекта
--  "deviceTypeName": "" // наименование устройства объекта
--  "parentId": "",   // идентификатор клиента-родителя
--  "parentName": ""  // наименование клиента-родителя,
--  "modelId": "",   // идентификатор модели объекта
--  "modelName": ""  // наименование модели объекта,
--  "unitId": "",   // идентификатор подразделения
--  "unitName": "",   // наименование подразделения
--  "status": “”,   // статус объекта
-- ...
--  },
-- ...}}}
++    "vehicleId": "" ,  ~/~/ идентификатор объекта
++    "name": "" ,  ~/~/ имя объекта
++    "imei": "" ,  ~/~/ IMEI объекта
++    "deviceTypeId": "" ,  ~/~/ идентификатор устройства объекта
++    "deviceTypeName": "" ,  ~/~/ наименование устройства объекта
++    "parentId": "" ,  ~/~/ идентификатор клиента-родителя
++    "parentName": "" ,  ~/~/ наименование клиента-родителя,
++    "modelId": "" ,  ~/~/ идентификатор модели объекта
++    "modelName": "" ,  ~/~/ наименование модели объекта,
++    "unitId": "" ,  ~/~/ идентификатор подразделения
++    "unitName": "" ,  ~/~/ наименование подразделения
++    "status": "" ,  ~/~/ статус объекта
--(% style="color:#000000" %)}
++}
  (% style="text-align:left" %)
  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
@@ -350,235 +350,397 @@
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
++(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
--(% class="western" %)
--{{{  "parentId": "",  // ID клиента
--  "name": "", // имя ТС
--  "imei":  "", // IMEI
--  "deviceTypeId": "",// ID типа устройства
--  "modelId": "",
--  "unitId": "", // ID подразделения
--  "sim1": "", // Номер SIM 1
--  "sim2": "", // Номер SIM2
--  "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
--  "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
--  "consumptionIdle": "",// Расход топлива на холостом ходу
--  "counters": {
--      "mileage": "", // пробег
--      "mileageEnabled": true, // флаг активности счётчика "пробег"
--      "motohours":"", // моточасы
--      "motohoursEnabled": true // флаг активности счётчика "моточасы"
--  },
--  "cmsv6Parameters": { // параметры CMSv6
--      "enabled": true, // флаг включения
--      //"id": "", // идентификатор
--      "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
--      "login": "", // имя учетной записи
--      "password": "" // пароль учетной записи
++(% style="color:#000000" %){
++
++    "parentId": "" ,  ~/~/ ID клиента
++    "name": "" ,  ~/~/ имя ТС
++    "imei": "" ,  ~/~/ IMEI
++    "deviceTypeId": "" ,  ~/~/ ID типа устройства
++    "modelId": "" , ~/~/ ID модели
++    "unitId": "" ,  ~/~/ ID подразделения
++    "sim1": "" ,  ~/~/ Номер SIM 1
++    "sim2": "" ,  ~/~/ Номер SIM2
++    "consumptionPer100Km": "" ,  ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
++    "consumptionPerHour": "" ,  ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
++    "consumptionIdle": "" ,  ~/~/ Расход топлива на холостом ходу
++    "counters": {
++      "mileage": "" ,  ~/~/ пробег
++      "mileageEnabled": true,  ~/~/ флаг активности счётчика "пробег"
++      "motohours": "" ,  ~/~/ моточасы
++      "motohoursEnabled": true  ~/~/ флаг активности счётчика "моточасы"
        },
--  "inspectionTasks": [ // задания на ТО
--      {
--          "enabled": "", // Признак включения
--          "name": "", // Имя задания
--          "description": "", // Описание задания
--          "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
--          "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
--          "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
--          "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
--          "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
--          "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
--          "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
--          "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
++    "cmsv6Parameters": { ~/~/ параметры CMSv6
++      "enabled": true,  ~/~/ флаг включения
++      "id": "" ,  ~/~/ идентификатор
++      "host": "" ,  ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
++      "login": "" ,  ~/~/ имя учетной записи
++      "password": ""   ~/~/ пароль учетной записи
        },
--   ]}}}
++    "inspectionTasks":  ~/~/ задания на ТО
++      {
++      "enabled": "" ,  ~/~/ Признак включения
++      "name": "" ,  ~/~/ Имя задания
++      "description": "" ,  ~/~/ Описание задания
++      "mileageCondition": "" ,  ~/~/ Условие по пробегу (в метрах, null - условие не работает)
++      "lastMileage": "" ,  ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
++      "motohoursCondition": "" ,  ~/~/ Условие по моточасам (в секундах, null - условие не работает)
++      "lastMotohours": "" ,  ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
++      "periodicCondition": "" ,  ~/~/  Условие периодичности по времени (null - условие не работает)
++      "kind": "" ,  ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
++      "lastInspectionDate": "" ,  ~/~/ Дата последнего ТО (null - не указано)
++      "maxQuantity": ""   ~/~/ Сколько раз выполнить задание (null - однократно)
++      }
--(% style="color:#000000" %)… }
++(% style="color:#000000" %) }
  (% style="color:#000000" %)Ответ:
  (% style="color:#000000" %){
--(% class="western" %)
--{{{  "vehicleId": "", //ID ТС
--  "parentId": "", //Guid владельца ТС
--  "name": "", //Имя объекта
--  "imei": "", //IMEI
--  "deviceTypeId": "", //ID типа устройства
--  "modelId": "", //ID модели
--  "unitId": "", //ID подразделения
--  "sim1": "", //SIM1
--  "sim2": "", //SIM2
--  "consumptionPer100Km": "", //Расход топлива на 100 км
--  "consumptionIdle": "", //Расход топлива на холостом ходу
--  "counters": { //Счётчики
--      "mileageEnabled": true,
--      "motohoursEnabled": true,
--      "mileage": "",
--      "motohours": 345.0
--  },
--  "cmsv6Parameters": { //Параметры CmsV6
--      "id": null,
--      "enabled": true, //флаг включения
--      "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
--      "login": "", // имя учетной записи
--      "password": "" // пароль учетной записи
--  },
--  "inspectionTasks": [ // задания на ТО
--      {
--          "id": "", // ID задачи
--          "enabled": false, // Признак включения
--          "name": "", // Имя задания
--          "description": "", // Описание задания
--          "mileageCondition": "", // Условие по пробегу
--          "lastMileage": "", // Пробег (в метрах)
--          "motohoursCondition": "", // Условие по моточасам
--          "lastMotohours": "", // Моточасы
--          "periodicCondition": "", // Условие периодичности по времени
--          "kind": "", // Вид периодичности по времени
--          "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
--      }
--  ]}}}
++    "vehicleId": "", ~/~/ID ТС
++    "parentId": "", ~/~/Guid владельца ТС
++    "name": "", ~/~/Имя объекта
++    "imei": "", ~/~/IMEI
++    "deviceTypeId": "", ~/~/ID типа устройства
++    "modelId": "", ~/~/ID модели
++    "unitId": "", ~/~/ID подразделения
++    "sim1": "", ~/~/SIM1
++    "sim2": "", ~/~/SIM2
++    "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
++    "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
++ "counters": { ~/~/Счётчики
++    "mileageEnabled": true,
++    "motohoursEnabled": true,
++    "mileage": "",
++    "motohours": 345.0
++    },
++ "cmsv6Parameters": { ~/~/Параметры CmsV6
++    "id": null,
++    "enabled": true, ~/~/флаг включения
++    "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
++    "login": "", ~/~/ имя учетной записи
++    "password": "" ~/~/ пароль учетной записи
++    },
++  "inspectionTasks": { ~/~/ задания на ТО
++    "id": "", ~/~/ ID задачи
++    "enabled": false, ~/~/ Признак включения
++    "name": "", ~/~/ Имя задания
++    "description": "", ~/~/ Описание задания
++    "mileageCondition": "", ~/~/ Условие по пробегу
++    "lastMileage": "", ~/~/ Пробег (в метрах)
++    "motohoursCondition": "", ~/~/ Условие по моточасам
++    "lastMotohours": "", ~/~/ Моточасы
++    "periodicCondition": "", ~/~/ Условие периодичности по времени
++    "kind": "", ~/~/ Вид периодичности по времени
++    "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
++    }
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
--(% class="box warningmessage" %)
++(% class="box successmessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
++(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
  )))
--(% style="color:#000000" %)          Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
++(% style="color:#000000" %)          Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
--(% style="color:#000000" %)Метод запроса: **PUT**
++(% style="color:#000000" %)          Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
++(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
++(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
--(% 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»: «» //Сколько раз выполнить задание         }     ] }
++(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
++(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
++
++(% style="color:#000000" %)Метод запроса: **POST**
++
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
++
++(% style="color:#000000" %)В заголовках запроса:
++
++(% style="color:#000000" %)− Content-Type: application/json
++
++(% style="color:#000000" %)− X-Auth: Токен авторизации
++
++(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
++
++(% class="western" style="color:#000000" %)##{##
++
++(% 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" %)Ответ:
--(% lang="en-US" style="text-align:left" %)
--(% 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»: «» //Сколько раз выполнить задание         }     ] }
++(% style="color:#000000" %){
++(% style="color:#000000" %)    "vehicleId": "" ~/~/ идентификатор объекта
++    "name": "" ~/~/ наименование объекта
++    "imei": "" ~/~/ IMEI объекта
++    "deviceTypeId": "" ~/~/ идентификатор типа устройства
++    "deviceTypeName": "" ~/~/ наименование типа устройства
++    "sim1": "" ~/~/ первый номер телефона
++    "sim2": "" ~/~/ второй номер телефона
++    "parentId": "" ~/~/ идентификатор клиента-родителя
++    "parentName": "" ~/~/ наименование клиента-родителя
++    "modelId": "" ~/~/ идентификатор модели объекта
++    "modelName": "" ~/~/ наименование модели объекта
++    "unitId": "" ~/~/ идентификатор подразделения
++    "unitName": "" ~/~/ наименование подразделения
++    "status": "" ~/~/ статус объекта
++    "createdAt": "" ~/~/ дата создания объектов  (%%)
++(% style="color:#000000" %)}
++(% 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**
++(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
  )))
--(% style="color:#000000" %)          Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
++(% style="color:#000000" %)          Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--(% style="color:#000000" %)          Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
++(% style="color:#000000" %)Метод запроса: **POST**
--(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
++(% 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" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
++(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
--(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
++(% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
++(% style="color:#000000" %){
--(% style="color:#000000" %)Метод запроса: **POST**
++  "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
++                                   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
++                                   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
++  "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
++  "description": "", ~/~/ Описание
++  "data": "", ~/~/ Данные
++  "overwrite": false, ~/~/ Флаг перезаписи
++  "stage": "", ~/~/ Состояние, может быть null
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
++(% style="color:#000000" %)}
--(% style="color:#000000" %)В заголовках запроса:
++(% style="color:#000000" %)Ответ:
--(% style="color:#000000" %)− Content-Type: application/json
++(% style="color:#000000" %){
--(% style="color:#000000" %)− X-Auth: Токен авторизации
++  "status": "", ~/~/ значение статуса
++  "date": "", ~/~/ Дата смены статуса
++  "description": "", ~/~/ Описание
++  "data": "", ~/~/ Данные
++  "overwrite": false, ~/~/ Флаг перезаписи
++  "stage": "", ~/~/ Состояние
--(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
++(% style="text-align:left" %)
++(% style="color:#000000" %)  }
--(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
--(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
++(% class="box warningmessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
++)))
--(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
++(% style="color:#000000" %)          Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
++(% style="color:#000000" %)Метод запроса: **PUT**
--(% style="color:#000000" %)          Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
--(% style="color:#000000" %)Ответ: [     {         «vehicleId»: «», //идентификатор объекта         «name»: «», // наименование объекта         «imei»: «», // IMEI объекта         «deviceTypeId»: «», // идентификатор типа устройства         «deviceTypeName»: «», // наименование типа устройства         «sim1»: «», // первый номер телефона         «sim2»: «», //второй номер телефона         «parentId»: «», //идентификатор клиента-родителя         «parentName»: «», //наименование клиента-родителя         «modelId»: «», //идентификатор модели объекта         «modelName»: «», //наименование модели объекта         «unitId»: «», //идентификатор подразделения         «unitName»: «», //наименование подразделения         «status»: «», // статус объекта         //«//createdAt//»: «» дата создания объектов         //},     … ]
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)          Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
++(% style="color:#000000" %)Параметры в теле запроса (JSON):
--(% style="color:#000000" %)0 - «Блокировка»
++(% style="color:#000000" %){
--(% style="color:#000000" %)1 - «Активен»,
++(% style="color:#000000" %)    "vehicleId": "", ~/~/ ID ТС
++    "parentId": "", ~/~/ ID клиента
++    "name": "", ~/~/ имя ТС
++    "imei": "", ~/~/ IMEI
++    "deviceTypeId": "", ~/~/ ID типа устройства
++    "modelId": "", ~/~/ , ID модели
++    "unitId": "", ~/~/ подразделения
++    "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" %)2 - «Отменен»
++(% style="color:#000000" %)}
--(% style="color:#000000" %)3 - «Оборудован»
++(% style="color:#000000" %)Ответ:
--(% style="color:#000000" %)4 - «Диагностика»
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %){
--(% style="color:#000000" %)5 - «Сервис»
++(% 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": "", ~/~/ Сколько раз выполнить задание
++        }
--(% style="color:#000000" %)6 - «Демонтаж»
++(% lang="en-US" style="text-align:left" %)
++(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
--(% style="color:#000000" %)7 - «Монтаж»
--(% style="color:#000000" %)8 - «Дозаказ»
++(% class="box errormessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
++)))
--(% style="color:#000000" %)9 - «Обслужен»
++(% style="color:#000000" %)          Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--(% style="color:#000000" %)10 - «Списан»
++(% style="color:#000000" %)Метод запроса: **DELETE**
--(% style="color:#000000" %)11 - «Неисправен»
++(% 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" %)12 - «Проверен»
++(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
  (% style="text-align:left" %)
--(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
++(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
--(% class="box successmessage" %)
++(% class="box" lang="en-US" style="text-align: center;" %)
  (((
--(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
++(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
  )))
--(% style="color:#000000" %)          Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
++(% class="box infomessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
++)))
--(% style="color:#000000" %)Метод запроса: **POST**
++(% style="color:#000000" %)          Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--(% 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" %)Метод запроса: **GET**
--(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
++(% 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]]
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)Параметры в теле запроса (JSON): {
++(% style="color:#000000" %)Ответ:
--(% class="western" %)
--{{{  "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
--  "date": "", // Дата смены статуса (null если сменить немедленно)
--  "description": "", // Описание
--  "data": "", // Данные
--  "overwrite": false, // Флаг перезаписи
--  "stage": "", // Состояние, может быть null}}}
++(% style="color:#000000" %){
++    "deviceTypeId" : "", ~/~/ ID типа устройства
++    "deviceTypeName" : "" ~/~/ Название типа устройства
++
++(% style="text-align:left" %)
  (% style="color:#000000" %)}
--(% style="color:#000000" %)Ответ: {
--(% class="western" %)
--{{{  "status": "", // значение статуса
--  "date": "", // Дата смены статуса
--  "description": "", // Описание
--  "data": "", // Данные
--  "overwrite": false, // Флаг перезаписи
--  "stage": "", // Состояние}}}
++(% class="box" style="text-align: center;" %)
++(((
++(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
++)))
++(% class="box infomessage" %)
++(((
++(% 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" %)Метод запроса: **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" %)Ответ:
++
++(% style="color:#000000" %){
++
++    "id": "", ~/~/ ID типа датчика
++    "name": "", ~/~/ Название
++    "description": "", ~/~/ Описание
++
  (% style="text-align:left" %)
  (% style="color:#000000" %)}

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

Summary

Details

Меню