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

1

(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)

2

== Описание ГЛОНАССSoft Public API 3.0 ==

== ==

(% class="box" style="text-align: center;" %)

7

(((

8

(% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**

9

)))

10

11

(% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).

12

13

(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).

14

15

Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.

16

17

18

(% class="box" style="text-align: center;" %)

19

(((

20

(% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**

21

)))

22

23

(% class="box successmessage" %)

24

(((

25

(% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**

26

)))

27

28

(% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.

29

30

(% style="color:#000000" %)Метод запроса: **POST**

31

32

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]

33

34

(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».

35

36

(% style="color:#000000" %)Параметры в теле запроса (JSON):

37

38

(% style="color:#000000" %){

39

"login": "testuser",

40

"password": "testuser"

}(%%)

(% style="color:#000000" %)**Ответ:**

45

46

(% lang="en-US" %)

47

(% style="color:#000000" %){

48

49

(% lang="en-US" %)

50

(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации

51

"User": "testuser" , ~/~/ имя пользователя

(% lang="en-US" %)

}

**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.

57

58

59

(% class="box infomessage" %)

60

(((

61

(% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**

62

)))

63

64

(% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

65

66

(% style="color:#000000" %)Метод запроса: **GET**

67

68

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]

69

70

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

71

72

(% lang="en-US" %)

73

(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**

74

75

76

(% class="box" style="text-align: center;" %)

77

(((

78

(% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**

79

)))

80

81

(% class="box infomessage" %)

82

(((

83

(% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**

84

)))

85

86

(% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):

87

88

(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;

89

90

(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;

91

92

(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».

93

94

(% style="color:#000000" %)Метод запроса: **GET**

95

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>

97

98

(% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)

99

100

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

101

102

(% style="color:#000000" %)Ответ:

103

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 - Отказ)

}

(% class="box" style="text-align: center;" %)

115

(((

116

(% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**

117

)))

118

119

(% class="box successmessage" %)

120

(((

121

(% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**

122

)))

123

124

(% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

125

126

(% style="color:#000000" %)Метод запроса: **POST**

127

128

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

129

130

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

131

132

(% style="color:#000000" %)Параметры в теле запроса (JSON):

133

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

}

153

154

(% style="text-align:left" %)

155

(% style="color:#000000; font-weight:normal" %)Ответ:

156

157

(% style="text-align:left" %)

158

(% style="color:#000000; font-weight:normal" %){

159

160

(% style="text-align:left" %)

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» названия группы пользователя

178

179

(% style="text-align:left" %)

180

(% style="color:#000000; font-weight:normal" %)}

181

182

183

(% class="box successmessage" %)

184

(((

185

(% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**

186

)))

187

188

(% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.

189

190

(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.

191

192

(% style="color:#000000" %)Метод запроса: **POST**

193

194

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]

195

196

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

197

198

(% style="color:#000000" %)Параметры в теле запроса (JSON):

199

200

(% style="color:#000000" %){

201

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 - неважно

206

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

230

(% class="box warningmessage" %)

231

(((

232

(% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**

233

)))

234

235

(% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

236

237

(% style="color:#000000" %)Метод запроса: **PUT**

238

239

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]

240

241

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

242

243

(% lang="en-US" style="text-align:left" %)

244

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):

245

246

(% lang="en-US" style="text-align:left" %)

247

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

248

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» названия группы пользователя

268

269

(% lang="en-US" style="text-align:left" %)

270

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__

271

272

(% lang="en-US" style="text-align:left" %)

273

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://

274

275

(% lang="en-US" style="text-align:left" %)

276

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

277

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» названия группы пользователя

296

297

(% lang="en-US" style="text-align:left" %)

298

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

299

300

301

(% class="box warningmessage" %)

302

(((

303

(% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**

304

)))

305

306

(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

307

308

(% style="color:#000000" %)Метод запроса: **PUT**

309

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}

311

312

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя

313

314

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

315

316

(% style="color:#000000" %)Параметры в теле запроса (JSON):

317

318

(% style="color:#000000" %){

319

320

"status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)

321

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

322

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

323

324

(% style="color:#000000" %)}

325

326

(% style="text-align:left" %)

327

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**

328

329

330

(% class="box warningmessage" %)

331

(((

332

**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**

333

)))

334

335

Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

336

337

(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**

338

339

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]

340

341

(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):

342

343

[

344

"8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",

345

"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"

346

]

347

348

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**

349

350

351

(% class="box warningmessage" %)

352

(((

353

**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**

354

)))

355

356

Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

357

358

(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**

359

360

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]

361

362

(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):

363

364

[

365

"8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",

366

"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"

367

]

368

369

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)

370

\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__

В теле ответа:

{

"errorMessages": [

"Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."

376

],

377

"users": [

378

"415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"

379

]

380

}

381

\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.

382

"users" - массив id пользователей, которых не удалось включить или отключить.

383

384

385

(% class="box errormessage" %)

386

(((

387

(% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**

388

)))

389

390

(% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

391

392

(% style="color:#000000" %)Метод запроса: **DELETE**

393

394

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}

395

396

(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя

397

398

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

399

400

(% style="text-align:left" %)

401

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

402

403

404

(% class="box" style="text-align: center;" %)

405

(((

406

(% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**

407

)))

408

409

(% class="box infomessage" %)

410

(((

411

(% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**

412

)))

413

414

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

415

416

(% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):

417

418

(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;

419

420

(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.

421

422

(% style="color:#000000" %)Метод запроса: **GET**

423

424

(% 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>

425

426

(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)

427

428

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

429

430

(% style="color:#000000" %)Ответ:

{

"vehicleId": ,

"name": "",

"imei": "",

"deviceTypeId": ,

"deviceTypeName": "",

"sim1": "",

"parentId": "",

"parentName": "",

"modelId": "",

"modelName": "",

"createdAt": "",

"mileageCalcMethod": "",

"counters": {

"mileageEnabled": ,

"motohoursEnabled": ,

463

464

"mileage": 22438858.137653351, ~/~/ пробег по нормам в метрах

465

466

"motohours": 54545302.0 ~/~/ моточасы по нормам, в секундах

},

"inspectionTasks": [

{

"id": "",

"enabled": ,

"name": "",

"description": "",

"mileageCondition": ,

"lastMileage": ,

"motohoursCondition": ,

"lastMotohours": ,

"periodicCondition": ,

"kind": "",

"lastInspectionDate": ""

}

]

}

(% style="text-align:left" %)

503

Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:

504

505

(% style="text-align:left" %)

506

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

507

508

509

(% class="box successmessage" %)

510

(((

511

(% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**

512

)))

513

514

(% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).

515

516

(% style="color:#000000" %)Метод запроса: **POST**

517

518

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

519

520

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

521

522

(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON

523

524

(% style="color:#000000" %){

525

526

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

527

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

528

"imei": "" , ~/~/ IMEI

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

538

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

539

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

540

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

541

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

542

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

543

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

544

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

545

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

546

"counters": ~/~/ счетчики

547

{

548

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

549

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

550

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

551

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

552

},

553

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

554

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

555

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

556

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

557

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

558

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

559

},

560

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

561

{

562

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

563

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

564

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

565

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

566

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

567

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

568

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

569

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

570

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

571

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

572

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

573

}

574

575

(% style="color:#000000" %) }

576

577

(% style="color:#000000" %)Ответ:

578

579

(% style="color:#000000" %){

580

581

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

582

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

583

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

584

"imei": "", ~/~/IMEI

585

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

586

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

587

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

588

"sim1": "", ~/~/SIM1

589

"sim2": "", ~/~/SIM2

590

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

591

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

592

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

593

"mileageEnabled": true,

594

"motohoursEnabled": true,

"mileage": "",

"motohours": 345.0

},

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

599

"id": null,

600

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

601

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

602

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

603

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

604

},

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

}

618

619

(% style="text-align:left" %)

620

(% style="color:#000000" %)}

621

622

**Валидация:**

623

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

624

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

625

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

626

627

628

(% class="box successmessage" %)

629

(((

630

(% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**

631

)))

632

633

(% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).

634

635

(% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):

636

637

(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;

638

639

(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;

640

641

(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;

642

643

(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;

644

645

(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.

646

647

(% style="color:#000000" %)Метод запроса: **POST**

648

649

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]

650

651

(% style="color:#000000" %)В заголовках запроса:

652

653

(% style="color:#000000" %)− Content-Type: __**application/json**__

654

655

(% style="color:#000000" %)− X-Auth: Токен авторизации

656

657

(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.

658

659

(% style="color:#000000" %)Параметры в теле запроса (JSON):

660

661

(% class="western" style="color:#000000" %)##{##

662

663

(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)

664

"name": null, ~/~/ Имя ТС (string, опционально)

665

"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)

666

"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)

667

"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)

668

"parentId": null, ~/~/ ID клиента (Guid, опционально)

669

"unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)

670

(% style="color:#000000" %)}

671

672

(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.

673

674

(% style="color:#000000" %)Ответ:

675

676

(% style="color:#000000" %){

677

678

(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта

679

"name": "" ~/~/ наименование объекта

680

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

681

"deviceTypeId": "" ~/~/ идентификатор типа устройства

682

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

683

"sim1": "" ~/~/ первый номер телефона

684

"sim2": "" ~/~/ второй номер телефона

685

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

686

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

687

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

688

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

689

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

690

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

691

"status": "" ~/~/ статус объекта (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

692

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

693

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

694

(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов (%%)

695

(% style="color:#000000" %)}

696

697

(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

698

699

700

(% class="box successmessage" %)

701

(((

702

(% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**

703

)))

704

705

(% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

706

707

(% style="color:#000000" %)Метод запроса: **POST**

708

709

(% 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}

710

711

(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС

712

713

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

714

715

(% style="color:#000000" %)Параметры в теле запроса (JSON):

716

717

(% style="color:#000000" %){

718

719

"status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика,

720

~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан,

721

~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)

722

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

723

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

724

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

725

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

726

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

727

728

(% style="color:#000000" %)}

729

730

(% style="color:#000000" %)Ответ:

731

732

(% style="color:#000000" %){

733

734

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

735

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

736

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

737

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

738

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

739

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

740

741

(% style="text-align:left" %)

742

(% style="color:#000000" %) }

743

744

745

(% class="box warningmessage" %)

746

(((

747

(% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**

748

)))

749

750

(% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

751

752

(% style="color:#000000" %)Метод запроса: **PUT**

753

754

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]

755

756

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

757

758

(% style="color:#000000" %)Параметры в теле запроса (JSON):

759

760

(% style="color:#000000" %){

761

762

(((

763

(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС

764

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

765

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

766

"imei": "", ~/~/ IMEI

767

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

768

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

769

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

770

"sim1": "", ~/~/ SIM 1

771

"sim2": "", ~/~/ SIM2 (%%)

772

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

773

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

774

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

775

"consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км

776

"consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас

777

"consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу

778

"consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км

779

"consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км

780

"consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас

781

"consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас

782

"consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х

783

"consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х

784

(% style="color:#000000" %) "counters":

785

{

786

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

787

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

788

"mileage": "", ~/~/ пробег, в метрах

789

"motohours": "" ~/~/ моточасы, в секундах

790

}

791

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

792

{

793

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

794

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

795

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

796

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

797

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

798

}

799

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

800

{

801

"id": "", ~/~/ ID задания

802

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

803

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

804

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

805

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

806

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

807

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

808

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

809

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

810

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

811

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

}

)))

(% style="color:#000000" %)}

816

817

(% style="color:#000000" %)Ответ:

818

819

(% lang="en-US" style="text-align:left" %)

820

(% lang="ru-RU" style="color:#000000; font-weight:normal" %){

821

822

(% lang="en-US" style="text-align:left" %)

823

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

824

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

825

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

826

"imei": "", ~/~/ IMEI

827

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

828

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

829

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

830

"sim1": "", ~/~/ SIM 1

831

"sim2": "", ~/~/ SIM2

832

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

833

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

834

"counters":

835

{

836

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

837

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

838

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

839

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

840

}

841

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

842

{

843

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

844

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

845

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

846

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

847

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

848

}

849

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

850

{

851

"id": "", ~/~/ ID задания

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

"maxQuantity": "", ~/~/ Сколько раз выполнить задание

862

}

863

864

(% lang="en-US" style="text-align:left" %)

865

(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}

866

867

**валидация:**

868

- сезонный параметр может быть задан только если задана соответствующая обычная норма;

869

- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;

870

- при задании сезонной нормы обязательны соответствующие даты начала/окончания.

871

872

873

(% class="box errormessage" %)

874

(((

875

(% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**

876

)))

877

878

(% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

879

880

(% style="color:#000000" %)Метод запроса: **DELETE**

881

882

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}

883

884

(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта

885

886

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

887

888

(% style="text-align:left" %)

889

(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**

890

891

892

(% class="box" lang="en-US" style="text-align: center;" %)

893

(((

894

(% style="color:#000000; font-size:14pt" %)**Раздел Устройства**

895

)))

896

897

(% class="box infomessage" %)

898

(((

899

(% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**

900

)))

901

902

(% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

903

904

(% style="color:#000000" %)Метод запроса: **GET**

905

906

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

907

908

(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации

909

910

(% style="color:#000000" %)Ответ:

911

912

(% style="color:#000000" %){

913

914

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

915

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

916

917

(% style="text-align:left" %)

918

(% style="color:#000000" %)}

919

920

921

(% class="box" style="text-align: center;" %)

922

(((

923

(% style="color:#000000; font-size:14pt" %)**Раздел Датчики**

924

)))

925

926

(% class="box infomessage" %)

927

(((

928

(% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**

929

)))

930

931

(% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).

932

933

(% style="color:#000000" %)Метод запроса: **GET**

934

935

(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]

936

937

(% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации

938

939

(% style="color:#000000" %)Ответ:

940

941

(% style="color:#000000" %){

942

943

"id": "", ~/~/ ID типа датчика

944

"name": "", ~/~/ Название

945

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

946

947

(% style="text-align:left" %)

948

(% style="color:#000000" %)}

949

950

951

(% class="box" lang="en-US" style="text-align: center;" %)

952

(((

953

(% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

954

)))

Wiki source code of Методы API для работы с ГЛОНАССSoft

Меню