<
From version < 15.2 >
edited by Артем Шемяков
on 2022/09/01 15:29
To version < 28.7 >
edited by Артем Шемяков
on 2022/09/22 10:16
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Tags
... ... @@ -1,0 +1,1 @@
1 +Public API|API
Content
... ... @@ -1,5 +1,5 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -== Описание ГЛОНАССSoft Public API ==
2 +== Описание ГЛОНАССSoft Public API 3.0 ==
3 3  
4 4  == ==
5 5  
... ... @@ -10,7 +10,7 @@
10 10  
11 11  (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12 12  
13 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
13 +(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
... ... @@ -17,39 +17,44 @@
17 17  
18 18  (% class="box" style="text-align: center;" %)
19 19  (((
20 -(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
20 +(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 21  )))
22 22  
23 -(% class="box infomessage" %)
23 +(% class="box successmessage" %)
24 24  (((
25 -(% style="color:#000000" %)**Получение основных параметров клиента **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
25 + (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)** **(% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
27 27  
28 -(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
28 +(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 29  
30 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
30 +(% style="color:#000000" %)Метод запроса: **POST**
31 31  
32 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
32 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %) информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35 35  
36 -(% style="color:#000000" %)Метод запроса: **GET**
36 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
38 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
38 +(% style="color:#000000" %){
39 + "login": "testuser",
40 + "password": "testuser"
41 +}(%%)
42 +
39 39  
40 -(% style="color:#000000" %)Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
44 +(% style="color:#000000" %)**Ответ:**
41 41  
42 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
46 +(% lang="en-US" %)
47 +(% style="color:#000000" %){
43 43  
44 -(% style="color:#000000" %)Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
49 +(% lang="en-US" %)
50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 + "User": "testuser" , ~/~/ имя пользователя
45 45  
46 -(% style="color:#000000" %)Примечание. Возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
53 +(% lang="en-US" %)
54 +}
47 47  
56 +**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
48 48  
49 -(% class="box" style="text-align: center;" %)
50 -(((
51 -(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
52 -)))
53 53  
54 54  (% class="box infomessage" %)
55 55  (((
... ... @@ -56,7 +56,7 @@
56 56  (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
57 57  )))
58 58  
59 -(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
64 +(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
60 60  
61 61  (% style="color:#000000" %)Метод запроса: **GET**
62 62  
... ... @@ -68,117 +68,166 @@
68 68  (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
69 69  
70 70  
71 -(% class="box infomessage" %)
76 +(% class="box" style="text-align: center;" %)
72 72  (((
73 -(% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/login**
78 +(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
74 74  )))
75 75  
76 -(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
77 -
78 -(% style="color:#000000" %)Метод запроса: **GET**
79 -
80 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
81 -
82 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
83 -
84 -(% lang="en-US" %)
85 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
86 -
87 -**Примечание: **Время жизни токена авторизации задается через настройки пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
88 -
89 -(% class="box" lang="en-US" style="text-align: center;" %)
90 -(((
91 -(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
92 -)))
93 -
94 94  (% class="box infomessage" %)
95 95  (((
96 -(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
83 +(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
97 97  )))
98 98  
99 -(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
86 +(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
100 100  
88 +(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89 +
90 +(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91 +
92 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93 +
101 101  (% style="color:#000000" %)Метод запроса: **GET**
102 102  
103 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
96 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
104 104  
98 +(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
99 +
105 105  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
106 106  
107 -(% style="color:#000000" %)Ответ: [
102 +(% style="color:#000000" %)Ответ:
108 108  
109 -(% class="western" %)
110 -{{{ {
111 - "deviceTypeId" : "", // ID типа устройства
112 - "deviceTypeName" : "" // Название типа устройства
113 - },}}}
104 +(% style="color:#000000" %){
105 + "agentId": "", ~/~/ идентификатор клиента
106 + "parentId": "", ~/~/ идентификатор клиента-родителя
107 + "name": "", ~/~/ наименование клиента
108 + "fullName": "", ~/~/ полное наименование клиента
109 + "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 + "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 +}
114 114  
115 -(% style="text-align:left" %)
116 -(% style="color:#000000" %)…** **]
117 117  
118 -
119 119  (% class="box" style="text-align: center;" %)
120 120  (((
121 -(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
116 +(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
122 122  )))
123 123  
124 -(% class="box infomessage" %)
119 +(% class="box successmessage" %)
125 125  (((
126 -(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
121 +(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
127 127  )))
128 128  
129 -(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
124 +(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
130 130  
131 -(% style="color:#000000" %)Метод запроса: **GET**
126 +(% style="color:#000000" %)Метод запроса: **POST**
132 132  
133 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
128 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
134 134  
135 -(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
130 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
136 136  
137 -(% style="color:#000000" %)Ответ: [
132 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
138 138  
139 -(% class="western" style="margin-bottom:19px" %)
140 -{{{ {}}}
134 +(% style="color:#000000" %){ 
135 + "lastName": "", ~/~/ фамилия
136 + "firstName": "", ~/~/ имя
137 + "position": "", ~/~/ должность
138 + "phone": "", ~/~/ телефон
139 + "organization": "", ~/~/ организация
140 + "login": "", ~/~/ логин
141 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 + "email": "", ~/~/ email
143 + "description": "", ~/~/ описание
144 + "isEnabled": "", ~/~/ признак включения
145 + "parentId": "", ~/~/ Guid родительского агента
146 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 + "groups": "" , ~/~/ группы пользователя, названия групп
152 +}
141 141  
142 -(% style="color:#000000" %)«id»: «», //ID типа датчика «name»: «», //Название
154 +(% style="text-align:left" %)
155 +(% style="color:#000000; font-weight:normal" %)Ответ:
143 143  
144 -(% class="western" %)
145 -{{{ "description": "" // Описание
146 - },}}}
157 +(% style="text-align:left" %)
158 +(% style="color:#000000; font-weight:normal" %){    
147 147  
148 148  (% style="text-align:left" %)
149 -(% style="color:#000000" %)… ]
161 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
162 + "lastName": "" , ~/~/ Фамилия ,
163 + "firstName": "" , ~/~/ Имя
164 + "position": "" , ~/~/ Должность
165 + "phone": "" , ~/~/ Телефон
166 + "organization": "" , ~/~/ Организация
167 + "login": "" , ~/~/ Логин
168 + "password": "" , ~/~/ Пароль
169 + "email": "" , ~/~/ Email
170 + "description": "" , ~/~/ Описание
171 + "isEnabled": "" , ~/~/ Признак включения
172 + "parentId": "" , ~/~/ Guid родительского агента
173 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
174 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 + "kind": "" , ~/~/ тип аутентификации
176 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
150 150  
179 +(% style="text-align:left" %)
180 +(% style="color:#000000; font-weight:normal" %)}
151 151  
152 -(% class="box" style="text-align: center;" %)
153 -(((
154 -(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
155 -)))
156 156  
157 157  (% class="box successmessage" %)
158 158  (((
159 -(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
185 +(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
160 160  )))
161 161  
162 -(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
188 +(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
163 163  
190 +(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191 +
164 164  (% style="color:#000000" %)Метод запроса: **POST**
165 165  
166 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
194 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
167 167  
168 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
196 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
169 169  
170 -(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
198 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
171 171  
172 -(% style="text-align:left" %)
173 -(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
200 +(% style="color:#000000" %){
174 174  
202 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
203 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
204 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
175 175  
207 +(% style="color:#000000" %)}
208 +
209 +(% style="color:#000000" %)Ответ:
210 +
211 +(% style="color:#000000" %){         (%%)
212 +
213 + "id": "" , ~/~/ идентификатор пользователя
214 + "lastName": "" , ~/~/ фамилия
215 + "firstName": "" , ~/~/ имя
216 + "position": "" , ~/~/ должность
217 + "phone": "" , ~/~/ телефон
218 + "parentId": "" , ~/~/ идентификатор клиента-родителя
219 + "parentName": "" , ~/~/ наименование клиента-родителя
220 + "organization": "" , ~/~/ организация
221 + "login": "" , ~/~/ логин
222 + "email": "" , ~/~/ E-mail
223 + "sessionDuration":"", ~/~/ длительность сессии в минутах
224 + "status": "1",  ~/~/ статус пользователя
225 + "astLogged": "", ~/~/ дата/время последней авторизации
226 +
227 +(% style="color:#000000" %)}
228 +
229 +
176 176  (% class="box warningmessage" %)
177 177  (((
178 178  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
179 179  )))
180 180  
181 -(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
235 +(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
182 182  
183 183  (% style="color:#000000" %)Метод запроса: **PUT**
184 184  
... ... @@ -187,62 +187,90 @@
187 187  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
188 188  
189 189  (% lang="en-US" style="text-align:left" %)
190 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }  //
244 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
191 191  
246 +(% lang="en-US" style="text-align:left" %)
247 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
192 192  
193 -(% class="box warningmessage" %)
194 -(((
195 -(% style="color:#000000" %)**Изменить статус пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
196 -)))
249 +(% lang="en-US" style="text-align:left" %)
250 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
251 + "lastName": "" , ~/~/ фамилия
252 + "firstName": "" , ~/~/ имя
253 + "position": "" , ~/~/ должность
254 + "phone": "" , ~/~/ телефон
255 + "organization": "" , ~/~/ организация
256 + "login": "" , ~/~/ логин
257 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 + "email": "" , ~/~/ email
259 + "description": "" , ~/~/ описание
260 + "isEnabled": "" , ~/~/ признак включения
261 + "parentId": "" , ~/~/ Guid родительского агента
262 + "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
263 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
264 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
265 + "kind": "" , ~/~/ тип аутентификации
266 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
267 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
197 197  
198 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
269 +(% lang="en-US" style="text-align:left" %)
270 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
199 199  
200 -(% style="color:#000000" %)Метод запроса: **PUT**
272 +(% lang="en-US" style="text-align:left" %)
273 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
201 201  
202 -(% 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} Параметр запроса:
275 +(% lang="en-US" style="text-align:left" %)
276 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
203 203  
204 -(% style="color:#000000" %){id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»~:// «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
278 +(% lang="en-US" style="text-align:left" %)
279 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
280 + "lastName": "" , ~/~/ фамилия
281 + "firstName": "" , ~/~/ имя
282 + "position": "" , ~/~/ должность
283 + "phone": "" , ~/~/ телефон
284 + "organization": "" , ~/~/ организация
285 + "login": "" , ~/~/ логин
286 + "password": "" , ~/~/ пароль 
287 + "email": "" , ~/~/ email
288 + "description": "" , ~/~/ описание
289 + "isEnabled": "" , ~/~/ признак включения
290 + "parentId": "" , ~/~/ Guid родительского агента
291 + "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
292 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
293 + "kind": "" , ~/~/ тип аутентификации
294 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
295 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
205 205  
206 -(% class="western" %)
207 -{{{ "description": "", // описание
208 - "data": "" // данные, связанные со сменой статуса}}}
297 +(% lang="en-US" style="text-align:left" %)
298 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
209 209  
210 -(% style="color:#000000" %)}
211 211  
212 -(% style="text-align:left" %)
213 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
214 -
215 -
216 -(% class="box successmessage" %)
301 +(% class="box warningmessage" %)
217 217  (((
218 -(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
303 +(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
219 219  )))
220 220  
221 -(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
306 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
222 222  
223 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«Просмотр пользователей»**.
308 +(% style="color:#000000" %)Метод запроса: **PUT**
224 224  
225 -(% style="color:#000000" %)Метод запроса: **POST**
310 +(% 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}
226 226  
227 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
312 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
228 228  
229 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
314 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
230 230  
231 -(% class="western" %)
232 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
233 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
234 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
235 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
316 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
236 236  
237 -(% style="color:#000000" %)}
318 +(% style="color:#000000" %){
238 238  
239 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
320 + "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
321 + "description": "" , ~/~/ описание
322 + "data": "" , ~/~/ данные, связанные со сменой статуса
240 240  
241 -(% class="western" style="margin-bottom:19px" %)
242 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
324 +(% style="color:#000000" %)}
243 243  
244 -(% lang="en-US" style="text-align:left" %)
245 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
326 +(% style="text-align:left" %)
327 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
246 246  
247 247  
248 248  (% class="box errormessage" %)
... ... @@ -250,14 +250,16 @@
250 250  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
251 251  )))
252 252  
253 -(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
335 +(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
254 254  
255 255  (% style="color:#000000" %)Метод запроса: **DELETE**
256 256  
257 257  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
258 258  
259 -(% style="color:#000000" %)Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
341 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
260 260  
343 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
344 +
261 261  (% style="text-align:left" %)
262 262  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
263 263  
... ... @@ -267,25 +267,6 @@
267 267  (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
268 268  )))
269 269  
270 -(% class="box errormessage" %)
271 -(((
272 -(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
273 -)))
274 -
275 -(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
276 -
277 -(% style="color:#000000" %)Метод запроса: **DELETE**
278 -
279 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
280 -
281 -(% style="color:#000000" %)Параметр запроса: {id} - Guid объекта
282 -
283 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
284 -
285 -(% style="text-align:left" %)
286 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
287 -
288 -
289 289  (% class="box infomessage" %)
290 290  (((
291 291  (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
... ... @@ -293,17 +293,17 @@
293 293  
294 294  (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
295 295  
296 -(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
361 +(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
297 297  
298 298  (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
299 299  
300 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«Просмотр заданий на техобслуживание»**.
365 +(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
301 301  
302 302  (% style="color:#000000" %)Метод запроса: **GET**
303 303  
304 304  (% 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>
305 305  
306 -(% style="color:#000000" %)Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
371 +(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
307 307  
308 308  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
309 309  
... ... @@ -311,24 +311,20 @@
311 311  
312 312  (% style="color:#000000" %){
313 313  
314 -(% class="western" %)
315 -{{{ "vehicleId": “”, // идентификатор объекта
316 - "name": "", // имя объекта
317 - "imei": "", // IMEI объекта
318 - "deviceTypeId": “”, // идентификатор устройства объекта
319 - "deviceTypeName": "" // наименование устройства объекта
320 - "parentId": "", // идентификатор клиента-родителя
321 - "parentName": "" // наименование клиента-родителя,
322 - "modelId": "", // идентификатор модели объекта
323 - "modelName": "" // наименование модели объекта,
324 - "unitId": "", // идентификатор подразделения
325 - "unitName": "", // наименование подразделения
326 - "status": “”, // статус объекта
327 - ...
328 - },
329 - ...}}}
379 + "vehicleId": "" , ~/~/ идентификатор объекта
380 + "name": "" , ~/~/ имя объекта
381 + "imei": "" , ~/~/ IMEI объекта
382 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
383 + "deviceTypeName": "" , ~/~/ наименование устройства объекта
384 + "parentId": "" , ~/~/ идентификатор клиента-родителя
385 + "parentName": "" , ~/~/ наименование клиента-родителя,
386 + "modelId": "" , ~/~/ идентификатор модели объекта
387 + "modelName": "" , ~/~/ наименование модели объекта,
388 + "unitId": "" , ~/~/ идентификатор подразделения
389 + "unitName": "" , ~/~/ наименование подразделения
390 + "status": "" , ~/~/ статус объекта
330 330  
331 -(% style="color:#000000" %)}
392 +}
332 332  
333 333  (% style="text-align:left" %)
334 334  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -342,7 +342,7 @@
342 342  (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
343 343  )))
344 344  
345 -(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**, //Content-Type//: **application/json**; //charset//=**utf-8**).
406 +(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
346 346  
347 347  (% style="color:#000000" %)Метод запроса: **POST**
348 348  
... ... @@ -350,235 +350,429 @@
350 350  
351 351  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
352 352  
353 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
414 +(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
354 354  
355 -(% class="western" %)
356 -{{{ "parentId": "", // ID клиента
357 - "name": "", // имя ТС
358 - "imei": "", // IMEI
359 - "deviceTypeId": "",// ID типа устройства
360 - "modelId": "",
361 - "unitId": "", // ID подразделения
362 - "sim1": "", // Номер SIM 1
363 - "sim2": "", // Номер SIM2
364 - "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
365 - "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
366 - "consumptionIdle": "",// Расход топлива на холостом ходу
367 - "counters": {
368 - "mileage": "", // пробег
369 - "mileageEnabled": true, // флаг активности счётчика "пробег"
370 - "motohours":"", // моточасы
371 - "motohoursEnabled": true // флаг активности счётчика "моточасы"
372 - },
373 - "cmsv6Parameters": { // параметры CMSv6
374 - "enabled": true, // флаг включения
375 - //"id": "", // идентификатор
376 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
377 - "login": "", // имя учетной записи
378 - "password": "" // пароль учетной записи
379 - },
380 - "inspectionTasks": [ // задания на ТО
416 +(% style="color:#000000" %){
417 +
418 + "parentId": "" , ~/~/ ID клиента
419 + "name": "" , ~/~/ имя ТС
420 + "imei": "" , ~/~/ IMEI
421 + "deviceTypeId": "" , ~/~/ ID типа устройства
422 + "modelId": "" , ~/~/ ID модели
423 + "unitId": "" , ~/~/ ID подразделения
424 + "sim1": "" , ~/~/ Номер SIM 1
425 + "sim2": "" , ~/~/ Номер SIM2
426 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
427 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
428 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
429 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
430 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
431 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
432 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
433 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
434 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
435 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
436 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
437 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
438 + "counters": ~/~/ счетчики
381 381   {
382 - "enabled": "", // Признак включения
383 - "name": "", // Имя задания
384 - "description": "", // Описание задания
385 - "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
386 - "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
387 - "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
388 - "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
389 - "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
390 - "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
391 - "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
392 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
440 + "mileage": "" , ~/~/ пробег
441 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
442 + "motohours": "" , ~/~/ моточасы
443 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
393 393   },
394 - ]}}}
445 + "cmsv6Parameters": { ~/~/ параметры CMSv6
446 + "enabled": true, ~/~/ флаг включения
447 + "id": "" , ~/~/ идентификатор
448 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
449 + "login": "" , ~/~/ имя учетной записи
450 + "password": "" ~/~/ пароль учетной записи
451 + },
452 + "inspectionTasks": ~/~/ задания на ТО
453 + {
454 + "enabled": "" , ~/~/ Признак включения
455 + "name": "" , ~/~/ Имя задания
456 + "description": "" , ~/~/ Описание задания
457 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
458 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
459 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
460 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
461 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
462 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
463 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
464 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
465 + }
395 395  
396 -(% style="color:#000000" %) }
467 +(% style="color:#000000" %) }
397 397  
398 398  (% style="color:#000000" %)Ответ:
399 399  
400 400  (% style="color:#000000" %){
401 401  
402 -(% class="western" %)
403 -{{{ "vehicleId": "", //ID ТС
404 - "parentId": "", //Guid владельца ТС
405 - "name": "", //Имя объекта
406 - "imei": "", //IMEI
407 - "deviceTypeId": "", //ID типа устройства
408 - "modelId": "", //ID модели
409 - "unitId": "", //ID подразделения
410 - "sim1": "", //SIM1
411 - "sim2": "", //SIM2
412 - "consumptionPer100Km": "", //Расход топлива на 100 км
413 - "consumptionIdle": "", //Расход топлива на холостом ходу
414 - "counters": { //Счётчики
415 - "mileageEnabled": true,
416 - "motohoursEnabled": true,
417 - "mileage": "",
418 - "motohours": 345.0
419 - },
420 - "cmsv6Parameters": { //Параметры CmsV6
421 - "id": null,
422 - "enabled": true, //флаг включения
423 - "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
424 - "login": "", // имя учетной записи
425 - "password": "" // пароль учетной записи
426 - },
427 - "inspectionTasks": [ // задания на ТО
428 - {
429 - "id": "", // ID задачи
430 - "enabled": false, // Признак включения
431 - "name": "", // Имя задания
432 - "description": "", // Описание задания
433 - "mileageCondition": "", // Условие по пробегу
434 - "lastMileage": "", // Пробег (в метрах)
435 - "motohoursCondition": "", // Условие по моточасам
436 - "lastMotohours": "", // Моточасы
437 - "periodicCondition": "", // Условие периодичности по времени
438 - "kind": "", // Вид периодичности по времени
439 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
440 - }
441 - ]}}}
473 + "vehicleId": "", ~/~/ID ТС 
474 + "parentId": "", ~/~/Guid владельца ТС
475 + "name": "", ~/~/Имя объекта
476 + "imei": "", ~/~/IMEI
477 + "deviceTypeId": "", ~/~/ID типа устройства
478 + "modelId": "", ~/~/ID модели
479 + "unitId": "", ~/~/ID подразделения
480 + "sim1": "", ~/~/SIM1
481 + "sim2": "", ~/~/SIM2
482 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
483 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
484 + "counters": { ~/~/Счётчики
485 + "mileageEnabled": true,
486 + "motohoursEnabled": true,
487 + "mileage": "",
488 + "motohours": 345.0
489 + },
490 + "cmsv6Parameters": { ~/~/Параметры CmsV6
491 + "id": null,
492 + "enabled": true, ~/~/флаг включения
493 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
494 + "login": "", ~/~/ имя учетной записи
495 + "password": "" ~/~/ пароль учетной записи
496 + },
497 + "inspectionTasks": { ~/~/ задания на ТО
498 + "id": "", ~/~/ ID задачи
499 + "enabled": false, ~/~/ Признак включения
500 + "name": "", ~/~/ Имя задания
501 + "description": "", ~/~/ Описание задания
502 + "mileageCondition": "", ~/~/ Условие по пробегу
503 + "lastMileage": "", ~/~/ Пробег (в метрах)
504 + "motohoursCondition": "", ~/~/ Условие по моточасам
505 + "lastMotohours": "", ~/~/ Моточасы
506 + "periodicCondition": "", ~/~/ Условие периодичности по времени
507 + "kind": "", ~/~/ Вид периодичности по времени 
508 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
509 + }
442 442  
443 443  (% style="text-align:left" %)
444 444  (% style="color:#000000" %)}
445 445  
514 +**Валидация:**
515 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
516 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
517 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
446 446  
447 -(% class="box warningmessage" %)
519 +
520 +(% class="box successmessage" %)
448 448  (((
449 -(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
522 +(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
450 450  )))
451 451  
452 -(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
525 +(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
453 453  
454 -(% style="color:#000000" %)Метод запроса: **PUT**
527 +(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
455 455  
456 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
529 +(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
457 457  
458 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
531 +(% style="color:#000000" %) возвращает информацию об объектах с учетом заданных настроек видимости объектов;
459 459  
533 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
534 +
535 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
536 +
537 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
538 +
539 +(% style="color:#000000" %)Метод запроса: **POST**
540 +
541 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
542 +
543 +(% style="color:#000000" %)В заголовках запроса:
544 +
545 +(% style="color:#000000" %)− Content-Type: __**application/json**__
546 +
547 +(% style="color:#000000" %)− X-Auth: Токен авторизации
548 +
549 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
550 +
460 460  (% style="color:#000000" %)Параметры в теле запроса (JSON):
461 461  
462 -(% style="color:#000000" %)//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
553 +(% class="western" style="color:#000000" %)##{##
463 463  
555 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
556 + "name": null, ~/~/ Имя ТС (string, опционально) 
557 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
558 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
559 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
560 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
561 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
562 +(% style="color:#000000" %)}
563 +
564 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
565 +
464 464  (% style="color:#000000" %)Ответ:
465 465  
466 -(% lang="en-US" style="text-align:left" %)
467 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
568 +(% style="color:#000000" %){
468 468  
570 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
571 + "name": "" ~/~/ наименование объекта
572 + "imei": "" ~/~/ IMEI объекта
573 + "deviceTypeId": "" ~/~/ идентификатор типа устройства
574 + "deviceTypeName": "" ~/~/ наименование типа устройства
575 + "sim1": "" ~/~/ первый номер телефона
576 + "sim2": "" ~/~/ второй номер телефона
577 + "parentId": "" ~/~/ идентификатор клиента-родителя
578 + "parentName": "" ~/~/ наименование клиента-родителя
579 + "modelId": "" ~/~/ идентификатор модели объекта
580 + "modelName": "" ~/~/ наименование модели объекта
581 + "unitId": "" ~/~/ идентификатор подразделения
582 + "unitName": "" ~/~/ наименование подразделения
583 + "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
584 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
585 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
586 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
587 +(% style="color:#000000" %)}
469 469  
589 +(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
590 +
591 +
470 470  (% class="box successmessage" %)
471 471  (((
472 -(% style="color:#000000; line-height:100%" %)**Получение списка объектов — **(% lang="en-US" %)**POST /api/v3/vehicles**
594 +(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
473 473  )))
474 474  
475 -(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиентодитель).
597 +(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
476 476  
477 -(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**):
599 +(% style="color:#000000" %)Метод запроса: **POST**
478 478  
479 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
601 +(% 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}
480 480  
481 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
603 +(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
482 482  
483 -(% style="color:#000000" %) информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
605 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
484 484  
485 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
607 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
486 486  
487 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
609 +(% style="color:#000000" %){
488 488  
489 -(% style="color:#000000" %)Метод запроса: **POST**
611 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
612 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
613 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
614 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
615 + "description": "", ~/~/ Описание
616 + "data": "", ~/~/ Данные
617 + "overwrite": false, ~/~/ Флаг перезаписи
618 + "stage": "", ~/~/ Состояние, может быть null
490 490  
491 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
620 +(% style="color:#000000" %)}
492 492  
493 -(% style="color:#000000" %)В заголовках запроса:
622 +(% style="color:#000000" %)Ответ:
494 494  
495 -(% style="color:#000000" %)− Content-Type: application/json
624 +(% style="color:#000000" %){
496 496  
497 -(% style="color:#000000" %)− X-Auth: Токен авторизации
626 + "status": "", ~/~/ значение статуса
627 + "date": "", ~/~/ Дата смены статуса 
628 + "description": "", ~/~/ Описание
629 + "data": "", ~/~/ Данные
630 + "overwrite": false, ~/~/ Флаг перезаписи
631 + "stage": "", ~/~/ Состояние
498 498  
499 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
633 +(% style="text-align:left" %)
634 +(% style="color:#000000" %) }
500 500  
501 -(% class="western" style="color:#000000" %)##{"vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##
502 502  
503 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5##
637 +(% class="box warningmessage" %)
638 +(((
639 +(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
640 +)))
504 504  
505 -(% class="western" style="color:#000000" %)##~/~/ ID типа устройства (short, опционально) "parentId": null, ~/~/ ID клиента (Guid, опционально) "unitId": null##
642 +(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
506 506  
507 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}
644 +(% style="color:#000000" %)Метод запроса: **PUT**
508 508  
509 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
646 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
510 510  
511 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
648 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
512 512  
513 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
650 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
514 514  
515 -(% style="color:#000000" %)0 - «Блокировка»
652 +(% style="color:#000000" %){    
516 516  
517 -(% style="color:#000000" %)1 - «Активен»,
654 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
655 + "parentId": "", ~/~/ ID клиента
656 + "name": "", ~/~/ имя ТС
657 + "imei": "", ~/~/ IMEI
658 + "deviceTypeId": "", ~/~/ ID типа устройства
659 + "modelId": "", ~/~/ , ID модели    
660 + "unitId": "", ~/~/ подразделения
661 + "sim1": "", ~/~/ SIM 1
662 + "sim2": "", ~/~/ SIM2 (%%)
663 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
664 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
665 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
666 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
667 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
668 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
669 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
670 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
671 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
672 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
673 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
674 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
675 +(% style="color:#000000" %) "counters": 
676 + {
677 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
678 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
679 + "mileage": «», пробег
680 + "motohours": «» моточасы
681 + }
682 + "cmsv6Parameters": ~/~/ параметры CMSv6
683 + {       
684 + "id": "", ~/~/ идентификатор
685 + "enabled": true, ~/~/ флаг включения
686 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
687 + "login": "", ~/~/ имя учетной записи
688 + "password": "", ~/~/ пароль учетной записи
689 + }
690 + "inspectionTasks": ~/~/ задания на ТО
691 + {
692 + "id": "", ~/~/ ID задания
693 + "enabled": false, ~/~/ Признак включения
694 + "name": "", ~/~/ Имя задания
695 + "description": "", ~/~/ Описание задания
696 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
697 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
698 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
699 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
700 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
701 + "kind": "", ~/~/ Вид периодичности по времени
702 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
703 + } 
518 518  
519 -(% style="color:#000000" %)2 - «Отменен»
705 +(% style="color:#000000" %)}
520 520  
521 -(% style="color:#000000" %)3 - «Оборудован»
707 +(% style="color:#000000" %)Ответ:
522 522  
523 -(% style="color:#000000" %)4 - «Диагностика»
709 +(% lang="en-US" style="text-align:left" %)
710 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
524 524  
525 -(% style="color:#000000" %)5 - «Сервис»
712 +(% lang="en-US" style="text-align:left" %)
713 + "vehicleId": "", ~/~/ ID ТС
714 + "parentId": "", ~/~/ ID клиента
715 + "name": "", ~/~/ имя ТС
716 + "imei": "", ~/~/ IMEI
717 + "deviceTypeId": "", ~/~/ типа устройства
718 + "modelId": "", ~/~/ ID модели
719 + "unitId": "", ~/~/ ID подразделения
720 + "sim1": "", ~/~/ SIM 1
721 + "sim2": "", ~/~/ SIM2
722 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
723 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
724 + "counters": 
725 + {
726 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
727 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
728 + "mileage": "", ~/~/ пробег
729 + "motohours": "", ~/~/ моточасы
730 + }
731 + "cmsv6Parameters": ~/~/ параметры CMSv6
732 + {
733 + "id": ~/~/ идентификатор
734 + "enabled": true, ~/~/ флаг включения
735 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
736 + "login": "", ~/~/ имя учетной записи
737 + "password": "", ~/~/ пароль учетной записи
738 + }
739 + "inspectionTasks": ~/~/ задания на ТО
740 + {
741 + "id": "", ~/~/ ID задания
742 + "enabled": false, ~/~/ Признак включения
743 + "name": "", ~/~/ Имя задания
744 + "description": "", ~/~/ Описание задания
745 + "mileageCondition": "", ~/~/ Условие по пробегу
746 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
747 + "motohoursCondition": "", ~/~/ Условие по моточасам
748 + "lastMotohours": "", ~/~/ Моточасы
749 + "periodicCondition": "", ~/~/ Условие периодичности по времени
750 + "kind": "", ~/~/ Вид периодичности по времени
751 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание
752 + }
526 526  
527 -(% style="color:#000000" %)6 - «Демонтаж»
754 +(% lang="en-US" style="text-align:left" %)
755 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
528 528  
529 -(% style="color:#000000" %)7 - «Монтаж»
757 +**валидация:**
758 +- сезонный параметр может быть задан только если задана соответствующая обычная норма;
759 +- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
760 +- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
530 530  
531 -(% style="color:#000000" %)8 - «Дозаказ»
532 532  
533 -(% style="color:#000000" %)9 - «Обслужен»
763 +(% class="box errormessage" %)
764 +(((
765 +(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
766 +)))
534 534  
535 -(% style="color:#000000" %)10 - «Списан»
768 +(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
536 536  
537 -(% style="color:#000000" %)11 - «Неисправен»
770 +(% style="color:#000000" %)Метод запроса: **DELETE**
538 538  
539 -(% style="color:#000000" %)12 - «Проверен»
772 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
540 540  
774 +(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
775 +
776 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
777 +
541 541  (% style="text-align:left" %)
542 -(% style="color:#000000; font-weight:normal" %)13 - «Не эксплуатируется»
779 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
543 543  
544 544  
545 -(% class="box successmessage" %)
782 +(% class="box" lang="en-US" style="text-align: center;" %)
546 546  (((
547 -(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта**(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
784 +(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
548 548  )))
549 549  
550 -(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«X-Auth»**).
787 +(% class="box infomessage" %)
788 +(((
789 +(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
790 +)))
551 551  
552 -(% style="color:#000000" %)Метод запроса: **POST**
792 +(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
553 553  
554 -(% 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}
794 +(% style="color:#000000" %)Метод запроса: **GET**
555 555  
556 -(% style="color:#000000" %)Параметр запроса: {vehicleId} - ID ТС
796 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
557 557  
558 558  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
559 559  
560 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {
800 +(% style="color:#000000" %)Ответ:
561 561  
562 -(% class="western" %)
563 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
564 - "date": "", // Дата смены статуса (null если сменить немедленно)
565 - "description": "", // Описание
566 - "data": "", // Данные
567 - "overwrite": false, // Флаг перезаписи
568 - "stage": "", // Состояние, может быть null}}}
802 +(% style="color:#000000" %){
569 569  
804 + "deviceTypeId" : "", ~/~/ ID типа устройства
805 + "deviceTypeName" : "" ~/~/ Название типа устройства
806 +
807 +(% style="text-align:left" %)
570 570  (% style="color:#000000" %)}
571 571  
572 -(% style="color:#000000" %)Ответ: {
573 573  
574 -(% class="western" %)
575 -{{{ "status": "", // значение статуса
576 - "date": "", // Дата смены статуса
577 - "description": "", // Описание
578 - "data": "", // Данные
579 - "overwrite": false, // Флаг перезаписи
580 - "stage": "", // Состояние}}}
811 +(% class="box" style="text-align: center;" %)
812 +(((
813 +(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
814 +)))
581 581  
816 +(% class="box infomessage" %)
817 +(((
818 +(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
819 +)))
820 +
821 +(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
822 +
823 +(% style="color:#000000" %)Метод запроса: **GET**
824 +
825 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
826 +
827 +(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
828 +
829 +(% style="color:#000000" %)Ответ:
830 +
831 +(% style="color:#000000" %){
832 +
833 + "id": "", ~/~/ ID типа датчика 
834 + "name": "", ~/~/ Название
835 + "description": "", ~/~/ Описание
836 +
582 582  (% style="text-align:left" %)
583 583  (% style="color:#000000" %)}
584 584  

Меню

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