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

Last modified by Андрей Калиновский on 2025/01/28 12:59

From version < 104.2 >

edited by Илья Крайнов
on 2023/08/03 18:01

To version < 110.1 >

edited by Илья Крайнов
on 2023/10/18 16:32

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -682,6 +682,225 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
++
++(% class="box infomessage" %)
++(((
++(% lang="en-US" %)**GET /api/v3/models/{Id}**
++)))
++
++Метод возвращает полную информацию о модели объекта.
++
++(% style="color:#000000" %)Метод запроса: **GET**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
++
++(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="color:#000000" %)Ответ:
++
++(% style="color:#000000" %){
++  "parentName": "string",
++  "name": "string",
++  "picture": "string",
++  "minspeed": 0,
++  "maxspeed": 0,
++  "width": 0,
++  "imbeddedtrailer": true,
++  "fueloutlay": 0,
++  "hoppercapacity": 0,
++  "hopperdischargespeed": 0,
++  "modelType": 0,
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "deleted": true
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
++|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
++|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
++|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
++|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
++|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
++|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
++|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
++|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
++|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
++|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
++|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
++|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
++|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
++
++== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
++
++(% class="box successmessage" %)
++(((
++(% lang="en-US" %)**POST /api/v3/models/find**
++)))
++
++(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
++
++(% style="color:#000000" %)Метод запроса: **POST**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="color:#000000" %)Параметры в теле запроса (JSON):{
++
++(% style="color:#000000" %)  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
++}
++
++(% style="color:#000000" %)Ответ:
++
++(% style="color:#000000" %)[
++  {
++    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "parentName": "string",
++    "name": "string",
++    "modelType": 0
++  }
++]
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
++|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
++|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
++|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
++|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
++
++== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
++
++(% class="box successmessage" %)
++(((
++(% lang="en-US" %)**POST /api/v3/models**
++)))
++
++(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
++
++(% style="color:#000000" %)Метод запроса: **POST**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="color:#000000" %)Параметры в теле запроса (JSON):
++
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "deleted": true,
++  "extId": "string",
++  "name": "string",
++  "picture": "string",
++  "minspeed": 0,
++  "maxspeed": 0,
++  "width": 0,
++  "imbeddedtrailer": true,
++  "fueloutlay": 0,
++  "hoppercapacity": 0,
++  "hopperdischargespeed": 0,
++  "modelType": 0
++}
++
++Ответ:
++
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "deleted": true,
++  "extId": "string",
++  "name": "string",
++  "picture": "string",
++  "minspeed": 0,
++  "maxspeed": 0,
++  "width": 0,
++  "imbeddedtrailer": true,
++  "fueloutlay": 0,
++  "hoppercapacity": 0,
++  "hopperdischargespeed": 0,
++  "modelType": 0
++}
++
++
++== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
++
++(% class="box warningmessage" %)
++(((
++(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
++)))
++
++(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
++
++(% style="color:#000000" %)Метод запроса: **PUT**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="color:#000000" %)Параметры в теле запроса (JSON):
++
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "deleted": true,
++  "extId": "string",
++  "name": "string",
++  "picture": "string",
++  "minspeed": 0,
++  "maxspeed": 0,
++  "width": 0,
++  "imbeddedtrailer": true,
++  "fueloutlay": 0,
++  "hoppercapacity": 0,
++  "hopperdischargespeed": 0,
++  "modelType": 0
++}
++
++Ответ:
++
++{
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "deleted": true,
++  "extId": "string",
++  "name": "string",
++  "picture": "string",
++  "minspeed": 0,
++  "maxspeed": 0,
++  "width": 0,
++  "imbeddedtrailer": true,
++  "fueloutlay": 0,
++  "hoppercapacity": 0,
++  "hopperdischargespeed": 0,
++  "modelType": 0
++}
++
++== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
++
++(% class="box errormessage" %)
++(((
++(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
++)))
++
++(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
++
++(% style="color:#000000" %)Метод запроса: **DELETE**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
++
++(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++Ответ: В случае успеха **Success 200**
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
@@ -1504,7 +1504,312 @@
  (% style="text-align:left" %)
  (% style="color:#000000" %)}
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
++== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
++
++(% class="box infomessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
++)))
++
++(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
++
++(% style="color:#000000" %)Метод запроса: **GET**
++
++(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="color:#000000" %)Ответ:
++
++(% style="color:#000000" %){
++
++    "id": "", ~/~/ ID типа датчика
++    "name": "", ~/~/ Название
++    "description": "", ~/~/ Описание
++
++(% style="text-align:left" %)
++(% style="color:#000000" %)}
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
++
++(% class="box infomessage" style="text-align: left;" %)
++(((
++**POST /api/v3/terminalMessages/count**
++)))
++
++(% style="text-align: left;" %)
++Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
++
++(% style="text-align: left;" %)
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="text-align: left;" %)
++{
++  "vehicleIds": [
++    id ~/~/ здесь передается список идентификаторов объектов
++  ],
++  "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
++  "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
++}
++
++(% style="text-align: left;" %)
++Ответ:
++
++(% style="text-align: left;" %)
++[
++  {
++    "vehicleId": 0, ~/~/ идентификатор объекта
++    "count": 0 ~/~/ количество сообщений за период
++  }
++]
++
++== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/terminalMessages**
++)))
++
++Метод возвращает список сообщений терминала объекта за выбранный период.
++
++(% style="text-align: left;" %)
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++{
++  "vehicleId": 0, ~/~/ id объекта
++  "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
++  "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
++}
++
++Ответ:
++
++[
++  {
++    "messages": [
++      {
++        "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
++        "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
++        "speed": 0, ~/~/ Скорость, км/ч
++        "altitude": 0, ~/~/ Высота, м
++        "latitude": 0, ~/~/ Широта [-90°;90°]
++        "longitude": 0, ~/~/ Долгота [-180°;180°]
++        "satellites": 0, ~/~/ Кол-во спутников
++        "voltage": 0, ~/~/ Напряжение
++        "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
++          "additionalProp1": "string",
++          "additionalProp2": "string",
++          "additionalProp3": "string"
++        },
++        "photoCount": 0 ~/~/ Кол-во фото
++      }
++    ]
++  }
++]
++
++== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**POST /api/v3/vehicles/export/history**
++)))
++
++Метод возвращает список сообщений терминала объекта за выбранный период.
++
++(% style="text-align: left;" %)
++Метод запроса **POST**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++{
++  "vehicleId": 0, ~/~/ ID объекта
++  "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
++  "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
++  "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
++}
++
++Ответ:
++
++Получаете файл. Сообщение: Code 200/Success
++
++== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/vehicles/export/history/status**
++)))
++
++Метод возвращает список сообщений терминала объекта за выбранный период.
++
++(% style="text-align: left;" %)
++Метод запроса **GET**
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
++
++(% style="text-align: left;" %)
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++Ответ:
++
++{
++  "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
++  "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
++  "message": "string" ~/~/ текст описывающий статус.
++}
++
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
++
++== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
++
++(% class="box infomessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
++)))
++
++(% style="color:#000000" %)Метод запроса: **POST**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="text-align:left" %)
++Тело запроса:
++
++{
++  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "vehicleIds": [0], ~/~/ Список ID объектов
++  "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
++  "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
++  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++}
++
++Ответ:
++
++[
++  {
++    "vehicleId": 0, ~/~/ ID объекта
++    "name": "string", ~/~/ Имя ТС
++    "periods": [ ~/~/ Периоды
++      {
++        "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
++        "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
++        "mileageBegin": 0, ~/~/ Пробег на начало периода
++        "mileageEnd": 0, ~/~/ Пробег на окончание периода
++        "motohoursBegin": 0, ~/~/ Моточасы на начало периода
++        "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
++      }
++    ]
++  }
++]
++
++== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
++
++(% class="box infomessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
++)))
++
++(% style="color:#000000" %)Метод запроса: **POST**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="text-align:left" %)
++Тело запроса:
++
++{
++  "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
++  "vehicleIds": [0], ~/~/ Список ID объектов
++  "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
++  "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
++  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++}
++
++Ответ:
++
++[
++  {
++    "vehicleId": 0, ~/~/ ID объекта
++    "name": "string", ~/~/ Имя ТС
++    "periods": [ ~/~/ Периоды
++      {
++        "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало
++        "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание
++        "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
++        "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
++        "fuelConsumption": 0, ~/~/ Расход топлива
++        "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
++      }
++    ]
++  }
++]
++
++== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
++
++(% class="box infomessage" %)
++(((
++(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
++)))
++
++(% style="color:#000000" %)Метод запроса: **POST**
++
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
++
++(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
++
++(% style="text-align:left" %)
++Тело запроса:
++
++{
++  "vehicleIds": [0], ~/~/ Список ID объектов
++  "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
++  "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
++  "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
++}
++
++Ответ:
++
++[
++  {
++    "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
++    "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
++    "vehicleId": 0, ~/~/ ID объекта
++    "name": "string", ~/~/ Имя объекта
++    "model": "string", ~/~/ Модель объекта
++    "fuels": [ ~/~/ Массив данным по заправкам и сливам
++      {
++        "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
++        "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
++        "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
++        "valueFuel": 0, ~/~/ Количество
++        "fuelStart": 0, ~/~/ Уровень топлива на начало события
++        "fuelEnd": 0 ~/~/ Уровень топливо на конец события
++      }
++    ]
++  }
++]
++
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
@@ -1518,7 +1518,7 @@
  (% style="color:#000000" %)Метод запроса: **POST**
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/users/api/v3/gis/find
++(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
@@ -1633,124 +1633,6 @@
    }
  ]
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
--
--(% class="box infomessage" %)
--(((
--(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
--)))
--
--(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
--
--(% style="color:#000000" %)Метод запроса: **GET**
--
--(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
--
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="color:#000000" %)Ответ:
--
--(% style="color:#000000" %){
--
--    "id": "", ~/~/ ID типа датчика
--    "name": "", ~/~/ Название
--    "description": "", ~/~/ Описание
--
--(% style="text-align:left" %)
--(% style="color:#000000" %)}
--
--= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
--
--== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
--
--(% class="box infomessage" style="text-align: left;" %)
--(((
--**POST /api/v3/terminalMessages/count**
--)))
--
--(% style="text-align: left;" %)
--Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
--
--(% style="text-align: left;" %)
--Метод запроса **POST**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--(% style="text-align: left;" %)
--{
--  "vehicleIds": [
--    id ~/~/ здесь передается список идентификаторов объектов
--  ],
--  "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
--  "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
--}
--
--(% style="text-align: left;" %)
--Ответ:
--
--(% style="text-align: left;" %)
--[
--  {
--    "vehicleId": 0, ~/~/ идентификатор объекта
--    "count": 0 ~/~/ количество сообщений за период
--  }
--]
--
--== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
--
--(% class="box infomessage" %)
--(((
--**POST /api/v3/terminalMessages**
--)))
--
--Метод возвращает список сообщений терминала объекта за выбранный период.
--
--(% style="text-align: left;" %)
--Метод запроса **POST**
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
--
--(% style="text-align: left;" %)
--(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
--
--{
--  "vehicleId": 0, ~/~/ id объекта
--  "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
--  "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
--}
--
--Ответ:
--
--[
--  {
--    "messages": [
--      {
--        "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
--        "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
--        "speed": 0, ~/~/ Скорость, км/ч
--        "altitude": 0, ~/~/ Высота, м
--        "latitude": 0, ~/~/ Широта [-90°;90°]
--        "longitude": 0, ~/~/ Долгота [-180°;180°]
--        "satellites": 0, ~/~/ Кол-во спутников
--        "voltage": 0, ~/~/ Напряжение
--        "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
--          "additionalProp1": "string",
--          "additionalProp2": "string",
--          "additionalProp3": "string"
--        },
--        "photoCount": 0 ~/~/ Кол-во фото
--      }
--    ]
--  }
--]
--
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
@@ -2549,7 +2549,6 @@
    }
  ]
--
  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
  (% class="box infomessage" %)
@@ -2601,7 +2601,6 @@
    "deleted": true
  }
