WebMap - Создание токенов — различия между версиями
Admin (обсуждение | вклад) |
Admin (обсуждение | вклад) (→Создание токена) |
||
| Строка 12: | Строка 12: | ||
URL: /Account/MakeToken |
URL: /Account/MakeToken |
||
| − | + | {|border="1" cellspacing="0" cellpadding="5" style="width: 100%;" |
|
| + | |- |
||
| − | <tr> |
||
| + | | Параметр |
||
| − | <td>id</td> |
||
| + | | Описание |
||
| − | <td>- ID организации, в которой будет выполнятся поиск объектов нижеуказанных UIDов.</td> |
||
| + | | Требуется? |
||
| − | <td>Обязателен</td> |
||
| + | |- |
||
| − | </tr> |
||
| + | |id |
||
| − | <tr> |
||
| + | |ID организации, в которой будет выполнятся поиск объектов нижеуказанных UIDов. |
||
| − | <td>iduser</td> |
||
| + | |Обязателен |
||
| − | <td>- ID пользователя, на которого создается токен (таблица Users в БД)</td> |
||
| + | |- |
||
| − | <td>Обязателен</td> |
||
| + | |iduser |
||
| − | </tr> |
||
| + | |ID пользователя, на которого создается токен (таблица Users в БД) |
||
| − | |||
| + | |Обязателен |
||
| − | <tr> |
||
| + | |- |
||
| − | <td>objID</td> |
||
| + | |objID |
||
| − | <td>- GUID объекта или объектов (ТС), на которой создаются токены. Один или несколько GUIDов (через запятую). Может быть как GUID группы так и отдельных ТС, так и тех и других (таблицы CarGroup и Cars в БД, поле UID)</td> |
||
| + | |GUID объекта или объектов (ТС), на которой создаются токены. Один или несколько GUIDов (через запятую). Может быть как GUID группы так и отдельных ТС, так и тех и других (таблицы CarGroup и Cars в БД, поле UID) |
||
| − | <td>Обязателен</td> |
||
| + | |Обязателен |
||
| − | </tr> |
||
| + | |- |
||
| − | |||
| + | |objSubgroups |
||
| − | <tr> |
||
| + | |true, если включать в токен все подгруппы указанных в objID групп или false, если включатся только ТС в указанной группе. |
||
| − | <td>objSubgroups</td> |
||
| + | |Если отсутствует - принимается как false |
||
| − | <td>- true, если включать в токен все подгруппы указанных в objID групп или false, если включатся только ТС в указанной группе.</td> |
||
| + | |- |
||
| − | <td>Если отсутствует - принимается как false</td> |
||
| + | |objTrack |
||
| − | </tr> |
||
| + | |true, если показывать трек за текущие сутки (по умолчанию) по всем доступным токену ТС или false, если только последнее местоположение |
||
| − | |||
| + | |Если отсутствует - принимается как false |
||
| − | <tr> |
||
| + | |- |
||
| − | <td>objTrack</td> |
||
| + | |geoFilterID |
||
| − | <td>- true, если показывать трек за текущие сутки (по умолчанию) по всем доступным токену ТС или false, если только последнее местоположение</td> |
||
| + | |GUID геозон, которые используются для фильтрации. Позволяет ограничить просмотр трека - трек будет отображаться только в указанных геозонах, например если указана большая геозона очерченная вокруг города - трек ТС будет показываться только в городе и не будет показываться вне этой геозоны (таблица GeoObject или GeoObjectGroup, поле UID) |
||
| − | <td>Если отсутствует - принимается как false</td> |
||
| + | |Не обязателен |
||
| − | </tr> |
||
| + | |- |
||
| − | |||
| + | |geoFilterSubgroups |
||
| − | <tr> |
||
| + | |true, если при фильтрации используется все вложенные подгруппы, а geoFilterID - GUID группы |
||
| − | <td>geoFilterID</td> |
||
| + | |Если отсутствует - принимается как false |
||
| − | <td>- GUID геозон, которые используются для фильтрации. Позволяет ограничить просмотр трека - трек будет отображаться только в указанных геозонах, например если указана большая геозона очерченная вокруг города - трек ТС будет показываться только в городе и не будет показываться вне этой геозоны (таблица GeoObject или GeoObjectGroup, поле UID)</td> |
||
| + | |- |
||
| − | <td>Не обязателен</td> |
||
| + | |geoViewID |
||
| − | </tr> |
||
| + | |GUID геозон или групп геозон, которые будут показываться на карте |
||
| − | |||
| + | |Не обязателен |
||
| − | <tr> |
||
| + | |- |
||
| − | <td>geoFilterSubgroups</td> |
||
| + | |geoViewSubgroups |
||
| − | <td>- true, если при фильтрации используется все вложенные подгруппы, а geoFilterID - GUID группы</td> |
||
| + | |true, если для отображения используется все вложенные подгруппы, а geoFilterID - GUID группы |
||
| − | <td>Если отсутствует - принимается как false</td> |
||
| + | |Если отсутствует - принимается как false |
||
| − | </tr> |
||
| + | |- |
||
| − | |||
| + | |SD |
||
| − | <tr> |
||
| + | |дата/время начала действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM |
||
| − | <td>geoViewID</td> |
||
| + | |Не обязательный параметр, если отсутствует - токен начинает действовать немедленно |
||
| − | <td>- GUID геозон или групп геозон, которые будут показываться на карте</td> |
||
| + | |- |
||
| − | <td>Не обязателен</td> |
||
| + | |ED |
||
| − | </tr> |
||
| + | |дата/время окончания действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM |
||
| − | |||
| + | |Не обязательный параметр, если отсутствует - токен будет бессрочным |
||
| − | <tr> |
||
| + | |- |
||
| − | <td>geoViewSubgroups</td> |
||
| + | |VSD |
||
| − | <td>- true, если для отображения используется все вложенные подгруппы, а geoFilterID - GUID группы</td> |
||
| + | |начальные дата/время доступных токену данных по ТС, локальное время пользователя. Формат YYYYMMDD-HHMM |
||
| − | <td>Если отсутствует - принимается как false</td> |
||
| + | |Не обязательный параметр, если отсутствует - данные доступны за весь период |
||
| − | </tr> |
||
| + | |- |
||
| − | |||
| + | |VED |
||
| − | <tr> |
||
| + | |конечные дата/время доступных токену данных - локальное время пользователя. Формат YYYYMMDD-HHMM |
||
| − | <td>SD</td> |
||
| + | |Не обязательный параметр, если отсутствует - данные доступны за весь период |
||
| − | <td>- дата/время начала действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM</td> |
||
| + | |} |
||
| − | <td>Не обязательный параметр, если отсутствует - токен начинает действовать немедленно</td> |
||
| − | </tr> |
||
| − | <tr> |
||
| − | <td>ED</td> |
||
| − | <td>- дата/время окончания действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM</td> |
||
| − | <td>Не обязательный параметр, если отсутствует - токен будет бессрочным</td> |
||
| − | </tr> |
||
| − | <tr> |
||
| − | <td>VSD</td> |
||
| − | <td>- начальные дата/время доступных токену данных по ТС, локальное время пользователя. Формат YYYYMMDD-HHMM</td> |
||
| − | <td>Не обязательный параметр, если отсутствует - данные доступны за весь период</td> |
||
| − | </tr> |
||
| − | <tr> |
||
| − | <td>VED</td> |
||
| − | <td>- конечные дата/время доступных токену данных - локальное время пользователя. Формат YYYYMMDD-HHMM</td> |
||
| − | <td>Не обязательный параметр, если отсутствует - данные доступны за весь период</td> |
||
| − | </tr> |
||
| − | </table> |
||
Пример: |
Пример: |
||
| + | <pre> |
||
| − | |||
| + | id=49&iduser=2&objID=25f86189-adc9-445d-940c-abf860874622&objSubgroups=true&objTrack=falseSD=20160806-0000&ED=20160901-0700 |
||
| + | </pre> |
||
== Изменение параметров токена == |
== Изменение параметров токена == |
||
Версия 17:46, 6 августа 2016
Через создание токенов можно предоставлять конечным пользователям уникальную ссылку для отслеживания транспортных средств в ограниченный период времени (например для слежения за грузами или доставкой).
Поддерживается следующие операции с токенами:
- Создание токена
- Изменение параметров токена (период действия, список доступных ТС, включение/отключение режима трека, ...)
- Удаление токена
Перед созданием токена необходима Аутентификация. Все операции выполняются методом POST с заголовком Content-Type = "application/x-www-form-urlencoded" и кодировке UTF-8.
Создание токена
URL: /Account/MakeToken
| Параметр | Описание | Требуется? |
| id | ID организации, в которой будет выполнятся поиск объектов нижеуказанных UIDов. | Обязателен |
| iduser | ID пользователя, на которого создается токен (таблица Users в БД) | Обязателен |
| objID | GUID объекта или объектов (ТС), на которой создаются токены. Один или несколько GUIDов (через запятую). Может быть как GUID группы так и отдельных ТС, так и тех и других (таблицы CarGroup и Cars в БД, поле UID) | Обязателен |
| objSubgroups | true, если включать в токен все подгруппы указанных в objID групп или false, если включатся только ТС в указанной группе. | Если отсутствует - принимается как false |
| objTrack | true, если показывать трек за текущие сутки (по умолчанию) по всем доступным токену ТС или false, если только последнее местоположение | Если отсутствует - принимается как false |
| geoFilterID | GUID геозон, которые используются для фильтрации. Позволяет ограничить просмотр трека - трек будет отображаться только в указанных геозонах, например если указана большая геозона очерченная вокруг города - трек ТС будет показываться только в городе и не будет показываться вне этой геозоны (таблица GeoObject или GeoObjectGroup, поле UID) | Не обязателен |
| geoFilterSubgroups | true, если при фильтрации используется все вложенные подгруппы, а geoFilterID - GUID группы | Если отсутствует - принимается как false |
| geoViewID | GUID геозон или групп геозон, которые будут показываться на карте | Не обязателен |
| geoViewSubgroups | true, если для отображения используется все вложенные подгруппы, а geoFilterID - GUID группы | Если отсутствует - принимается как false |
| SD | дата/время начала действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM | Не обязательный параметр, если отсутствует - токен начинает действовать немедленно |
| ED | дата/время окончания действия токена - локальное время пользователя. Формат YYYYMMDD-HHMM | Не обязательный параметр, если отсутствует - токен будет бессрочным |
| VSD | начальные дата/время доступных токену данных по ТС, локальное время пользователя. Формат YYYYMMDD-HHMM | Не обязательный параметр, если отсутствует - данные доступны за весь период |
| VED | конечные дата/время доступных токену данных - локальное время пользователя. Формат YYYYMMDD-HHMM | Не обязательный параметр, если отсутствует - данные доступны за весь период |
Пример:
id=49&iduser=2&objID=25f86189-adc9-445d-940c-abf860874622&objSubgroups=true&objTrack=falseSD=20160806-0000&ED=20160901-0700
