AutoGRAPH.NET Service OTLCreate — различия между версиями

Материал из TK
Перейти к: навигация, поиск
(Новая страница: «Создает токен для уникальной ссылки. После создания токена его можно использовать в вид…»)
 
Строка 1: Строка 1:
Создает токен для уникальной ссылки. После создания токена его можно использовать в виде http://localhost/Strict/Token/f4aefb2e-bce3-4c0d-8857-14edf40cdd19 - где f4aefb2e-bce3-4c0d-8857-14edf40cdd19 это тот самый токен. Предназначено для публикации состояния для конечных клиентов.
+
Создает токен для уникальной ссылки. После создания токена его можно использовать в виде [http://localhost/Strict/Token/f4aefb2e-bce3-4c0d-8857-14edf40cdd19 http://localhost/Strict/Token/f4aefb2e-bce3-4c0d-8857-14edf40cdd19] - где f4aefb2e-bce3-4c0d-8857-14edf40cdd19 это тот самый токен. Предназначено для публикации состояния для конечных клиентов.
   
== WCF ==
+
== JSON ==
  +
  +
Вызов:
  +
<pre>http://localhost:8300/OTLCreate?schemaID=34f0dea6-5762-41a5-89d3-bc5d28f35c03&IDUSER= ...
  +
(остальные параметры по именам и назначению соответствуют определению WCF-метода)
  +
</pre>
  +
  +
Булевы параметры задаются 0 или 1.<br/>showStages - указывается через запятую<br/>Дата и время задается в формате '''yyyyMMdd-HHmm'''<br/>Если ID'ов больше одного - идентификаторы указывается через запятую.
  +
  +
== WCF&nbsp;''<small><span style="background-color:#FFFF00;">протокол устарел и не рекомендуется к использованию. Будет удалён с 01.06.2020</span></small>'' ==
   
 
Определение:
 
Определение:
Строка 11: Строка 20:
 
DateTime? ViewSD, DateTime? ViewED)</pre>
 
DateTime? ViewSD, DateTime? ViewED)</pre>
   