--
  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
  (% class="box warningmessage" %)
@@ -2631,7 +2631,6 @@
    "deleted": true
  }
--
  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
  (% class="box errormessage" %)
@@ -2646,6 +2646,310 @@
  Success
++= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
++
++(% class="wikigeneratedid" %)
++== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Billing/client/balance/{clientId}**
++)))
++
++Параметр запроса: **clientId **- идентификатор клиента.
++
++Ответ:
++
++{
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Balance": 0
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
++|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
++
++(% class="wikigeneratedid" %)
++== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Billing/client/constraint/{clientId}**
++)))
++
++Параметр запроса: **clientId **- идентификатор клиента.
++
++Ответ:
++
++{
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "CalculationType": 0,
++  "PermissibleBalance": 0,
++  "DefermentDays": 0,
++  "SendUiNotifications": true,
++  "SendEmailNotifications": true,
++  "IsPrivate": true,
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
++|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
++|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
++|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
++|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
++|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
++|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
++
++(% class="wikigeneratedid" %)
++== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Billing/client/plan/{clientId}**
++)))
++
++Параметры запроса:
++
++**clientId **- идентификатор клиента.
++
++**planId **- идентификатор тарифного плана.
++
++Ответ:
++
++{
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Plan": { **~/~/ Описание тарифного плана**
++    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "Name": "string",
++    "IsArchived": true,
++    "Constraint": {
++      "CalculationType": 0,
++      "PermissibleBalance": 0,
++      "DefermentDays": 0
++    },
++    "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
++      {
++        "Feature": "string",
++        "IsFactual": true,
++        "Limit": 0,
++        "Price": 0,
++        "PeriodValue": 0,
++        "PeriodType": 0
++      }
++    ]
++  },
++  "DebitDate": "2023-10-18T12:46:24.213Z",
++  "Features": [ **~/~/ Описание услуг тарифного плана как есть**
++    {
++      "Feature": "string",
++      "IsEnabled": true,
++      "IsPrivate": true,
++      "IsFactual": true,
++      "Limit": 0,
++      "Price": 0,
++      "DebitDate": "2023-10-18T12:46:24.213Z",
++      "PeriodValue": 0,
++      "PeriodType": 0
++    }
++  ]
++}
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|ClientId|Идентификатор клиента
++|Id|Идентификатор тарифного плана
++|OwnerId|Идентификатор клиента-владельца
++|Name|Наименование тарифного плана
++|IsArchived|Признак, определяющий архивный тарифный план
++|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
++|PermissibleBalance|Допустимый баланс
++|DefermentDays|Отсрочка, количество дней
++|Feature|Код услуги
++|IsEnabled|Признак, определяющий активирована ли услуга
++|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
++|IsFactual|Признак, определяющий расчёт по факту
++|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
++|Price|Цена за единицу.
++|DebitDate|Следующий момент времени списания с баланса за услугу.
++|PeriodValue|Значение периода.
++|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
++
++(% class="wikigeneratedid" %)
++== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
++)))
++
++Параметр запроса: **clientId **- идентификатор клиента.
++
++Ответ:
++
++[
++  {
++    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "Name": "string",
++    "IsArchived": true,
++    "Constraint": {
++      "CalculationType": 0,
++      "PermissibleBalance": 0,
++      "DefermentDays": 0
++    },
++    "Features": [
++      {
++        "Feature": "string",
++        "IsFactual": true,
++        "Limit": 0,
++        "Price": 0,
++        "PeriodValue": 0,
++        "PeriodType": 0
++      }
++    ]
++  }
++]
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|ClientId|Идентификатор клиента
++|Id|Идентификатор тарифного плана
++|OwnerId|Идентификатор клиента-владельца
++|Name|Наименование тарифного плана
++|IsArchived|Признак, определяющий архивный тарифный план
++|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
++|PermissibleBalance|Допустимый баланс
++|DefermentDays|Отсрочка, количество дней
++|Feature|Код услуги
++|IsFactual|Признак, определяющий расчёт по факту
++|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
++|Price|Цена за единицу.
++|PeriodValue|Значение периода.
++|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
++
++(% class="wikigeneratedid" %)
++== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
++
++(% class="box infomessage" %)
++(((
++**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
++)))
++
++Параметр запроса: **clientId **- идентификатор клиента.
++
++Ответ:
++
++[
++  {
++    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++    "Name": "string",
++    "IsArchived": true,
++    "Constraint": {
++      "CalculationType": 0,
++      "PermissibleBalance": 0,
++      "DefermentDays": 0
++    },
++    "Features": [
++      {
++        "Feature": "string",
++        "IsFactual": true,
++        "Limit": 0,
++        "Price": 0,
++        "PeriodValue": 0,
++        "PeriodType": 0
++      }
++    ]
++  }
++]
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|ClientId|Идентификатор клиента
++|Id|Идентификатор тарифного плана
++|OwnerId|Идентификатор клиента-владельца
++|Name|Наименование тарифного плана
++|IsArchived|Признак, определяющий архивный тарифный план
++|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
++|PermissibleBalance|Допустимый баланс
++|DefermentDays|Отсрочка, количество дней
++|Feature|Код услуги
++|IsFactual|Признак, определяющий расчёт по факту
++|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
++|Price|Цена за единицу.
++|PeriodValue|Значение периода.
++|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
++
++== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
++
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/Billing/client/constraint**
++)))
++
++Тело запроса:
++
++{
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "CalculationType": 0,
++  "PermissibleBalance": 0,
++  "DefermentDays": 0,
++  "SendUiNotifications": true,
++  "SendEmailNotifications": true,
++  "IsPrivate": true,
++}
++
++Ответ: Success
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|ClientId|Идентификатор клиента
++|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
++|PermissibleBalance|Допустимый баланс
++|DefermentDays|(((
++Отсрочка, количество дней
++)))
++|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
++|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
++|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
++
++== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
++
++(% class="box warningmessage" %)
++(((
++**PUT /api/v3/Billing/client/plan**
++)))
++
++Тело запроса:
++
++{
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Features": [
++    {
++      "Feature": "string",
++      "IsEnabled": true,
++      "IsFactual": true,
++      "Limit": 0,
++      "Price": 0,
++      "DebitDate": "2023-10-18T13:26:58.987Z",
++      "PeriodValue": 0,
++      "PeriodType": 0
++    }
++  ]
++}
++
++Ответ: Success
++
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|ClientId|Идентификатор клиента
++|Feature|Код услуги
++|IsEnabled|Признак, определяющий активирована ли услуга
++|IsFactual|Признак, определяющий расчёт по факту
++|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
++|Price|Цена за единицу.
++|DebitDate|Следующий момент времени списания с баланса за услугу.
++|PeriodValue|Значение периода.
++|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
++
++
  (% class="box" lang="en-US" style="text-align: center;" %)
  (((
  (% 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]] **

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

Summary

Details

Меню