Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/03/28 11:43
отредактировано Андрей Калиновский
на 2022/08/31 14:11
на 2022/08/31 14:11
отредактировано Андрей Калиновский
на 2022/05/16 11:15
на 2022/05/16 11:15
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -1,16 +1,11 @@ 1 -== Описание ГЛОНАССSoft Public API == 1 +== Описание ГЛОНАССSoft Public API 2 + == 2 2 3 -== == 4 - 5 5 **Действующие ограничения** 6 - 7 7 8 - -Между запросамина формированиетрека/отчетадолжнабытьпауза1 секунду(превышениеотвергаетсясистемойсуведомлениемопревышении частотызапросов)6 +Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 9 9 10 -- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login). 11 - 12 12 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 13 -\\ 14 14 15 15 **Авторизация** 16 16 ... ... @@ -50,11 +50,17 @@ 50 50 51 51 Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 52 52 53 -{{{{"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, опционально)}}}} 48 +{{{ {"vehicleId": null,//84350, // ID ТС (int, опционально) 49 + "name": null, // Имя ТС (string, опционально) 50 + "imei": null,//"710179307", // IMEI (string, опционально) 51 + "sim": null,//"938112", // Номер телефона (string, опционально) 52 + "deviceTypeId": null,//5 // ID типа устройства (short, опционально) 53 + "parentId": null, // ID клиента (Guid, опционально) 54 + "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}} 54 54 55 55 Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». 56 56 57 -Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «» ,// статус объекта//«//createdAt//»: «» дата создания объектов //}, … ]58 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «» // статус объекта }, … ] 58 58 59 59 Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 60 60