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

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

From version < 20.5 >

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

To version < 16.1 >

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

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 3.0 ==
++== Описание ГЛОНАССSoft Public API ==
  ==   ==
@@ -17,6 +17,37 @@
  (% class="box" style="text-align: center;" %)
  (((
++(% 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" %)          Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«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/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" %)Ответ: [     {         «agentId»: «», //идентификатор клиента         «parentId»: «», //идентификатор клиента-родителя         «name»: «», //наименование клиента         «fullName»: «», //полное наименование клиента         «agentInfoType»: , //тип клиента1         «status»:  //статус клиента     }, … ]
++
++(% style="color:#000000" %)Примечание. Возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
++
++
++(% class="box" style="text-align: center;" %)
++(((
  (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
  )))
@@ -34,18 +34,8 @@
  (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
  (% lang="en-US" %)
--(% style="color:#000000" %)**Ответ:**
++(% style="color:#000000" %)**Ответ: [     {         «AuthId»: «», //токен авторизации         «User»: «», // имя пользователя     },     … ]**
--(% lang="en-US" %)
--(% style="color:#000000" %){
--
--(% lang="en-US" %)
--(% style="color:#000000" %)    "AuthId": "" ,  ~/~/ токен авторизации
--    "User": "" ,  ~/~/ имя пользователя
--
--(% lang="en-US" %)
--    }
--
  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
@@ -66,161 +66,93 @@
  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
--(% class="box" style="text-align: center;" %)
++(% class="box" lang="en-US" 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/devices/types**
  )))
--(% 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/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/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
--(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
--
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %)Ответ:
++(% style="color:#000000" %)Ответ: [
--(% style="color:#000000" %){
--    "agentId": "",  ~/~/ идентификатор клиента
--    "parentId": "",  ~/~/ идентификатор клиента-родителя
--    "name": "",  ~/~/ наименование клиента
--    "fullName": "",  ~/~/ полное наименование клиента
--    "agentInfoType": "",  ~/~/ тип клиента1
--    "status": "",  ~/~/ статус клиента
--    }
++(% class="western" %)
++{{{ {
++      "deviceTypeId" : "", // ID типа устройства
++        "deviceTypeName" : "" // Название типа устройства
++    },}}}
++(% style="text-align:left" %)
++(% 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" %)]
--
  (% class="box" style="text-align: center;" %)
  (((
--(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
++(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
  )))
--(% class="box successmessage" %)
++(% class="box infomessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
++(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
  )))
--(% style="color:#000000" %)          Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
++(% style="color:#000000" %)          Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--(% style="color:#000000" %)Метод запроса: **POST**
++(% style="color:#000000" %)Метод запроса: **GET**
--(% 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/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
--(% style="color:#000000" %)Параметры в теле запроса (JSON):
++(% style="color:#000000" %)Ответ: [
--(% 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": "" ,  ~/~/ группы пользователя, названия групп
--    }
++(% class="western" style="margin-bottom:19px" %)
++{{{   {}}}
--(% style="text-align:left" %)
--(% style="color:#000000; font-weight:normal" %)Ответ:
++(% 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" %)    "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" %)… ]
--(% 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/find**
++(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
  )))
--(% style="color:#000000" %)          Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
++(% style="color:#000000" %)          Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
--
  (% style="color:#000000" %)Метод запроса: **POST**
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
--(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--(% style="color:#000000" %){
++(% 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:#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="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**
@@ -240,7 +240,7 @@
  (% class="box warningmessage" %)
  (((
--(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
++(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
  )))
  (% style="color:#000000" %)          Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
@@ -261,6 +261,38 @@
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
++(% class="box successmessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
++)))
++
++(% style="color:#000000" %)          Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
++
++(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
++
++(% style="color:#000000" %)Метод запроса: **POST**
++
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
++
++(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
++
++(% 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" %)}
++
++(% style="color:#000000" %)Ответ: [     {         «id»: «», //идентификатор пользователя         «lastName»: «», //фамилия         «firstName»: «», //имя         «position»: «», //должность         «phone»: «», //телефон         «parentId»: «», //идентификатор клиента-родителя         «parentName»: «», //наименование клиента-родителя         «organization»: «», //организация         «login»: «», //логин        «email»: «», //E-mail
++
++(% class="western" style="margin-bottom:19px" %)
++{{{  "sessionDuration":"", // длительность сессии в минутах}}}
++
++(% lang="en-US" style="text-align:left" %)
++(% style="color:#000000" %)     **«status»: 1, //статус пользователя         «lastLogged»: «» //дата/время последней авторизации }, … ]**
++
++
  (% class="box errormessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
@@ -283,6 +283,25 @@
  (% 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}**
@@ -441,9 +441,32 @@
  (% style="color:#000000" %)}
++(% class="box warningmessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
++)))
++
++(% style="color:#000000" %)          Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
++
++(% style="color:#000000" %)Метод запроса: **PUT**
++
++(% 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):
++
++(% 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" %)Ответ:
++
++(% 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»: «» //Сколько раз выполнить задание         }     ] }
++
++
  (% class="box successmessage" %)
  (((
--(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
++(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
  )))
  (% style="color:#000000" %)          Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
@@ -486,9 +486,36 @@
  (% style="color:#000000" %)          Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
--0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
++(% 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="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
++
++
  (% class="box successmessage" %)
  (((
  (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
@@ -507,9 +507,7 @@
  (% style="color:#000000" %)Параметры в теле запроса (JSON): {
  (% class="western" %)
--{{{  "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,
--                                   // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,
--                                   // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
++{{{  "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
    "date": "", // Дата смены статуса (null если сменить немедленно)
    "description": "", // Описание
    "data": "", // Данные
@@ -532,112 +532,7 @@
  (% style="color:#000000" %)}
--(% class="box warningmessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
--)))
--
--(% style="color:#000000" %)          Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--
--(% style="color:#000000" %)Метод запроса: **PUT**
--
--(% 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):
--
--(% 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" %)Ответ:
--
--(% 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»: «» //Сколько раз выполнить задание         }     ] }
--
--
--(% 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" 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" %)          Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
--
--(% 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" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Ответ: [
--
--(% class="western" %)
--{{{ {
--      "deviceTypeId" : "", // ID типа устройства
--        "deviceTypeName" : "" // Название типа устройства
--    },}}}
--
--(% style="text-align:left" %)
--(% style="color:#000000" %)…** **]
--
--
--(% 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" %)Ответ: [
--
--(% class="western" style="margin-bottom:19px" %)
--{{{   {}}}
--
--(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
--
--(% class="western" %)
--{{{        "description": "" // Описание
--    },}}}
--
--(% style="text-align:left" %)
--(% style="color:#000000" %)… ]
--
--
--(% class="box" lang="en-US" style="text-align: center;" %)
--(((
  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
  )))

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

Summary

Details

Меню