API - Wiki-ГЛОНАССSoft

Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.

14

15

Метод запроса: GET

16

17

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]]

18

19

В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».

20

21

Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]

22

23

**Получение списка объектов**

24

25

Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):

26

27

−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

28

29

−возвращает информацию об объектах с учетом заданных настроек видимости объектов;

30

31

−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;

32

33

−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;

34

35

−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

40

41

В заголовках запроса:

42

43

−Content-Type: application/json

44

45

−X-Auth: Токен авторизации

46

47

Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):

48

49

{{{{"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, опционально)}}}}

50

51

Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».

52

53

Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ]

54

55

Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.

0 - «Блокировка»

1 - «Активен»,

2 - «Отменен»

3 - «Оборудован»

4 - «Диагностика»

5 - «Сервис»

6 - «Демонтаж»

7 - «Монтаж»

8 - «Дозаказ»

9 - «Обслужен»

10 - «Списан»

11 - «Неисправен»

12 - «Проверен»

13 - «Не эксплуатируется»

84

85

**Получение списка клиентов.**

86

87

Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

88

89

−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;

90

91

−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;

92

93

−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>

98

99

Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)

100

101

В заголовках запроса: X-Auth: Токен авторизации

102

103

Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»: //статус клиента }, … ]

104

105

Примечание. Возможные значение параметра agentInfoType:

106

107

**Получение списка пользователей.**

108

109

Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.

110

111

Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]

116

117

Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {

118

119

{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента

120

//"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно

121

"login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно

122

//"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}

}

Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail

127

128

{{{ "sessionDuration": "", // длительность сессии в минутах}}}

129

130

«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]

131

132

**Получение списка типов устройств**

133

134

Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]

139

140

В заголовках запроса:X-Auth: Токен авторизации

Ответ: [

{{{ {

"deviceTypeId" : "", // ID типа устройства

146

"deviceTypeName" : "" // Название типа устройства

},}}}

… ]

**Получение списка типов датчиков**

152

153

Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

158

159

В заголовках запроса:X-Auth: Токен авторизации

Ответ: [

{{{ {}}}

«id»: «», //ID типа датчика «name»: «», //Название

166

167

{{{ "description": "" // Описание

},}}}

… ]

**Получение информации об объекте**

173

174

Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».

175

176

Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):

177

178

−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>

183

184

Параметр запроса: <vehicleid> - идентификатор объекта (опционально)

185

186

В заголовках запроса: X-Auth: Токен авторизации

Ответ:

{

{{{ "vehicleId": “”, // идентификатор объекта

193

"name": "", // имя объекта

194

"imei": "", // IMEI объекта

195

"deviceTypeId": “”, // идентификатор устройства объекта

196

"deviceTypeName": "" // наименование устройства объекта

197

"parentId": "", // идентификатор клиента-родителя

198

"parentName": "" // наименование клиента-родителя,

199

"modelId": "", // идентификатор модели объекта

200

"modelName": "" // наименование модели объекта,

201

"unitId": "", // идентификатор подразделения

202

"unitName": "", // наименование подразделения

203

"status": “”, // статус объекта

...

},

...}}}

}

Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»

211

212

**Добавление пользователя**

213

214

Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

219

220

В заголовках запроса: X-Auth: Токен авторизации

221

222

Параметры в теле запроса (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»: [ // группы пользователя «», //названия групп «», «» ] }

223

224

Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }

225

226

**Редактирование пользователя**

227

228

Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: PUT

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

233

234

В заголовках запроса: X-Auth: Токен авторизации

235

236

Параметры в теле запроса (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 - блокирован)

237

238

{{{ "description": "", // описание

239

"data": "" // данные, связанные со сменой статуса}}}

}

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»

244

245

**Удаление пользователя**

246

247

Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

248

249

Метод запроса: DELETE

250

251

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}

252

253

Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации

254

255

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»

256

257

**Добавление объекта**

258

259

Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

264

265

В заголовках запроса: X-Auth: Токен авторизации

266

267

Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {

268

269

{{{ "parentId": "", // ID клиента

270

"name": "", // имя ТС

271

"imei": "", // IMEI

272

"deviceTypeId": "",// ID типа устройства

273

"modelId": "",

274

"unitId": "", // ID подразделения

275

"sim1": "", // Номер SIM 1

276

"sim2": "", // Номер SIM2

277

"consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)

278

"consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)

279

"consumptionIdle": "",// Расход топлива на холостом ходу

280

"counters": {

281

"mileage": "", // пробег

282

"mileageEnabled": true, // флаг активности счётчика "пробег"

283

"motohours":"", // моточасы

284

"motohoursEnabled": true // флаг активности счётчика "моточасы"

285

},

286

"cmsv6Parameters": { // параметры CMSv6

287

"enabled": true, // флаг включения

288

//"id": "", // идентификатор

289

"host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6

290

"login": "", // имя учетной записи

291

"password": "" // пароль учетной записи

292

},

293

"inspectionTasks": [ // задания на ТО

294

{

295

"enabled": "", // Признак включения

296

"name": "", // Имя задания

297

"description": "", // Описание задания

298

"mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)

299

"lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)

300

"motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)

301

"lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)

302

"periodicCondition": "", // Условие периодичности по времени (null - условие не работает)

303

"kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)

304

"lastInspectionDate": "", // Дата последнего ТО (null - не указано)

305

"maxQuantity": "" // Сколько раз выполнить задание (null - однократно)

},

]}}}

… }

Ответ:

{

{{{ "vehicleId": "", //ID ТС

316

"parentId": "", //Guid владельца ТС

317

"name": "", //Имя объекта

318

"imei": "", //IMEI

319

"deviceTypeId": "", //ID типа устройства

320

"modelId": "", //ID модели

321

"unitId": "", //ID подразделения

322

"sim1": "", //SIM1

323

"sim2": "", //SIM2

324

"consumptionPer100Km": "", //Расход топлива на 100 км

325

"consumptionIdle": "", //Расход топлива на холостом ходу

326

"counters": { //Счётчики

327

"mileageEnabled": true,

328

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

"cmsv6Parameters": { //Параметры CmsV6

333

"id": null,

334

"enabled": true, //флаг включения

335

"host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6

336

"login": "", // имя учетной записи

337

"password": "" // пароль учетной записи

338

},

339

"inspectionTasks": [ // задания на ТО

340

{

341

"id": "", // ID задачи

342

"enabled": false, // Признак включения

343

"name": "", // Имя задания

344

"description": "", // Описание задания

345

"mileageCondition": "", // Условие по пробегу

346

"lastMileage": "", // Пробег (в метрах)

347

"motohoursCondition": "", // Условие по моточасам

348

"lastMotohours": "", // Моточасы

349

"periodicCondition": "", // Условие периодичности по времени}}}

350

351

{{{ "kind": "", // Вид периодичности по времени

352

"maxQuantity": "" // Сколько раз выполнить задание (null - однократно)

}

]}}}

}

**Удаление объекта**

Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

361

362

Метод запроса: DELETE

363

364

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}

365

366

Параметр запроса: {id} - Guid объекта

367

368

В заголовках запроса: X-Auth: Токен авторизации

369

370

Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»

371

372

**Редактирование объекта**

373

374

Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: PUT

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

379

380

В заголовках запроса: X-Auth: Токен авторизации

381

382

Параметры в теле запроса (JSON):

383

384

//Обязательные параметры наименование и модель объекта //В теле запроса - объект 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»: «» //Сколько раз выполнить задание } ] }

Ответ:

{ «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»: «» //Сколько раз выполнить задание } ] }

389

390

**Изменение статуса объекта**

391

392

Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)

Метод запроса: POST

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}

397

398

Параметр запроса: {vehicleId} - ID ТС

399

400

В заголовках запроса: X-Auth: Токен авторизации

401

402

Параметры в теле запроса (JSON): {

403

404

{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

405

"date": "", // Дата смены статуса (null если сменить немедленно)

406

"description": "", // Описание

407

"data": "", // Данные

408

"overwrite": false, // Флаг перезаписи

409

"stage": "", // Состояние, может быть null}}}

}

Ответ: {

{{{ "status": "", // значение статуса

416

"date": "", // Дата смены статуса

417

"description": "", // Описание

418

"data": "", // Данные

419

"overwrite": false, // Флаг перезаписи

420

"stage": "", // Состояние}}}

}

**Проверка авторизации**

425

426

Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»

Метод запроса: GET

URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]

431

432

В заголовках запроса: X-Auth: Токен авторизации

433

434

Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»

435

436

**Расширенное описание API доступно по запросу на support@glonasssoft.ru**

Wiki source code of API

Меню