Last modified by Андрей Калиновский on 2025/04/24 15:46
<
From version < 189.1 >
edited by Андрей Калиновский
on 2024/11/22 14:54
To version < 6.1 >
edited by Андрей Калиновский
on 2022/08/31 14:13
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -1,4816 +1,454 @@
1 -(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -(((
3 -(% class="box warningmessage" %)
4 -(((
5 -(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно просим вас соблюдать несколько простых правил при использовании API-команд:##
6 -)))
1 +== Описание ГЛОНАССSoft Public API ==
7 7  
8 -* Формировать не более 3 отчётов одновременно.
9 -* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
3 +== ==
10 10  
11 -В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить работу команд.
5 + **Действующие ограничения**
6 +
12 12  
8 +- Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
13 13  
14 -**Содержание страницы:**
15 -)))
10 +- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
16 16  
17 -{{toc/}}
18 -
19 -
20 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
21 -
22 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
23 -
24 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
25 -
26 26  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
13 +\\
27 27  
28 -(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
15 + **Авторизация**
29 29  
17 +Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
30 30  
31 -(% style="color:#000000; font-size:16px" %)**Рекомендации**
19 +Метод запроса: GET
32 32  
33 -- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
21 +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]]
34 34  
35 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
23 +В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
36 36  
37 -(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
38 -(((
39 -(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
40 -(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
41 -)))
25 +Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
26 +
42 42  
43 -(% class="box successmessage" %)
44 -(((
45 -(% lang="en-US" %)**POST /api/v3/auth/login**
46 -)))
28 + **Получение списка объектов**
47 47  
48 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
30 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
49 49  
50 -(% style="color:#000000" %)Метод запроса: **POST**
32 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
51 51  
52 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
34 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
53 53  
54 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
36 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
55 55  
56 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
38 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
57 57  
58 -(% style="color:#000000" %){
59 - "login": "testuser",
60 - "password": "testuser"
61 -}
40 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
62 62  
63 -(% style="color:#000000" %)**Ответ:**
42 +Метод запроса: POST
64 64  
65 -(% lang="en-US" %)
66 -(% style="color:#000000" %){
67 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
68 - "User": "testuser" , ~/~/ имя пользователя(%%)
69 -}
44 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
70 70  
71 -**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
46 +В заголовках запроса:
72 72  
73 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
74 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
75 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
76 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
77 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
48 +−Content-Type: application/json
78 78  
79 -(% class="wikigeneratedid" %)
80 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
50 +−X-Auth: Токен авторизации
81 81  
82 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
52 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
83 83  
84 -(% class="box infomessage" %)
85 -(((
86 -(% lang="en-US" %)**GET /api/v3/auth/check**
87 -)))
54 +{{{{"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, опционально)}}}}
88 88  
89 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
56 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
90 90  
91 -(% style="color:#000000" %)Метод запроса: **GET**
58 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
92 92  
93 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
60 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
94 94  
95 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
62 +0 - «Блокировка»
96 96  
97 -(% lang="en-US" %)
98 -(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
64 +1 - «Активен»,
99 99  
100 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
66 +2 - «Отменен»
101 101  
102 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
68 +3 - «Оборудован»
103 103  
104 -(% class="box infomessage" %)
105 -(((
106 -**GET api/v3/agents/{id}**
107 -)))
70 +4 - «Диагностика»
108 108  
109 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
72 +5 - «Сервис»
110 110  
111 -(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
74 +6 - «Демонтаж»
112 112  
113 -(% style="color:#000000" %)Метод запроса: **GET**
76 +7 - «Монтаж»
114 114  
115 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
78 +8 - «Дозаказ»
116 116  
117 -Запрос должен содержать данные параметра "**agentId**"
80 +9 - «Обслужен»
118 118  
119 -(% style="color:#000000" %)Ответ:
120 -{
121 - "agentId": "",  (%%)
122 - "parentId": "",
123 - "parentName": "string",
124 - "name": "string",
125 - "fullName": "string",
126 - "agentInfoType": 0,
127 - "isForeign": true/false,
128 - "district": "string", 
129 - "region": "string",
130 - "city": "string",
131 - "inn": "string",
132 - "kpp": "string",
133 - "address": "string",
134 - "addressFact": "string",
135 - "email": "string",
136 - "director": "string",
137 - "bankName": "string",
138 - "bankBIK": "string",
139 - "bankRS": "string",
140 - "bankKS": "string"
141 - }
82 +10 - «Списан»
142 142  
143 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
144 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
145 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
146 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
147 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
148 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
149 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
150 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
151 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
152 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
153 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
154 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
155 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
156 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
157 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
158 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
159 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
160 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
161 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
162 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
163 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
84 +11 - «Неисправен»
164 164  
165 -== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
86 +12 - «Проверен»
166 166  
167 -(% class="box infomessage" %)
168 -(((
169 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
170 -)))
88 +13 - «Не эксплуатируется»
89 +
171 171  
172 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
91 + **Получение списка клиентов.**
173 173  
174 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
93 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
175 175  
176 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
95 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
177 177  
178 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
97 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
179 179  
180 -(% style="color:#000000" %)Метод запроса: **POST**
99 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
181 181  
182 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
101 +Метод запроса: GET
183 183  
184 -(% style="color:#000000" %)Параметр запроса:
103 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
185 185  
186 -(% style="color:#000000" %){
187 - "parentId": "string"
188 -}
105 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
189 189  
190 -(% style="color:#000000" %)Ответ:
191 -
192 -{
193 - "agentId": "",(% style="color:#000000" %)   (%%)
194 - "parentId": "",
195 - "name": "string",
196 - "fullName": "string",
197 - "agentInfoType": 0,
198 -(% style="color:#000000" %) "status": "",
199 -}
200 -
201 -
202 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
203 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
204 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
205 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
206 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
207 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
208 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
209 -
210 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
211 -
212 -(% class="box successmessage" %)
213 -(((
214 -**POST /api/v3/agents **
215 -)))
216 -
217 -Метод позволяет добавить клиента, указанного в запросе.
218 -
219 -Метод запроса: **POST**
220 -
221 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
222 -
223 223  В заголовках запроса: X-Auth: Токен авторизации
224 224  
225 -Параметры в теле запроса (JSON):
109 +Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
226 226  
227 -{
228 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
229 - "name": "string", ~/~/ имя
230 - "fullName": "string", ~/~/ полное наименование
231 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
232 - "isForeign": true, ~/~/ иностранный контрагент
233 - "district": "string", ~/~/ округ
234 - "region": "string", ~/~/ регион
235 - "city": "string", ~/~/ город
236 - "inn": "string", ~/~/ ИНН
237 - "kpp": "string", ~/~/ КПП
238 - "address": "string", ~/~/ юридический адрес
239 - "addressFact": "string", ~/~/ фактический адрес
240 - "email": "string", ~/~/ email
241 - "director": "string", ~/~/ ФИО руководителя
242 - "bankName": "string", ~/~/ банк
243 - "bankBIK": "string", ~/~/ БИК
244 - "bankRS": "string", ~/~/ номер счёта
245 - "bankKS": "string" ~/~/ корр. счёт
246 -}
111 +Примечание. Возможные значение параметра agentInfoType:
112 +
247 247  
248 -Ответ:
114 + **Получение списка пользователей.**
249 249  
250 -{
251 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
252 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
253 - "name": "string", ~/~/ имя
254 - "fullName": "string", ~/~/ полное наименование
255 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
256 - "isForeign": true, ~/~/ иностранный контрагент
257 - "district": "string", ~/~/ округ
258 - "region": "string", ~/~/ регион
259 - "city": "string", ~/~/ город
260 - "inn": "string", ~/~/ ИНН
261 - "kpp": "string", ~/~/ КПП
262 - "address": "string", ~/~/ юридический адрес
263 - "addressFact": "string", ~/~/ фактический адрес
264 - "email": "string", ~/~/ email
265 - "director": "string", ~/~/ ФИО руководителя
266 - "bankName": "string", ~/~/ банк
267 - "bankBIK": "string", ~/~/ БИК
268 - "bankRS": "string", ~/~/ номер счёта
269 - "bankKS": "string" ~/~/ корр. счёт
270 -}
116 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
271 271  
272 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
273 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
274 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
275 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
276 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
277 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
278 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
279 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
280 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
281 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
282 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
283 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
284 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
285 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
286 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
287 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
288 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
289 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
290 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
291 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
292 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
118 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
293 293  
294 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
120 +Метод запроса: POST
295 295  
296 -(% class="box warningmessage" %)
297 -(((
298 -**PUT /api/v3/agents**
299 -)))
122 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
300 300  
301 -Метод позволяет отредактировать клиента, указанного в запросе.
124 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
302 302  
303 -Метод запроса: **PUT**
126 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
127 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
128 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
129 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
304 304  
305 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
306 -
307 -В заголовках запроса: X-Auth: Токен авторизации
308 -
309 -Параметры в теле запроса (JSON):
310 -
311 -{
312 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
313 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
314 - "name": "string", ~/~/ имя
315 - "fullName": "string", ~/~/ полное наименование
316 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
317 - "isForeign": true, ~/~/ иностранный контрагент
318 - "district": "string", ~/~/ округ
319 - "region": "string", ~/~/ регион
320 - "city": "string", ~/~/ город
321 - "inn": "string", ~/~/ ИНН
322 - "kpp": "string", ~/~/ КПП
323 - "address": "string", ~/~/ юридический адрес
324 - "addressFact": "string", ~/~/ фактический адрес
325 - "email": "string", ~/~/ email
326 - "director": "string", ~/~/ ФИО руководителя
327 - "bankName": "string", ~/~/ банк
328 - "bankBIK": "string", ~/~/ БИК
329 - "bankRS": "string", ~/~/ номер счёта
330 - "bankKS": "string" ~/~/ корр. счёт
331 331  }
332 332  
333 -Ответ:
133 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
334 334  
335 -{
336 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
337 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
338 - "name": "string", ~/~/ имя
339 - "fullName": "string", ~/~/ полное наименование
340 - "isForeign": true, ~/~/ иностранный контрагент
341 - "district": "string", ~/~/ округ
342 - "region": "string", ~/~/ регион
343 - "city": "string", ~/~/ город
344 - "inn": "string", ~/~/ ИНН
345 - "kpp": "string", ~/~/ КПП
346 - "address": "string", ~/~/ юридический адрес
347 - "addressFact": "string", ~/~/ фактический адрес
348 - "email": "string", ~/~/ email
349 - "director": "string", ~/~/ ФИО руководителя
350 - "bankName": "string", ~/~/ банк
351 - "bankBIK": "string", ~/~/ БИК
352 - "bankRS": "string", ~/~/ номер счёта
353 - "bankKS": "string" ~/~/ корр. счёт
354 -}
135 +{{{ "sessionDuration": "", // длительность сессии в минутах}}}
355 355  
356 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
137 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
138 +
357 357  
358 -(% class="box errormessage" %)
359 -(((
360 -**DELETE /api/v3/agents/{clientId}**
361 -)))
140 + **Получение списка типов устройств**
362 362  
363 -Метод позволяет удалить клиента, указанного в строке запроса.
142 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
364 364  
365 -Метод запроса: **DELETE**
144 +Метод запроса: GET
366 366  
367 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
146 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
368 368  
369 -Параметр запроса: **{clientId}** - Guid пользователя
148 +В заголовках запроса:X-Auth: Токен авторизации
370 370  
371 -В заголовках запроса: X-Auth: Токен авторизации
150 +Ответ: [
372 372  
373 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
152 +{{{ {
153 + "deviceTypeId" : "", // ID типа устройства
154 + "deviceTypeName" : "" // Название типа устройства
155 + },}}}
374 374  
375 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
157 +… ]
158 +
376 376  
377 -(% class="box warningmessage" %)
378 -(((
379 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
380 -)))
160 + **Получение списка типов датчиков**
381 381  
382 -Метод позволяет изменить статус клиента, указанного в запросе.
162 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
383 383  
384 -В пути указывается GUID клиента и статус клиента.
164 +Метод запроса: GET
385 385  
386 -**status **- значение 0 - заблокирован, 1 - активен.
166 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
387 387  
388 -Ответ: Code 204
168 +В заголовках запроса:X-Auth: Токен авторизации
389 389  
390 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
170 +Ответ: [
391 391  
392 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
172 +{{{ {}}}
393 393  
394 -(% class="box successmessage" %)
395 -(((
396 -(% lang="en-US" %)**POST /api/v3/users**
397 -)))
174 +«id»: «», //ID типа датчика «name»: «», //Название
398 398  
399 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
176 +{{{ "description": "" // Описание
177 + },}}}
400 400  
401 -(% style="color:#000000" %)Метод запроса: **POST**
179 +… ]
180 +
402 402  
403 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
182 + **Получение информации об объекте**
404 404  
405 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
184 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
406 406  
407 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
186 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
408 408  
409 -(% style="color:#000000" %)
410 -{ 
411 - "lastName": "", ~/~/ фамилия
412 - "firstName": "", ~/~/ имя
413 - "position": "", ~/~/ должность
414 - "phone": "", ~/~/ телефон
415 - "organization": "", ~/~/ организация
416 - "login": "", ~/~/ логин (обязателен)
417 - "password": "", ~/~/ пароль (обязателен)
418 - "email": "", ~/~/ email (обязателен)
419 - "description": "string", ~/~/ Описание
420 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
421 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
422 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
423 - "parentId": "", ~/~/ Guid родительского агента
424 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
425 - "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
426 - "doubleAuth":
427 - {
428 - "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
429 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
430 - },
431 - "groups":
432 - [
433 - "string" ~/~/ группы пользователя, перечисление названия системных ролей
434 - ],
435 - "customGroups":
436 - [
437 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
438 - ],
439 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
440 -}
441 -{
442 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
443 - "lastName": "string",
444 - "firstName": "string",
445 - "position": "string",
446 - "phone": "string",
447 - "organization": "string",
448 - "login": "string",
449 - "password": "string",
450 - "email": "string",
188 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
451 451  
452 -(% style="text-align:left" %)
453 -(% style="color:#000000; font-weight:normal" %)Ответ:
454 -{     
455 - "id": "" , ~/~/ ID пользователя
456 - "lastName": "" , ~/~/ Фамилия ,
457 - "firstName": "" , ~/~/ Имя
458 - "position": "" , ~/~/ Должность
459 - "phone": "" , ~/~/ Телефон
460 - "organization": "" , ~/~/ Организация
461 - "login": "" , ~/~/ Логин
462 - "password": "" , ~/~/ Пароль
463 - "email": "" , ~/~/ Email
464 - "description": "" , ~/~/ Описание
465 - "isEnabled": "" , ~/~/ Признак включения
466 - "parentId": "" , ~/~/ Guid родительского агента
467 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
468 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
469 - "kind": "" , ~/~/ тип аутентификации
470 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
471 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
472 -}
190 +Метод запроса: GET
473 473  
192 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
474 474  
475 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
194 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
476 476  
477 -(% class="box infomessage" %)
478 -(((
479 -(% lang="en-US" %)**POST /api/v3/users/find**
480 -)))
196 +В заголовках запроса: X-Auth: Токен авторизации
481 481  
482 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
483 -
484 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
485 -
486 -(% style="color:#000000" %)Метод запроса: **POST**
487 -
488 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
489 -
490 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
491 -
492 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
493 -
494 -(% style="color:#000000" %){(%%)
495 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
496 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
497 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
498 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
499 -(% style="color:#000000" %)}
500 -
501 -(% style="color:#000000" %)Ответ:
502 -
503 -(% style="color:#000000" %){         (%%)
504 - "id": "" , ~/~/ идентификатор пользователя
505 - "lastName": "" , ~/~/ фамилия
506 - "firstName": "" , ~/~/ имя
507 - "position": "" , ~/~/ должность
508 - "phone": "" , ~/~/ телефон
509 - "parentId": "" , ~/~/ идентификатор клиента-родителя
510 - "parentName": "" , ~/~/ наименование клиента-родителя
511 - "organization": "" , ~/~/ организация
512 - "login": "" , ~/~/ логин
513 - "email": "" , ~/~/ E-mail
514 - "sessionDuration":"", ~/~/ длительность сессии в минутах
515 - "status": "1",  ~/~/ статус пользователя
516 - "lastLogged": "", ~/~/ дата/время последней авторизации
517 -(% style="color:#000000" %)}
518 -
519 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
520 -
521 -(% class="box infomessage" %)
522 -(((
523 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
524 -)))
525 -
526 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
527 -
528 -(% style="color:#000000" %)Метод запроса: **GET**
529 -
530 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
531 -
532 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
533 -
534 -(% style="color:#000000" %)Ответ:
535 -
536 -(((
537 -(((
538 -{
539 - "id": "", ~/~/ GUID пользователя
540 - "lastName": "", ~/~/ Фамилия 
541 - "firstName": "", ~/~/ Имя
542 - "position": "", ~/~/ Должность
543 - "phone": "", ~/~/ Номер телефона
544 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
545 - "parentName": "", Наименование клиента, которому принадлежит пользователь
546 - "organization": "", ~/~/ Организация
547 - "login": "", ~/~/ Логин пользователя
548 - "email": "", ~/~/ Адрес электронной почты
549 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
550 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
551 - "description": "", ~/~/ Описание
552 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
553 - "doubleAuth":
554 - {
555 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
556 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
557 - },
558 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
559 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
560 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
561 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
562 - "groups": [], ~/~/ Список ролей пользователя
563 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
564 - "authDevices": [ ], ~/~/ Список авторизованных устройств
565 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
566 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
567 -}
568 -)))
569 -)))
570 -
571 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
572 -
573 -(% class="box warningmessage" %)
574 -(((
575 -(% lang="en-US" %)**PUT /api/v3/users**
576 -)))
577 -
578 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
579 -
580 -(% style="color:#000000" %)Метод запроса: **PUT**
581 -
582 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
583 -
584 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
585 -
586 -(% lang="en-US" style="text-align:left" %)
587 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
588 -
589 -(% lang="en-US" style="text-align:left" %)
590 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
591 - "id": "" , ~/~/ ID пользователя 
592 - "lastName": "" , ~/~/ фамилия
593 - "firstName": "" , ~/~/ имя
594 - "position": "" , ~/~/ должность
595 - "phone": "" , ~/~/ телефон
596 - "organization": "" , ~/~/ организация
597 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
598 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
599 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
600 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
601 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
602 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
603 - "isEnabled": "" , ~/~/ признак включения
604 - "parentId": "" , ~/~/ Guid родительского агента
605 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
606 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
607 - "doubleAuth":
608 - {
609 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
610 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
611 - },
612 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
613 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
614 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
615 -
616 -(% lang="en-US" style="text-align:left" %)
617 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
618 -
619 -(% lang="en-US" style="text-align:left" %)
620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
621 - "id": "" , ~/~/ идентификатор пользователя
622 - "lastName": "" , ~/~/ фамилия
623 - "firstName": "" , ~/~/ имя
624 - "position": "" , ~/~/ должность
625 - "phone": "" , ~/~/ телефон
626 - "organization": "" , ~/~/ организация
627 - "login": "" , ~/~/ логин
628 - "password": "" , ~/~/ пароль 
629 - "email": "" , ~/~/ email
630 - "description": "" , ~/~/ описание
631 - "isEnabled": "" , ~/~/ признак включения
632 - "parentId": "" , ~/~/ Guid родительского агента
633 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
634 - "doubleAuth":
635 - {
636 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
637 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
638 - },
639 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
640 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
641 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
642 -}
643 -
644 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
645 -
646 -(% class="box warningmessage" %)
647 -(((
648 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
649 -)))
650 -
651 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
652 -
653 -(% style="color:#000000" %)Метод запроса: **PUT**
654 -
655 -(% 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}
656 -
657 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
658 -
659 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
660 -
661 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
662 -
663 -(% style="color:#000000" %){(%%)
664 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
665 - "description": "" , ~/~/ описание
666 - "data": "" , ~/~/ данные, связанные со сменой статуса
667 -(% style="color:#000000" %)}
668 -
669 -(% style="text-align:left" %)
670 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
671 -
672 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
673 -
674 -(% class="box warningmessage" %)
675 -(((
676 -**POST /api/v3/users/disable**
677 -)))
678 -
679 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
680 -
681 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
682 -
683 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
684 -
685 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
686 -
687 - [ 
688 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
689 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
690 - ]
691 -
692 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
693 -
694 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
695 -
696 -(% class="box warningmessage" %)
697 -(((
698 -**POST /api/v3/users/enable**
699 -)))
700 -
701 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
702 -
703 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
704 -
705 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
706 -
707 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
708 -
709 - [ 
710 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
711 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
712 - ]
713 -
714 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
715 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
716 -
717 -(((
718 -В теле ответа:
719 -{
720 - "errorMessages": [
721 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
722 - ],
723 - "users": [
724 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
725 - ]
726 -}
727 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
728 -"users" - массив id пользователей, которых не удалось включить или отключить.
729 -)))
730 -
731 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
732 -
733 -(% class="box errormessage" %)
734 -(((
735 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
736 -)))
737 -
738 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
739 -
740 -(% style="color:#000000" %)Метод запроса: **DELETE**
741 -
742 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
743 -
744 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
745 -
746 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
747 -
748 -(% style="text-align:left" %)
749 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
750 -
751 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
752 -
753 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
754 -
755 -(% class="box infomessage" %)
756 -(((
757 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
758 -)))
759 -
760 -Метод возвращает полную информацию о модели объекта.
761 -
762 -(% style="color:#000000" %)Метод запроса: **GET**
763 -
764 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
765 -
766 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
767 -
768 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
769 -
770 -(% style="color:#000000" %)Ответ:
771 -
772 -(% style="color:#000000" %){
773 - "parentName": "string",
774 - "name": "string",
775 - "picture": "string",
776 - "minspeed": 0,
777 - "maxspeed": 0,
778 - "width": 0,
779 - "imbeddedtrailer": true,
780 - "hoppercapacity": 0,
781 - "hopperdischargespeed": 0,
782 - "modelType": 0,
783 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
784 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
785 - "deleted": true
786 -}
787 -
788 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
789 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
790 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
791 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
792 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
793 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
794 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
795 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
796 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
797 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
798 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
799 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
800 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
801 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
802 -
803 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
804 -
805 -(% class="box successmessage" %)
806 -(((
807 -(% lang="en-US" %)**POST /api/v3/models/find**
808 -)))
809 -
810 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
811 -
812 -(% style="color:#000000" %)Метод запроса: **POST**
813 -
814 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
815 -
816 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
817 -
818 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
819 -
820 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
821 -}
822 -
823 -(% style="color:#000000" %)Ответ:
824 -
825 -(% style="color:#000000" %)[
826 - {
827 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
828 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
829 - "parentName": "string",
830 - "name": "string",
831 - "modelType": 0
832 - }
833 -]
834 -
835 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
836 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
837 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
838 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
839 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
840 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
841 -
842 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
843 -
844 -(% class="box successmessage" %)
845 -(((
846 -(% lang="en-US" %)**POST /api/v3/models**
847 -)))
848 -
849 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
850 -
851 -(% style="color:#000000" %)Метод запроса: **POST**
852 -
853 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
854 -
855 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
856 -
857 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
858 -
859 -{
860 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
861 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 - "deleted": true,
863 - "extId": "string",
864 - "name": "string",
865 - "picture": "string",
866 - "minspeed": 0,
867 - "maxspeed": 0,
868 - "width": 0,
869 - "imbeddedtrailer": true,
870 - "fueloutlay": 0,
871 - "hoppercapacity": 0,
872 - "hopperdischargespeed": 0,
873 - "modelType": 0
874 -}
875 -
876 876  Ответ:
877 877  
878 878  {
879 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
880 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 - "deleted": true,
882 - "extId": "string",
883 - "name": "string",
884 - "picture": "string",
885 - "minspeed": 0,
886 - "maxspeed": 0,
887 - "width": 0,
888 - "imbeddedtrailer": true,
889 - "hoppercapacity": 0,
890 - "hopperdischargespeed": 0,
891 - "modelType": 0
892 -}
893 893  
894 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
895 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
896 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
897 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
898 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
899 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
900 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
901 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
902 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
903 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
904 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
905 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
906 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
907 -
908 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
909 -
910 -(% class="box warningmessage" %)
911 -(((
912 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
913 -)))
914 -
915 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
916 -
917 -(% style="color:#000000" %)Метод запроса: **PUT**
918 -
919 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
920 -
921 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
922 -
923 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
924 -
925 -{
926 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
927 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
928 - "deleted": true,
929 - "extId": "string",
930 - "name": "string",
931 - "picture": "string",
932 - "minspeed": 0,
933 - "maxspeed": 0,
934 - "width": 0,
935 - "imbeddedtrailer": true,
936 - "fueloutlay": 0,
937 - "hoppercapacity": 0,
938 - "hopperdischargespeed": 0,
939 - "modelType": 0
940 -}
941 -
942 -Ответ:
943 -
944 -{
945 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
946 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
947 - "deleted": true,
948 - "extId": "string",
949 - "name": "string",
950 - "picture": "string",
951 - "minspeed": 0,
952 - "maxspeed": 0,
953 - "width": 0,
954 - "imbeddedtrailer": true,
955 - "fueloutlay": 0,
956 - "hoppercapacity": 0,
957 - "hopperdischargespeed": 0,
958 - "modelType": 0
959 -}
960 -
961 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
962 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
963 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
964 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
965 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
966 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
967 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
968 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
969 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
970 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
971 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
972 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
973 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
974 -
975 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
976 -
977 -(% class="box errormessage" %)
978 -(((
979 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
980 -)))
981 -
982 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
983 -
984 -(% style="color:#000000" %)Метод запроса: **DELETE**
985 -
986 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
987 -
988 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
989 -
990 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
991 -
992 -Ответ: В случае успеха **Success 200**
993 -
994 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
995 -
996 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
997 -
998 -(% class="box infomessage" %)
999 -(((
1000 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1001 -)))
1002 -
1003 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1004 -
1005 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1006 -
1007 -(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1008 -
1009 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1010 -
1011 -(% style="color:#000000" %)Метод запроса: **GET**
1012 -
1013 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
1014 -
1015 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1016 -
1017 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1018 -
1019 -(% style="color:#000000" %)Ответ:
1020 -
1021 -(((
1022 -{
1023 - "vehicleId": "", ~/~/ ID объекта
1024 - "name": "", ~/~/ Имя объекта
1025 - "imei": "", ~/~/ IMEI объекта
1026 - "deviceTypeId": , ~/~/ ID типа устройства
1027 - "deviceTypeName": "", ~/~/ Название типа устройства
1028 - "sim1": "", ~/~/ Номер SIM1
1029 - "sim2": "", ~/~/ Номер SIM2
1030 - "parentId": "", ~/~/ ID клиента-родителя
1031 - "parentName": "", ~/~/ Наименование клиента-родителя
1032 - "modelId": "", ~/~/ ID модели объекта
1033 - "modelName": "", ~/~/ Имя модели объекта
1034 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1035 - "unitName": "string", ~/~/ Наименование подразделения
1036 - "status": 0, ~/~/ Статус объекта
1037 - "createdAt": "", ~/~/ Дата создания объекта
1038 - },
1039 -"customFields": [ ~/~/ Произвольные поля
1040 - {
1041 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1042 - "name": "string", ~/~/ Имя поля
1043 - "value": "string", ~/~/ Значение поля
1044 - "forClient": true, ~/~/ Не используемая функция
1045 - "forTooltip": true, ~/~/ Отображать в подсказке
1046 - "forReport": true ~/~/ Отображать в отчете
1047 - }
1048 -
1049 -], ~/~/ Данные с вкладки нормы
1050 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1051 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1052 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1053 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1054 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1055 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1056 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1057 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1058 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1059 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1060 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1061 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1062 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1063 - "mileageCoeff": 0, ~/~/ коэффициент пробега
1064 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1065 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1066 - "counters": { ~/~/ Счетчики
1067 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1068 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1069 - "mileage": 0, ~/~/ Текущий пробег
1070 - "motohours": 0, ~/~/ Текущие моточасы
1071 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1072 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
202 +{{{ "vehicleId": “”, // идентификатор объекта
203 + "name": "", // имя объекта
204 + "imei": "", // IMEI объекта
205 + "deviceTypeId": “”, // идентификатор устройства объекта
206 + "deviceTypeName": "" // наименование устройства объекта
207 + "parentId": "", // идентификатор клиента-родителя
208 + "parentName": "" // наименование клиента-родителя,
209 + "modelId": "", // идентификатор модели объекта
210 + "modelName": "" // наименование модели объекта,
211 + "unitId": "", // идентификатор подразделения
212 + "unitName": "", // наименование подразделения
213 + "status": “”, // статус объекта
214 + ...
1073 1073   },
216 + ...}}}
1074 1074  
1075 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1076 - "id": "string", ~/~/ ID объекта
1077 - "enabled": true, ~/~/ Включить, true - активна, false - не активна
1078 - "host": "string", ~/~/ CMSV6 Web Host
1079 - "login": "string", ~/~/ CMSV6 Account
1080 - "password": "string" ~/~/ CMSV6 Password
1081 - },
1082 -
1083 -"commandTemplates": [ ~/~/ Шаблоны команд
1084 - {
1085 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1086 - "name": "string", ~/~/ Наименование команды
1087 - "command": "string", ~/~/ Текст команды
1088 - "retries": 0 ~/~/ Количество попыток
1089 - }
1090 - ],
1091 - "sensors": [ ~/~/ Датчики
1092 - {
1093 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1094 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1095 - "type": 0, ~/~/ Тип датчика
1096 - "name": "string", ~/~/ Имя датчика
1097 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1098 - "inputNumber": 0, ~/~/ Номер входа
1099 - "pseudonym": "string", ~/~/ Псевдоним
1100 - "medianDegree": 0, ~/~/ Медианная фильтрация
1101 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1102 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1103 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1104 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1105 - {
1106 - "grades": [ ~/~/ Таблица тарировки 1
1107 - {
1108 - "input": 0, ~/~/ Входящее значение
1109 - "output": 0 ~/~/ Выходящее значение
1110 - }
1111 - ],
1112 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1113 - }
1114 - ],
1115 - "showInTooltip": true, ~/~/ Отображать в подсказке
1116 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1117 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1118 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1119 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1120 - "expr": "string", ~/~/ Формула
1121 - "children": [ ~/~/ массив дочерних датчиков
1122 - "string"
1123 - ],
1124 - "customParams": { ~/~/ прочие произвольные параметры
1125 - "additionalProp1": "string",
1126 - "additionalProp2": "string",
1127 - "additionalProp3": "string"
1128 - },
1129 -
1130 -~/~/ Характерные для произвольного:
1131 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1132 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1133 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1134 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1135 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1136 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1137 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1138 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1139 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1140 -~/~/ "ValueOn": "Вкл.",
1141 -~/~/ "ValueOff": "Выкл."
1142 - "summaryMaxValue": 0 ~/~/ Макс. значение
1143 - }
1144 - "drivers": [ ~/~/ Водители
1145 - {
1146 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1147 - "name": "string", ~/~/ Наименование
1148 - "description": "string",
1149 - "isDefault": true ~/~/ По умолчанию
1150 - }
1151 - ],
1152 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1153 - {
1154 - "id": "", ~/~/ ID  задания
1155 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1156 - "name": "", ~/~/ Наименование задания
1157 - "description": "", ~/~/ Описание задания
1158 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1159 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1160 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1161 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1162 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1163 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1164 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1165 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1166 - }
1167 - ],
1168 -"statusHistory": [ ~/~/ История статусов
1169 - {
1170 - "status": 0,
1171 - "date": "2023-05-22T09:57:39.562Z",
1172 - "description": "string",
1173 - "additionalInfo": "string"
1174 - }
1175 - ]
1176 1176  }
1177 -)))
1178 1178  
1179 -(% style="text-align:left" %)
1180 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
220 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
221 +
1181 1181  
1182 -(% style="text-align:left" %)
1183 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
223 + **Добавление пользователя**
1184 1184  
225 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1185 1185  
1186 -== **Отправить команду на терминал** ==
227 +Метод запроса: POST
1187 1187  
1188 -(% class="box successmessage" %)
1189 -(((
1190 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1191 -)))
229 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1192 1192  
1193 -Команда для отправки на тс.
231 +В заголовках запроса: X-Auth: Токен авторизации
1194 1194  
1195 -{  
1196 -"id": "", ~/~/идентификатор произвольного поля
1197 -"command": "", ~/~/ Текст команды
1198 -"retries": "", ~/~/ Количество попыток
1199 -"idTemplate": "" ~/~/ ID шаблона команды
1200 -}
233 +Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }
1201 1201  
235 +Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
236 +
1202 1202  
1203 -== **Получить ответ на отправленную на ТС команду** ==
238 + **Редактирование пользователя**
1204 1204  
1205 -(% class="box infomessage" %)
1206 -(((
1207 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1208 -)))
240 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1209 1209  
1210 -Идентификатор команды: cmdid
242 +Метод запроса: PUT
1211 1211  
1212 -Запрос от терминала на ответ команды
244 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1213 1213  
1214 -Пример ответ от терминала:
246 +В заголовках запроса: X-Auth: Токен авторизации
1215 1215  
1216 -ID= "" ~/~/ идентификатор произвольного поля
1217 -Soft="" ~/~/ версия софта
1218 -GPS=4 ~/~/ тип трекера
1219 -Time=11:05:43 28.06.24 ~/~/ время запроса
1220 -Lat=45.056221 ~/~/ широта
1221 -Lon=39.035938 ~/~/ долгота
1222 -Speed=0.0 ~/~/ скорость
1223 -Course=181.4 ~/~/направление
248 +Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
1224 1224  
1225 -(((
1226 -== **Список отправленных объекту команд с ответами** ==
250 +{{{ "description": "", // описание
251 + "data": "" // данные, связанные со сменой статуса}}}
1227 1227  
1228 -(% class="box infomessage" %)
1229 -(((
1230 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1231 -)))
1232 -
1233 -Идентификатор ТС: vehicleId
1234 -
1235 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1236 -
1237 -Пример ответа терминала
1238 -
1239 -[ 
1240 -{    
1241 -"id": "", ~/~/ идентификатор пользователя
1242 -"commandText": "", ~/~/Текст команды.
1243 -"templateId": "", ~/~/Идентификатор шаблона
1244 -"updated": "", ~/~/ Время отправки  
1245 -"tryCount": 0, ~/~/ Количество попыток отправки команды
1246 -"answer": "", ~/~/ Ответ терминала.
1247 -"status": "" ~/~/ Статус отправки
1248 1248  }
1249 -]
1250 -)))
1251 1251  
1252 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
255 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
256 +
1253 1253  
1254 -(% class="box successmessage" %)
1255 -(((
1256 -(% lang="en-US" %)**POST /api/v3/vehicles**
1257 -)))
258 + **Удаление пользователя**
1258 1258  
1259 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
260 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1260 1260  
1261 -(% style="color:#000000" %)Метод запроса: **POST**
262 +Метод запроса: DELETE
1262 1262  
1263 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
264 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
1264 1264  
1265 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
266 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
1266 1266  
1267 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
268 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
269 +
1268 1268  
1269 -(% style="color:#000000" %){(%%)
1270 - "parentId": "" , ~/~/ ID клиента
1271 - "name": "" , ~/~/ имя ТС
1272 - "imei": "" , ~/~/ IMEI
1273 - "deviceTypeId": "" , ~/~/ ID типа устройства
1274 - "modelId": "" , ~/~/ ID модели
1275 - "unitId": "" , ~/~/ ID подразделения
1276 - "sim1": "" , ~/~/ Номер SIM 1
1277 - "sim2": "" , ~/~/ Номер SIM2
1278 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1279 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1280 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1281 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1282 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1283 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1284 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1285 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1286 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1287 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1288 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1289 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1290 - "mileageCalcMethod": 0,
1291 - "mileageCoeff": 0,
1292 - "locationByCellId": true,
1293 - "dottedLineTrackWhenNoCoords": true,
1294 - "counters": ~/~/ счетчики
1295 - {
1296 - "mileage": "" , ~/~/ пробег
1297 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1298 - "motohours": "" , ~/~/ моточасы
1299 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1300 - },
1301 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1302 - "enabled": true, ~/~/ флаг включения
1303 - "id": "" , ~/~/ идентификатор
1304 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1305 - "login": "" , ~/~/ имя учетной записи
1306 - "password": "" ~/~/ пароль учетной записи
1307 - },
1308 - "inspectionTasks": ~/~/ задания на ТО
1309 - {
1310 - "enabled": "" , ~/~/ Признак включения
1311 - "name": "" , ~/~/ Имя задания
1312 - "description": "" , ~/~/ Описание задания
1313 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1314 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1315 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1316 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1317 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1318 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1319 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1320 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1321 - }
1322 -"drivers": [ ~/~/ Водители
1323 - {
1324 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1325 - "isDefault": true
1326 - }
1327 - ],
1328 - "commandTemplates": [ ~/~/ Шаблон команды
1329 - {
1330 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1331 - "name": "string",
1332 - "command": "string",
1333 - "retries": 0
1334 - }
1335 - ],
1336 -"sensors": [ ~/~/ Датчики
1337 - {
1338 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1339 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1340 - "type": 0, ~/~/ Тип датчика
1341 - "name": "string", ~/~/ Имя датчика
1342 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1343 - "inputNumber": 0, ~/~/ Номер входа
1344 - "pseudonym": "string", ~/~/ Псевдоним
1345 - "medianDegree": 0, ~/~/ Медианная фильтрация
1346 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1347 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1348 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1349 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1350 - {
1351 - "grades": [ ~/~/ Таблица тарировки 1
1352 - {
1353 - "input": 0, ~/~/ Входящее значение
1354 - "output": 0 ~/~/ Выходящее значение
1355 - }
1356 - ],
1357 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1358 - }
1359 - ],
1360 - "showInTooltip": true, ~/~/ Отображать в подсказке
1361 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1362 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1363 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1364 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1365 - "expr": "string", ~/~/ Формула
1366 - "children": [ ~/~/ массив дочерних датчиков
1367 - "string"
1368 - ],
1369 - "customParams": { ~/~/ прочие произвольные параметры
1370 - "additionalProp1": "string",
1371 - "additionalProp2": "string",
1372 - "additionalProp3": "string"
1373 - },
1374 -~/~/ Характерные для произвольного:
1375 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1376 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1377 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1378 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1379 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1380 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1381 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1382 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1383 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1384 -~/~/ "ValueOn": "Вкл.",
1385 -~/~/ "ValueOff": "Выкл."
1386 - "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
271 + **Добавление объекта**
1387 1387  
1388 -(((
1389 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1390 - {
1391 - "from": 0, ~/~/ С какого значения
1392 - "color": "string", ~/~/ Каким цветом
1393 - "text": "string" ~/~/ Текст подписи к этому интервалу
1394 - }
1395 - ]
1396 - }
1397 - ],
1398 -)))
273 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
1399 1399  
1400 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
275 +Метод запроса: POST
1401 1401  
277 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1402 1402  
1403 - "customFields": [ ~/~/ Произвольные поля
1404 - {
1405 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1406 - "name": "string", ~/~/ Наименование произвольного поля
1407 - "value": "string", ~/~/ Значение произвольного поля
1408 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1409 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1410 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
1411 - }
1412 - ]
1413 -}
279 +В заголовках запроса: X-Auth: Токен авторизации
1414 1414  
1415 -(% style="color:#000000" %)Ответ:
281 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
1416 1416  
1417 -
1418 -(((
1419 -(((
1420 -(((
1421 -{
1422 - "vehicleId": 0,  ~/~/ ID ТС
1423 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1424 - "name": "string", ~/~/ Имя объекта
1425 - "imei": "string", ~/~/ IMEI
1426 - "deviceTypeId": 0, ~/~/ ID типа устройства
1427 - "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1428 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1429 - "sim1": "string", ~/~/ SIM1
1430 - "sim2": "string", ~/~/ SIM2
1431 - "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1432 - "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1433 - "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1434 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1435 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1436 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1437 - "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1438 - "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1439 - "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1440 - "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1441 - "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1442 - "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1443 - "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1444 - "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1445 - "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1446 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1447 - "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1448 - "counters": {  ~/~/ Dto для состояний счётчиков
1449 - "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1450 - "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1451 - "mileage": 0, ~/~/ Пробег
1452 - "motohours": 0 ~/~/ Моточасы
283 +{{{ "parentId": "", // ID клиента
284 + "name": "", // имя ТС
285 + "imei": "", // IMEI
286 + "deviceTypeId": "",// ID типа устройства
287 + "modelId": "",
288 + "unitId": "", // ID подразделения
289 + "sim1": "", // Номер SIM 1
290 + "sim2": "", // Номер SIM2
291 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
292 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
293 + "consumptionIdle": "",// Расход топлива на холостом ходу
294 + "counters": {
295 + "mileage": "", // пробег
296 + "mileageEnabled": true, // флаг активности счётчика "пробег"
297 + "motohours":"", // моточасы
298 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
1453 1453   },
1454 - "cmsv6Parameters": { ~/~/ Dto для CMSv6
1455 - "id": "string", ~/~/ CMSV6 Идентификатор
1456 - "enabled": true, ~/~/ Признак включения
1457 - "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1458 - "login": "string", ~/~/ CMSV6 имя учетной записи
1459 - "password": "string" ~/~/ CMSV6 — пароль учетной записи
1460 - },
1461 - "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1462 - {
1463 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1464 - "enabled": true, ~/~/ Признак включения
1465 - "name": "string", ~/~/ Имя задания
1466 - "description": "string", ~/~/ Описание задания
1467 - "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1468 - "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1469 - "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1470 - "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1471 - "periodicCondition": 0, ~/~/ Условие периодичности по времени
1472 - "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1473 - "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1474 - "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1475 - }
1476 - ],
1477 - "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1478 - {
1479 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1480 - "inputNumber": 0, ~/~/ № входа.
1481 - "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1482 - "comment": "string", ~/~/ Комментарий
1483 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1484 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1485 - "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1486 - "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1487 - }
1488 - ],
1489 - "commandTemplates": [  ~/~/ Список шаблонов команд
1490 - {
1491 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1492 - "name": "string", ~/~/ Название шаблона команд
1493 - "command": "string", ~/~/ Команда на выполнение
1494 - "retries": 0 ~/~/ Лимит попыток отправки
1495 - }
1496 - ],
1497 - "sensors": [ ~/~/ Список датчиков
1498 - {
1499 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1500 - "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1501 - "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1502 - "name": "string",  ~/~/ Имя датчика
1503 - "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1504 - "inputNumber": 0, ~/~/ Номер входа
1505 - "pseudonym": "string", ~/~/ Псевдоним
1506 - "medianDegree": 0, ~/~/ Степень медианной фильтрации
1507 - "isInverted": true, ~/~/  Признак инверсии
1508 - "disabled": true, ~/~/ Датчик не участвует в обработке
1509 - "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1510 - "gradesTables": [ ~/~/ Тарировка
1511 - {
1512 - "grades": [ ~/~/ Таблицы тарировки
1513 - {
1514 - "input": 0, ~/~/ Вход
1515 - "output": 0 ~/~/ Выход
1516 - }
1517 - ],
1518 - "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1519 - }
1520 - ],
1521 - "showInTooltip": true, ~/~/ Отображение в подсказке
1522 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1523 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1524 - "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1525 - "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1526 - "expr": "string", ~/~/ Выражение
1527 - "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1528 - "string"
1529 - ],
1530 - "customParams": {
1531 - "additionalProp1": "string",
1532 - "additionalProp2": "string",
1533 - "additionalProp3": "string"
300 + "cmsv6Parameters": { // параметры CMSv6
301 + "enabled": true, // флаг включения
302 + //"id": "", // идентификатор
303 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
304 + "login": "", // имя учетной записи
305 + "password": "" // пароль учетной записи
1534 1534   },
1535 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1536 - "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1537 - {
1538 - "from": 0, ~/~/ С какого значения
1539 - "color": "string", ~/~/ Каким цветом
1540 -)))
1541 -
1542 -(((
1543 - "text": "string" ~/~/ Текст подписи к этому интервалу
1544 - }
1545 - ]
1546 - }
1547 - ],
1548 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1549 - "customFields": [ ~/~/ Список произвольных полей
1550 - {
1551 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1552 - "name": "string", ~/~/ Наименование произвольного поля
1553 - "value": "string", ~/~/ Значение произвольного поля
1554 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1555 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1556 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
1557 - }
1558 - ],
1559 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
1560 -}
1561 -)))
1562 -)))
1563 -)))
1564 -
1565 -
1566 -**Валидация:**
1567 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1568 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1569 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1570 -
1571 -
1572 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1573 -
1574 -(% class="box successmessage" %)
1575 -(((
1576 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1577 -)))
1578 -
1579 -Метод запроса: **POST**
1580 -
1581 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1582 -
1583 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1584 -
1585 -
1586 -Ответ:
1587 -
1588 -{
1589 -
1590 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1591 -
1592 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1593 -
1594 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1595 -
1596 - "Message": "string", ~/~/ Информация о выполнении запроса
1597 -
1598 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1599 -
1600 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1601 -
1602 - "Data": "string" ~/~/ Данные
1603 -
1604 -}
1605 -
1606 -
1607 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1608 -
1609 -(% class="box infomessage" %)
1610 -(((
1611 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1612 -)))
1613 -
1614 -Метод запроса: **GET**
1615 -
1616 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1617 -
1618 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1619 -
1620 -
1621 -Ответ:
1622 -
1623 -{
1624 -
1625 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1626 -
1627 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1628 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1629 -
1630 - "Message": "string", ~/~/ Информация о выполнении запроса
1631 -
1632 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1633 -
1634 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1635 -
1636 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1637 -
1638 - "Data": "string" ~/~/ Данные
1639 -
1640 -}
1641 -
1642 -
1643 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1644 -
1645 -(% class="box infomessage" %)
1646 -(((
1647 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
1648 -)))
1649 -
1650 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1651 -
1652 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1653 -
1654 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1655 -
1656 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1657 -
1658 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1659 -
1660 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1661 -
1662 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1663 -
1664 -(% style="color:#000000" %)Метод запроса: **POST**
1665 -
1666 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1667 -
1668 -(% style="color:#000000" %)В заголовках запроса:
1669 -
1670 -(% style="color:#000000" %)− Content-Type: __**application/json**__
1671 -
1672 -(% style="color:#000000" %)− X-Auth: Токен авторизации
1673 -
1674 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1675 -
1676 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1677 -
1678 -{
1679 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1680 - "name": null, ~/~/ Имя ТС (string, опционально)
1681 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1682 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1683 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1684 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1685 - "unitName": "string",  ~/~/ Название подразделения (опционально)
1686 - "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1687 - "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1688 - "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1689 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1690 -}
1691 -
1692 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1693 -
1694 -(% style="color:#000000" %)Ответ:
1695 -
1696 -(% style="color:#000000" %)[
1697 -{
1698 -
1699 -(((
1700 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1701 -)))
1702 -
1703 -(((
1704 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1705 - "name": "" ~/~/ наименование объекта
1706 - "imei": "" ~/~/ IMEI объекта
1707 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
1708 - "deviceTypeName": "" ~/~/ наименование типа устройства
1709 - "sim1": "" ~/~/ первый номер телефона
1710 - "sim2": "" ~/~/ второй номер телефона
1711 - "parentId": "" ~/~/ идентификатор клиента-родителя
1712 - "parentName": "" ~/~/ наименование клиента-родителя
1713 - "modelId": "" ~/~/ идентификатор модели объекта
1714 - "modelName": "" ~/~/ наименование модели объекта
1715 - "unitId": "" ~/~/ идентификатор подразделения
1716 - "unitName": "" ~/~/ наименование подразделения
1717 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1718 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1719 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1720 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1721 - "customFields": [ 
1722 - {
1723 - "id": "", ~/~/ идентификатор произвольного поля
1724 - "name": "", ~/~/ имя произвольного поля
1725 - "value": "", ~/~/ значение произвольного поля
1726 - "forClient": true, ~/~/ право на отображение у клиента
1727 - "forTooltip": false, ~/~/ право на отображение в подсказке
1728 - "forReport": false ~/~/ право на отображение в отчетах
1729 -)))
1730 -
1731 -(((
1732 - }
1733 - ],
1734 - "vehicleGroups": [  ~/~/ Группы ТС
307 + "inspectionTasks": [ // задания на ТО
1735 1735   {
1736 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1737 - "name": "string" ~/~/ Наименование группы ТС
1738 - }
1739 - ]
1740 - }
1741 -]
1742 -)))
1743 -
1744 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1745 -
1746 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1747 -
1748 -(% class="box successmessage" %)
1749 -(((
1750 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1751 -)))
1752 -
1753 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1754 -
1755 -(% style="color:#000000" %)Метод запроса: **POST**
1756 -
1757 -(% 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}
1758 -
1759 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1760 -
1761 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1762 -
1763 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1764 -
1765 -(% style="color:#000000" %){
1766 -
1767 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1768 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1769 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1770 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1771 - "description": "", ~/~/ Описание
1772 - "data": "", ~/~/ Данные
1773 - "overwrite": false, ~/~/ Флаг перезаписи
1774 - "stage": "", ~/~/ Состояние, может быть null
1775 -(% style="color:#000000" %)}
1776 -
1777 -(% style="color:#000000" %)Ответ:
1778 -
1779 -(% style="color:#000000" %){(%%)
1780 - "status": "", ~/~/ значение статуса
1781 - "date": "", ~/~/ Дата смены статуса 
1782 - "description": "", ~/~/ Описание
1783 - "data": "", ~/~/ Данные
1784 - "overwrite": false, ~/~/ Флаг перезаписи
1785 - "stage": "", ~/~/ Состояние
1786 -(% style="color:#000000" %) }
1787 -
1788 -== ==
1789 -
1790 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1791 -
1792 -(% class="box warningmessage" %)
1793 -(((
1794 -(% lang="en-US" %)**PUT /api/v3/vehicles**
1795 -)))
1796 -
1797 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1798 -
1799 -(% style="color:#000000" %)Метод запроса: **PUT**
1800 -
1801 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1802 -
1803 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1804 -
1805 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1806 -
1807 -(% style="color:#000000" %){
1808 - "vehicleId": , ~/~/ ID объекта
1809 - "parentId": "" , ~/~/ ID клиента
1810 - "name": "" , ~/~/ имя ТС
1811 - "imei": "" , ~/~/ IMEI
1812 - "deviceTypeId": "" , ~/~/ ID типа устройства
1813 - "modelId": "" , ~/~/ ID модели
1814 - "unitId": "" , ~/~/ ID подразделения
1815 - "sim1": "" , ~/~/ Номер SIM 1
1816 - "sim2": "" , ~/~/ Номер SIM2
1817 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1818 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1819 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1820 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1821 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1822 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1823 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1824 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1825 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1826 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1827 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1828 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1829 -
1830 - "mileageCalcMethod": 0,
1831 - "mileageCoeff": 0,
1832 - "locationByCellId": true,
1833 - "dottedLineTrackWhenNoCoords": true,
1834 - "counters": ~/~/ счетчики
1835 - {
1836 - "mileage": "" , ~/~/ пробег
1837 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1838 - "motohours": "" , ~/~/ моточасы
1839 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
309 + "enabled": "", // Признак включения
310 + "name": "", // Имя задания
311 + "description": "", // Описание задания
312 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
313 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
314 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
315 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
316 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
317 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
318 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
319 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1840 1840   },
1841 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1842 - "enabled": true, ~/~/ флаг включения
1843 - "id": "" , ~/~/ идентификатор
1844 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1845 - "login": "" , ~/~/ имя учетной записи
1846 - "password": "" ~/~/ пароль учетной записи
1847 - },
1848 - "inspectionTasks": ~/~/ задания на ТО
1849 - {
1850 - "enabled": "" , ~/~/ Признак включения
1851 - "name": "" , ~/~/ Имя задания
1852 - "description": "" , ~/~/ Описание задания
1853 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1854 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1855 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1856 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1857 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1858 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1859 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1860 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1861 - }
321 + ]}}}
1862 1862  
1863 -"drivers": [ ~/~/ Водители
1864 - {
1865 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1866 - "isDefault": true
1867 - }
1868 - ],
1869 - "commandTemplates": [ ~/~/ Шаблон команды
1870 - {
1871 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1872 - "name": "string",
1873 - "command": "string",
1874 - "retries": 0
1875 - }
1876 - ],
1877 -"sensors": [ ~/~/ Датчики
1878 - {
1879 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1880 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1881 - "type": 0, ~/~/ Тип датчика
1882 - "name": "string", ~/~/ Имя датчика
1883 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1884 - "inputNumber": 0, ~/~/ Номер входа
1885 - "pseudonym": "string", ~/~/ Псевдоним
1886 - "medianDegree": 0, ~/~/ Медианная фильтрация
1887 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1888 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1889 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1890 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1891 - {
1892 - "grades": [ ~/~/ Таблица тарировки 1
1893 - {
1894 - "input": 0, ~/~/ Входящее значение
1895 - "output": 0 ~/~/ Выходящее значение
1896 - }
1897 - ],
1898 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1899 - }
1900 - ],
1901 - "showInTooltip": true, ~/~/ Отображать в подсказке
1902 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1903 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1904 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1905 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1906 - "expr": "string", ~/~/ Формула
1907 - "children": [ ~/~/ массив дочерних датчиков
1908 - "string"
1909 - ],
1910 - "customParams": { ~/~/ прочие произвольные параметры
1911 - "additionalProp1": "string",
1912 - "additionalProp2": "string",
1913 - "additionalProp3": "string"
1914 - },
1915 -~/~/ Характерные для произвольного:
1916 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1917 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1918 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1919 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1920 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1921 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1922 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1923 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1924 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1925 -~/~/ "ValueOn": "Вкл.",
1926 -~/~/ "ValueOff": "Выкл."
1927 - "summaryMaxValue": 0 ~/~/ Макс. значение
323 +… }
1928 1928  
1929 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1930 - {
1931 - "from": 0, ~/~/ С какого значения
1932 - "color": "string", ~/~/ Каким цветом
1933 - "text": "string" ~/~/ Текст подписи к этому интервалу
1934 - }
1935 - ]
1936 - }
1937 - ],
1938 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1939 -
1940 - "customFields": [ ~/~/ Произвольные поля
1941 - {     
1942 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1943 - "name": "string", ~/~/ Наименование произвольного поля
1944 - "value": "string", ~/~/ Значение произвольного поля
1945 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1946 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1947 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
1948 - }
1949 - ]
1950 -}
1951 -
1952 -
1953 -(% style="color:#000000" %)Ответ:
1954 -
1955 -(((
1956 -{
1957 - "vehicleId": 0, ~/~/ ID ТС
1958 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1959 - "name": "string", ~/~/ Имя объекта
1960 - "imei": "string", ~/~/ IMEI
1961 - "deviceTypeId": 0, ~/~/ ID типа устройства
1962 - "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1963 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1964 - "sim1": "string", ~/~/ SIM1
1965 - "sim2": "string", ~/~/ SIM2
1966 - "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1967 - "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1968 - "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1969 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1970 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1971 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1972 - "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1973 - "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1974 - "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1975 - "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1976 - "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1977 - "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1978 - "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1979 - "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1980 - "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1981 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1982 - "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1983 - "counters": { ~/~/ состояний счётчиков
1984 - "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1985 - "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1986 - "mileage": 0, ~/~/ Пробег
1987 - "motohours": 0 ~/~/ Моточасы 
1988 - },
1989 - "cmsv6Parameters": { ~/~/ Dto для CMSv6
1990 - "id": "string", ~/~/ CMSV6 Идентификатор
1991 - "enabled": true, ~/~/ Признак включения
1992 - "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1993 -)))
1994 -
1995 -
1996 -(((
1997 -~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1998 - "login": "string", ~/~/ CMSV6 имя учетной записи
1999 - "password": "string" ~/~/ CMSV6 — пароль учетной записи
2000 - },
2001 - "inspectionTasks": [ ~/~/ Задания на ТО
2002 - {
2003 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2004 - "enabled": true, ~/~/ Признак включения
2005 - "name": "string", ~/~/ Имя задания
2006 - "description": "string", ~/~/ Описание задания
2007 - "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2008 - "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2009 - "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2010 - "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2011 - "periodicCondition": 0, ~/~/ Условие периодичности по времени
2012 - "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2013 - "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2014 - "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2015 - }
2016 - ],
2017 - "drivers": [  ~/~/ Список водителей
2018 - {
2019 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2020 - "inputNumber": 0, ~/~/ № входа.
2021 - "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2022 - "comment": "string", ~/~/ Комментарий.
2023 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2024 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2025 - "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2026 - "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2027 - }
2028 - ],
2029 - "commandTemplates": [ ~/~/ Список шаблонов команд
2030 - {
2031 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2032 - "name": "string", ~/~/ Название шаблона команд
2033 - "command": "string", ~/~/ Команда на выполнение
2034 - "retries": 0 ~/~/ Лимит попыток отправки
2035 - }
2036 - ],
2037 - "sensors": [  ~/~/ Список датчиков 
2038 - {
2039 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2040 - "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2041 - "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2042 -)))
2043 -
2044 -(((
2045 -~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2046 -)))
2047 -
2048 -(((
2049 -~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2050 -)))
2051 -
2052 -(((
2053 -~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2054 -)))
2055 -
2056 -(((
2057 -~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2058 -)))
2059 -
2060 -(((
2061 -~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2062 - "name": "string", ~/~/ Имя датчика
2063 - "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2064 -)))
2065 -
2066 -(((
2067 -~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2068 - "inputNumber": 0, ~/~/ Номер входа
2069 - "pseudonym": "string", ~/~/ Псевдоним
2070 - "medianDegree": 0, ~/~/ Степень медианной фильтрации
2071 - "isInverted": true, ~/~/ Признак инверсии
2072 - "disabled": true, ~/~/ Датчик не участвует в обработке
2073 - "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2074 - "gradesTables": [ ~/~/ Тарировка
2075 - {
2076 - "grades": [ ~/~/ Таблицы тарировки
2077 - {
2078 - "input": 0, ~/~/ Вход
2079 - "output": 0 ~/~/ Выход
2080 - }
2081 - ],
2082 - "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2083 - }
2084 - ],
2085 - "showInTooltip": true, ~/~/ Отображение в подсказке
2086 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
2087 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2088 - "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2089 - "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2090 - "expr": "string", ~/~/ Выражение
2091 - "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2092 - "string" 
2093 - ],
2094 - "customParams": { ~/~/ Дополнительные настройки
2095 - "additionalProp1": "string",
2096 - "additionalProp2": "string",
2097 - "additionalProp3": "string"
2098 - },
2099 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2100 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2101 - {
2102 - "from": 0, ~/~/ С какого значения
2103 - "color": "string", ~/~/ Каким цветом
2104 - "text": "string" ~/~/ Текст подписи к этому интервалу
2105 - }
2106 - ]
2107 - }
2108 - ],
2109 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2110 - "customFields": [ ~/~/ Список произвольных полей
2111 - {
2112 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2113 - "name": "string", ~/~/ Наименование произвольного поля
2114 - "value": "string", ~/~/ Значение произвольного поля
2115 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2116 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2117 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
2118 - }
2119 - ],
2120 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2121 -}
2122 -)))
2123 -
2124 -**Валидация:**
2125 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
2126 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2127 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2128 -
2129 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2130 -
2131 -(% class="box errormessage" %)
2132 -(((
2133 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2134 -)))
2135 -
2136 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2137 -
2138 -(% style="color:#000000" %)Метод запроса: **DELETE**
2139 -
2140 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2141 -
2142 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2143 -
2144 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2145 -
2146 -(% style="text-align:left" %)
2147 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2148 -
2149 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2150 -
2151 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2152 -
2153 -(% class="box infomessage" %)
2154 -(((
2155 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2156 -)))
2157 -
2158 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2159 -
2160 -(% style="color:#000000" %)Метод запроса: **GET**
2161 -
2162 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2163 -
2164 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2165 -
2166 -(% style="color:#000000" %)Ответ:
2167 -
2168 -(% style="color:#000000" %){(%%)
2169 - "deviceTypeId" : "", ~/~/ ID типа устройства
2170 - "deviceTypeName" : "" ~/~/ Название типа устройства
2171 -(% style="color:#000000" %)}
2172 -
2173 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2174 -
2175 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2176 -
2177 -(% class="box infomessage" %)
2178 -(((
2179 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2180 -)))
2181 -
2182 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2183 -
2184 -(% style="color:#000000" %)Метод запроса: **GET**
2185 -
2186 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2187 -
2188 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2189 -
2190 -(% style="color:#000000" %)Ответ:
2191 -
2192 -(% style="color:#000000" %){(%%)
2193 - "id": "", ~/~/ ID типа датчика 
2194 - "name": "", ~/~/ Название
2195 - "description": "", ~/~/ Описание
2196 -(% style="color:#000000" %)}
2197 -
2198 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2199 -
2200 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2201 -
2202 -(% class="box infomessage" style="text-align: left;" %)
2203 -(((
2204 -**POST /api/v3/terminalMessages/count**
2205 -)))
2206 -
2207 -(% style="text-align: left;" %)
2208 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2209 -
2210 -(% style="text-align: left;" %)
2211 -Метод запроса **POST**
2212 -
2213 -(% style="text-align: left;" %)
2214 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2215 -
2216 -(% style="text-align: left;" %)
2217 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2218 -
2219 -(% style="text-align: left;" %)
2220 -{
2221 - "vehicleIds": [
2222 - id ~/~/ здесь передается список идентификаторов объектов
2223 - ],
2224 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2225 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2226 -}
2227 -
2228 -(% style="text-align: left;" %)
2229 2229  Ответ:
2230 2230  
2231 -(% style="text-align: left;" %)
2232 -[
2233 - {
2234 - "vehicleId": 0, ~/~/ идентификатор объекта
2235 - "count": 0 ~/~/ количество сообщений за период
2236 - }
2237 -]
2238 -
2239 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2240 -
2241 -(% class="box infomessage" style="text-align: left;" %)
2242 -(((
2243 -**POST /api/v3/terminalMessages/mapping**
2244 -)))
2245 -
2246 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2247 -
2248 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2249 -
2250 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2251 -
2252 2252  {
2253 - "protocolType": 0,
2254 - "params": ["string"]
2255 -}
2256 2256  
2257 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2258 -|protocolType|ID типа протокола
2259 -|params|(((
2260 -Массив наименований параметров в сообщении
2261 -)))
2262 -
2263 -Ответ:
2264 -
2265 -{
2266 - "protocolType": 0,
2267 - "mapping": {
2268 - "additionalProp1": {
2269 - "inputType": 0,
2270 - "inputNumber": 0
2271 - },
2272 - "additionalProp2": {
2273 - "inputType": 0,
2274 - "inputNumber": 0
2275 - }
2276 - }
2277 -}
2278 -
2279 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2280 -|protocolType|Тип протокола
2281 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2282 -|inputNumber|(((
2283 -Номер входа
2284 -)))
2285 -
2286 -(% class="wikigeneratedid" %)
2287 -Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2288 -
2289 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2290 -
2291 -(% class="box infomessage" %)
2292 -(((
2293 -**POST /api/v3/terminalMessages**
2294 -)))
2295 -
2296 -Метод возвращает список сообщений терминала объекта за выбранный период.
2297 -
2298 -(% style="text-align: left;" %)
2299 -Метод запроса **POST**
2300 -
2301 -(% style="text-align: left;" %)
2302 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2303 -
2304 -(% style="text-align: left;" %)
2305 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2306 -
2307 -{
2308 - "vehicleId": 0, ~/~/ id объекта
2309 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2310 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2311 -}
2312 -
2313 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2314 -|vehicleId|ID объекта
2315 -|from|Дата и время начала периода запроса
2316 -|to|Дата и время окончания периода запроса
2317 -
2318 -Ответ:
2319 -
2320 -[
2321 - {
2322 - "messages": [
2323 - {
2324 - "deviceTime": "2023-11-29T07:40:44.052Z",
2325 - "serverTime": "2023-11-29T07:40:44.052Z",
2326 - "speed": 0,
2327 - "altitude": 0,
2328 - "latitude": 0,
2329 - "longitude": 0,
2330 - "satellites": 0,
2331 - "course": 0,
2332 - "voltage": 0,
2333 - "parameters": {
2334 - "additionalProp1": "string",
2335 - "additionalProp2": "string",
2336 - "additionalProp3": "string"
2337 - },
2338 - "photoCount": 0,
2339 - "lbsCorrectedCoords": true,
2340 - "protocolType": 0
2341 - }
2342 - ]
2343 - }
2344 -]
2345 -
2346 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2347 -|deviceTime|Время сообщения терминала
2348 -|serverTime|Время когда сообщение поступило на сервер
2349 -|speed|Скорость
2350 -|altitude|Высота над уровнем моря
2351 -|latitude|Широта
2352 -|longitude|Долгота
2353 -|satellites|Кол-во спутников
2354 -|course|Курс
2355 -|voltage|Бортовое напряжение
2356 -|parameters|Список параметров и их значений
2357 -|photoCount|Количество фото
2358 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2359 -|protocolType|ID типа протокола
2360 -
2361 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2362 -
2363 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2364 -
2365 -(% class="box infomessage" %)
2366 -(((
2367 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2368 -)))
2369 -
2370 -(% style="color:#000000" %)Метод запроса: **POST**
2371 -
2372 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2373 -
2374 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2375 -
2376 -(% style="text-align:left" %)
2377 -Тело запроса:
2378 -
2379 -{
2380 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2381 - "vehicleIds": [0], ~/~/ Список ID объектов
2382 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2383 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2384 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2385 -}
2386 -
2387 -Ответ:
2388 -
2389 -[
2390 - {
2391 - "vehicleId": 0, ~/~/ ID объекта
2392 - "name": "string", ~/~/ Имя ТС
2393 - "periods": [ ~/~/ Периоды
2394 - {
2395 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2396 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2397 - "mileage": 0, ~/~/ Пробег за период, километры
2398 - "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2399 - "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2400 - "motohours": 0, ~/~/ Моточасы за период, секунды
2401 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2402 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2403 - }
2404 - ]
2405 - }
2406 -]
2407 -
2408 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2409 -
2410 -(% class="box infomessage" %)
2411 -(((
2412 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2413 -)))
2414 -
2415 -(% style="color:#000000" %)Метод запроса: **POST**
2416 -
2417 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2418 -
2419 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2420 -
2421 -(% style="text-align:left" %)
2422 -Тело запроса:
2423 -
2424 -{
2425 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2426 - "vehicleIds": [0], ~/~/ Список ID объектов
2427 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2428 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2429 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2430 -}
2431 -
2432 -Ответ:
2433 -
2434 -[
2435 - {
2436 - "vehicleId": 0, ~/~/ ID объекта
2437 - "name": "string", ~/~/ Имя ТС
2438 - "periods": [ ~/~/ Периоды
2439 - {
2440 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2441 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2442 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2443 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2444 - "fuelConsumption": 0, ~/~/ Расход топлива
2445 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2446 - }
2447 - ]
2448 - }
2449 -]
2450 -
2451 -(% class="box warningmessage" %)
2452 -(((
2453 -Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2454 -\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2455 -)))
2456 -
2457 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2458 -
2459 -(% class="box infomessage" %)
2460 -(((
2461 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2462 -)))
2463 -
2464 -(% style="color:#000000" %)Метод запроса: **POST**
2465 -
2466 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2467 -
2468 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2469 -
2470 -(% style="text-align:left" %)
2471 -Тело запроса:
2472 -
2473 -{
2474 - "vehicleIds": [0], ~/~/ Список ID объектов
2475 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2476 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2477 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2478 -}
2479 -
2480 -Ответ:
2481 -
2482 -[
2483 - {
2484 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2485 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2486 - "vehicleId": 0, ~/~/ ID объекта
2487 - "name": "string", ~/~/ Имя объекта
2488 - "model": "string", ~/~/ Модель объекта
2489 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2490 - {
2491 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2492 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2493 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2494 - "valueFuel": 0, ~/~/ Количество
2495 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2496 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2497 - }
2498 - ]
2499 - }
2500 -]
2501 -
2502 -
2503 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2504 -
2505 -(% class="box infomessage" %)
2506 -(((
2507 -**POST /api/v3/vehicles/moveStop**
2508 -)))
2509 -
2510 -Метод запроса: **POST**
2511 -
2512 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2513 -
2514 -В заголовках запроса: X-Auth: Токен авторизации
2515 -
2516 -
2517 -Тело запроса:
2518 -
2519 -{
2520 - "vehicleIds": [ ], ~/~/ Список ID объектов
2521 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2522 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2523 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2524 -}
2525 -
2526 -Ответ:
2527 -
2528 -[ 
2529 - {
2530 - "vehicleId": 0, ~/~/ ID объекта
2531 - "vehicleName": "string", ~/~/ Имя объекта
2532 - "moves": [ ~/~/ Событие движения
2533 - {
2534 - "mileage": 0, ~/~/ Пробег, км
2535 - "eventId": 0, ~/~/ Идентификатор события
2536 - "eventName": "string", ~/~/ Название события
2537 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2538 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2539 - "duration": 0 ~/~/ Продолжительность события, секунд
2540 - }
2541 - ],
2542 - "stops": [ ~/~/ События стоянок
2543 - {
2544 - "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2545 - "eventId": 0, ~/~/ Идентификатор события
2546 - "eventName": "string", ~/~/ Название события
2547 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2548 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2549 - "duration": 0 ~/~/ Продолжительность события, секунд
2550 - }
2551 - ]
2552 - }
2553 -]
2554 -
2555 -
2556 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2557 -
2558 -(% class="box infomessage" %)
2559 -(((
2560 -**POST /api/v3/vehicles/getlastdata**
2561 -)))
2562 -
2563 -Метод запроса: **POST**
2564 -
2565 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2566 -
2567 -В заголовках запроса: X-Auth: Токен авторизации
2568 -
2569 -
2570 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2571 -
2572 -Ответ:
2573 - {
2574 - "vehicleId": 0, ~/~/Идентификатор объекта.
2575 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2576 - "vehicleNumber": "string",~/~/Номер объекта.
2577 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2578 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2579 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2580 - "speed": 0,~/~/Скорость объекта.
2581 - "course": 0,~/~/Курс движения [0;360]
2582 - "latitude": 0,~/~/Широта [-90°;90°].
2583 - "longitude": 0,~/~/Долгота [-180°;180°].
2584 - "address": "string",~/~/Адрес.
2585 - "geozones": [ ~/~/Сведения по геозонам.
2586 - {
2587 - "id": 0,
2588 - "name": "string"
2589 - }
2590 -
2591 -
2592 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2593 -
2594 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2595 -
2596 -(% class="box infomessage" %)
2597 -(((
2598 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2599 -)))
2600 -
2601 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2602 -
2603 -(% style="color:#000000" %)Метод запроса: **POST**
2604 -
2605 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2606 -
2607 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2608 -
2609 -(% style="text-align:left" %)
2610 -Тело запроса:
2611 -
2612 -(% style="text-align:left" %)
2613 -{
2614 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2615 -}
2616 -
2617 -(% style="text-align:left" %)
2618 -Ответ:
2619 -
2620 -[
2621 - {
2622 - "id": 0, ~/~/ Идентификатор объекта геозоны
2623 - "name": "string", ~/~/ Название объекта геозоны
2624 - "type": 0, ~/~/ Тип объекта геозоны
2625 - "fname": "string", ~/~/ Имя файла
2626 - "parentId": "string", ~/~/ Идентификатор клиента
2627 - "radius": 0, ~/~/ Радиус геообъекта
2628 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2629 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2630 - "description": "string", ~/~/ Описание
2631 - "area": 0, ~/~/ Площадь, м^^2^^
2632 - "perimetr": 0, ~/~/ Периметр, м
2633 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2634 - }
2635 -]
2636 -
2637 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2638 -
2639 -(% class="box infomessage" %)
2640 -(((
2641 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2642 -)))
2643 -
2644 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2645 -
2646 -(% style="color:#000000" %)Метод запроса: **POST**
2647 -
2648 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2649 -
2650 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2651 -
2652 -(% style="text-align:left" %)
2653 -Тело запроса:
2654 -
2655 -{
2656 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2657 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2658 - "ids": [ ], ~/~/ Массив id объектов
2659 - "byTime": 0, ~/~/ Объединение событий по времени 
2660 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2661 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2662 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2663 -}
2664 -
2665 -Ответ:
2666 -[
2667 - {
2668 - "geozoneId": 0, ~/~/ ID геообъекта
2669 - "geozoneName": "string", ~/~/ Название геообъекта
2670 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2671 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2672 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2673 - "vehicleId": 0, ~/~/ ID объекта
2674 - "vehicleName": "string" ~/~/ Имя объекта
2675 - }
2676 -]
2677 -
2678 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2679 -
2680 -(% class="box infomessage" %)
2681 -(((
2682 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2683 -)))
2684 -
2685 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2686 -
2687 -(% style="color:#000000" %)Метод запроса: **POST**
2688 -
2689 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2690 -
2691 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2692 -
2693 -(% style="text-align:left" %)
2694 -Тело запроса:
2695 -
2696 -{
2697 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2698 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2699 - "ids": [ ], ~/~/ Массив id геообъектов
2700 - "byTime": 0, ~/~/ Объединение событий по времени 
2701 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2702 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2703 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2704 -}
2705 -
2706 -Ответ:
2707 -
2708 -[
2709 - {
2710 - "geozoneId": 0, ~/~/ ID геообъекта
2711 - "geozoneName": "string", ~/~/ Название геообъекта
2712 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2713 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2714 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2715 - "vehicleId": 0, ~/~/ ID объекта
2716 - "vehicleName": "string" ~/~/ Имя объекта
2717 - }
2718 -]
2719 -
2720 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2721 -
2722 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2723 -
2724 -(% class="box infomessage" %)
2725 -(((
2726 -**POST /api/v3/notifications/find**
2727 -)))
2728 -
2729 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2730 -
2731 -(% style="text-align: left;" %)
2732 -Метод запроса **POST**
2733 -
2734 -(% style="text-align: left;" %)
2735 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2736 -
2737 -(% style="text-align: left;" %)
2738 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2739 -
2740 -{
2741 - "parentId": "" ~/~/ id клиента
2742 -}
2743 -
2744 -Ответ:
2745 -
2746 -[
2747 - {
2748 - "id": 0, ~/~/ ID уведомления
2749 - "name": "string", ~/~/ Название уведомления
2750 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2751 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2752 - "userId": "", ~/~/ Пользователь, создавший уведомление
2753 - "parentId": "", ~/~/ Идентификатор клиента
2754 - "parentName": "string" ~/~/ Имя клиента
2755 - }
2756 -]
2757 -
2758 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2759 -
2760 -(% class="box infomessage" %)
2761 -(((
2762 -**GET /api/v3/notifications/{id}**
2763 -)))
2764 -
2765 -Метод возвращает данные правил формирования выбранного уведомления.
2766 -
2767 -(% style="text-align: left;" %)
2768 -Метод запроса **GET**
2769 -
2770 -(% style="text-align: left;" %)
2771 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2772 -
2773 -(% style="text-align: left;" %)
2774 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2775 -
2776 -(% style="text-align: left;" %)
2777 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2778 -
2779 -(% style="text-align: left;" %)
2780 -(% style="color:#000000" %)Ответ:
2781 -
2782 -(% style="text-align: left;" %)
2783 -(% style="color:#000000" %){
2784 - "id": 0, ~/~/ (%%)id уведомления
2785 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2786 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2787 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2788 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2789 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2790 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2791 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2792 -(% style="color:#000000" %) 0
2793 - ],
2794 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2795 -(% style="color:#000000" %) 0
2796 - ],
2797 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
2798 -(% style="color:#000000" %) 0
2799 - ],
2800 - "settings": { ~/~/ Список параметров уведомления
2801 - "additionalProp1": "string",
2802 - "additionalProp2": "string",
2803 - "additionalProp3": "string"
329 +{{{ "vehicleId": "", //ID ТС
330 + "parentId": "", //Guid владельца ТС
331 + "name": "", //Имя объекта
332 + "imei": "", //IMEI
333 + "deviceTypeId": "", //ID типа устройства
334 + "modelId": "", //ID модели
335 + "unitId": "", //ID подразделения
336 + "sim1": "", //SIM1
337 + "sim2": "", //SIM2
338 + "consumptionPer100Km": "", //Расход топлива на 100 км
339 + "consumptionIdle": "", //Расход топлива на холостом ходу
340 + "counters": { //Счётчики
341 + "mileageEnabled": true,
342 + "motohoursEnabled": true,
343 + "mileage": "",
344 + "motohours": 345.0
2804 2804   },
2805 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2806 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2807 -(% style="color:#000000" %) ""
2808 - ],
2809 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2810 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2811 -(% style="color:#000000" %) "string"
2812 - ],
2813 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2814 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2815 -(% style="color:#000000" %) {
2816 - "id": 0, ~/~/ (%%)Идентификатор участника чата
2817 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2818 -(% style="color:#000000" %) }
2819 - ],
2820 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2821 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2822 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2823 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2824 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2825 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2826 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2827 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2828 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2829 -(% style="color:#000000" %)}
2830 -
2831 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2832 -
2833 -(% class="box warningmessage" %)
2834 -(((
2835 -**PUT /api/v3/notifications/**
2836 -)))
2837 -
2838 -Метод позволяет отредактировать уведомление.
2839 -
2840 -Метод запроса **PUT**
2841 -
2842 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2843 -
2844 -В заголовках запроса: X-Auth: Токен авторизации
2845 -
2846 -Тело запроса:
2847 -{
2848 - "id": 0, ~/~/ id уведомления
2849 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2850 - "userId": "", ~/~/ Пользователь, создавший уведомление
2851 - "parentId": "", ~/~/ Идентификатор клиента
2852 - "parentName": "string", ~/~/ Имя клиента
2853 - "name": "string", ~/~/ Название уведомления
2854 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2855 - "vehicleIds": [ ~/~/ Список id объектов для анализа
2856 - 0
2857 - ],
2858 - "geoids": [ ~/~/ Список id геообъектов для анализа
2859 - 0
2860 - ],
2861 - "fieldids": [ ~/~/ Список id полей для анализа
2862 - 0
2863 - ],
2864 - "settings": { ~/~/ Список параметров уведомления
2865 - "additionalProp1": "string",
2866 - "additionalProp2": "string",
2867 - "additionalProp3": "string"
346 + "cmsv6Parameters": { //Параметры CmsV6
347 + "id": null,
348 + "enabled": true, //флаг включения
349 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
350 + "login": "", // имя учетной записи
351 + "password": "" // пароль учетной записи
2868 2868   },
2869 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2870 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2871 - ""
2872 - ],
2873 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2874 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2875 - "string"
2876 - ],
2877 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2878 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2879 - {
2880 - "id": 0, ~/~/ Идентификатор участника чата
2881 - "info": "string" ~/~/ Дополнительные сведения
2882 - }
2883 - ],
2884 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2885 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2886 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2887 - "kind": 0, ~/~/ Определяет вид уведомления
2888 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2889 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2890 - "timezone": 0, ~/~/ Сдвиг часового пояса
2891 - "validity": 0, ~/~/ Срок действия в днях (1-90)
2892 - "autoProlongation": true ~/~/ Автопродление срока действия
2893 -}
2894 -
2895 -Ответ:
2896 -
2897 -Success
2898 -
2899 -
2900 -== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2901 -
2902 -(% class="box warningmessage" %)
2903 -(((
2904 -**PUT** /api/v3/notifications/prolongation
2905 -)))
2906 -
2907 -Метод позволяет продлить уведомления.
2908 -
2909 -Метод запроса **PUT**
2910 -
2911 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2912 -
2913 -В заголовках запроса: X-Auth: Токен авторизации.
2914 -
2915 -Тело запроса:
2916 -
2917 -[
2918 -
2919 -0
2920 -
2921 -]
2922 -
2923 -где 0 идентификатор ids.
2924 -
2925 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2926 -
2927 -(% class="box errormessage" %)
2928 -(((
2929 -**DELETE /api/v3/notifications/{id}**
2930 -)))
2931 -
2932 -Метод позволяет удалить выбранное уведомление.
2933 -
2934 -Метод запроса **DELETE**
2935 -
2936 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2937 -
2938 -Передаваемый параметр: {id} - id уведомления
2939 -
2940 -В заголовках запроса: X-Auth: Токен авторизации
2941 -
2942 -Ответ:
2943 -
2944 -Success
2945 -
2946 -
2947 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
2948 -
2949 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
2950 -
2951 -(% class="box infomessage" %)
2952 -(((
2953 -**POST /api/v3/Drivers/find**
2954 -)))
2955 -
2956 -Передается параметр: parentId - ID клиента-родителя
2957 -
2958 -Ответ:
2959 -
2960 -[
2961 - {
2962 - "name": "string", ~/~/ Определяет наименование
2963 - "description": "string", ~/~/ Определяет описание
2964 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
2965 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
2966 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2967 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2968 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2969 - "deleted": true ~/~/ Признак удаления
2970 - }
2971 -]
2972 -
2973 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
2974 -
2975 -(% class="box infomessage" %)
2976 -(((
2977 -**GET /api/v3/Drivers/{driverGuid}**
2978 -)))
2979 -
2980 -Передается параметр: ID водителя
2981 -
2982 -Ответ:
2983 -
2984 -{
2985 - "name": "string", ~/~/ Определяет наименование
2986 - "description": "string", ~/~/ Определяет описание
2987 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
2988 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
2989 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
2990 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
2991 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
2992 - "deleted": true ~/~/ Признак удаления
2993 -}
2994 -
2995 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
2996 -
2997 -(% class="box successmessage" %)
2998 -(((
2999 -**POST /api/v3/Drivers**
3000 -)))
3001 -
3002 -Запрос:
3003 -
3004 -{
3005 - "name": "string",
3006 - "description": "string",
3007 - "hiredate": "2023-06-30T12:50:54.020Z",
3008 - "chopdate": "2023-06-30T12:50:54.020Z",
3009 - "exclusive": true,
3010 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3011 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3012 - "deleted": true
3013 -}
3014 -
3015 -Ответ:
3016 -
3017 -{
3018 - "name": "string",
3019 - "description": "string",
3020 - "hiredate": "2023-06-30T12:50:54.051Z",
3021 - "chopdate": "2023-06-30T12:50:54.051Z",
3022 - "exclusive": true,
3023 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3024 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3025 - "deleted": true
3026 -}
3027 -
3028 -
3029 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3030 -
3031 -(% class="box warningmessage" %)
3032 -(((
3033 -**PUT /api/v3/Drivers**
3034 -)))
3035 -
3036 -Запрос:
3037 -
3038 -{
3039 - "name": "string",
3040 - "description": "string",
3041 - "hiredate": "2023-06-30T12:50:27.910Z",
3042 - "chopdate": "2023-06-30T12:50:27.910Z",
3043 - "exclusive": true,
3044 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3045 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3046 - "deleted": true
3047 -}
3048 -
3049 -Ответ:
3050 -
3051 -{
3052 - "name": "string",
3053 - "description": "string",
3054 - "hiredate": "2023-06-30T12:50:27.929Z",
3055 - "chopdate": "2023-06-30T12:50:27.929Z",
3056 - "exclusive": true,
3057 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3058 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3059 - "deleted": true
3060 -}
3061 -
3062 -
3063 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3064 -
3065 -(% class="box errormessage" %)
3066 -(((
3067 -**DELETE /api/v3/Drivers/{driverGuid}**
3068 -)))
3069 -
3070 -Передается параметр: ID водителя
3071 -
3072 -Ответ:
3073 -
3074 -Success
3075 -
3076 -
3077 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3078 -
3079 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3080 -
3081 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3082 -
3083 -(% class="box infomessage" %)
3084 -(((
3085 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3086 -)))
3087 -
3088 -Запрос:
3089 -
3090 -{
3091 - "Ids": [
3092 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3093 - ],
3094 - "BeginTime": "2023-06-30T12:49:04.365Z",
3095 - "EndTime": "2023-06-30T12:49:04.365Z"
3096 -}
3097 -
3098 -Ответ:
3099 -
3100 -[
3101 - {
3102 - "VehicleId": 0,
3103 - "CreateTime": "2023-06-30T09:52:31.240Z",
3104 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3105 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3106 - "BeginTime": "2023-06-30T09:52:31.240Z",
3107 - "EndTime": "2023-06-30T09:52:31.240Z"
3108 - }
3109 -]
3110 -
3111 -
3112 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3113 -
3114 -(% class="box infomessage" %)
3115 -(((
3116 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3117 -)))
3118 -
3119 -Запрос:
3120 -
3121 -{
3122 - "Ids": [
3123 - 0
3124 - ],
3125 - "BeginTime": "2023-06-30T12:48:39.419Z",
3126 - "EndTime": "2023-06-30T12:48:39.419Z"
3127 -}
3128 -
3129 -Ответ:
3130 -
3131 -[
3132 - {
3133 - "VehicleId": 0,
3134 - "CreateTime": "2023-06-30T09:54:01.631Z",
3135 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3136 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3137 - "BeginTime": "2023-06-30T09:54:01.631Z",
3138 - "EndTime": "2023-06-30T09:54:01.631Z"
3139 - }
3140 -]
3141 -
3142 -
3143 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3144 -
3145 -(% class="box successmessage" %)
3146 -(((
3147 -**POST /api/v3/DriversVehiclesAssignments**
3148 -)))
3149 -
3150 -Передается массив назначений
3151 -
3152 -Запрос:
3153 -
3154 -[
3155 - {
3156 - "VehicleId": 0, ~/~/ Идентификатор объекта
3157 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3158 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3159 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3160 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3161 - }
3162 -]
3163 -
3164 -Ответ:
3165 -
3166 -[
3167 - {
3168 - "VehicleId": 0,
3169 - "CreateTime": "2023-06-30T11:04:46.903Z",
3170 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3171 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3172 - "BeginTime": "2023-06-30T11:04:46.903Z",
3173 - "EndTime": "2023-06-30T11:04:46.903Z"
3174 - }
3175 -]
3176 -
3177 -
3178 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3179 -
3180 -(% class="box warningmessage" %)
3181 -(((
3182 -**PUT /api/v3/DriversVehiclesAssignments**
3183 -)))
3184 -
3185 -Запрос:
3186 -
3187 -[
3188 - {
3189 - "VehicleId": 0,
3190 - "CreateTime": "2023-06-30T11:14:08.117Z",
3191 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3192 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3193 - "BeginTime": "2023-06-30T11:14:08.117Z",
3194 - "EndTime": "2023-06-30T11:14:08.117Z"
3195 - }
3196 -]
3197 -
3198 -Ответ:
3199 -
3200 -[
3201 - {
3202 - "VehicleId": 0,
3203 - "CreateTime": "2023-06-30T11:14:53.349Z",
3204 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3205 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3206 - "BeginTime": "2023-06-30T11:14:53.349Z",
3207 - "EndTime": "2023-06-30T11:14:53.349Z"
3208 - }
3209 -]
3210 -
3211 -
3212 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3213 -
3214 -(% class="box errormessage" %)
3215 -(((
3216 -**DELETE /api/v3/DriversVehiclesAssignments**
3217 -)))
3218 -
3219 -Запрос:
3220 -
3221 -[
3222 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3223 -]
3224 -
3225 -Ответ:
3226 -
3227 -Success
3228 -
3229 -
3230 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3231 -
3232 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3233 -
3234 -(% class="box infomessage" %)
3235 -(((
3236 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3237 -)))
3238 -
3239 -Запрос:
3240 -
3241 -{
3242 - "Ids": [
3243 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3244 - ],
3245 - "BeginTime": "2023-06-30T12:47:12.162Z",
3246 - "EndTime": "2023-06-30T12:47:12.162Z"
3247 -}
3248 -
3249 -Ответ:
3250 -
3251 -[
3252 - {
3253 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3254 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3255 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3256 - "BeginTime": "2023-06-30T11:19:40.703Z",
3257 - "EndTime": "2023-06-30T11:19:40.703Z"
3258 - }
3259 -]
3260 -
3261 -
3262 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3263 -
3264 -(% class="box infomessage" %)
3265 -(((
3266 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
3267 -)))
3268 -
3269 -Запрос:
3270 -
3271 -{
3272 - "Ids": [
3273 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3274 - ],
3275 - "BeginTime": "2023-06-30T12:47:12.162Z",
3276 - "EndTime": "2023-06-30T12:47:12.162Z"
3277 -}
3278 -
3279 -Ответ:
3280 -
3281 -[
3282 - {
3283 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3284 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3285 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3286 - "BeginTime": "2023-06-30T11:19:40.703Z",
3287 - "EndTime": "2023-06-30T11:19:40.703Z"
3288 - }
3289 -]
3290 -
3291 -
3292 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3293 -
3294 -(% class="box successmessage" %)
3295 -(((
3296 -**POST /api/v3/DriversRfidsAssignments**
3297 -)))
3298 -
3299 -Запрос:
3300 -
3301 -[
3302 - {
3303 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3304 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3305 - "BeginTime": "2023-06-30T11:27:08.635Z",
3306 - "EndTime": "2023-06-30T11:27:08.635Z"
3307 - }
3308 -]
3309 -
3310 -Ответ:
3311 -
3312 -[
3313 - {
3314 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3315 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3316 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3317 - "BeginTime": "2023-06-30T11:27:08.677Z",
3318 - "EndTime": "2023-06-30T11:27:08.677Z"
3319 - }
3320 -]
3321 -
3322 -
3323 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3324 -
3325 -(% class="box warningmessage" %)
3326 -(((
3327 -**PUT /api/v3/DriversRfidsAssignments**
3328 -)))
3329 -
3330 -Запрос:
3331 -
3332 -[
3333 - {
3334 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3335 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3336 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3337 - "BeginTime": "2023-06-30T11:28:43.330Z",
3338 - "EndTime": "2023-06-30T11:28:43.330Z"
3339 - }
3340 -]
3341 -
3342 -Ответ:
3343 -
3344 -[
3345 - {
3346 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3347 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3348 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3349 - "BeginTime": "2023-06-30T11:28:43.331Z",
3350 - "EndTime": "2023-06-30T11:28:43.331Z"
3351 - }
3352 -]
3353 -
3354 -
3355 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3356 -
3357 -(% class="box errormessage" %)
3358 -(((
3359 -**DELETE /api/v3/DriversRfidsAssignments**
3360 -)))
3361 -
3362 -Запрос:
3363 -
3364 -[
3365 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3366 -]
3367 -
3368 -Ответ:
3369 -
3370 -Success
3371 -
3372 -
3373 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3374 -
3375 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3376 -
3377 -(% class="box infomessage" %)
3378 -(((
3379 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3380 -)))
3381 -
3382 -Запрос:
3383 -
3384 -{
3385 - "Ids": [
3386 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3387 - ],
3388 - "BeginTime": "2023-06-30T12:45:10.852Z",
3389 - "EndTime": "2023-06-30T12:45:10.852Z"
3390 -}
3391 -
3392 -Ответ:
3393 -
3394 -[
3395 - {
3396 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3397 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3398 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3399 - "BeginTime": "2023-06-30T11:58:04.695Z",
3400 - "EndTime": "2023-06-30T11:58:04.695Z"
3401 - }
3402 -]
3403 -
3404 -
3405 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3406 -
3407 -(% class="box infomessage" %)
3408 -(((
3409 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3410 -)))
3411 -
3412 -Запрос:
3413 -
3414 -{
3415 - "Ids": [
3416 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3417 - ],
3418 - "BeginTime": "2023-06-30T12:45:10.852Z",
3419 - "EndTime": "2023-06-30T12:45:10.852Z"
3420 -}
3421 -
3422 -Ответ:
3423 -
3424 -[
3425 - {
3426 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3427 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3428 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3429 - "BeginTime": "2023-06-30T11:58:04.695Z",
3430 - "EndTime": "2023-06-30T11:58:04.695Z"
3431 - }
3432 -]
3433 -
3434 -
3435 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3436 -
3437 -(% class="box successmessage" %)
3438 -(((
3439 -**POST /api/v3/DriversFuelCardsAssignments**
3440 -)))
3441 -
3442 -Запрос:
3443 -
3444 -[
3445 - {
3446 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3447 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3448 - "BeginTime": "2023-06-30T12:09:53.175Z",
3449 - "EndTime": "2023-06-30T12:09:53.175Z"
3450 - }
3451 -]
3452 -
3453 -Ответ:
3454 -
3455 -[
3456 - {
3457 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3458 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3459 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3460 - "BeginTime": "2023-06-30T12:09:53.201Z",
3461 - "EndTime": "2023-06-30T12:09:53.201Z"
3462 - }
3463 -]
3464 -
3465 -
3466 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3467 -
3468 -(% class="box warningmessage" %)
3469 -(((
3470 -**PUT /api/v3/DriversFuelCardsAssignments**
3471 -)))
3472 -
3473 -Запрос:
3474 -
3475 -[
3476 - {
3477 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3478 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3479 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3480 - "BeginTime": "2023-06-30T12:09:53.201Z",
3481 - "EndTime": "2023-06-30T12:09:53.201Z"
3482 - }
3483 -]
3484 -
3485 -Ответ:
3486 -
3487 -[
3488 - {
3489 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3490 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3491 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3492 - "BeginTime": "2023-06-30T12:09:53.201Z",
3493 - "EndTime": "2023-06-30T12:09:53.201Z"
3494 - }
3495 -]
3496 -
3497 -
3498 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3499 -
3500 -(% class="box errormessage" %)
3501 -(((
3502 -**DELETE /api/v3/DriversFuelCardsAssignments**
3503 -)))
3504 -
3505 -Запрос:
3506 -
3507 -[
3508 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3509 -]
3510 -
3511 -Ответ:
3512 -
3513 -Success
3514 -
3515 -
3516 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3517 -
3518 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3519 -
3520 -(% class="box infomessage" %)
3521 -(((
3522 -**POST /api/v3/Trailers**
3523 -)))
3524 -
3525 -Пример запроса:
3526 -
3527 -{
3528 - "startDate": "2023-11-14T10:48:03.671Z",
3529 - "endDate": "2023-11-14T10:48:03.671Z",
3530 - "ids": [ 0 ],
3531 - "timezone": 0
3532 -}
3533 -
3534 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3535 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3536 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3537 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3538 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3539 -
3540 -Пример ответа:
3541 -
3542 -[
3543 - {
3544 - "SD": "2023-11-14T10:48:03.717Z",
3545 - "ED": "2023-11-14T10:48:03.717Z", 
3546 - "id": 0,
3547 - "SLat": 0,
3548 - "SLon": 0,
3549 - "ELat": 0,
3550 - "ELon": 0,
3551 - "mileage": 0
3552 - "Duration": 0
3553 - "Address": "string",
3554 - "Address2": "string",
3555 - "name": "string",
3556 - "rid": "string",
3557 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3558 - "trailer": {
3559 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3560 - "Number": "string",
3561 - "Description": "string",
3562 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3563 - "ExternalID": "string",
3564 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3565 - "CreateTime": "2023-11-14T10:48:03.717Z",
3566 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3567 - "IsDeleted": true
3568 - },
3569 - "filesCount": 0,
3570 - }
3571 -]
3572 -
3573 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3574 -|SD|Дата и время начала события
3575 -|ED|Дата и время окончания события
3576 -|id|ID объекта
3577 -|SLat|Широта начальной координаты
3578 -|SLon|Долгота начальной координаты
3579 -|ELat|Широта конечной координаты
3580 -|ELon|Долгота конечной координаты
3581 -|mileage|Пробег
3582 -|Duration|Продолжительность
3583 -|Address|Адрес начального местоположения
3584 -|Address2|Адрес конечного местоположения
3585 -|name|Имя радиометки
3586 -|rid|Номер радиометки
3587 -|rguid|ID радиометки
3588 -|trailer|Информация об агрегате
3589 -|ModelGuid|ID агрегата
3590 -|Number|Название/номер агрегата
3591 -|Description|Текст примечания агрегата
3592 -
3593 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3594 -
3595 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3596 -
3597 -(% class="box infomessage" %)
3598 -(((
3599 -**POST /api/v3/Rfids/find**
3600 -)))
3601 -
3602 -Запрос:
3603 -
3604 -{
3605 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3606 -}
3607 -
3608 -Ответ:
3609 -
3610 -[
3611 - {
3612 - "name": "string",
3613 - "number": 0,
3614 - "period": 0,
3615 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3616 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3617 - }
3618 -]
3619 -
3620 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3621 -|parentId|ID клиента
3622 -|name|Название карты-метки
3623 -|number|Номер
3624 -|period|Период запросов в секундах (работает только для агрегатов)
3625 -|id|ID карты-метки
3626 -
3627 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3628 -
3629 -(% class="box infomessage" %)
3630 -(((
3631 -**GET /api/v3/Rfids/{rfidGuid}**
3632 -)))
3633 -
3634 -Передаем параметр rfidGuid - идентификатор карты-метки
3635 -
3636 -Ответ:
3637 -
3638 -[
3639 - {
3640 - "name": "string",
3641 - "number": 0,
3642 - "period": 0,
3643 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3644 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3645 - }
3646 -]
3647 -
3648 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3649 -|name|Название карты-метки
3650 -|number|Номер
3651 -|period|Период запросов в секундах (работает только для агрегатов)
3652 -|id|ID карты-метки
3653 -|parentId|ID клиента
3654 -
3655 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3656 -
3657 -(% class="box successmessage" %)
3658 -(((
3659 -**POST /api/v3/Rfids**
3660 -)))
3661 -
3662 -Запрос:
3663 -
3664 -{
3665 - "name": "string",
3666 - "number": 0,
3667 - "period": 0,
3668 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3669 -}
3670 -
3671 -Ответ:
3672 -
3673 -{
3674 - "name": "string",
3675 - "number": 0,
3676 - "period": 0,
3677 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3678 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3679 -}
3680 -
3681 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3682 -|name|Название карты-метки
3683 -|number|Номер
3684 -|period|Период запросов в секундах (работает только для агрегатов)
3685 -|id|ID карты-метки
3686 -|parentId|ID клиента
3687 -
3688 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3689 -
3690 -(% class="box warningmessage" %)
3691 -(((
3692 -**PUT /api/v3/Rfids**
3693 -)))
3694 -
3695 -Запрос:
3696 -
3697 -{
3698 - "name": "string",
3699 - "number": 0,
3700 - "period": 0,
3701 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3702 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3703 -}
3704 -
3705 -Ответ:
3706 -
3707 -{
3708 - "name": "string",
3709 - "number": 0,
3710 - "period": 0,
3711 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3712 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3713 -}
3714 -
3715 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3716 -|name|Название карты-метки
3717 -|number|Номер
3718 -|period|Период запросов в секундах (работает только для агрегатов)
3719 -|id|ID карты-метки
3720 -|parentId|ID клиента
3721 -
3722 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3723 -
3724 -(% class="box errormessage" %)
3725 -(((
3726 -**DELETE /api/v3/Rfids/{rfidGuid}**
3727 -)))
3728 -
3729 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3730 -
3731 -Ответ:
3732 -
3733 -Success
3734 -
3735 -
3736 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3737 -
3738 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3739 -
3740 -(% class="box infomessage" %)
3741 -(((
3742 -**GET /api/v3/Billing/client/balance/{clientId}**
3743 -)))
3744 -
3745 -Параметр запроса: **clientId **- идентификатор клиента.
3746 -
3747 -Ответ:
3748 -
3749 -{
3750 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3751 - "Balance": 0
3752 -}
3753 -
3754 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3755 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3756 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3757 -
3758 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3759 -
3760 -(% class="box infomessage" %)
3761 -(((
3762 -**GET /api/v3/Billing/client/constraint/{clientId}**
3763 -)))
3764 -
3765 -Параметр запроса: **clientId **- идентификатор клиента.
3766 -
3767 -Ответ:
3768 -
3769 -{
3770 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3771 - "CalculationType": 0,
3772 - "PermissibleBalance": 0,
3773 - "DefermentDays": 0,
3774 - "SendUiNotifications": true,
3775 - "SendEmailNotifications": true,
3776 - "IsPrivate": true,
3777 -}
3778 -
3779 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3780 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3781 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3782 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3783 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3784 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3785 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3786 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3787 -
3788 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3789 -
3790 -(% class="box infomessage" %)
3791 -(((
3792 -**GET /api/v3/Billing/client/plan/{clientId}**
3793 -)))
3794 -
3795 -Параметры запроса:
3796 -
3797 -**clientId **- идентификатор клиента.
3798 -
3799 -**planId **- идентификатор тарифного плана.
3800 -
3801 -Ответ:
3802 -
3803 -{
3804 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3805 - "Plan": { **~/~/ Описание тарифного плана**
3806 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3807 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3808 - "Name": "string",
3809 - "IsArchived": true,
3810 - "Constraint": {
3811 - "CalculationType": 0,
3812 - "PermissibleBalance": 0,
3813 - "DefermentDays": 0
3814 - },
3815 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
353 + "inspectionTasks": [ // задания на ТО
3816 3816   {
3817 - "Feature": "string",
3818 - "IsFactual": true,
3819 - "Limit": 0,
3820 - "Price": 0,
3821 - "PeriodValue": 0,
3822 - "PeriodType": 0
3823 - }
3824 - ]
3825 - },
3826 - "DebitDate": "2023-10-18T12:46:24.213Z",
3827 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3828 - {
3829 - "Feature": "string",
3830 - "IsEnabled": true,
3831 - "IsPrivate": true,
3832 - "IsFactual": true,
3833 - "Limit": 0,
3834 - "Price": 0,
3835 - "DebitDate": "2023-10-18T12:46:24.213Z",
3836 - "PeriodValue": 0,
3837 - "PeriodType": 0
3838 - }
3839 - ]
3840 -}
355 + "id": "", // ID задачи
356 + "enabled": false, // Признак включения
357 + "name": "", // Имя задания
358 + "description": "", // Описание задания
359 + "mileageCondition": "", // Условие по пробегу
360 + "lastMileage": "", // Пробег (в метрах)
361 + "motohoursCondition": "", // Условие по моточасам
362 + "lastMotohours": "", // Моточасы
363 + "periodicCondition": "", // Условие периодичности по времени}}}
3841 3841  
3842 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3843 -|ClientId|Идентификатор клиента
3844 -|Id|Идентификатор тарифного плана
3845 -|OwnerId|Идентификатор клиента-владельца
3846 -|Name|Наименование тарифного плана
3847 -|IsArchived|Признак, определяющий архивный тарифный план
3848 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3849 -|PermissibleBalance|Допустимый баланс
3850 -|DefermentDays|Отсрочка, количество дней
3851 -|Feature|Код услуги
3852 -|IsEnabled|Признак, определяющий активирована ли услуга
3853 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3854 -|IsFactual|Признак, определяющий расчёт по факту
3855 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3856 -|Price|Цена за единицу.
3857 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3858 -|PeriodValue|Значение периода.
3859 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3860 -
3861 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3862 -
3863 -(% class="box infomessage" %)
3864 -(((
3865 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3866 -)))
3867 -
3868 -Параметр запроса: **clientId **- идентификатор клиента.
3869 -
3870 -Ответ:
3871 -
3872 -[
3873 - {
3874 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3875 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3876 - "Name": "string",
3877 - "IsArchived": true,
3878 - "Constraint": {
3879 - "CalculationType": 0,
3880 - "PermissibleBalance": 0,
3881 - "DefermentDays": 0
3882 - },
3883 - "Features": [
3884 - {
3885 - "Feature": "string",
3886 - "IsFactual": true,
3887 - "Limit": 0,
3888 - "Price": 0,
3889 - "PeriodValue": 0,
3890 - "PeriodType": 0
365 +{{{ "kind": "", // Вид периодичности по времени
366 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
3891 3891   }
3892 - ]
3893 - }
3894 -]
368 + ]}}}
3895 3895  
3896 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3897 -|ClientId|Идентификатор клиента
3898 -|Id|Идентификатор тарифного плана
3899 -|OwnerId|Идентификатор клиента-владельца
3900 -|Name|Наименование тарифного плана
3901 -|IsArchived|Признак, определяющий архивный тарифный план
3902 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3903 -|PermissibleBalance|Допустимый баланс
3904 -|DefermentDays|Отсрочка, количество дней
3905 -|Feature|Код услуги
3906 -|IsFactual|Признак, определяющий расчёт по факту
3907 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3908 -|Price|Цена за единицу.
3909 -|PeriodValue|Значение периода.
3910 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3911 -
3912 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3913 -
3914 -(% class="box infomessage" %)
3915 -(((
3916 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3917 -)))
3918 -
3919 -Параметр запроса: **clientId **- идентификатор клиента.
3920 -
3921 -Ответ:
3922 -
3923 -[
3924 - {
3925 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3926 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3927 - "Name": "string",
3928 - "IsArchived": true,
3929 - "Constraint": {
3930 - "CalculationType": 0,
3931 - "PermissibleBalance": 0,
3932 - "DefermentDays": 0
3933 - },
3934 - "Features": [
3935 - {
3936 - "Feature": "string",
3937 - "IsFactual": true,
3938 - "Limit": 0,
3939 - "Price": 0,
3940 - "PeriodValue": 0,
3941 - "PeriodType": 0
3942 - }
3943 - ]
3944 - }
3945 -]
3946 -
3947 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3948 -|ClientId|Идентификатор клиента
3949 -|Id|Идентификатор тарифного плана
3950 -|OwnerId|Идентификатор клиента-владельца
3951 -|Name|Наименование тарифного плана
3952 -|IsArchived|Признак, определяющий архивный тарифный план
3953 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3954 -|PermissibleBalance|Допустимый баланс
3955 -|DefermentDays|Отсрочка, количество дней
3956 -|Feature|Код услуги
3957 -|IsFactual|Признак, определяющий расчёт по факту
3958 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3959 -|Price|Цена за единицу.
3960 -|PeriodValue|Значение периода.
3961 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3962 -
3963 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
3964 -
3965 -(% class="box warningmessage" %)
3966 -(((
3967 -**PUT /api/v3/Billing/client/balance**
3968 -)))
3969 -
3970 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3971 -
3972 -Тело запроса:
3973 -
3974 -{
3975 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3976 - "Balance": 0
3977 3977  }
371 +
3978 3978  
3979 -Ответ: Success
373 + **Удаление объекта**
3980 3980  
3981 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3982 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3983 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
375 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
3984 3984  
3985 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
377 +Метод запроса: DELETE
3986 3986  
3987 -(% class="box warningmessage" %)
3988 -(((
3989 -**PUT /api/v3/billing/client/balance/deposit**
3990 -)))
379 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
3991 3991  
3992 -Создает операцию **Пополнение **с указанной суммой
381 +Параметр запроса: {id} - Guid объекта
3993 3993  
3994 -Тело запроса:
383 +В заголовках запроса: X-Auth: Токен авторизации
3995 3995  
3996 -{
3997 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3998 - "Balance": 0
3999 -}
4000 -
4001 -Ответ: Success
4002 -
4003 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4004 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4005 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4006 -
4007 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4008 -
4009 -Создает операцию **Списание **с указанной суммой
4010 -
4011 -(% class="box warningmessage" %)
4012 -(((
4013 -**PUT /api/v3/billing/client/balance/withdraw**
4014 -)))
4015 -
4016 -Тело запроса:
4017 -
4018 -{
4019 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4020 - "Balance": 0
4021 -}
4022 -
4023 -Ответ: Success
4024 -
4025 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4026 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4027 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4028 -
4029 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4030 -
4031 -(% class="box warningmessage" %)
4032 -(((
4033 -**PUT /api/v3/Billing/client/constraint**
4034 -)))
4035 -
4036 -Тело запроса:
4037 -
4038 -{
4039 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4040 - "CalculationType": 0,
4041 - "PermissibleBalance": 0,
4042 - "DefermentDays": 0,
4043 - "SendUiNotifications": true,
4044 - "SendEmailNotifications": true,
4045 - "IsPrivate": true,
4046 -}
4047 -
4048 -Ответ: Success
4049 -
4050 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4051 -|ClientId|Идентификатор клиента
4052 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4053 -|PermissibleBalance|Допустимый баланс
4054 -|DefermentDays|(((
4055 -Отсрочка, количество дней
4056 -)))
4057 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4058 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4059 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4060 -
4061 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4062 -
4063 -(% class="box warningmessage" %)
4064 -(((
4065 -**PUT /api/v3/Billing/client/plan**
4066 -)))
4067 -
4068 -Тело запроса:
4069 -
4070 -{
4071 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4072 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4073 - "Features": [
4074 - {
4075 - "Feature": "string",
4076 - "IsEnabled": true,
4077 - "IsFactual": true,
4078 - "Limit": 0,
4079 - "Price": 0,
4080 - "DebitDate": "2023-10-18T13:26:58.987Z",
4081 - "PeriodValue": 0,
4082 - "PeriodType": 0
4083 - }
4084 - ]
4085 -}
4086 -
4087 -Ответ: Success
4088 -
4089 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4090 -|ClientId|Идентификатор клиента
4091 -|PlanId|Идентификатор тарифного плана
4092 -|Feature|Код услуги
4093 -|IsEnabled|Признак, определяющий активирована ли услуга
4094 -|IsFactual|Признак, определяющий расчёт по факту
4095 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4096 -|Price|Цена за единицу.
4097 -|DebitDate|Следующий момент времени списания с баланса за услугу.
4098 -|PeriodValue|Значение периода.
4099 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4100 -
4101 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4102 -
4103 -(% class="box warningmessage" %)
4104 -(((
4105 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4106 -)))
4107 -
4108 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4109 -
4110 -(% class="box infomessage" %)
4111 -(((
4112 -**POST /api/v3/vehicles/import/{agentId}**
4113 -)))
4114 -
4115 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4116 -
4117 -В пути указывается **agentId** - id клиента.
4118 -
4119 -**Заголовок**
4120 -
4121 -**X-Auth: [токен авторизации]**
4122 -
4123 -**Параметры**
4124 -
4125 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4126 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4127 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4128 -
4129 -В теле использовать тип **form-data,** тип значения** file**
4130 -
4131 -**Ключи**
4132 -
4133 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4134 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
4135 -|csv|В значении передаем файл датчиков, формат **csv**
4136 -
4137 -Ответ:
4138 -
4139 -{
4140 - "vehicleId": 0,
4141 - "name": "string",
4142 - "errors": ["string"]
4143 -}
4144 -
4145 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4146 -|vehicleId|ID созданного объекта
4147 -|name|Имя созданного объекта
4148 -|errors|Ошибки и их описание
4149 -
4150 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4151 -
4152 -(% class="box infomessage" %)
4153 -(((
4154 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4155 -)))
4156 -
4157 -(% class="wikigeneratedid" %)
4158 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4159 -
4160 -(% class="wikigeneratedid" %)
4161 -В пути указывается **vehicleId **- id объекта.
4162 -
4163 -**Заголовок**
4164 -
4165 -**X-Auth: [токен авторизации]**
4166 -
4167 -В теле использовать тип **form-data.**
4168 -
4169 -Ключи:
4170 -
4171 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4172 -|**history**|В значении передавать файл с историей
4173 -
4174 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4175 -
4176 -Ответ:
4177 -
4178 -{
4179 - "results": [
4180 - {
4181 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4182 - "vehicleId": 0,
4183 - "errors": [
4184 - "string"
4185 - ],
4186 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
4187 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
4188 - "producedCount": 0,
4189 - "msgCount": 0
4190 - }
4191 - ]
4192 -}
4193 -
4194 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4195 -|results|Результаты импорта в разрезе ТС
4196 -|vehicleGuid|Guid ТС
4197 -|vehicleId|ID ТС
4198 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4199 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
4200 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4201 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
4202 -|msgCount|Кол-во обработанных сообщений всего
4203 -
4204 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4205 -
4206 -(% class="box infomessage" %)
4207 -(((
4208 -**GET /api/v3/vehicles/import/history/status**
4209 -)))
4210 -
4211 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4212 -
4213 -Ответ:
4214 -
4215 -{
4216 - "activity": true,
4217 - "progress": 0,
4218 - "message": "string"
4219 -}
4220 -
4221 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4222 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4223 -|progress|Guid ТС
4224 -
4225 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4226 -
4227 -(% class="box infomessage" %)
4228 -(((
4229 -**POST /api/v3/vehicles/export**
4230 -)))
4231 -
4232 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4233 -
4234 -Тело запроса:
4235 -
4236 -[
4237 - id
4238 -]
4239 -
4240 -Ответ: Success 200, получаете файлы с настройками.
4241 -
4242 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4243 -
4244 -(% class="box infomessage" %)
4245 -(((
4246 -**POST /api/v3/vehicles/export/history**
4247 -)))
4248 -
4249 -Метод возвращает список сообщений терминала объекта за выбранный период.
4250 -
4251 -Тело запроса:
4252 -
4253 -{
4254 - "vehicleId": 0,
4255 - "asArchive": true,
4256 - "from": "2023-09-27T12:17:45.973Z",
4257 - "to": "2023-09-27T12:17:45.973Z"
4258 -}
4259 -
4260 -Ответ:
4261 -
4262 -Получаете файл. Сообщение: Code 200/Success
4263 -
4264 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4265 -|vehicleId|ID объекта
4266 -|asArchive|true - Архивировать файл, False - не архивировать
4267 -|from|Дата и время начала запроса
4268 -|to|Дата и время окончания запроса
4269 -
4270 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4271 -
4272 -(% class="box infomessage" %)
4273 -(((
4274 -**GET /api/v3/vehicles/export/history/status**
4275 -)))
4276 -
4277 -Метод возвращает список сообщений терминала объекта за выбранный период.
4278 -
4279 -Ответ:
4280 -
4281 -{
4282 - "activity": true,
4283 - "progress": 0,
4284 - "message": "string"
4285 -}
4286 -
4287 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4288 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4289 -|progress|Прогресс экспорта, от 0 до 100%
4290 -|message|Текст описывающий статус
4291 -
4292 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4293 -
4294 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4295 -
4296 -(% class="box infomessage" %)
4297 -(((
4298 -**POST /api/v3/EcoDriving/rating**
4299 -)))
4300 -
4301 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4302 -
4303 -Тело запроса:
4304 -
4305 -{
4306 - "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4307 - "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4308 - "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4309 -}
4310 -
4311 -Ответ:
4312 -
4313 -{
4314 - "items": [  ~/~/ Список в разрезе ТС
4315 - {
4316 - "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4317 - "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4318 - "vehicleId": 0, ~/~/ ID ТС
4319 - "vehicleName": "string", ~/~/ Название ТС
4320 - "vehicleModel": "string", ~/~/ Модель ТС
4321 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4322 - "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4323 - "totalViolations": 0, ~/~/ Нарушений всего
4324 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4325 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4326 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4327 - "brakingViolations": 0, ~/~/ Нарушений торможения
4328 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4329 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4330 - "sensorViolations": 0 ~/~/ Нарушений по датчику
4331 - },
4332 -
4333 -(((
385 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
4334 4334  
4335 -)))
4336 4336  
4337 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4338 - "mileage": 0, ~/~/ Пробег, м
4339 - "tripsCount": 0, ~/~/ Кол-во рейсов
4340 - "trips": [  ~/~/ Информация по рейсу
4341 - {
4342 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4343 - "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4344 - "violationsCount": 0, ~/~/ Всего нарушений
4345 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4346 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4347 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4348 - "brakingViolations": 0, ~/~/ Нарушений торможения
4349 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4350 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4351 - "sensorViolations": 0 ~/~/ Нарушений по датчику
4352 - },
388 + **Редактирование объекта**
4353 4353  
4354 - "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4355 - "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4356 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4357 - "mileage": 0, ~/~/ Пробег, м
4358 - "motohours": 0, ~/~/ Моточасы, секунды
4359 - "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4360 - "startAddress": "string", ~/~/ Адрес начала рейса
4361 - "endAddress": "string", ~/~/ Адрес конца рейса
4362 - "drivers": [  ~/~/ Список водителей
4363 - {
4364 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4365 - "driverName": "string", ~/~/ФИО водителя
4366 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4367 - }
4368 - ]
4369 - }
4370 - ]
4371 - }
4372 - ]
4373 -}
390 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
4374 4374  
4375 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
392 +Метод запроса: PUT
4376 4376  
4377 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
394 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
4378 4378  
4379 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
396 +В заголовках запроса: X-Auth: Токен авторизации
4380 4380  
4381 -(% class="box infomessage" %)
4382 -(((
4383 -POST /api/v3/fuelcards/transactions
4384 -)))
4385 -
4386 -Метод запроса: POST
4387 -
4388 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4389 -\\В заголовках запроса: X-Auth: Токен авторизации
4390 -
4391 4391  Параметры в теле запроса (JSON):
4392 4392  
4393 -{
4394 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4395 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4396 - "ids": [ 
4397 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4398 - ],
4399 - "timezone": 0 ~/~/Таймзона
4400 -}
400 +//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }
4401 4401  
4402 -
4403 4403  Ответ:
4404 - {
4405 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4406 - "driver": "string", ~/~/Водители, привязанные к ТК
4407 - "object": "string", ~/~/Наименование ТС
4408 - "amount": 0, ~/~/Количество топлива
4409 - "amountDut": 0, ~/~/Количество по ДУТ
4410 - "amountDiff": 0, ~/~/Разница, л
4411 - "amountDiffPerc": 0, ~/~/Разница, %
4412 - "summa": 0, ~/~/Стоимость, руб
4413 - "serviceName": "string", ~/~/Тип топлива
4414 - "price": 0, ~/~/Цена за литр, руб
4415 - "cardName": "string", ~/~/Наименование ТК
4416 - "cardNum": "string", ~/~/Номер ТК
4417 - "operator": "string", ~/~/Оператор ТК
4418 - "address": "string" ~/~/Адрес АЗС
4419 - }
4420 4420  
404 +{ «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»: «» //Сколько раз выполнить задание } ] }
405 +
4421 4421  
4422 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
407 + **Изменение статуса объекта**
4423 4423  
409 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
4424 4424  
4425 -== **Получение полных данных о ретрансляторе** ==
411 +Метод запроса: POST
4426 4426  
4427 -(% class="box infomessage" %)
4428 -(((
4429 -**GET ** **/api/v3/retranslations/{id}**
4430 -)))
413 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
4431 4431  
4432 -Идентификатор запроса: ID
415 +Параметр запроса: {vehicleId} - ID ТС
4433 4433  
417 +В заголовках запроса: X-Auth: Токен авторизации
4434 4434  
4435 -Пример ответа:
419 +Параметры в теле запроса (JSON): {
4436 4436  
4437 -{  
4438 -"description": "", ~/~/ Определяет описание
4439 -"subscriberId": "", ~/~/ Подписчик
4440 -"protocolType": 0, ~/~/ Тип протокола
4441 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4442 -"address": "string", ~/~/ Адрес события
4443 -"objects": [ ~/~/Объекты для ретрансляции
4444 -{      
4445 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4446 -"name": "", ~/~/ Наименование объекта ретрансляции
4447 -"imei": "", ~/~/ IMEI объекта  
4448 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4449 -}
4450 - ],  
4451 -"id": "", ~/~/ идентификатор пользователя   
4452 -"parentId": "", ~/~/Guid родителя
4453 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4454 -}
421 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
422 + "date": "", // Дата смены статуса (null если сменить немедленно)
423 + "description": "", // Описание
424 + "data": "", // Данные
425 + "overwrite": false, // Флаг перезаписи
426 + "stage": "", // Состояние, может быть null}}}
4455 4455  
4456 -
4457 -== **Удаление данных ретранслятора** ==
4458 -
4459 -(% class="box infomessage" %)
4460 -(((
4461 -**DELETE** **/api/v3/retranslations/{id}**
4462 -)))
4463 -
4464 -Параметр запроса: ID
4465 -
4466 -
4467 -== **Создание ретранслятора** ==
4468 -
4469 -(% class="box infomessage" %)
4470 -(((
4471 -**POST ** **/api/v3/retranslations/{id}**
4472 -)))
4473 -
4474 -Запрос:
4475 -
4476 -{  
4477 -"description": "", ~/~/ Описание
4478 -"subscriberId": "", ~/~/ Подписчик
4479 -"protocolType": 0, ~/~/ Тип протокола
4480 -"address": "", ~/~/ Адрес ретрансляции
4481 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4482 -"objects": [ ~/~/Объекты для ретрансляции
4483 -{      
4484 -"id": "", ~/~/ идентификатор пользователя     
4485 -"imei": "", ~/~/IMEI объекта
4486 -"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4487 4487  }
4488 - ]
4489 -}
4490 4490  
430 +Ответ: {
4491 4491  
4492 -Ответ:
432 +{{{ "status": "", // значение статуса
433 + "date": "", // Дата смены статуса
434 + "description": "", // Описание
435 + "data": "", // Данные
436 + "overwrite": false, // Флаг перезаписи
437 + "stage": "", // Состояние}}}
4493 4493  
4494 -{  
4495 -"description": "string", ~/~/ Определяет описание
4496 -"subscriberId": "", ~/~/ идентификатор запроса
4497 -"protocolType": 0, ~/~/ Тип протокола
4498 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4499 -"address": "", ~/~/ Адрес события
4500 -"objects": [ ~/~/Объекты для ретрансляции
4501 -{      
4502 -"id": "", ~/~/ идентификатор пользователя    
4503 -"name": "string", ~/~/ Название уведомления
4504 -"imei": "string", ~/~/IMEI объекта  
4505 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4506 4506  }
4507 - ],  
4508 -"id": "", ~/~/ идентификатор пользователя  
4509 -"parentId": "", ~/~/ Guid идентификатор родителя
4510 -"deleted": true ~/~/ Признак удаления
4511 -}
4512 -
4513 -
4514 -== **Редактирование ретранслятора** ==
4515 -
4516 -(% class="box infomessage" %)
4517 -(((
4518 -**PUT** **/api/v3/retranslations**
4519 -)))
4520 -
4521 -Пример запроса:
4522 -
4523 -{  
4524 -"id": "", ~/~/ идентификатор пользователя   
4525 -"description": "string", ~/~/ Определяет описание
4526 -"subscriberId": "", ~/~/ идентификатор запроса
4527 -"protocolType": 0, ~/~/ Тип протокола
4528 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4529 -"address": "string", ~/~/ Адрес события
4530 -"objects": ~/~/Объекты для ретрансляции
4531 -[    
4532 -{      
4533 -"id": "",  ~/~/ идентификатор пользователя         
4534 -"imei": "", ~/~/IMEI объекта
4535 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4536 -}
4537 - ]
4538 -}
4539 -
4540 -
4541 -Пример ответа:
4542 -
4543 -{  
4544 -"description": "", ~/~/ Определяет описание
4545 -"subscriberId": "", ~/~/ идентификатор запроса
4546 -"protocolType": 0, ~/~/ Тип протокола
4547 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4548 -"address": "string", ~/~/ Адрес события
4549 -"objects": [ ~/~/Объекты для ретрансляции
4550 -{      
4551 -"id": "", ~/~/ идентификатор пользователя     
4552 -"name": "string", ~/~/ Название уведомления    
4553 -"imei": "", ~/~/IMEI объекта
4554 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4555 -}
4556 - ],
4557 -"id": "", ~/~/ идентификатор пользователя   
4558 -"parentId": "", ~/~/ Guid идентификатор родителя
4559 -"deleted": true ~/~/ Признак удаления
4560 -}
4561 -
4562 -
4563 -== **Получение списка ретранслятора клиента** ==
4564 -
4565 -(% class="box infomessage" %)
4566 -(((
4567 -**POST /api/v3/retranslations/find**
4568 -)))
4569 -
4570 -Пример запроса:
4571 -
4572 -{  
4573 -"id": "", ~/~/ идентификатор пользователя   
4574 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4575 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4576 -}
4577 -
4578 -Ответ:
4579 -
4580 -[ 
4581 -{    
4582 -"description": "", ~/~/ Определяет описание
4583 -"subscriberId": "", ~/~/ идентификатор запроса
4584 -"protocolType": 0, ~/~/ Тип протокола
4585 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4586 -"address": "string", ~/~/ Адрес события
4587 -"id": "", ~/~/ идентификатор пользователя   
4588 -"parentId": "", ~/~/ Guid идентификатор родителя
4589 -"deleted": true ~/~/ Признак удаления
4590 -}
4591 -]
4592 -
4593 -
4594 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4595 -
4596 -== **API для отчета по выгрузке комбайнов** ==
4597 -
4598 -(% class="box infomessage" %)
4599 -(((
4600 -POST **/api/v3/Reports/harvesterUnloading**
4601 -)))
4602 -
4603 -Пример запроса:
4604 -
4605 -{
4606 - "byTime": 0, ~/~/ Объединение событий по времени
4607 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4608 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4609 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4610 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4611 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4612 - 0
4613 - ],
4614 - "from": "", ~/~/ Дата и время начало запроса
4615 - "to": "", ~/~/ Дата и время окончания запроса
4616 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4617 -}
4618 -
4619 -Пример ответа:
4620 -
4621 -[ 
4622 - {
4623 - "harvesterName": "", ~/~/Комбайн, номер
4624 - "harvesterId": 0, ~/~/Комбайн, id
4625 -"harvesterModel": "", ~/~/ Модель комбайна
4626 -"hopperCapacity": 0, ~/~/ Объем бункера м3
4627 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4628 - "events": [ ~/~/Список событий в разрезе комбайна
4629 - {
4630 - "driverId": "", ~/~/Идентификатор водителя
4631 - "driverName": "", ~/~/Водитель комбайна, ФИО
4632 - "RFID": "", ~/~/ идентификатор карты-метки
4633 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4634 - "vehicleId": 0, ~/~/идентификатор объекта
4635 - "vehicleName": "string", ~/~/ Имя объекта
4636 - "modelName": "string", ~/~/ Имя модели объекта
4637 - "nearestVehicles": [ ~/~/Объекты рядом
4638 - {
4639 - "vehicleId": 0, ~/~/идентификатор объекта
4640 - "vehicleName": "string" ~/~/ Имя объекта
4641 - }
4642 - ],
4643 - "fields": [ ~/~/Поля, где происходила выгрузка
4644 - {
4645 - "id": 0, ~/~/ идентификатор пользователя 
4646 - "name": "string" ~/~/ имя пользователя 
4647 - }
4648 - ],
4649 - "event": "string", ~/~/Событие
4650 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4651 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4652 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4653 - "cultureName": "string", ~/~/ название культуры
4654 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4655 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4656 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4657 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4658 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4659 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4660 - "issued": 0, ~/~/Выдано, бункеров
4661 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4662 - "latitude": 0, ~/~/Широта
4663 - "longitude": 0, ~/~/ Долгота
4664 - "litresAway": 0, ~/~/Отдано, л
4665 - "m3Away": 0 ~/~/Отдано, м3
4666 - }
4667 - ]
4668 - }
4669 -]
4670 -
4671 -
4672 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4673 -
4674 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4675 -
4676 -
4677 -(% class="box infomessage" %)
4678 -(((
4679 -GET api/v3/Vehicles/recyclebin/all
4680 -)))
4681 -
4682 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4683 -
4684 -Параметр запроса: {parentId} - идентификатор агента
4685 -
4686 -В заголовках запроса: X-Auth: Токен авторизации
4687 -
4688 -Ответ:
4689 -
4690 -[ 
4691 - {
4692 - "recordTime": "", ~/~/Время записи
4693 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4694 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4695 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4696 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4697 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4698 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4699 - "items": [ ~/~/ 
4700 -nullable: true ~/~/Детали
4701 - {
4702 - "name": "string", ~/~/наименование столбца
4703 - "value": "string" ~/~/содержание столбца
4704 - }
4705 - ]
4706 - },
4707 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4708 - "string"
4709 - ]
4710 - }
4711 -]
4712 -
4713 -
4714 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4715 -
4716 -(% class="box infomessage" %)
4717 -(((
4718 -POST/api/v3/Vehicles/recyclebin/erase
4719 -)))
4720 -
4721 -В заголовках запроса: X-Auth: Токен авторизации
4722 -
4723 -Пример запроса:
4724 -
4725 -[
4726 -0
4727 -]
4728 4728  
4729 4729  
4730 -Пример ответа:
442 + **Проверка авторизации**
4731 4731  
4732 -[ 
4733 -{
4734 - "recordTime": "", ~/~/Время записи
4735 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4736 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4737 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
4738 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4739 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4740 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4741 - "items": [ ~/~/Детали
4742 - {
4743 - "name": "", ~/~/Имя свойства
4744 - "value": "" ~/~/Значение свойства
4745 - }
4746 - ]
4747 - },
4748 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4749 - ""
4750 - ]
4751 - }
4752 -]
444 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
4753 4753  
4754 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
446 +Метод запроса: GET
4755 4755  
4756 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
448 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
4757 4757  
4758 -(% class="box infomessage" %)
4759 -(((
4760 -POST/api/v3/Vehicles/recyclebin/restore
4761 -)))
4762 -
4763 4763  В заголовках запроса: X-Auth: Токен авторизации
4764 4764  
4765 -Параметры в теле запроса (JSON):
452 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
4766 4766  
4767 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4768 -
4769 -В заголовках запроса: X-Auth: Токен авторизации
4770 -
4771 -
4772 -Пример запроса:
4773 -
4774 -(((
4775 -[
4776 -)))
4777 -
4778 -(((
4779 - 0
4780 -)))
4781 -
4782 -(((
4783 -]
4784 -)))
4785 -
4786 -
4787 -Пример ответа:
4788 -
4789 -[
4790 -{
4791 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4792 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4793 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4794 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
4795 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4796 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4797 - "details": { ~/~/Список деталей объекта, помещённого в корзину
4798 - "items": [ ~/~/Детали
4799 - {
4800 - "name": "string", ~/~/Имя свойства
4801 - "value": "string" ~/~/Значение свойства
4802 - }
4803 - ]
4804 - },
4805 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4806 - "string"
4807 - ]
4808 - }
4809 -]
4810 -
4811 -
4812 -
4813 -(% class="box" lang="en-US" style="text-align: center;" %)
4814 -(((
4815 -(% 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]] **
4816 -)))
454 +**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

ГЛОНАССSoft wiki - 2024 г.