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

Last modified by Андрей Калиновский on 2025/06/27 16:12

From version < 243.1

edited by Андрей Калиновский
on 2025/06/27 16:12

To version < 240.1 >

edited by Андрей Калиновский
on 2025/06/09 16:36

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -2586,50 +2586,26 @@
  В заголовках запроса: X-Auth: Токен авторизации
--В массиве указываем id объектов через запятую
++В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
  Ответ:
--
--[
    {
--    "vehicleId": 55728, ~/~/ Идентификатор объекта
--    "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта
--    "vehicleNumber": "0105 КМ", ~/~/ Номер объекта
--    "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных
--    "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных
--    "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
--    "speed": 31, ~/~/ Скорость объекта
--    "course": 116, ~/~/ Курс движения [0;360]
--    "latitude": 45.722128, ~/~/ Широта [-90°;90°].
--    "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
--    "address": "\"   Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес
--    "geozones": [ ~/~/ Сведения по геозонам.
++    "vehicleId": 0, ~/~/Идентификатор объекта.
++    "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
++    "vehicleNumber": "string",~/~/Номер объекта.
++    "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
++    "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
++    "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
++    "speed": 0,~/~/Скорость объекта.
++    "course": 0,~/~/Курс движения [0;360]
++    "latitude": 0,~/~/Широта [-90°;90°].
++    "longitude": 0,~/~/Долгота [-180°;180°].
++    "address": "string",~/~/Адрес.
++    "geozones": [ ~/~/Сведения по геозонам.
        {
--        "id": 10225647, ~/~/ ID Геозоны
--        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 10282875, ~/~/ ID Геозоны
--        "name": "Ё2" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 10226240, ~/~/ ID Геозоны
--        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 9747869, ~/~/ ID Геозоны
--        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 10221123, ~/~/ ID Геозоны
--        "name": "53r" ~/~/ Наименование геозоны
--      },
--      {
--        "id": 10197638, ~/~/ ID Геозоны
--        "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны
++        "id": 0,
++        "name": "string"
        }
--    ]
--  }
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
@@ -4193,12 +4193,16 @@
  Тело запроса:
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "Balance": 0 ~/~/ Значение баланса.
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Balance": 0
  }
  Ответ: Success
++|=(% 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" %)Значение баланса
++
  == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
  (% class="box warningmessage" %)
@@ -4210,29 +4210,16 @@
  Тело запроса:
--(((
  {
--  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "amount": 0 ~/~/ Сумма пополнения баланса
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Balance": 0
  }
--)))
--(((
--
--)))
--
  Ответ: Success
--(((
--{
--  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
--  "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
--  "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
--  "Description": "string" ~/~/ Описание корректировки.
--}
--)))
++|=(% 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" %)Значение баланса
  == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
@@ -4245,25 +4245,16 @@
  Тело запроса:
--(((
  {
--  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "amount": 0 ~/~/ Сумма списания с баланса
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Balance": 0
  }
--)))
  Ответ: Success
--(((
--{
--  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
--  "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
--  "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
--  "Description": "string" ~/~/ Описание корректировки
--}
--)))
++|=(% 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" %)Значение баланса
  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
@@ -4274,35 +4274,28 @@
  Тело запроса:
--(((
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
--  "PermissibleBalance": 0, ~/~/ Допустимый баланс
--  "DefermentDays": 0, ~/~/ Отсрочка (дни).
--  "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
--  "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "CalculationType": 0,
++  "PermissibleBalance": 0,
++  "DefermentDays": 0,
++  "SendUiNotifications": true,
++  "SendEmailNotifications": true,
++  "IsPrivate": true,
  }
--)))
--(((
--
--)))
--
  Ответ: Success
--(((
--{
--  "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
--  "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
--  "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
--  "PermissibleBalance": 0, ~/~/ Допустимый баланс.
--  "DefermentDays": 0, ~/~/ Отсрочка (дни)
--  "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
--  "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
--}
++|=(% 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" %)**Изменить тариф клиента**(%%) ==
@@ -4314,68 +4314,35 @@
  Тело запроса:
  {
--  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
--  "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
--  "Features": [ ~/~/ Набор услуг по тарифу клиента.
++  "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
++  "Features": [
      {
--      "Feature": "string", ~/~/ Код услуги.
--      "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
--      "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
--      "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
--      "Price": 0, ~/~/ Цена за единицу.
--      "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
--      "PeriodValue": 0, ~/~/ Значение периода.
--      "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
++      "Feature": "string",
++      "IsEnabled": true,
++      "IsFactual": true,
++      "Limit": 0,
++      "Price": 0,
++      "DebitDate": "2023-10-18T13:26:58.987Z",
++      "PeriodValue": 0,
++      "PeriodType": 0
      }
    ]
  }
--
  Ответ: Success
--(((
--{
--  "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, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни)
--      "PermissibleBalance": 0, ~/~/ Допустимый баланс.
--      "DefermentDays": 0 ~/~/ Отсрочка (дни)
--    },
--    "Features": [ ~/~/ Набор услуг по тарифному плану.
--      {
--        "Feature": "string", ~/~/Код услуги.
--        "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
--        "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
--        "Price": 0, ~/~/ Цена за единицу.
--        "PeriodValue": 0, ~/~/ Значение периода.
--        "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни)
--      }
--    ],
--    "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
--    "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
--    "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
--  },
--  "Features": [ ~/~/ Набор услуг по тарифу клиента.
--    {
--      "Feature": "string", ~/~/ Код услуги.
--      "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
--      "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
--      "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
--      "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
--      "Price": 0, ~/~/ Цена за единицу.
--      "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
--      "PeriodValue": 0, ~/~/ Значение периода.
--      "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
--      "Quantity": 0 ~/~/ Количество использования услуги.
--    }
--  ]
--}
--)))
++|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
++|ClientId|Идентификатор клиента
++|PlanId|Идентификатор тарифного плана
++|Feature|Код услуги
++|IsEnabled|Признак, определяющий активирована ли услуга
++|IsFactual|Признак, определяющий расчёт по факту
++|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
++|Price|Цена за единицу.
++|DebitDate|Следующий момент времени списания с баланса за услугу.
++|PeriodValue|Значение периода.
++|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
@@ -6307,6 +6307,7 @@
  (((
  {
++  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
    "isEnabled": true, ~/~/ Активность
    "name": "string", ~/~/ Наименование локатора
    "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
@@ -6313,7 +6313,8 @@
    "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
    "validity": 0, ~/~/ Срок действия в днях (1-90)
    "autoProlongation": true, ~/~/ Автопродление срока действия.
--  "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++  "url": "string", ~/~/ Ссылка
++  "language": 0 ~/~/ Язык
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
    "vehiclesIds": [ ~/~/ Oбъекты
@@ -6329,8 +6329,9 @@
    "allowTrackReport": true, ~/~/ Трек
    "showTrackTracing": true, ~/~/ Трассировка трека
    "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
--      ]
++  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
++    0
++  ]
  }
  )))
@@ -6361,7 +6361,9 @@
    "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
    "validity": 0, ~/~/ Срок действия в днях (1-90)
    "autoProlongation": true, ~/~/ Автопродление срока действия
--  "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
++  "url": "string", ~/~/ Ссылка
++  "language": 0 ~/~/ Язык
++  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
    "vehiclesIds": [ ~/~/ Oбъекты
    ],
@@ -6376,7 +6376,8 @@
    "allowTrackReport": true, ~/~/ Трек
    "showTrackTracing": true, ~/~/ Трассировка трека
    "showSensors": true, ~/~/ Датчик
--  "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
++  "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
++    0
    ]
  }

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

Summary

Details

Меню