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

Материал из TK
Перейти к: навигация, поиск
(Новая страница: «Ищет устройств по указанным критериям и возвращает N первых найденных. == Вызов (метод GET):…»)
 
(нет различий)

Текущая версия на 14:22, 14 июля 2020

Ищет устройств по указанным критериям и возвращает N первых найденных.

Вызов (метод GET):

http://m.tk-chel.ru/ServiceJSON/FindDevices?session=B05043B71F4B9C67C910163779FFF06EDBBAEF994B2D6C3A84DD96EB767A0F44&schemaID=b4b68be6-a124-4ca3-ab02-589e7c2ef102&serials=9999999,9999998,9999997&firstN=10
http://m.tk-chel.ru/ServiceJSON/FindDevices?session=B05043B71F4B9C67C910163779FFF06EDBBAEF994B2D6C3A84DD96EB767A0F44&schemaID=b4b68be6-a124-4ca3-ab02-589e7c2ef102&names=Frei*,GAZell,Courier*
http://m.tk-chel.ru/ServiceJSON/FindDevices?session=B05043B71F4B9C67C910163779FFF06EDBBAEF994B2D6C3A84DD96EB767A0F44&schemaID=b4b68be6-a124-4ca3-ab02-589e7c2ef102&vehicleRegNumbers=*783*,OT739*

Параметры:

  • schemaID  - идентификатор схемы, полученный с помощью EnumSchemas
  • serials (необязательный параметр) - 0 или более серийных номеров для поиска
  • names (необязательный параметр) - 0 или более названий устройств для поиска, подерживается обработка масок * (любое количество символов) и ? (один символ)
  • vehicleRegNumbers (необязательный параметр) - 0 или более регистрационных номеров устройств для поиска (свойство VehicleRegNumber), подерживается обработка масок * (любое количество символов) и ? (один символ)
  • firstN (необязательный параметр) - вернуть только первые firstN найденных элементов. По умолчанию 100, минимум 1.

Один из параметров serials, names или vehicleRegNumbers обязательно должен быть указан.

Результат - массив RFindDevice (RDeviceItem, RGroupItem в описании EnumDevices):

public class RFindDevice
{
    public RFindDeviceKind FindBy { get; set; }
    public RDeviceItem     Item   { get; set; }
    
    /// <summary> from Item.Parent ... to root </summary>
    public RGroupItem[]    Path   { get; set; }
}

public enum RFindDeviceKind
{
    BySerial           = 0,
    ByName             = 1,
    ByVehicleRegNumber = 2
}