AutoGRAPH.NET Service Methods — различия между версиями
Admin (обсуждение | вклад) |
|||
| (не показано 19 промежуточных версий 2 участников) | |||
| Строка 1: | Строка 1: | ||
| + | |||
=== Базовые методы сервиса === |
=== Базовые методы сервиса === |
||
| − | *[[AutoGRAPH.NET_Service_Login|Login]] – аутентификация и получение токена (в случае, если она включена) |
+ | *[[AutoGRAPH.NET_Service_Login|Login]] – аутентификация и получение токена (в случае, если она включена) |
| − | *[[AutoGRAPH.NET_Service_EnumSchemas|EnumSchemas]] – получение списка доступных сервису схем |
+ | *[[AutoGRAPH.NET_Service_EnumSchemas|EnumSchemas]] – получение списка доступных сервису схем |
| − | *[[AutoGRAPH.NET_Service_EnumDevices|EnumDevices]] – получение списка устройств схемы |
+ | *[[AutoGRAPH.NET_Service_EnumDevices|EnumDevices]] – получение списка устройств схемы |
| − | *[[AutoGRAPH.NET_Service_EnumDrivers|EnumDrivers]] – получение информации о водителях в схеме |
+ | *[[AutoGRAPH.NET_Service_EnumDrivers|EnumDrivers]] – получение информации о водителях в схеме |
| − | *[[AutoGRAPH. |
+ | *[[AutoGRAPH.NET_Service_EnumImplements|EnumImplements]] – получение информации об инструментах в схеме |
| − | *[[AutoGRAPH. |
+ | *[[AutoGRAPH.NET_Service_EnumParameters|EnumParameters]] – получение списка параметров устройства в схеме |
| − | *[[AutoGRAPH. |
+ | *[[AutoGRAPH.NET_Service_EnumGeoFences|EnumGeoFences]] – получение списка геозон схемы |
| − | *[[AutoGRAPH. |
+ | *[[AutoGRAPH.NET_Service_EnumStatuses|EnumStatuses]] – получение списка доступных статусов устройств |
| + | *[[AutoGRAPH.NET_Service_GetGeoFences|GetGeoFences]] – получение информации о геозонах (точки для полигонов и т.д.) |
||
| + | *[[AutoGRAPH.NET_Service_FindDevices|FindDevices]] – поиск устройств по разным критериям |
||
=== Получение данных по приборам === |
=== Получение данных по приборам === |
||
| + | |||
| − | *[[AutoGRAPH.NET_Service_GetDevicesInfo|GetDevicesInfo]] – получение информации об устройстве в схеме |
||
| − | *[[AutoGRAPH. |
+ | *[[AutoGRAPH.NET_Service_GetDevicesInfo|GetDevicesInfo]] – получение информации об устройстве в схеме |
| − | *[[AutoGRAPH. |
+ | *[[AutoGRAPH.NET_Service_GetOnlineInfo|GetOnlineInfo]] – получение информации о последнем местоположении устройств |
| + | *[[AutoGRAPH.NET_Service_GetOnlineInfoAll|GetOnlineInfoAll]] – получение информации о последнем местоположении всех устройств |
||
| − | *''GetDataRanges – получение информации о загруженных данных для приборов (минимальная/максимальные доступные даты)'' |
||
| − | * |
+ | *''GetDataRanges – получение информации о загруженных данных для приборов (минимальная/максимальные доступные даты)'' |
| − | *[[AutoGRAPH. |
+ | *[[AutoGRAPH.NET_Service_GetTrips|GetTrips]] – получение информации о рейсах приборов с текущими настройками схемы |
| − | *[[AutoGRAPH. |
+ | *[[AutoGRAPH.NET_Service_GetTripsArea|GetTripsArea]] – получение информации о рейсах приборов с текущими настройками схемы + рассчитанные полигоны полей (если включена обработка полей) |
| + | *[[AutoGRAPH.NET_Service_GetTrips|GetTripsTotal]] – получение информации о рейсах приборов с текущими настройками схемы (только итоговые данные) |
||
| − | итоговые данные) |
||
| − | *[[AutoGRAPH.NET_Service_GetTripsArea|GetTripsAreaTotal]] – получение информации о рейсах приборов с текущими настройками схемы (только итоговые данные) + рассчитанные полигоны полей (если включена обработка полей) |
+ | *[[AutoGRAPH.NET_Service_GetTripsArea|GetTripsAreaTotal]] – получение информации о рейсах приборов с текущими настройками схемы (только итоговые данные) + рассчитанные полигоны полей (если включена обработка полей) |
| − | *[[AutoGRAPH.NET_Service_GetTripTables|GetTripTables]] – получение табличных данных по рейсам приборов |
+ | *[[AutoGRAPH.NET_Service_GetTripTables|GetTripTables]] – получение табличных данных по рейсам приборов |
| − | *[[AutoGRAPH.NET_Service_GetTripsCustom|GetTripsCustom]] – получение информации о рейсах приборов с указанными геозонами |
+ | *[[AutoGRAPH.NET_Service_GetTripsCustom|GetTripsCustom]] – получение информации о рейсах приборов с указанными геозонами |
| − | *[[AutoGRAPH.NET_Service_GetStage|GetStage]] – получение информации по одному отрезку для приборов |
+ | *[[AutoGRAPH.NET_Service_GetStage|GetStage]] – получение информации по одному отрезку для приборов |
| − | *[[AutoGRAPH.NET_Service_GetTrack|GetTrack]] – получение трека (даты/время, координаты, скорость) прибора |
+ | *[[AutoGRAPH.NET_Service_GetTrack|GetTrack]] – получение трека (даты/время, координаты, скорость) прибора |
| − | *[[AutoGRAPH.NET_Service_GetTripItems|GetTripItems |
+ | *[[AutoGRAPH.NET_Service_GetTripItems|GetTripItems]] - |
| + | *[[AutoGRAPH.NET_Service_GetTripByPeriod|GetTripByPeriod]] - |
||
| + | *[[AutoGRAPH.NET_Service_GetTripsMobileCheckpoints|GetTripsMobileCheckpoints]] – получение информации о рейсах приборов с мобильными контрольными точками |
||
| + | *[[GetTripsGroupByArea|GetTripsGroupByArea]] [[File:Tag-new.png|RTENOTITLE]] - возвращает площади обработанных полей, группированных по Поле/Устройство/Инструмент |
||
| + | *[[GetTripsGroupByDevice|GetTripsGroupByDevice]] [[File:Tag-new.png|RTENOTITLE]] - возвращает площади обработанных полей, группированных по Устройство/Поле/Инструмент |
||
=== Доступ к свойствам === |
=== Доступ к свойствам === |
||
| + | |||
| − | *[[AutoGRAPH.NET_Service_GetProperties|GetProperties]] – получение списка свойств и их значений устройства |
||
| + | *[[AutoGRAPH.NET_Service_GetProperties|GetProperties]], [[AutoGRAPH.NET_Service_GetProperties|GetGFProperties]], [[AutoGRAPH.NET_Service_GetProperties|GetDriverProperties]], [[AutoGRAPH.NET_Service_GetProperties|GetImplementProperties]] – получение списка свойств и их значений объектов |
||
| − | *[[AutoGRAPH.NET_Service_GetProperty|GetProperty]] – получение значения одного свойства у списка приборов |
||
| + | *[[AutoGRAPH.NET_Service_GetProperty|GetProperty]], [[AutoGRAPH.NET_Service_GetProperty|GetGFProperty]], [[AutoGRAPH.NET_Service_GetProperty|GetDriverProperty]], [[AutoGRAPH.NET_Service_GetProperty|GetImplementProperty]] – получение значения одного свойства у списка объектов |
||
| − | *[[AutoGRAPH.NET_Service_GetGFProperties|GetGFProperties]] – получение списка свойств и их значений геозон |
||
| + | *[[AutoGRAPH.NET_Service_SetProperties|SetProperties]], [[AutoGRAPH.NET_Service_SetProperties|SetGFProperties]], [[AutoGRAPH.NET_Service_SetProperties|SetDriverProperties]], [[AutoGRAPH.NET_Service_SetProperties|SetImplementProperties]] - установка значений свойств (или удаление свойств) у объектов |
||
| − | *[[AutoGRAPH.NET_Service_GetGFProperty|GetGFProperty]] – получение значения одного свойства у списка геозон |
||
| + | *[[AutoGRAPH.NET_Service_SetProperty|SetProperty]], [[AutoGRAPH.NET_Service_SetProperty|SetGFProperty]], [[AutoGRAPH.NET_Service_SetProperty|SetDriverProperty]], [[AutoGRAPH.NET_Service_SetProperty|SetImplementProperty]] - установка значений одного свойства (или удаление свойства) у объектов |
||
| − | *[[AutoGRAPH.NET_Service_GetDriverProperties|GetDriverProperties]] – получение списка свойств и их значений геозон |
||
| + | |||
| − | *[[AutoGRAPH.NET_Service_GetDriverProperty|GetDriverProperty]] – получение значения одного свойства у списка геозон |
||
| + | === Изменение объектов === |
||
| + | |||
| + | *[[SetGeofences|SetGeofences]] - создание/изменение/удаление геозон |
||
=== Выполнение отчетов === |
=== Выполнение отчетов === |
||
| − | *[[AutoGRAPH.NET_Service_EnumReports|EnumReports]] - получение списка доступных отчетов |
||
| − | *[[AutoGRAPH.NET_Service_GetReports|GetReports]] - выполнение нескольких отчетов и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается) |
||
| − | *[[AutoGRAPH.NET_Service_GetReport|GetReport]] - выполнение одного отчета и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается) |
||
| − | *[[AutoGRAPH.NET_Service_ExecuteReports|ExecuteReports]] - асинхронное выполнение отчета(ов) |
||
| − | *[[AutoGRAPH.NET_Service_GetReportsStatus|GetReportsStatus]] - получение состояния выполнения отчета(ов) |
||
| − | *[[AutoGRAPH.NET_Service_EnumReportSchedules|EnumReportSchedules]] [[File:Tag-new.png|RTENOTITLE]] - |
||
| − | *''CancelReports - отмена выполнения отчета'' |
||
| + | *[[AutoGRAPH.NET_Service_EnumReports|EnumReports]] - получение списка доступных отчетов |
||
| − | === Получение информации из DDD-файлов тахографа === |
||
| + | *[[AutoGRAPH.NET_Service_GetReports|GetReports]] - выполнение нескольких отчетов и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается) |
||
| − | *[[AutoGRAPH.NET_Service_GetCardStatistic|GetCardStatistic]] - получение информации по DDD-файлам указанной карты |
||
| + | *[[AutoGRAPH.NET_Service_GetReport|GetReport]] - выполнение одного отчета и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается) |
||
| − | *[[AutoGRAPH.NET_Service_GetCardStatisticAll|GetCardStatisticAll]] - получение информации по всем доступным DDD-файлам |
||
| − | *[[AutoGRAPH.NET_Service_GetCardRecords|GetCardRecords]] - получение информации из DDD-файлов указанных карт |
||
| − | *[[AutoGRAPH.NET_Service_GetCardStatByDrivers|GetCardStatByDrivers]] - получение информации с группировкой по водителям (номерам карт) |
||
| − | *[[AutoGRAPH.NET_Service_GetCardStatByVehicles|GetCardStatByVehicles]] - получение информации с группировкой по транспортному средству |
||
=== Пользователи, роли и токены === |
=== Пользователи, роли и токены === |
||
| + | |||
| − | *[[AutoGRAPH.NET_Service_EnumUsers|EnumUsers]] [[File:Tag-new.png|RTENOTITLE]] - получение списка пользователей |
||
| + | *[[AutoGRAPH.NET_Service_OTLCreate|OTLCreate]] - создание уникальных одноразовых ссылок с токеном (one-time link) |
||
| − | *[[AutoGRAPH.NET_Service_EnumRoles|EnumRoles]] [[File:Tag-new.png|RTENOTITLE]] - получение списка ролей |
||
| + | *[[AutoGRAPH.NET_Service_OTLDelete|OTLDelete]] - удаление уникальных ссылок по ID |
||
| − | *[[AutoGRAPH.NET_Service_UserDelete|UserDelete]] [[File:Tag-new.png|RTENOTITLE]] - |
||
| + | |||
| − | *[[AutoGRAPH.NET_Service_UserUpdate|UserUpdate]] [[File:Tag-new.png|RTENOTITLE]] - |
||
| + | === Работа с кэшированными данными === |
||
| − | *[[AutoGRAPH.NET_Service_MRuleDelete|MRuleDelete]] [[File:Tag-new.png|RTENOTITLE]] - |
||
| + | |||
| − | *[[AutoGRAPH.NET_Service_MRuleUpdate|MRuleUpdate]] [[File:Tag-new.png|RTENOTITLE]] - |
||
| + | *[[AutoGRAPH.NET_Service_CacheFind|CacheFind]] - получение кэшированных данных по отрезкам |
||
| − | *[[AutoGRAPH.NET_Service_OTLCreate|OTLCreate]] [[File:Tag-new.png|RTENOTITLE]] - создание уникальных одноразовых ссылок с токеном (one-time link) |
||
| + | |||
| − | *[[AutoGRAPH.NET_Service_OTLDelete|OTLDelete]] [[File:Tag-new.png|RTENOTITLE]] - удаление уникальных ссылок по ID |
||
| + | === Работа с данными приложения === |
||
| + | |||
| + | *[[AutoGRAPH.NET_Service_DataSave|DataSave]] - обновление кэшированных данных за указанны период |
||
| + | *[[AutoGRAPH.NET_Service_DataLoad|DataLoad]] - получение кэшированных данных по отрезкам |
||
| + | *[[AutoGRAPH.NET_Service_DataEnum|DataEnum]] - получение списка хранимых объектов-данных приложения |
||
=== Прочее === |
=== Прочее === |
||
| + | |||
| − | *[[AutoGRAPH.NET_Service_GetRoute|GetRoute]] – прокладка маршрута и получение этой информации в виде набора точек |
||
| + | *[[AutoGRAPH.NET_Service_GetRoute|GetRoute]] – прокладка маршрута и получение этой информации в виде набора точек |
||
| − | *[[AutoGRAPH.NET_Service_WaitData|WaitData]] - ожидание получения новых данных |
||
| − | *[[AutoGRAPH.NET_Service_GetDeviceStatus|GetDeviceStatus]] - получение текущего статуса транспортных средств |
+ | *[[AutoGRAPH.NET_Service_GetDeviceStatus|GetDeviceStatus]] - получение текущего статуса транспортных средств |
| − | *[[AutoGRAPH.NET_Service_SetDeviceStatus|SetDeviceStatus]] - установка текущего статуса транспортных средств |
+ | *[[AutoGRAPH.NET_Service_SetDeviceStatus|SetDeviceStatus]] - установка текущего статуса транспортных средств |
| + | *<s>[[AutoGRAPH.NET_Service_EnumTasks|EnumTasks]]</s> |
||
| + | *<s>[[AutoGRAPH.NET_Service_SetTasks|SetTasks]]</s> |
||
| + | *[[AutoGRAPH.NET_Service_GetNotes|GetNotes]] [[File:Tag-new.png|RTENOTITLE]] |
||
| + | *[[SendCommand|SendCommand]] - отправляет команду с аргументами на указанный список приборов |
||
| + | *[[GetCommandResponse|GetCommandResponse]] - получает список ответов приборов на команды за период |
||
Также сервис поддерживает загрузку/выгрузку и получение списка схем. AutoGRAPH.Pro (начиная с версии 2015.8.6) умеет работать с AutoGRAPH.NET Service как с веб-сервером. [[AutoGRAPH.NET_Service_WorkingSchemas|Подробнее здесь]]. |
Также сервис поддерживает загрузку/выгрузку и получение списка схем. AutoGRAPH.Pro (начиная с версии 2015.8.6) умеет работать с AutoGRAPH.NET Service как с веб-сервером. [[AutoGRAPH.NET_Service_WorkingSchemas|Подробнее здесь]]. |
||
=== Примеры === |
=== Примеры === |
||
| − | (C#, .NET 4, Visual Studio 2013 или Visual Studio Express) |
||
| + | (C#, .NET 4+, Visual Studio 2013 или Visual Studio Express) |
||
| − | [[AutoGRAPH.NET_Service_Examples|Примеры (WCF)]] |
||
| + | |||
| + | Скачать примеры (консольные и WinForms): [http://agi.tk-chel.ru/install/service/AutoGRAPHServiceExamples.zip http://agi.tk-chel.ru/install/service/AutoGRAPHServiceExamples.zip] |
||
[[AutoGRAPH.NET_Service_Examples_Powershell|Примеры на Powershell (JSON и экспорт в CSV)]] |
[[AutoGRAPH.NET_Service_Examples_Powershell|Примеры на Powershell (JSON и экспорт в CSV)]] |
||
Текущая версия на 12:01, 31 мая 2021
Содержание
Базовые методы сервиса
- Login – аутентификация и получение токена (в случае, если она включена)
- EnumSchemas – получение списка доступных сервису схем
- EnumDevices – получение списка устройств схемы
- EnumDrivers – получение информации о водителях в схеме
- EnumImplements – получение информации об инструментах в схеме
- EnumParameters – получение списка параметров устройства в схеме
- EnumGeoFences – получение списка геозон схемы
- EnumStatuses – получение списка доступных статусов устройств
- GetGeoFences – получение информации о геозонах (точки для полигонов и т.д.)
- FindDevices – поиск устройств по разным критериям
Получение данных по приборам
- GetDevicesInfo – получение информации об устройстве в схеме
- GetOnlineInfo – получение информации о последнем местоположении устройств
- GetOnlineInfoAll – получение информации о последнем местоположении всех устройств
- GetDataRanges – получение информации о загруженных данных для приборов (минимальная/максимальные доступные даты)
- GetTrips – получение информации о рейсах приборов с текущими настройками схемы
- GetTripsArea – получение информации о рейсах приборов с текущими настройками схемы + рассчитанные полигоны полей (если включена обработка полей)
- GetTripsTotal – получение информации о рейсах приборов с текущими настройками схемы (только итоговые данные)
- GetTripsAreaTotal – получение информации о рейсах приборов с текущими настройками схемы (только итоговые данные) + рассчитанные полигоны полей (если включена обработка полей)
- GetTripTables – получение табличных данных по рейсам приборов
- GetTripsCustom – получение информации о рейсах приборов с указанными геозонами
- GetStage – получение информации по одному отрезку для приборов
- GetTrack – получение трека (даты/время, координаты, скорость) прибора
- GetTripItems -
- GetTripByPeriod -
- GetTripsMobileCheckpoints – получение информации о рейсах приборов с мобильными контрольными точками
- GetTripsGroupByArea
- возвращает площади обработанных полей, группированных по Поле/Устройство/Инструмент - GetTripsGroupByDevice - возвращает площади обработанных полей, группированных по Устройство/Поле/Инструмент
Доступ к свойствам
- GetProperties, GetGFProperties, GetDriverProperties, GetImplementProperties – получение списка свойств и их значений объектов
- GetProperty, GetGFProperty, GetDriverProperty, GetImplementProperty – получение значения одного свойства у списка объектов
- SetProperties, SetGFProperties, SetDriverProperties, SetImplementProperties - установка значений свойств (или удаление свойств) у объектов
- SetProperty, SetGFProperty, SetDriverProperty, SetImplementProperty - установка значений одного свойства (или удаление свойства) у объектов
Изменение объектов
- SetGeofences - создание/изменение/удаление геозон
Выполнение отчетов
- EnumReports - получение списка доступных отчетов
- GetReports - выполнение нескольких отчетов и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается)
- GetReport - выполнение одного отчета и загрузка его в виде XML/PDF/DOCX/XLS/.../ZIP-файла (формат выполнения указывается)
Пользователи, роли и токены
- OTLCreate - создание уникальных одноразовых ссылок с токеном (one-time link)
- OTLDelete - удаление уникальных ссылок по ID
Работа с кэшированными данными
- CacheFind - получение кэшированных данных по отрезкам
Работа с данными приложения
- DataSave - обновление кэшированных данных за указанны период
- DataLoad - получение кэшированных данных по отрезкам
- DataEnum - получение списка хранимых объектов-данных приложения
Прочее
- GetRoute – прокладка маршрута и получение этой информации в виде набора точек
- GetDeviceStatus - получение текущего статуса транспортных средств
- SetDeviceStatus - установка текущего статуса транспортных средств
EnumTasksSetTasks- GetNotes
- SendCommand - отправляет команду с аргументами на указанный список приборов
- GetCommandResponse - получает список ответов приборов на команды за период
Также сервис поддерживает загрузку/выгрузку и получение списка схем. AutoGRAPH.Pro (начиная с версии 2015.8.6) умеет работать с AutoGRAPH.NET Service как с веб-сервером. Подробнее здесь.
Примеры
(C#, .NET 4+, Visual Studio 2013 или Visual Studio Express)
Скачать примеры (консольные и WinForms): http://agi.tk-chel.ru/install/service/AutoGRAPHServiceExamples.zip