* schemaID – ID схемы [[AutoGRAPH.NET_Service_EnumSchemas|EnumSchemas]])
+
*schemaID – ID схемы [[AutoGRAPH.NET_Service_EnumSchemas|EnumSchemas]])
* IDUSER - ID пользователя (список получается с помощью метода [[AutoGRAPH.NET_Service_EnumUsers|EnumUsers]])
+
*IDUSER - ID пользователя (список получается с помощью метода [[AutoGRAPH.NET_Service_EnumUsers|EnumUsers]])
* carOrGroupID - ID группы или ТС, которые будут доступны по токену ([[AutoGRAPH.NET_Service_EnumDevices|EnumDevices]])
+
*carOrGroupID - ID группы или ТС, которые будут доступны по токену ([[AutoGRAPH.NET_Service_EnumDevices|EnumDevices]])
* objectSubgroups - включать или нет подгруппы (имеет смысл, только если в carOrGroupID указан ID группы)
+
*objectSubgroups - включать или нет подгруппы (имеет смысл, только если в carOrGroupID указан ID группы)
* showTrack - показывать трек или нет (по умолчанию за текущие сутки)
+
*showTrack - показывать трек или нет (по умолчанию за текущие сутки)
* showStages - отображать на треке указанные статусы ([[AutoGRAPH.NET_Service_EnumParameters|EnumParameters]] - те параметры, у которых Statuses!=null ([[AutoGRAPH.NET_Service_EnumGeoFences|EnumGeoFences]]) (в настоящее время не реализовано и игнорируется)
+
*showStages - отображать на треке указанные статусы ([[AutoGRAPH.NET_Service_EnumParameters|EnumParameters]] - те параметры, у которых Statuses!=null ([[AutoGRAPH.NET_Service_EnumGeoFences|EnumGeoFences]]) (в настоящее время не реализовано и игнорируется)
   
* geoOrGroupFilterID - ID группы или геозоны, который используется для фильтрации. Объекты, которые находятся вне этих геообъектов - на карте отображаться не будут ([[AutoGRAPH.NET_Service_EnumGeoFences|EnumGeoFences]])
+
*geoOrGroupFilterID - ID группы или геозоны, который используется для фильтрации. Объекты, которые находятся вне этих геообъектов - на карте отображаться не будут ([[AutoGRAPH.NET_Service_EnumGeoFences|EnumGeoFences]])
* geoFilterSubgroups - включать или нет геообъекты из подгрупп для фильтрации
+
*geoFilterSubgroups - включать или нет геообъекты из подгрупп для фильтрации
   
* geoOrGroupShowID - ID группы или геозоны для отображения на карте ([[AutoGRAPH.NET_Service_EnumGeoFences|EnumGeoFences]])
+
*geoOrGroupShowID - ID группы или геозоны для отображения на карте ([[AutoGRAPH.NET_Service_EnumGeoFences|EnumGeoFences]])
* geoShowSubgroups - включать или нет геообъекты из подгрупп для отображения
+
*geoShowSubgroups - включать или нет геообъекты из подгрупп для отображения
* SD / ED - дата-время ограничения на трек
+
*SD / ED - дата-время ограничения на трек
* ViewSD / ViewED - не реализовано в данный момент
+
*ViewSD / ViewED - не реализовано в данный момент
   
 
Результат: возвращается GUID токена
 
Результат: возвращается GUID токена
== JSON ==
 
 
Вызов:
 
<pre>
 
http://localhost:8300/OTLCreate?schemaID=34f0dea6-5762-41a5-89d3-bc5d28f35c03&IDUSER= ...
 
(остальные параметры по именам и назначению соответствуют определению WCF-метода)
 
</pre>
 
 
Булевы параметры задаются 0 или 1.<br/>
 
showStages - указывается через запятую<br/>
 
Дата и время задается в формате '''yyyyMMdd-HHmm'''<br/>Если ID'ов больше одного - идентификаторы указывается через запятую.
 

Версия 16:18, 21 января 2020

Создает токен для уникальной ссылки. После создания токена его можно использовать в виде http://localhost/Strict/Token/f4aefb2e-bce3-4c0d-8857-14edf40cdd19 - где f4aefb2e-bce3-4c0d-8857-14edf40cdd19 это тот самый токен. Предназначено для публикации состояния для конечных клиентов.

JSON

Вызов:

http://localhost:8300/OTLCreate?schemaID=34f0dea6-5762-41a5-89d3-bc5d28f35c03&IDUSER= ...
(остальные параметры по именам и назначению соответствуют определению WCF-метода)

Булевы параметры задаются 0 или 1.
showStages - указывается через запятую
Дата и время задается в формате yyyyMMdd-HHmm
Если ID'ов больше одного - идентификаторы указывается через запятую.

WCF протокол устарел и не рекомендуется к использованию. Будет удалён с 01.06.2020

Определение:

Guid OTLCreate(string schemaID, Guid IDUSER,
            Guid carOrGroupID, bool objectSubgroups, bool showTrack, string[] showStages,
            Guid? geoOrGroupFilterID, bool geoFilterSubgroups,
            Guid? geoOrGroupShowID, bool geoShowSubgroups,
            DateTime? SD, DateTime? ED,
            DateTime? ViewSD, DateTime? ViewED)
  • schemaID – ID схемы EnumSchemas)
  • IDUSER - ID пользователя (список получается с помощью метода EnumUsers)
  • carOrGroupID - ID группы или ТС, которые будут доступны по токену (EnumDevices)
  • objectSubgroups - включать или нет подгруппы (имеет смысл, только если в carOrGroupID указан ID группы)
  • showTrack - показывать трек или нет (по умолчанию за текущие сутки)
  • showStages - отображать на треке указанные статусы (EnumParameters - те параметры, у которых Statuses!=null (EnumGeoFences) (в настоящее время не реализовано и игнорируется)
  • geoOrGroupFilterID - ID группы или геозоны, который используется для фильтрации. Объекты, которые находятся вне этих геообъектов - на карте отображаться не будут (EnumGeoFences)
  • geoFilterSubgroups - включать или нет геообъекты из подгрупп для фильтрации
  • geoOrGroupShowID - ID группы или геозоны для отображения на карте (EnumGeoFences)
  • geoShowSubgroups - включать или нет геообъекты из подгрупп для отображения
  • SD / ED - дата-время ограничения на трек
  • ViewSD / ViewED - не реализовано в данный момент

Результат: возвращается GUID токена