Notify
Методи API | Опис |
---|---|
POST v1/delNotify |
Метод для видалення нотифікації. |
GET v1/getNotify?id={id} |
Метод для отримання нотифікації. |
GET v1/getNotifyMessage?id={id} |
Метод для отримання повідомлення нотифікації. |
GET v1/getNotifyMessagesCount |
Метод для отримання кількості повідомлень нотифікації. |
POST v1/insNotify |
Метод для збереження нотифікації. |
GET v1/selNotifications |
Метод який повертає масив нотифікацій акаунта. |
GET v1/selNotifyActions |
Метод який повертає масив типів подій нотифікацій. |
GET v1/selNotifyMessages?RowIndex={RowIndex}&RowCount={RowCount} |
Метод який повертає масив повідомлень нотифікацій акаунта. |
POST v1/updNotify |
Метод для редагування нотифікації. |
POST v1/updNotifyIsActive |
Метод для встановлення IsActive нотифікації. |
POST v1/updNotifyMessageIsComplete |
Метод для завершення повідомлення нотифікації. |
Devices
Методи API | Опис |
---|---|
POST v1/delDeviceFuelNorm |
Метод для видалення норми пального по авто. |
POST v1/delDeviceEquipment |
Метод для видалення додаткового механізму. |
POST v1/delDeviceData |
Метод видалення даних датчиків авто за період. Доступно для адміністраторів. По-замовчуванню заборонено. Якщо вам потрібна дана функція - звертайтесь до вашого менеджера. |
POST v1/delDeviceEquipmentFuelNorm |
Метод для видалення норми пального додаткового механізму. |
POST v1/delDeviceSpeedometer |
Метод видалення показника спідометра. |
POST v1/delDeviceWatch |
Метод видалення посилання на авто. |
POST v1/delClientDriver |
Метод для видалення водія. |
GET v1/getClientDriver?id={id} |
Метод для отримання водія. |
GET v1/getDeviceLastStatus?DeviceID={DeviceID}&DateFrom={DateFrom}&DateTo={DateTo} |
Метод для отримання статусу авто за його ID. |
GET v1/getDeviceSummary?DeviceID={DeviceID}&DateFrom={DateFrom}&DateTo={DateTo}&IsUseTimeInEachDay={IsUseTimeInEachDay} |
Отримання узагальненої інформації по авто. |
GET v1/getDeviceEquipment?id={id} |
Метод для отримання додаткового механізму. |
GET v1/getDevicePoint?DeviceID={DeviceID}&OnDate={OnDate}&IsNeedSpeedFilter={IsNeedSpeedFilter}&IsNeedAngle={IsNeedAngle}&IsNeedLastCorrect={IsNeedLastCorrect}&IsNeedFirstSpeedPoint={IsNeedFirstSpeedPoint} |
Метод для отримання даних пристрою. |
POST v1/getDeviceWatch |
Метод для генерування нового веб посилання на авто. |
POST v1/getDeviceWatchSendBySMS |
Метод пересилки веб посилання на авто за допомогою СМС. |
POST v1/insClientDriver |
Метод збереження водія авто. |
POST v1/insDeviceEquipment |
Метод збереження додаткового обладнання авто. |
POST v1/insDeviceFuelNorm |
Метод збереження норми пального авто. |
POST v1/insDeviceSpeedometer |
Метод збереження показника спідометра. |
GET v1/selClientDriver |
Метод для отримання водіїв. |
GET v1/selDeviceData?DeviceID={DeviceID}&DateFrom={DateFrom}&DateTo={DateTo}&RowIndex={RowIndex}&RowCount={RowCount} |
Метод для отримання даних датчиків авто за певний період часу. |
GET v1/selDeviceEquipment |
Метод для отримання додаткового обладнання. |
GET v1/selDeviceFuelNorm?DeviceID={DeviceID} |
Метод для отримання норм пального по авто. |
GET v1/selDeviceEquipmentFuelNorm?DeviceEquipmentID={DeviceEquipmentID} |
Метод для отримання норм пального додаткового обладнання. |
GET v1/selDeviceLastPositions |
Метод який повертає останні позиції всіх пристроїв клієнта. |
GET v1/selDeviceLastStatus?DateFrom={DateFrom}&DateTo={DateTo}&IsOverrideOutOfTimeCalculation={IsOverrideOutOfTimeCalculation}&IsNeedLog={IsNeedLog} |
Метод для отримання списку останніх статусів авто акаунта. |
GET v1/selDeviceRoute?DeviceID={DeviceID}&DateFrom={DateFrom}&DateTo={DateTo}&RowIndex={RowIndex}&RowCount={RowCount} |
Метод для отримання даних gps-датчика авто за певний період часу. |
GET v1/selDeviceRouteUTC?DeviceID={DeviceID}&DateFromUTC={DateFromUTC}&DateToUTC={DateToUTC}&RowIndex={RowIndex}&RowCount={RowCount} |
Метод для отримання даних gps-датчика авто за певний період часу UTC. |
GET v1/selDevicePointsTemperature?DeviceID={DeviceID}&DateFrom={DateFrom}&DateTo={DateTo}&RowIndex={RowIndex}&RowCount={RowCount} |
Метод для отримання даних зовнішнього датчика температури за певний період часу |
GET v1/selDeviceWatch |
Метод для отримання посилань на авто згенерованих акаунтом. |
GET v1/selGroupDevices |
Метод який повертає масив груп авто. |
POST v1/updClientDriver |
Метод редагування водія авто. |
POST v1/updDeviceEquipment |
Метод редагування додаткового обладнання авто. |
POST v1/updDeviceFuelNorm |
Метод редагування норми пального авто. |
POST v1/updDeviceSpeedometer |
Метод редагування показника спідометра. |
POST v2/getDeviceWatch |
Метод для генерування нового веб посилання на авто (вер.2). |
GET v3/getDevice?id={id} |
Метод для отримання авто по його ID. |
GET v3/getDevicePath?deviceID={deviceID}&dateFrom={dateFrom}&dateTo={dateTo} |
Метод для отримання пройденого шляху авто за певний період часу. |
GET v3/getDevicePathDocument1C?deviceID={deviceID}&dateFrom={dateFrom}&dateTo={dateTo}&document1C={document1C} |
Метод для отримання відстані для авто за документом 1С. Тобто відстань від "Завантажено" до "Розвантажено". |
GET v3/selDevices |
Метод для отримання всіх авто акаунта. |
GET v3/selDeviceStatus1C?deviceID={deviceID}&dateFrom={dateFrom}&dateTo={dateTo}&document1C={document1C} |
Метод для отримання переліку статусів авто (завантажений, розвантажений) за період часу. |
POST v3/updDeviceCode1C |
Метод для оновлення коду 1С авто. |
POST v3/updDeviceLoadUnload |
Метод для оновлення статусу авто (оновлює статус "завантажено", "розвантажено") |
GET v4/selDevices?isNeedLastPosition={isNeedLastPosition} |
Метод для отримання всіх авто акаунта. |
ApiCommon
Службові методи
Методи API | Опис |
---|---|
POST v1/getVariablesCacheState |
Видалення застарілих наборів даних з кешу |
POST v1/cleanVariablesCache |
Видалення застарілих наборів даних з кешу |
POST v1/reloadSettings |
Перечитка налаштувань API |
GET v1/getMode |
Отримання режиму роботи |
IButton
Методи упраління Ключами-ідентифікаторами
Методи API | Опис |
---|---|
GET v1/selIButtons |
Метод для отимання всіх ключів |
GET v1/getIButton?id={id} |
Метод для отримання ключа |
GET v1/delIButton?id={id} |
Метод для видалення ключа |
POST v1/insIButton |
Метод для додавання ключа |
POST v1/insIButtonValue |
Метод для додавання значення ключа |
POST v1/updIButton |
Метод для редагування ключа |
POST v2/delIButton |
Метод для видалення ключа вер.2 |
Account
Методи API | Опис |
---|---|
POST v1/delAccount |
Метод для видалення акаунта. (Доступно для адміністраторів) |
POST v1/delFireBaseToken |
Метод для видалення токена доступу пуш-повідомлень. |
GET v1/getAccountSetting?type={type} |
Метод для отримання налаштувань акаунта |
GET v1/getAccount?token={token} |
Метод для отримання даних акаунта. (Доступно для всіх користувачів) |
GET v1/getAuth?phone={phone}&password={password} |
Метод для перевірки даних авторизації. (Доступно для всіх користувачів) |
GET v1/getAccountPasswordBySMS?phone={phone} |
Метод для надсилання паролю на телефон користувача. (Доступно для всіх користувачів) |
POST v1/insAccount |
Метод для збереження нового акаунта. |
GET v1/selAccounts |
Метод для отримання всіх акаунтів клієнта (доступно лише для акаунтів з правами адміністратора) |
GET v1/selAccountSettings |
Метод для отримання всіх налаштувань акаунта |
POST v1/insUpdAccountSetting |
Метод редагування налаштувань акаунта. |
POST v1/insUpdFireBaseToken |
Метод для збереження токена доступу для пуш-повідомлень. |
POST v1/updAccount |
Метод для редагування акаунта. |
GET v2/getAccountSettings?type[0]={type[0]}&type[1]={type[1]} |
Метод для отримання налаштувань акаунта вер.2 |
1C
Методи API | Опис |
---|---|
POST v2/1c/units/{id}/UpdateInfo |
Метод для оновлення додаткових властивостей авто (unit-a) в системі Контроль+". |
POST v2/1c/units/{id}/UpdateStatus |
Метод для збереження статусу авто unit-a (завантажений, розвантажений) в системі Контроль+. |
GET v2/1c/units/{id}/PathLengthByWayBill?from={from}&to={to}&documentguid={documentguid} |
Метод для отримання відстані для авто (unit-а) по документу в системі Контроль+. Тобто відстань від "Завантажено" до "Розвантажено". |
GET v2/1c/units/{id}/GetStatus |
Метод для отримання переліку статусів unit-a (завантажений, розвантажений) за період часу в системі Контроль+. |
Regions
Методи API | Опис |
---|---|
POST v3/delRegion |
Метод для видалення регіону. |
POST v3/insRegionCircle |
Метод для збереження нового кругового регіону. |
POST v3/insRegionsCircle |
Метод для збереження масиву кругових регіонів. |
POST v3/updRegionCircle |
Метод для редагування кругового регіону. |
POST v3/insRegionPolygon |
Метод для збереження нового регіону довільної форми. |
POST v3/insRegionsPolygon |
Метод для збереження масиву регіонів довільної форми. |
POST v3/updRegionPolygon |
Метод для редагування регіону довільної форми. |
GET v3/selRegions |
Метод для отримання списку регіонів. вер.3 |
POST v1/delGroupOfRegions |
Метод для видалення групи регіонів. |
POST v1/delRegions |
Метод для видалення регіонів клієнта. |
POST v1/delRegionBase |
Метод для видалення "базового" регіону авто. |
POST v1/delRegionGroup |
Метод для видалення регіонів з групи. |
POST v1/delRegionsBase |
Метод для видалення всіх "базових" регіонів авто. |
POST v1/delRegionCulture |
Метод для видалення агро-культури. |
POST v1/delRegionWork |
Метод для видалення агро-роботи. |
GET v1/getGroupOfRegions?id={id} |
Метод який повертає групу регіонів. |
GET v1/getRegion?id={id} |
Метод для отримання регіону. |
GET v1/getRegionCulture?id={id} |
Метод для отримання агро-культури. |
GET v1/getRegionVisited?RegionID={RegionID}&DeviceID={DeviceID}&DateFrom={DateFrom}&DateTo={DateTo} |
Метод для отримання всіх авто, що відвідали регіон. |
GET v1/getRegionWork?id={id} |
Метод для отримання агро-роботи. |
POST v1/insGroupOfRegion |
Метод для збереження групи регіонів. |
POST v1/insRegionBase |
Метод для збереження "базового" регіону авто. |
POST v1/insRegionGroup |
Метод для додавання регіонів до групи. |
POST v1/insRegionCulture |
Метод для збереження агро-культури. |
POST v1/insRegionWork |
Метод для збереження агро-роботи. |
GET v1/selGroupOfRegions |
Метод який повертає масив груп регіонів. |
GET v1/selRegionsBase?deviceID={deviceID} |
Метод який повертає масив регіонів за групою. |
GET v1/selRegionCulture |
Метод для отримання агро-культур. |
GET v1/selRegionWork |
Метод для отримання агро-робіт. |
POST v1/updGroupOfRegion |
Метод для редагування групи регіонів. |
GET v1/selRegionsByGroup?groupID={groupID} |
Метод який повертає масив регіонів за групою. |
POST v1/updRegion |
Метод для редагування регіону клієнта. |
POST v1/updRegionBase |
Метод для редагування "базового" регіону авто. |
POST v1/updRegionCache |
Метод для оновлення регіонів клієнта в кеш-памяті АПІ. |
POST v1/updRegionCulture |
Метод редагування агро-культури. |
POST v1/updRegionWork |
Метод для редагування агро-роботи. |
GET v4/selRegions |
Метод для отримання списку регіонів. вер.4 |
Units
Даний контролер буде видалено в наступних оновленнях АРІ. Використовуйте методи контролеру Devices
Методи API | Опис |
---|---|
GET v2/units/{id}/messages?from={from}&to={to} |
Метод для отримання даних датчиків за вказаний інтервал часу. |
GET v2/units |
Метод для отримання переліку доступних одиниць техніки (units), яка зареєстрована у користувача системи Контроль+. |
GET v2/units/{id} |
Метод для отримання unit-a по його ID. |
GET v2/units/{id}/sensors |
Метод отримання всіх доступних датчиків вказаного unit-а. |
GET v2/units/{id}/route |
Метод для отримання маршруту unit-а за визначений час, тобто значення gps-датчика. |
GET v2/units/{id}/PathLength |
Метод для отримання пройденого шляху unit-a за певний період часу. |
WayBills
Методи API | Опис |
---|---|
POST v3/insWayBillOneTime |
Метод для збереження нового "разового" маршрутного листа. |
POST v3/updWayBillOneTime |
Метод для редагування "разового" маршрутного листа. |
POST v3/insWayBillCyclical |
Метод для збереження нового циклічного маршрутного листа. |
POST v3/updWayBillCyclical |
Метод для редагування циклічного маршрутного листа. |
GET v3/selWayBillsOneTime?dateFrom={dateFrom}&dateTo={dateTo} |
Метод для отримання списку "разових" маршрутних листів за обраний період. (За відсутності параметрів отримаємо "разові" маршрутні в яких не вводились дати). |
GET v3/selWayBillsCyclical |
Метод для отримання списку циклічних маршрутних листів. |
GET v3/getWayBillOneTime?id={id} |
Метод для отримання "разового" маршрутного листа за його ID |
GET v3/getWayBillOneTimeByNo?no={no} |
Метод для отримання "разового" маршрутного листа за його номером |
GET v3/getWayBillCyclical?id={id} |
Метод для отримання циклічного маршрутного листа за його ID |
GET v3/getWayBillCyclicalByNo?no={no} |
Метод для отримання циклічного маршрутного листа за його номером |
Reports
Методи API | Опис |
---|---|
GET v2/fuelstation/{id}?from={from}&to={to} |
Метод для отримання інформації про заправки АЗС. |
GET v3/selReportFuelStation?deviceID={deviceID}&dateFrom={dateFrom}&dateTo={dateTo} |
Метод для отримання інформації про заправки АЗС. |
GET v3/selReportDownTime?deviceID={deviceID}&dateFrom={dateFrom}&dateTo={dateTo}&isNeedFindRegion={isNeedFindRegion}&isNeedAddress={isNeedAddress} |
Метод який обраховує звіт "Простої" |
GET v1/selReportCommons |
Метод який обраховує звіт "Загальний". |
GET v1/selReportFuelInOut |
Метод який обраховує звіт "Заправки/зливи". |
GET v1/selReportFuelSpend |
Метод який обраховує звіт "Витрати пального". |
GET v1/selReportGoToRoute |
Метод який обраховує звіт "Виїзд на маршрут". |
GET v1/selReportRegionVisit |
Метод який обраховує звіт "Відвідані регіони". |
GET v1/selReportPathInRegion |
Метод який обраховує звіт "Пробіг в регіоні". |
GET v1/selReportWayBill |
Метод який обраховує звіт "Маршрутний лист". |
GET v4/selReportDownTime |
Метод який обраховує звіт "Простої". вер.4 |
GET v4/selReportFuelStation |
Метод який обраховує звіт "Заправна станція". |
GET v4/selReportWayFuel |
Метод який обраховує звіт "Пробіг/Пальне" вер.4 |
Web5Agro
Методи API | Опис |
---|---|
POST v1/delWeb5AgroPlan |
Метод для видалення плану по агромодулю. |
POST v1/delWeb5AgroPlanRegion |
Метод для видалення регіонів агромодуля. |
GET v1/getWeb5AgroPlan?id={id} |
Метод отримання планування по агромодулю. |
POST v1/insWeb5AgroPlan |
Метод збереження плану по агромодулю. |
GET v1/selWeb5AgroPlan |
Метод отримання планувань по агромодулю. |
GET v1/selWeb5AgroPlanRegion |
Метод отримання регіонів агромодуля. |
GET v1/selWeb5AgroReport |
Метод для розрахунку звіту по агромодулю. |
POST v1/updWeb5AgroPlan |
Метод редагування плану по агромодулю. |
POST v1/updWeb5AgroPlanRegion |
Метод редагування регіонів агромодуля. |
POST v1/updWeb5AgroReport |
Метод для редагування звіту по агромодулю. |