TeamWherx

TeamWherx(TW) — это универсальная платформа управления службами, которая помогает более эффективно управлять удаленными командами сотрудников и общими бизнес-операциями от офиса. В качестве облачного решения TW обеспечивает удаленную сбор данных и отображает его с помощью панели мониторинга веб-приложения, предоставляя менеджерам дополнительную информацию, необходимую для создания более умных стратегий для повышения эффективности, производительности и снижения затрат при координации своих мобильных сотрудников.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Поддержка Actsoft
URL	https://www.actsoft.com/self-help-wizards
Адрес электронной почты	support@actsoft.com

Метаданные соединителя
Publisher	Actsoft
Веб-сайт	https://actsoft.com
Политика конфиденциальности	https://www.actsoft.com/privacy
Категории	Продуктивность

Описание соединителя:

TeamWherx позволяет создавать и записывать цифровые сведения о форме, сведения о времени сотрудников и управлять рабочими заказами с помощью системы диспетчеризации.

Подробное описание

Соединитель TeamWherx позволяет пользователям подключаться и обмениваться информацией между несколькими платформами. Вы можете анимировать данные для создания потоков обработки, управлять другими внутренними приложениями и получать мощные аналитические сведения. Автоматизируйте и оптимизируйте ежедневные, еженедельные или ежемесячные процессы с доступом к up-to-моменту практических данных.

Предварительные требования ##

Чтобы использовать этот соединитель, вам потребуется следующее:

Учетная запись TeamWherx
Ключ API TeamWherx
План Microsoft Power Apps или Power Automate

## Как получить учетные данные

Портал разработчика API

Чтобы получить доступ к соединителю, необходимо сначала настроить имя пользователя и пароль для портала разработчика API API и подписаться на API клиента:

В приложении перейдите в раздел "НастройкаAPIадминистративных>>параметров".
Выберите "Создать учетные данные".
Введите имя и фамилию в соответствующих полях.
Введите адрес электронной почты в поле "Адрес электронной почты".
Нажмите кнопку "Сохранить и отправить приглашение по электронной почте". Затем проверьте электронную почту, чтобы узнать, как создать пароль.
В сообщении электронной почты приглашения нажмите кнопку "Выбратьпароль", в котором откроется диалоговое окно, которое позволит вам создать пароль.
Нажмите кнопку "Сохранить пароль".
Чтобы перейти к порталу разработчика, перейдите напортал разработчика в разделе "Административные>параметры>".
На портале разработчика выберите "Продукты", а затем выберите API клиента.
Выберите "Подписаться".

Ключ API

Теперь, когда вы являетесь зарегистрированным пользователем API, буквенно-цифровой последовательностью, которая называется ключом, была создана для вас. Этот ключ потребуется для работы с данными в API.

Чтобы найти ключ API, выполните следующие действия.

Выберите продукты из меню портала разработчика. Будут отображаться продукты API, доступные в вашей лицензии.
Выберите версию API клиента в разделе "У вас есть подписки X для этого продукта".
Выберите "Показать рядом с первичным ключом для подписки".
Выберите содержимое поля, щелкните правой кнопкой мыши и выберите "Копировать". Ключ теперь сохраняется в буфер обмена и готов к вставке.

## Начало работы с соединителем

Перейдите в раздел "Мои потоки>" и выберите "Автоматизированный поток облака".
Выберите поток вручную из диалогового окна "Создание автоматизированного облачного потока".
Присвойте потоку имя или позволите системе автоматически создать его.
Найдите и выберите триггер для потока.
Выберите Создать.
В поле поиска найдите и выберите соединитель TeamWherx.
Найдите действие, которое требуется выполнить с соединителем.

Система предложит вам войти во все приложения, необходимые для выполнения выбранного действия, пропуская все, в которые вы уже вошли.

Введите имя нового соединителя в поле "Соединитель".
Затем введите ключ API.
Выберите Создать. Первый шаг в потоке обработки отображается как первое поле в блок-схеме.
Выберите новыйшаг , чтобы продолжить добавление дополнительных действий и шагов в поток процесса соединителя.
Нажмите кнопку Сохранить.

**Использование соединителя — пример опроса состояния заказа
** В приведенных ниже инструкциях показано, как создать поток процесса для вставки строк на лист и вставить данные сотрудника, который обновил заказ при обновлении состояния заказа.

Перейдите к соединителям.
Найдите и выберите соединитель [TeamWherx].
Выберите список состояний заказа из списка действий.
Введите имя нового подключения в поле "Имя подключения ".
Затем введите ключ API.
Выберите Создать. Первый шаг в потоке обработки отображается как первое поле в блок-схеме.

Каждое диалоговое окно действия в шагах потока подключения будет иметь поля свойств, которые можно настроить для управления выполненным действием.

Продолжая работу с примером, выберите, нужно ли отображать значения полей Forms (параметр excludeFormData).
Выберите версию X-API для подключения.
Нажмите кнопку "Далее", чтобы задать действие, необходимое при изменении состояния заказа.
В диалоговом окне "Выбор операции" используйте поле поиска, чтобы найти приложение, а затем нужное действие. Например, если вы хотите вставить строку на лист Google при каждом изменении состояния заказа, выберите GoogleSheet и вставьтестроку для действия.
В диалоговом окне "Вставкастроки ", которое следует, щелкните поле "Файл " и выберите файл, содержащий результаты.
В поле "Лист" выберите тип листа. Поля, которые динамически отображаются, являются столбцами данных на листе.
Щелкните поле для каждого столбца и выберите свойство из списка свойств опроса состояния заказа . Кроме того, можно использовать поле поиска для поиска определенного свойства.
Можно ввести несколько свойств в каждом поле столбца; в столбце событий выберите StatusLabel, вставьте тире и выберите StatusStartDate. Это означает, что для каждого обновления состояния заказа метка состояния и дата начала состояния записываются в столбец события в новой строке.
Выберите новыйшаг. Как примечание в стороне, вы всегда можете навести указатель мыши и щелкнуть соединитель со стрелками, чтобы вставить новый шаг
В диалоговом окне "Выбор операции" снова выберите соединитель TeamWherx и создайте клиент для действия.

Опять же, каждое поле, отображаемое в диалоговом окне, будет представлять столбец в электронной таблице GoogleSheet. Щелкните в каждом поле, чтобы активировать список свойств опроса состояния заказа , и выберите нужные свойства.

В этом примере выберите EmployeeNumber для поля "Имя ", чтобы определить сотрудника, который обновил состояние заказа.
Выберите GroupName и вставьте его в поле "Имя ".
Нажмите кнопку Сохранить.

Теперь вы создали поток обработки, который будет обновлять электронную таблицу с номером сотрудника и связанной группой при каждом обновлении состояния заказа.

## Известные проблемы и ограничения

Двоичные передачи аудиофайла (POST) для всех конечных точек ограничены только MP4.
Даты для всех конечных точек, требующих сведений о дате и времени, должны быть указаны в соответствии с рекомендациями RFC3339, как в следующем примере: 2021-09-22T02:36:56.52Z. Не обязательно указывать точные секунды в метке времени; 00 допустимо.

## Распространенные ошибки и средства устранения неполадок

Примеры распространенных ошибок, которые могут возникнуть, коды ответов и исправления можно найти на портале разработчиков API:

Бис- https://developer.wfmplatform.com/

Часто задаваемые вопросы о ##

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:


По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Ключ API	securestring	Ключ API для этого API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Активация пользователя	Активирует существующего пользователя по идентификатору.
Активация транспортного средства	Активация транспортного средства по идентификатору.
Деактивация транспортного средства	Деактивация транспортного средства по идентификатору.
Обновление заказа	Обновляет существующий заказ.
Обновление клиента	Обновляет существующий клиент.
Обновление пользователя	Обновляет существующего пользователя.
Обновление состояния заказа	Изменяет существующее состояние заказа.
Обновление существующей геозоны	Обновляет существующую геозону по идентификатору.
Обновление транспортного средства	Обновление транспортного средства по идентификатору.
Обновление части пользователя	Обновляет часть свойств пользователя.
Обратный вызов веб-перехватчика с веб-каналом событий	Этот пример метода используется событиями или подпиской на канал данных событий обратной передачи с использованием URL-адреса, предоставленного клиентом.
Обратный вызов веб-перехватчика с каналом данных GPS	Этот пример метода используется gpsdata/подписки на канал обратной передачи данных с помощью url-адреса, предоставленного клиентом.
Отключение пользователя	Деактивирует существующего пользователя по идентификатору.
Отмена подписки на веб-перехватчик данных GPS	Удаляет подписку на веб-перехватчик данных GPS по его идентификатору.
Отмена подписки на веб-перехватчик событий	Удаляет подписку веб-перехватчика событий по его идентификатору.
Отправка двоичного файла	Используйте этот параметр для отправки изображений форм и звуковых файлов. Двоичный размер ограничен 10 МБ. Поддерживаемые типы файлов: JPEG, PNG и MP4.
Отправка события	Отправляет событие.
Отправка файла вложения	Используйте этот параметр для отправки вложений в файл формы. Размер двоичного файла ограничен 25 МБ. Ожидаемый запрос многопартийных или форм-данных с одним файлом.
Подписка на веб-перехватчик данных GPS	Добавляет новые данные отслеживания GPS (позиции GPS) веб-перехватчика. Веб-перехватчики позволяют получать позиции GPS по указанному URL-адресу.
Подписка на веб-перехватчик событий	Добавляет новую подписку на веб-перехватчик событий. Веб-перехватчики позволяют получать автоматические уведомления о событиях компании, происходящих по указанному URL-адресу.
Получение геозоны	Извлекает геозону по идентификатору.
Получение дополнительной версии	Возвращает текущую дополнительную версию API.
Получение заказа	Возвращает существующий порядок по идентификатору.
Получение записей данных GPS	Извлекает записи данных GPS для указанного диапазона дат. Также возвращает маркер продолжения и ссылку, чтобы получить следующую часть данных. Можно указать количество возвращаемых страниц и количество элементов на страницу. Позиции удаленных пользователей и транспортных средств не возвращаются. Однако если пользователь или автомобиль существовал при запросе данных и был удален позже, данные для пользователя или транспортного средства, запрашиваемые маркером продолжения, будут возвращены. Результаты автоматически отсортированы по UTCTime и в порядке возрастания. Параметры сортировки не настраиваются.
Получение записи с временем	Извлекает запись по идентификатору.
Получение клиента	Извлекает объект клиента по идентификатору.
Получение настраиваемого определения события по идентификатору	Извлекает одно пользовательское определение события по идентификатору.
Получение одной записи из пользовательского списка	Извлекает запись данных единого пользовательского списка, найденную CustomListId и уникальным значением столбца. Ошибки: 404 — для предоставленного пользовательского значения listId и уникального значения столбца отсутствует пользовательская запись списка.
Получение определений настраиваемых списков	Извлекает описание определения пользовательского списка. Список определений содержит CustomListID, Name и Version для всех существующих настраиваемых списков.
Получение пользовательских данных списка с помощью CustomListID	Извлекает все записи данных в одном пользовательском списке с помощью CustomListID. Результаты сортируются по столбцу и поддерживаются разбиение по страницам. Ошибки: 404 — для предоставленного customListId нет настраиваемого списка.
Получение пользователя	Возвращает пользователя по идентификатору.
Получение списка геозон	Извлекает список геозон. Можно указать количество возвращаемых страниц и количество элементов на страницу, а также координаты геозоны метрики. Результаты автоматически отсортированы по имени и в порядке возрастания. Параметры сортировки не настраиваются.
Получение списка заказов	Извлекает список заказов с помощью фильтров из параметров запроса, показанных ниже. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по Client.Name и в порядке возрастания. Параметры сортировки не настраиваются.
Получение списка записей по временного хранения	Извлекает список записей времени на основе диапазона дат. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически сортируются по ClockInTime, а затем по timekeepingStatusId и в порядке возрастания. Параметры сортировки не настраиваются.
Получение списка клиентов	Извлекает список клиентов. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по имени и в порядке возрастания. Параметры сортировки не настраиваются.
Получение списка настраиваемых определений событий	Извлекает список настраиваемых определений событий.
Получение списка настраиваемых полей списка по CustomListID	Извлекает список полей для одного настраиваемого списка с помощью CustomListID.
Получение списка подписок	Извлекает список подписок веб-перехватчика. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по SubscriptionId и в порядке возрастания. Параметры сортировки не настраиваются.
Получение списка подписок веб-перехватчика событий	Извлекает список подписок веб-перехватчика событий. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по SubscriptionId и в порядке возрастания. Параметры сортировки не настраиваются.
Получение списка поездок	Извлекает список поездок за определенный период времени. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по StartUtcTIme и в порядке возрастания. Параметры сортировки не настраиваются.
Получение списка пользователей	Извлекает список пользователей. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по UserId и в порядке возрастания. Параметры сортировки не настраиваются.
Получение списка событий	Извлекает список событий за определенный период времени. Можно указать количество возвращаемых страниц и количество элементов на страницу. Фильтруйте по типу события, чтобы получить определенные события. События транспортного средства могут быть возвращены для сотрудника, если сотрудник связан с автомобилем.
Получение списка транспортных средств	Извлекает список транспортных средств.
Получение списка форм	Извлекает список форм с помощью любого из фильтров из параметров запроса, показанных ниже. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по SubmittedTime и в порядке убывания. Параметры сортировки не настраиваются.
Получение транспортного средства по идентификатору	Извлекает один автомобиль по идентификатору.
Получение формы	Извлекает форму по идентификатору.
Сброс состояния подписки	Изменяет состояние подписки на состояние = 1 ("Выполняется").
Сброс состояния подписки на веб-перехватчик событий	Изменяет состояние подписки на состояние = 1 ("Выполняется").
Создание геозоны	Создает новую геозону.
Создание или обновление настраиваемого определения события	Создает или обновляет настраиваемое определение события.
Создание или обновление пользовательской записи списка	Создает или обновляет настраиваемую запись данных списка. Значение уникального столбца может быть опущено, но при наличии оно должно соответствовать значению уникального идентификатора в параметре запроса.
Создание клиента	Создает новый клиент.
Создание пользователя	Создает нового пользователя.
Создание транспортного средства	Создает автомобиль.
Создание формы	Добавляет новую форму.
Создать заказ	Добавляет новый заказ.
Удаление геозоны	Удаляет существующую геозону по идентификатору.
Удаление клиента	Удаляет существующий клиент по идентификатору.
Удаление настраиваемой записи списка	Удаляет существующую запись в пользовательском списке по его customListId и идентификатору. id — это уникальное значение пользовательской записи списка. Ошибки: 404 — customListId или идентификатор не найден.
Удаление пользовательского определения события	Удаляет настраиваемое определение события.
Удаление транспортного средства	Удаление транспортного средства по идентификатору.
Частичное обновление транспортного средства	Частичное обновление транспортного средства по идентификатору.

Активация пользователя

Идентификатор операции:: UserController_Activate

Активирует существующего пользователя по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Активация транспортного средства

Идентификатор операции:: VehicleController_Activate

Активация транспортного средства по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

response: integer

Деактивация транспортного средства

Идентификатор операции:: VehicleController_Deactivate

Деактивация транспортного средства по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

response: integer

Обновление заказа

Идентификатор операции:: OrderController_Update

Обновляет существующий заказ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
ExternalOrderId	ExternalOrderId		string	External Use OrderId для клиента — свойство расширения API.
IsClosed	IsClosed		boolean	Состояние, показывающее, закрыт ли UpdateOrderApiModel.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
Имя	Name		string	Имя ContactApiModel.
Номер телефона	PhoneNumber		string	PhoneNumber объекта ContactApiModel.
Адрес электронной почты	Email		string	Электронная почта ContactApiModel.
Дата выполнения	DueDate		date-time	Время выполнения baseUpdateOrderApiModel должно быть завершено (устаревшее в версии 1.3).
StartTime	StartTime		date-time	На определенный момент времени этот параметр BaseUpdateOrderApiModel должен начинаться (представлен в версии 1.3).
EndTime	EndTime		date-time	Точка во времени, на который должен заканчиваться BaseUpdateOrderApiModel (представлено в версии 1.3).
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
НомерСотрудника	EmployeeNumber	True	string	EmployeeNumber пользователя, создавшего этот NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Содержимое метки для StatusLabel, связанного с этим NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	На момент начала работы этого состояния NewOrderStatusApiModel.
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
FieldIndex	FieldIndex		integer	Индекс поля.
Ценность	Value			Значение поля.
геокод	geocode		boolean	Должен быть закодирован или не должен быть адрес.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Обновление клиента

Идентификатор операции:: ClientController_Update

Обновляет существующий клиент.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
ExternalId	ExternalId		string	Идентификатор внешнего использования для клиента — свойство расширения API.
FieldIndex	FieldIndex		integer	Индекс поля.
Ценность	Value			Значение поля.
Имя	Name		string	Имя клиента.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
Имя	Name		string	Имя ContactApiModel.
Номер телефона	PhoneNumber		string	PhoneNumber объекта ContactApiModel.
Адрес электронной почты	Email		string	Электронная почта ContactApiModel.
геокод	geocode		boolean	Должен быть закодирован или не должен быть адрес.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Обновление пользователя

Идентификатор операции:: UserController_Update

Обновляет существующего пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
Имя пользователя	UserName		string	Имя пользователя.
Пароль	Password		password	Пароль пользователя.
GroupName	GroupName		string	Имя группы пользователя.
Имя	FirstName		string	Имя пользователя.
Фамилия	LastName		string	Фамилия пользователя.
НомерСотрудника	EmployeeNumber		string	Номер сотрудника пользователя.
Адрес электронной почты	Email		string	Адрес электронной почты пользователя.
Телефон	Phone		string	Номер телефона пользователя.
RoleId	RoleId		integer	RoleId пользователя — (администратор: 1, пользователь: 3, Power User: 5).
Активен	IsActive		boolean	Активное состояние пользователя.
EPTTEnabled	EPTTEnabled		boolean	Состояние расширенной функции push-to-Talk для пользователя: логическое значение.
EPTTNumber	EPTTNumber		string	Номер телефона для расширенной функции push-to-Talk для пользователя: строка.
EPTTWebMDN	EPTTWebMDN		string	Номер телефона, используемый для проверки подлинности пользователя в системе Kodiak EPTT, предоставленный Kodiak.
EPTTToken	EPTTToken		string	Маркер API, используемый для проверки подлинности пользователя в системе Kodiak EPTT, предоставляемый Kodiak.
GPSEnabled	GPSEnabled		boolean	Состояние функции GPS для пользователя.
MobileOnly	MobileOnly		boolean	Состояние доступа к классическому веб-приложению для CAB - (Нет WebApp Access: True, Full App Access: False).
LicenseType	LicenseType		integer	Тип лицензии, назначенной пользователю: — 0 для Undefined, 1 для Regular, 2 для WebOnly и 3 для сотрудников.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Обновление состояния заказа

Идентификатор операции:: OrderController_ChangeStatus

Изменяет существующее состояние заказа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
НомерСотрудника	EmployeeNumber	True	string	EmployeeNumber пользователя, создавшего этот NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Содержимое метки для StatusLabel, связанного с этим NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	На момент начала работы этого состояния NewOrderStatusApiModel.
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Обновление существующей геозоны

Идентификатор операции:: GeofenceController_UpdateGeofence

Обновляет существующую геозону по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	integer	Идентификатор геозоны.
GroupNames	GroupNames		array of string	GroupPaths объекта GeofenceUpdateApiModel.
Широта	Latitude		double
Долгота	Longitude		double
Имя	Name		string	Имя GeofenceApiModelBase.
Тип	Type		string	Тип GeofenceApiModel.
Shape	Shape		integer	Фигура: 0 для круга и 1 для многоугольника.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
Радиус.	Radius		double	Радиус геозоныApiModel.
UseGeofenceAddress	UseGeofenceAddress		boolean	UseGeofenceAddress объекта GeofenceApiModel.
useMetric	useMetric		boolean	Используйте систему метрик или нет.
геокод	geocode		boolean	Должен быть закодирован или не должен быть адрес.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Обновление транспортного средства

Идентификатор операции:: VehicleController_UpdateVehicle

Обновление транспортного средства по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
Number	Number		string
Имя	Name		string
Тип	Type		string
Тег	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
TimeZone	TimeZone		string
Делать	Make		string
Год	Year		integer
Модель	Model		string
Цвет	Color		string
VIN	VIN		string
Активен	IsActive		boolean
Тип устройства	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

response: integer

Обновление части пользователя

Идентификатор операции:: UserController_PartialUpdate

Обновляет часть свойств пользователя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
			object
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Обратный вызов веб-перехватчика с веб-каналом событий

Идентификатор операции:: EventController_subscribe_callback

Этот пример метода используется событиями или подпиской на канал данных событий обратной передачи с использованием URL-адреса, предоставленного клиентом.

Параметры

Имя	Ключ	Тип	Описание
Идентификатор	Id	string	URL-адрес, содержащий адрес webHookSubscriptionParamsApiModel.
Тип события	EventType	integer
Код события	EventCode	string
ВремяСобытия	EventTime	date-time	Формат ISO с локальным и смещением.
DeviceId	DeviceId	string	GpsDeviceDto Id, связанный с подпиской.
Тип устройства	DeviceType	integer	GpsDeviceDto type: Handset (0), CalAmp (1), Geotab (2), Xirgo (3).
UserId	UserId	integer	Идентификатор пользователя.
VehicleId	VehicleId	integer	Идентификатор транспортного средства.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Указывает, связан ли пользователь с автомобилем.
Lat	Lat	double	Широта.
Лон	Lon	double	Долгота.
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	Параметры события.

Возвращаемое значение

response: object

Обратный вызов веб-перехватчика с каналом данных GPS

Идентификатор операции:: TrackingController_subscribe_callback

Этот пример метода используется gpsdata/подписки на канал обратной передачи данных с помощью url-адреса, предоставленного клиентом.

Параметры

Имя	Ключ	Тип	Описание
Идентификатор	Id	string	URL-адрес, содержащий адрес webHookSubscriptionParamsApiModel.
DeviceId	DeviceId	string	GpsDeviceDto Id, связанный с подпиской.
Тип устройства	DeviceType	integer	GpsDeviceDto type: Handset(0), CalAmp(1), Geotab (2), Xirgo (3).
Отметка времени	Timestamp	date-time	Формат ISO с локальным и смещением.
CompanyId	CompanyId	integer	Идентификатор компании.
UserId	UserId	integer	Идентификатор пользователя.
VehicleId	VehicleId	integer	Идентификатор транспортного средства.
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Указывает, связан ли пользователь с автомобилем.
LocationProvider	LocationProvider	string	Имя поставщика расположения.
Lat	Lat	double	Широта.
Лон	Lon	double	Долгота.
ТочностьFt	AccuracyFt	double	Точность положения (ноги).
Высотафта	AltitudeFt	double	Высота (футы).
Heading	Heading	integer	Направление компаса в градусах.
SpeedMph	SpeedMph	double	Скорость перемещения (Mph).
BatteryStatus	BatteryStatus	integer	Состояние батареи: не зарядка(0), зарядка(1).
BatteryLevel	BatteryLevel	integer	Уровень батареи в процентах.
ActivityState	ActivityState	integer	Состояние действия: Пребывание(1), Modving(2).
IsNetworkConnected	IsNetworkConnected	boolean	Устройство подключено к сети в данный момент.
Rssi	Rssi	integer	Полученный индикатор надежности сигнала.
DOdoMl	DOdoMl	double	GpsDeviceDto Odometer (Мили).
VOdoMl	VOdoMl	double	Автомобиль Одометр (Мили).

Возвращаемое значение

response: object

Отключение пользователя

Идентификатор операции:: UserController_Deactivate

Деактивирует существующего пользователя по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Отмена подписки на веб-перехватчик данных GPS

Идентификатор операции:: TrackingController_RemoveGpsDataFeedSubscription

Удаляет подписку на веб-перехватчик данных GPS по его идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
subscriptionId	subscriptionId	True	string	Идентификатор подписки для удаления.

Отмена подписки на веб-перехватчик событий

Идентификатор операции:: EventController_RemoveEventDataFeedSubscription

Удаляет подписку веб-перехватчика событий по его идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
subscriptionId	subscriptionId	True	string	Идентификатор подписки для удаления.

Отправка двоичного файла

Идентификатор операции:: BinaryController_UploadBinary

Используйте этот параметр для отправки изображений форм и звуковых файлов. Двоичный размер ограничен 10 МБ. Поддерживаемые типы файлов: JPEG, PNG и MP4.

Возвращаемое значение

Тело: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Отправка события

Идентификатор операции:: EventController_Post

Отправляет событие.

Параметры

Имя	Ключ	Тип	Описание
EventDefinitionId	EventDefinitionId	string	Идентификатор определения события.
НомерСотрудника	EmployeeNumber	string	Номер сотрудника.
VehicleNumber	VehicleNumber	string	Номер автомобиля.
DeviceSerialNumber	DeviceSerialNumber	string	Серийный номер GpsDeviceDto.
Широта	Latitude	double
Долгота	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2	string	AddressLine2 этого locationApiModel.
Город	City	string	Город LocationApiModel.
Название региона	RegionName	string	Имя региона locationApiModel.
Почтовый индекс	PostalCode	string	Почтовый индекс LocationApiModel.
Код страны	CountryCode	string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName	string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode	string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode	string	Код региона для LocationApiModel.
Time	Time	date-time
Параметры	Parameters	object	Параметры события.

Отправка файла вложения

Идентификатор операции:: BinaryController_UploadAttachment

Используйте этот параметр для отправки вложений в файл формы. Размер двоичного файла ограничен 25 МБ. Ожидаемый запрос многопартийных или форм-данных с одним файлом.

Возвращаемое значение

Тело: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Подписка на веб-перехватчик данных GPS

Идентификатор операции:: TrackingController_SubscribeToGpsDataFeed

Добавляет новые данные отслеживания GPS (позиции GPS) веб-перехватчика. Веб-перехватчики позволяют получать позиции GPS по указанному URL-адресу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
URL-адрес	Url		string	URL-адрес, содержащий адрес webHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Маркер безопасности, связанный с этим webHookSubscriptionParamsApiModel.

Возвращаемое значение

Тело: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Подписка на веб-перехватчик событий

Идентификатор операции:: EventController_SubscribeToEventDataFeed

Добавляет новую подписку на веб-перехватчик событий. Веб-перехватчики позволяют получать автоматические уведомления о событиях компании, происходящих по указанному URL-адресу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
URL-адрес	Url		string	URL-адрес, содержащий адрес webHookSubscriptionParamsApiModel.
SecurityToken	SecurityToken		string	Маркер безопасности, связанный с этим webHookSubscriptionParamsApiModel.

Возвращаемое значение

Тело: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Получение геозоны

Идентификатор операции:: GeofenceController_GetGeofence

Извлекает геозону по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	integer	Идентификатор геозоны.
useMetric	useMetric		boolean	Используйте систему метрик или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.Geofence.GeofenceApiModel

Получение дополнительной версии

Идентификатор операции:: VersionController_Get

Возвращает текущую дополнительную версию API.

Получение заказа

Идентификатор операции:: OrderController_GetOrder

Возвращает существующий порядок по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
include-status-history	include-status-history		string	Если значение true, ответ будет содержать все данные журнала состояния и формы для этого заказа.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.Order.OrderApiModel

Получение записей данных GPS

Идентификатор операции:: TrackingController_GetGpsData

Извлекает записи данных GPS для указанного диапазона дат. Также возвращает маркер продолжения и ссылку, чтобы получить следующую часть данных. Можно указать количество возвращаемых страниц и количество элементов на страницу.

Позиции удаленных пользователей и транспортных средств не возвращаются. Однако если пользователь или автомобиль существовал при запросе данных и был удален позже, данные для пользователя или транспортного средства, запрашиваемые маркером продолжения, будут возвращены.

Результаты автоматически отсортированы по UTCTime и в порядке возрастания. Параметры сортировки не настраиваются.

Параметры

Имя	Ключ	Тип	Описание
fromDate	fromDate	date-time	Начало диапазона дат. Рекомендация. Используйте диапазоны больших дат (>=4 часа) вместо небольших диапазонов дат.
toDate	toDate	date-time	Конец диапазона дат. Рекомендация. Используйте диапазоны больших дат (>=4 часа) вместо небольших диапазонов дат.
номер сотрудника	employeeNumber	string	Номер сотрудника.
вин	vin	string	Номер VIN автомобиля.
useMetric	useMetric	boolean	Используйте систему метрик или нет.
token	token	string	Маркер продолжения, возвращаемый первоначальным вызовом, и должен использоваться в последовательном вызове.

Возвращаемое значение

Тело: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Получение записи с временем

Идентификатор операции:: TimekeepingController_GetTimekeepingEntryAsync

Извлекает запись по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Идентификатор записи.

Возвращаемое значение

Тело: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Получение клиента

Идентификатор операции:: ClientController_Get

Извлекает объект клиента по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Идентификатор клиента.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.Client.ReadClientApiModel

Получение настраиваемого определения события по идентификатору

Идентификатор операции:: EventController_Get

Извлекает одно пользовательское определение события по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Идентификатор определения события.

Возвращаемое значение

Пользовательская модель определения событий.

Тело: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Получение одной записи из пользовательского списка

Идентификатор операции:: CustomListController_GetSingleRecord

Извлекает запись данных единого пользовательского списка, найденную CustomListId и уникальным значением столбца.

Ошибки:

404 — для предоставленного пользовательского значения listId и уникального значения столбца отсутствует пользовательская запись списка.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
customListId	customListId	True	integer	Пользовательский идентификатор списка.
id	id	True	string	Уникальное значение.

Возвращаемое значение

Контейнер для массива данных столбцов пользовательского списка.

Тело: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Получение определений настраиваемых списков

Идентификатор операции:: CustomListController_Get

Извлекает описание определения пользовательского списка. Список определений содержит CustomListID, Name и Version для всех существующих настраиваемых списков.

Возвращаемое значение

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Получение пользовательских данных списка с помощью CustomListID

Идентификатор операции:: CustomListController_GetCustomList

Извлекает все записи данных в одном пользовательском списке с помощью CustomListID.

Результаты сортируются по столбцу и поддерживаются разбиение по страницам.

Ошибки:

404 — для предоставленного customListId нет настраиваемого списка.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
customListId	customListId	True	integer	Пользовательский идентификатор списка.
pageNumber	pageNumber		integer	Номер начальной страницы.
pageSize	pageSize		integer	Размер страницы.

Возвращаемое значение

Контейнер для массива данных столбцов пользовательского списка.

Тело: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Получение пользователя

Идентификатор операции:: UserController_Get

Возвращает пользователя по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.User.ReadUserApiModel

Получение списка геозон

Идентификатор операции:: GeofenceController_GetGeofences

Извлекает список геозон. Можно указать количество возвращаемых страниц и количество элементов на страницу, а также координаты геозоны метрики. Результаты автоматически отсортированы по имени и в порядке возрастания. Параметры сортировки не настраиваются.

Параметры

Имя	Ключ	Тип	Описание
pageNumber	pageNumber	integer	Номер начальной страницы. Значение по умолчанию — 1.
pageSize	pageSize	integer	Размер страницы. Значение по умолчанию — 500.
useMetric	useMetric	boolean	Используйте систему метрик или нет.

Возвращаемое значение

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Получение списка заказов

Идентификатор операции:: OrderController_GetOrders

Извлекает список заказов с помощью фильтров из параметров запроса, показанных ниже. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по Client.Name и в порядке возрастания. Параметры сортировки не настраиваются.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
dueDateFrom	dueDateFrom	True	date-time	Фильтрация по дате начала.
dueDateTo	dueDateTo	True	date-time	Фильтрация по дате окончания срока действия.
номер сотрудника	employeeNumber		string	Фильтрация по номеру сотрудника.
pageNumber	pageNumber		integer	Номер начальной страницы (по умолчанию 1).
pageSize	pageSize		integer	Размер страницы (по умолчанию — 500).

Возвращаемое значение

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

Получение списка записей по временного хранения

Идентификатор операции:: TimekeepingController_GetTimekeepingDataList

Извлекает список записей времени на основе диапазона дат. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически сортируются по ClockInTime, а затем по timekeepingStatusId и в порядке возрастания. Параметры сортировки не настраиваются.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
fromDate	fromDate	True	date-time	Дата начала.
toDate	toDate	True	date-time	Дата окончания.
номер сотрудника	employeeNumber		string	Номер сотрудника.
одобренный	approved		boolean	Фильтр только для утвержденной записи.
closedOnly	closedOnly		boolean	Фильтр только для закрытой записи.
excludeFormData	excludeFormData		boolean	Фильтр для исключения данных формы.
pageNumber	pageNumber		integer	Номер начальной страницы (по умолчанию 1).
pageSize	pageSize		integer	Размер страницы (по умолчанию 1000).

Возвращаемое значение

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Получение списка клиентов

Идентификатор операции:: ClientController_GetClients

Извлекает список клиентов. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по имени и в порядке возрастания. Параметры сортировки не настраиваются.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
pageNumber	pageNumber		integer	Номер начальной страницы.
pageSize	pageSize		integer	Размер страницы.

Возвращаемое значение

response: array of CustomerAPI.Models.Client.ReadClientApiModel

Получение списка настраиваемых определений событий

Идентификатор операции:: EventController_GetList

Извлекает список настраиваемых определений событий.

Возвращаемое значение

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Получение списка настраиваемых полей списка по CustomListID

Идентификатор операции:: CustomListController_GetById

Извлекает список полей для одного настраиваемого списка с помощью CustomListID.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
customListId	customListId	True	integer	Пользовательский идентификатор списка.

Возвращаемое значение

Пользовательская модель списка.

Тело: CustomerAPI.Models.CustomLists.CustomListApiModel

Получение списка подписок

Идентификатор операции:: TrackingController_GetSubscriptions

Извлекает список подписок веб-перехватчика. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по SubscriptionId и в порядке возрастания. Параметры сортировки не настраиваются.

Возвращаемое значение

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Получение списка подписок веб-перехватчика событий

Идентификатор операции:: EventController_GetSubscriptions

Извлекает список подписок веб-перехватчика событий. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по SubscriptionId и в порядке возрастания. Параметры сортировки не настраиваются.

Возвращаемое значение

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Получение списка поездок

Идентификатор операции:: TrackingController_GetTrips

Извлекает список поездок за определенный период времени. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по StartUtcTIme и в порядке возрастания. Параметры сортировки не настраиваются.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
fromDate	fromDate	True	date-time	Начало диапазона дат. Рекомендация. Используйте диапазоны больших дат (>=4 часа) вместо небольших диапазонов дат.
toDate	toDate	True	date-time	Конец диапазона дат. Рекомендация. Используйте диапазоны больших дат (>=4 часа) вместо небольших диапазонов дат.
номер сотрудника	employeeNumber		string	Номер сотрудника.
вин	vin		string	Номер VIN автомобиля.
pageNumber	pageNumber		integer	Номер начальной страницы. Значение по умолчанию — 1.
pageSize	pageSize		integer	Размер страницы. Значение по умолчанию — 1000.
useMetric	useMetric		boolean	Используйте систему метрик или нет.

Возвращаемое значение

response: array of CustomerAPI.Models.Tracking.TripApiModel

Получение списка пользователей

Идентификатор операции:: UserController_GetUsers

Извлекает список пользователей. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по UserId и в порядке возрастания. Параметры сортировки не настраиваются.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
pageNumber	pageNumber		integer	Номер начальной страницы. Значение по умолчанию — 1.
pageSize	pageSize		integer	Размер страницы. Значение по умолчанию — 500.

Возвращаемое значение

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

Получение списка событий

Идентификатор операции:: EventController_GetEvents

Извлекает список событий за определенный период времени. Можно указать количество возвращаемых страниц и количество элементов на страницу.

Фильтруйте по типу события, чтобы получить определенные события. События транспортного средства могут быть возвращены для сотрудника, если сотрудник связан с автомобилем.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
fromDate	fromDate	True	date-time	Начало диапазона дат.
toDate	toDate	True	date-time	Конец диапазона дат.
номер сотрудника	employeeNumber		string	Номер сотрудника.
vehicleNumber	vehicleNumber		string	Номер автомобиля.
pageNumber	pageNumber		integer	Номер начальной страницы.
pageSize	pageSize		integer	Размер страницы.
eventType	eventType		integer	Фильтрация по типу события. Указан номер сотрудника: UserEvents(0) — только события пользователя. VehicleEvents(1) — только события транспортного средства, включая события датчика. ExternalEvents(2) — только внешние события. Указан номер транспортного средства: UserEvents(0) — N/A. VehicleEvents(1) — только события транспортного средства, включая события датчика. ExternalEvents(2) — только внешние события. Ни номер сотрудника, ни номер транспортного средства не указан: UserEvents(0) — только события пользователя. VehicleEvents(1) — только события транспортного средства, включая события датчика. ExternalEvents(2) — только внешние события.

Возвращаемое значение

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Получение списка транспортных средств

Идентификатор операции:: VehicleController_GetVehicles

Извлекает список транспортных средств.

Параметры

Имя	Ключ	Тип	Описание
pageNumber	pageNumber	integer	Номер страницы.
pageSize	pageSize	integer	Максимальное количество элементов на странице. По умолчанию = 1000. Максимальное значение = 2000.
activeOnly	activeOnly	boolean	Значение true — возвращает только активные транспортные средства. Значение по умолчанию = false.

Возвращаемое значение

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

Получение списка форм

Идентификатор операции:: FormController_GetFormsAsync

Извлекает список форм с помощью любого из фильтров из параметров запроса, показанных ниже. Можно указать количество возвращаемых страниц и количество элементов на страницу. Результаты автоматически отсортированы по SubmittedTime и в порядке убывания. Параметры сортировки не настраиваются.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
submittedStartDate	submittedStartDate	True	date-time	Дата начала отправленной формы.
submittedEndDate	submittedEndDate	True	date-time	Дата окончания отправленной формы.
apiModuleId	apiModuleId		string	Идентификатор модуля формы.
номер сотрудника	employeeNumber		string	Номер сотрудника.
reviewed	reviewed		boolean	Извлекает только проверенные формы или нет. Значение по умолчанию равно NULL для всех.
pageNumber	pageNumber		integer	Начальный номер страницы. Значение по умолчанию — 1.
pageSize	pageSize		integer	Размер страницы. Значение по умолчанию — 1000.

Возвращаемое значение

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

Получение транспортного средства по идентификатору

Идентификатор операции:: VehicleController_GetVehicle

Извлекает один автомобиль по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Модель данных автомобиля.

Тело: CustomerAPI.Models.Vehicles.VehicleReadApi

Получение формы

Идентификатор операции:: FormController_GetFormAsync

Извлекает форму по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	integer	Идентификатор формы.

Возвращаемое значение

Тело: CustomerAPI.Models.Forms.StandaloneFormApiModel

Сброс состояния подписки

Идентификатор операции:: TrackingController_ResetSubscriptionHealthStatus

Изменяет состояние подписки на состояние = 1 ("Выполняется").

Параметры

Имя	Ключ	Обязательно	Тип	Описание
subscriptionId	subscriptionId	True	integer	Идентификатор подписки.

Сброс состояния подписки на веб-перехватчик событий

Идентификатор операции:: EventController_ResetSubscriptionHealthStatus

Изменяет состояние подписки на состояние = 1 ("Выполняется").

Параметры

Имя	Ключ	Обязательно	Тип	Описание
subscriptionId	subscriptionId	True	integer	Идентификатор подписки.

Создание геозоны

Идентификатор операции:: GeofenceController_CreateGeofence

Создает новую геозону.

Параметры

Имя	Ключ	Тип	Описание
GroupNames	GroupNames	array of string	GroupPaths объекта GeofenceCreateApiModel.
Широта	Latitude	double
Долгота	Longitude	double
Имя	Name	string	Имя GeofenceApiModelBase.
Тип	Type	string	Тип GeofenceApiModel.
Shape	Shape	integer	Фигура: 0 для круга и 1 для многоугольника.
Широта	Latitude	double
Долгота	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2	string	AddressLine2 этого locationApiModel.
Город	City	string	Город LocationApiModel.
Название региона	RegionName	string	Имя региона locationApiModel.
Почтовый индекс	PostalCode	string	Почтовый индекс LocationApiModel.
Код страны	CountryCode	string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName	string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode	string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode	string	Код региона для LocationApiModel.
Радиус.	Radius	double	Радиус геозоныApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress объекта GeofenceApiModel.
useMetric	useMetric	boolean	Используйте систему метрик или нет.
геокод	geocode	boolean	Должен быть закодирован или не должен быть адрес.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Создание или обновление настраиваемого определения события

Идентификатор операции:: EventController_Put

Создает или обновляет настраиваемое определение события.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Идентификатор определения события.
Имя	Name		string
ReverseGeocode	ReverseGeocode		boolean
Имя	Name		string
Тип	Type		integer
Заголовок	Caption		string
Обязательно	Required		boolean

Создание или обновление пользовательской записи списка

Идентификатор операции:: CustomListController_PutRecord

Создает или обновляет настраиваемую запись данных списка. Значение уникального столбца может быть опущено, но при наличии оно должно соответствовать значению уникального идентификатора в параметре запроса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
customListId	customListId	True	integer	Пользовательский идентификатор списка.
id	id	True	string	Уникальное значение.
ColumnIndex	ColumnIndex		integer	Пользовательский индекс столбца списка.
Заголовок	Caption		string	Заголовок столбца настраиваемого списка.
Ценность	Value			Значение столбца настраиваемого списка.

Создание клиента

Идентификатор операции:: ClientController_Create

Создает новый клиент.

Параметры

Имя	Ключ	Тип	Описание
ExternalId	ExternalId	string	Идентификатор внешнего использования для клиента — свойство расширения API.
FieldIndex	FieldIndex	integer	Индекс поля.
Ценность	Value		Значение поля.
Имя	Name	string	Имя клиента.
Широта	Latitude	double
Долгота	Longitude	double
AddressLine1	AddressLine1	string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2	string	AddressLine2 этого locationApiModel.
Город	City	string	Город LocationApiModel.
Название региона	RegionName	string	Имя региона locationApiModel.
Почтовый индекс	PostalCode	string	Почтовый индекс LocationApiModel.
Код страны	CountryCode	string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName	string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode	string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode	string	Код региона для LocationApiModel.
Имя	Name	string	Имя ContactApiModel.
Номер телефона	PhoneNumber	string	PhoneNumber объекта ContactApiModel.
Адрес электронной почты	Email	string	Электронная почта ContactApiModel.
геокод	geocode	boolean	Должен быть закодирован или не должен быть адрес.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Создание пользователя

Идентификатор операции:: UserController_Create

Создает нового пользователя.

Параметры

Имя	Ключ	Тип	Описание
Имя пользователя	UserName	string	Имя пользователя.
Пароль	Password	password	Пароль пользователя.
GroupName	GroupName	string	Имя группы пользователя.
Имя	FirstName	string	Имя пользователя.
Фамилия	LastName	string	Фамилия пользователя.
НомерСотрудника	EmployeeNumber	string	Номер сотрудника пользователя.
Адрес электронной почты	Email	string	Адрес электронной почты пользователя.
Телефон	Phone	string	Номер телефона пользователя.
RoleId	RoleId	integer	RoleId пользователя — (администратор: 1, пользователь: 3, Power User: 5).
Активен	IsActive	boolean	Активное состояние пользователя.
EPTTEnabled	EPTTEnabled	boolean	Состояние расширенной функции push-to-Talk для пользователя: логическое значение.
EPTTNumber	EPTTNumber	string	Номер телефона для расширенной функции push-to-Talk для пользователя: строка.
EPTTWebMDN	EPTTWebMDN	string	Номер телефона, используемый для проверки подлинности пользователя в системе Kodiak EPTT, предоставленный Kodiak.
EPTTToken	EPTTToken	string	Маркер API, используемый для проверки подлинности пользователя в системе Kodiak EPTT, предоставляемый Kodiak.
GPSEnabled	GPSEnabled	boolean	Состояние функции GPS для пользователя.
MobileOnly	MobileOnly	boolean	Состояние доступа к классическому веб-приложению для CAB - (Нет WebApp Access: True, Full App Access: False).
LicenseType	LicenseType	integer	Тип лицензии, назначенной пользователю: — 0 для Undefined, 1 для Regular, 2 для WebOnly и 3 для сотрудников.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Создание транспортного средства

Идентификатор операции:: VehicleController_CreateVehicle

Создает автомобиль.

Параметры

Имя	Ключ	Тип
Number	Number	string
Имя	Name	string
Тип	Type	string
Тег	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Делать	Make	string
Год	Year	integer
Модель	Model	string
Цвет	Color	string
VIN	VIN	string
Активен	IsActive	boolean
Тип устройства	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Создание формы

Идентификатор операции:: FormController_PostFormAsync

Добавляет новую форму.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ApiModuleId	ApiModuleId		string	Идентификатор ApiModule, связанный с этим CreateStandaloneFormApiModel.
Отзывы	Reviewed		boolean	Состояние проверки этого объекта CreateStandaloneFormApiModel.
UserId	UserId		integer	UserId пользователя.
НомерСотрудника	EmployeeNumber		string	Номер сотрудника пользователя.
SubmittedTime	SubmittedTime	True	date-time	Время отправки CreateStandaloneFormApiModel.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
ApiFieldId	ApiFieldId	True	string	Идентификатор поля API.
Ценность	Value	True		Значение FormFieldDataApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Sign" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Время записи двоичных данных. Формат — время даты (в качестве даты и времени в RFC3339), включая смещение.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
ApiFieldId	ApiFieldId	True	string	Идентификатор поля API.
Ценность	Value	True		Значение FormFieldDataApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Sign" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Время записи двоичных данных. Формат — время даты (в качестве даты и времени в RFC3339), включая смещение.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Создать заказ

Идентификатор операции:: OrderController_Create

Добавляет новый заказ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Дата и время создания	CreatedDateTime		date-time	Время создания CreateUpdateOrderApiModel.
ExternalClientId	ExternalClientId	True	string	Идентификатор внешнего использования для клиента — свойство расширения API.
ServiceType	ServiceType	True	string	Тип службы, связанный с этим CreateUpdateOrderApiModel.
ExternalOrderId	ExternalOrderId		string	External Use OrderId для клиента — свойство расширения API.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
Имя	Name		string	Имя ContactApiModel.
Номер телефона	PhoneNumber		string	PhoneNumber объекта ContactApiModel.
Адрес электронной почты	Email		string	Электронная почта ContactApiModel.
Дата выполнения	DueDate		date-time	Время выполнения baseUpdateOrderApiModel должно быть завершено (устаревшее в версии 1.3).
StartTime	StartTime		date-time	На определенный момент времени этот параметр BaseUpdateOrderApiModel должен начинаться (представлен в версии 1.3).
EndTime	EndTime		date-time	Точка во времени, на который должен заканчиваться BaseUpdateOrderApiModel (представлено в версии 1.3).
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
НомерСотрудника	EmployeeNumber	True	string	EmployeeNumber пользователя, создавшего этот NewOrderStatusApiModel.
StatusLabel	StatusLabel	True	string	Содержимое метки для StatusLabel, связанного с этим NewOrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	True	date-time	На момент начала работы этого состояния NewOrderStatusApiModel.
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
Широта	Latitude		double
Долгота	Longitude		double
AddressLine1	AddressLine1		string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2		string	AddressLine2 этого locationApiModel.
Город	City		string	Город LocationApiModel.
Название региона	RegionName		string	Имя региона locationApiModel.
Почтовый индекс	PostalCode		string	Почтовый индекс LocationApiModel.
Код страны	CountryCode		string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName		string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode		string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode		string	Код региона для LocationApiModel.
Заголовок	Caption	True	string
Ценность	Value			Значение UpdateFormFieldApiModel. Формат значения поля NFC: { "Type": number, /// 0 - Text "Payload": object, // Должен быть текстом для type = 0 } Формат значения поля "Камера" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного изображения (см. двоичный API отправки) "Примечание": строка // Примечание для указанного изображения } Формат значения поля "Сигнатура" (двоичная ссылка): { "BinaryId": string //Binary ID отправленного изображения (см. двоичный API отправки) } Формат значения поля "Audio" (двоичная ссылка): { "BinaryId": string, // Binary ID отправленного звука (см. двоичный API отправки) "DurationSeconds": число // Длительность звука в секундах }
CapturedTime	CapturedTime		date-time	Значение точки во времени было записано.
FieldIndex	FieldIndex		integer	Индекс поля.
Ценность	Value			Значение поля.
геокод	geocode		boolean	Должен быть закодирован или не должен быть адрес.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Удаление геозоны

Идентификатор операции:: GeofenceController_DeleteGeofence

Удаляет существующую геозону по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	integer	Идентификатор геозоны.

Удаление клиента

Идентификатор операции:: ClientController_Delete

Удаляет существующий клиент по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Идентификатор клиента.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Удаление настраиваемой записи списка

Идентификатор операции:: CustomListController_DeleteRecord

Удаляет существующую запись в пользовательском списке по его customListId и идентификатору.

id — это уникальное значение пользовательской записи списка.

Ошибки:

404 — customListId или идентификатор не найден.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
customListId	customListId	True	integer	Пользовательский идентификатор списка.
id	id	True	string	Уникальное значение.

Удаление пользовательского определения события

Идентификатор операции:: EventController_Delete

Удаляет настраиваемое определение события.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Идентификатор определения события.

Удаление транспортного средства

Идентификатор операции:: VehicleController_Delete

Удаление транспортного средства по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Частичное обновление транспортного средства

Идентификатор операции:: VehicleController_PartialUpdateVehicle

Частичное обновление транспортного средства по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
id	id	True	string	Внешний или внутренний идентификатор зависит от значения в параметре use-external-id.
			object
use-external-id	use-external-id		boolean	Используйте внешний идентификатор или нет.

Возвращаемое значение

Тело: CustomerAPI.Models.ReturnIdApiModel

Триггеры

Опрос времени хранения	Конечная точка опроса API времени позволяет приложению постоянно опрашивать и обрабатывать недавно отправленные записи времени. Интеграция: Эта конечная точка предназначена для работы с Microsoft Flow в качестве интеграции триггеров опроса. Кроме того, вы можете разработать собственную пользовательскую интеграцию с помощью любого языка. Использование: В типичном сценарии первый запрос к этой конечной точке не должен предоставлять никаких параметров. Существует два (2) возможных успешных ответа: Код ОТВЕТА HTTP 200 — недавно отправленные записи времени хранения существуют; Текст ответа будет отображать данные записи времени хранения. Код HTTP-ответа 202 — недавно отправленные записи отсутствуют; Текст ответа будет пустым. В обоих случаях в ответе есть два важных заголовка (2): Расположение — URL-адрес для следующего запроса. Retry-After — рекомендуемый интервал времени в секундах для следующего запроса. Например, если есть данные для извлечения, заголовок Retry-After будет иметь значение 1 или 60. Если нет данных для извлечения, значение заголовка Retry-After будет равно 300. Примечание. Это просто рекомендуемые значения. Приложение может выбрать для опроса по другой частоте в зависимости от ваших требований. После первого запроса все последующие запросы должны использовать URL-адрес, указанный в заголовке location последнего ответа. Не добавляйте дополнительные параметры в URL-адрес, так как он уже содержит те, которые необходимы для обеспечения отсутствия записей хранения времени в запросе. Результаты автоматически сортируются по ModifiedUtc, а затем по timekeepingStatusId, а затем в порядке возрастания. Параметры сортировки не настраиваются. Определение ChangeUtc: внутренний тег времени = время последнего изменения состояния хранения.
Опрос данных формы	Конечная точка опроса API Forms позволяет приложению постоянно опрашивать и обрабатывать недавно отправленные автономные формы. Интеграция: Эта конечная точка предназначена для работы с Microsoft Flow в качестве интеграции триггеров опроса. Кроме того, вы можете разработать собственную пользовательскую интеграцию с помощью любого языка. Использование: В типичном сценарии первый запрос к этой конечной точке не должен предоставлять никаких параметров. Существует два (2) возможных успешных ответа: Код ОТВЕТА HTTP 200 — недавно отправленные записи формы существуют; Текст ответа будет отображать данные формы. Код HTTP-ответа 202 — недавно отправленные записи отсутствуют; Текст ответа будет пустым. В обоих случаях в ответе есть два важных заголовка (2): Расположение — URL-адрес для следующего запроса. Retry-After — рекомендуемый интервал времени в секундах для следующего запроса. Например, если есть данные для извлечения, заголовок Retry-After будет иметь значение 1 или 60. Если нет данных для извлечения, значение заголовка Retry-After будет равно 300. Примечание. Это просто рекомендуемые значения. Приложение может выбрать для опроса по другой частоте в зависимости от ваших требований. После первого запроса все последующие запросы должны использовать URL-адрес, указанный в заголовке location последнего ответа. Не добавляйте дополнительные параметры в URL-адрес, так как он уже содержит необходимые параметры, необходимые для обеспечения отсутствия форм в запросе. Результаты автоматически сортируются по ModifiedUtc, а затем по FormHeaderId в порядке возрастания. Параметры сортировки не настраиваются. Определение ModifiedUtc: внутренний тег времени = время последнего изменения данных формы.
Опрос заказов	Конечная точка опроса API заказов позволяет приложению постоянно опрашивать и обрабатывать последние изменения заказов. Интеграция: Эта конечная точка предназначена для работы с Microsoft Flow в качестве интеграции триггеров опроса. Кроме того, вы можете разработать собственную пользовательскую интеграцию с помощью любого языка. Использование: В типичном сценарии первый запрос к этой конечной точке не должен предоставлять никаких параметров. Существует два (2) возможных успешных ответа: Код ОТВЕТА HTTP 200 — существуют недавно измененные заказы; Текст ответа будет отображать данные заказа. Код HTTP-ответа 202. Недавно измененные заказы не существуют; Текст ответа будет пустым. В обоих случаях в ответе есть два важных заголовка (2): Расположение — URL-адрес для следующего запроса. Retry-After — рекомендуемый интервал времени в секундах для следующего запроса. Например, если есть данные для извлечения, заголовок Retry-After будет иметь значение 1 или 60. Если нет данных для извлечения, значение заголовка Retry-After будет равно 300. Примечание. Это просто рекомендуемые значения. Приложение может выбрать для опроса по другой частоте в зависимости от ваших требований. После первого запроса все последующие запросы должны использовать URL-адрес, указанный в заголовке location последнего ответа. Не добавляйте дополнительные параметры в URL-адрес, так как он уже содержит необходимые параметры, необходимые для обеспечения отсутствия изменений порядка в запросе. Результаты автоматически сортируются по ModifiedUtc, а затем по OrderId в порядке возрастания. Параметры сортировки не настраиваются. Определение ModifiedUtc: внутренний тег времени = время последнего изменения данных заказа.
Опрос состояния заказа	Конечная точка опроса API состояния заказа позволяет приложению постоянно опрашивать и обрабатывать последние изменения заказов. Интеграция: Эта конечная точка предназначена для работы с Microsoft Flow в качестве интеграции триггеров опроса. Кроме того, вы можете разработать собственную пользовательскую интеграцию с помощью любого языка. Использование: В типичном сценарии первый запрос к этой конечной точке не должен предоставлять никаких параметров. Существует два (2) возможных успешных ответа: Код HTTP-ответа 200 — существуют недавно измененные записи состояния заказа; Текст ответа отобразит данные о состоянии заказа Код HTTP-ответа 202 — недавно отправленные записи отсутствуют; Текст ответа будет пустым. В обоих случаях в ответе есть два важных заголовка (2): Расположение — URL-адрес для следующего запроса. Retry-After — рекомендуемый интервал времени в секундах для следующего запроса. Например, если есть данные для извлечения, заголовок Retry-After будет иметь значение 1 или 60. Если нет данных для извлечения, значение заголовка Retry-After будет равно 300. Примечание. Это просто рекомендуемые значения. Приложение может выбрать для опроса по другой частоте в зависимости от ваших требований. После первого запроса все последующие запросы должны использовать URL-адрес, указанный в заголовке location последнего ответа. Не добавляйте дополнительные параметры в URL-адрес, так как он уже содержит необходимые для обеспечения отсутствия состояний заказа в запросе. Результаты сортируются по ModifiedUtc, а затем по StatusId в порядке возрастания. Параметры сортировки не настраиваются. Определение ChangeUtc: внутренний тег времени = время последнего изменения данных состояния заказа.

Опрос времени хранения

Идентификатор операции:: TimekeepingController_Poll

Конечная точка опроса API времени позволяет приложению постоянно опрашивать и обрабатывать недавно отправленные записи времени.

Интеграция:

Эта конечная точка предназначена для работы с Microsoft Flow в качестве интеграции триггеров опроса. Кроме того, вы можете разработать собственную пользовательскую интеграцию с помощью любого языка.

Использование:

В типичном сценарии первый запрос к этой конечной точке не должен предоставлять никаких параметров. Существует два (2) возможных успешных ответа:

Код ОТВЕТА HTTP 200 — недавно отправленные записи времени хранения существуют; Текст ответа будет отображать данные записи времени хранения.
Код HTTP-ответа 202 — недавно отправленные записи отсутствуют; Текст ответа будет пустым.

В обоих случаях в ответе есть два важных заголовка (2):

Расположение — URL-адрес для следующего запроса.
Retry-After — рекомендуемый интервал времени в секундах для следующего запроса. Например, если есть данные для извлечения, заголовок Retry-After будет иметь значение 1 или 60. Если нет данных для извлечения, значение заголовка Retry-After будет равно 300.

Примечание. Это просто рекомендуемые значения. Приложение может выбрать для опроса по другой частоте в зависимости от ваших требований. После первого запроса все последующие запросы должны использовать URL-адрес, указанный в заголовке location последнего ответа. Не добавляйте дополнительные параметры в URL-адрес, так как он уже содержит те, которые необходимы для обеспечения отсутствия записей хранения времени в запросе.

Результаты автоматически сортируются по ModifiedUtc, а затем по timekeepingStatusId, а затем в порядке возрастания. Параметры сортировки не настраиваются.

Определение ChangeUtc: внутренний тег времени = время последнего изменения состояния хранения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
excludeFormData	excludeFormData		boolean	Если значение true, ClockInFormData и ClockOutFormData всегда будет иметь значение NULL.

Возвращаемое значение

Тело: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Опрос данных формы

Идентификатор операции:: FormController_Poll

Конечная точка опроса API Forms позволяет приложению постоянно опрашивать и обрабатывать недавно отправленные автономные формы.

Интеграция:

Использование:

Код ОТВЕТА HTTP 200 — недавно отправленные записи формы существуют; Текст ответа будет отображать данные формы.
Код HTTP-ответа 202 — недавно отправленные записи отсутствуют; Текст ответа будет пустым.

В обоих случаях в ответе есть два важных заголовка (2):

Расположение — URL-адрес для следующего запроса.
Retry-After — рекомендуемый интервал времени в секундах для следующего запроса. Например, если есть данные для извлечения, заголовок Retry-After будет иметь значение 1 или 60. Если нет данных для извлечения, значение заголовка Retry-After будет равно 300.

Примечание. Это просто рекомендуемые значения. Приложение может выбрать для опроса по другой частоте в зависимости от ваших требований. После первого запроса все последующие запросы должны использовать URL-адрес, указанный в заголовке location последнего ответа. Не добавляйте дополнительные параметры в URL-адрес, так как он уже содержит необходимые параметры, необходимые для обеспечения отсутствия форм в запросе.

Результаты автоматически сортируются по ModifiedUtc, а затем по FormHeaderId в порядке возрастания. Параметры сортировки не настраиваются.

Определение ModifiedUtc: внутренний тег времени = время последнего изменения данных формы.

Возвращаемое значение

Тело: CustomerAPI.Models.Forms.StandaloneFormApiModel

Опрос заказов

Идентификатор операции:: OrderController_Poll

Конечная точка опроса API заказов позволяет приложению постоянно опрашивать и обрабатывать последние изменения заказов.

Интеграция:

Использование:

Код ОТВЕТА HTTP 200 — существуют недавно измененные заказы; Текст ответа будет отображать данные заказа.
Код HTTP-ответа 202. Недавно измененные заказы не существуют; Текст ответа будет пустым.

В обоих случаях в ответе есть два важных заголовка (2):

Расположение — URL-адрес для следующего запроса.
Retry-After — рекомендуемый интервал времени в секундах для следующего запроса. Например, если есть данные для извлечения, заголовок Retry-After будет иметь значение 1 или 60. Если нет данных для извлечения, значение заголовка Retry-After будет равно 300.

Примечание. Это просто рекомендуемые значения. Приложение может выбрать для опроса по другой частоте в зависимости от ваших требований. После первого запроса все последующие запросы должны использовать URL-адрес, указанный в заголовке location последнего ответа. Не добавляйте дополнительные параметры в URL-адрес, так как он уже содержит необходимые параметры, необходимые для обеспечения отсутствия изменений порядка в запросе.

Результаты автоматически сортируются по ModifiedUtc, а затем по OrderId в порядке возрастания. Параметры сортировки не настраиваются.

Определение ModifiedUtc: внутренний тег времени = время последнего изменения данных заказа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
excludeFormData	excludeFormData		boolean	Если значение true, OrderFormFields всегда будет пустым массивом.
excludeCustomFieldData	excludeCustomFieldData		boolean	Если значение true, customFields не будет возвращено.

Возвращаемое значение

Тело: CustomerAPI.Models.Order.OrderHeaderApiModel

Опрос состояния заказа

Идентификатор операции:: OrderController_StatusPoll

Конечная точка опроса API состояния заказа позволяет приложению постоянно опрашивать и обрабатывать последние изменения заказов.

Интеграция:

Использование:

Код HTTP-ответа 200 — существуют недавно измененные записи состояния заказа; Текст ответа отобразит данные о состоянии заказа
Код HTTP-ответа 202 — недавно отправленные записи отсутствуют; Текст ответа будет пустым.

В обоих случаях в ответе есть два важных заголовка (2):

Расположение — URL-адрес для следующего запроса.
Retry-After — рекомендуемый интервал времени в секундах для следующего запроса. Например, если есть данные для извлечения, заголовок Retry-After будет иметь значение 1 или 60. Если нет данных для извлечения, значение заголовка Retry-After будет равно 300.

Примечание. Это просто рекомендуемые значения. Приложение может выбрать для опроса по другой частоте в зависимости от ваших требований. После первого запроса все последующие запросы должны использовать URL-адрес, указанный в заголовке location последнего ответа. Не добавляйте дополнительные параметры в URL-адрес, так как он уже содержит необходимые для обеспечения отсутствия состояний заказа в запросе.

Результаты сортируются по ModifiedUtc, а затем по StatusId в порядке возрастания. Параметры сортировки не настраиваются.

Определение ChangeUtc: внутренний тег времени = время последнего изменения данных состояния заказа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
excludeFormData	excludeFormData		boolean	Если значение true, FieldValues всегда будет пустым массивом.

Возвращаемое значение

Тело: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Определения

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

Имя	Путь	Тип	Описание
Идентификатор	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

Имя	Путь	Тип	Описание
Идентификатор	Id	integer	Идентификатор клиента.
ExternalId	ExternalId	string	Идентификатор внешнего использования для клиента — свойство расширения API.
CreatedUtc	CreatedUtc	date-time	Исходная точка во времени создания клиента.
ModifiedUtc	ModifiedUtc	date-time	Последний момент времени обновления клиента.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Имя	Name	string	Имя клиента.
Address	Address	CustomerAPI.Models.LocationApiModel
Контакт	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

Имя	Путь	Тип	Описание
FieldIndex	FieldIndex	integer	Индекс поля.
Заголовок	Caption	string	Заголовок поля.
Тип данных	DataType	integer	Тип данных поля.
DateTimeFormat	DateTimeFormat	integer	Формат DateTime.
Ценность	Value		Значение поля.

CustomerAPI.Models.LocationApiModel

Имя	Путь	Тип	Описание
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
AddressLine1	AddressLine1	string	AddressLine1 этого locationApiModel.
Строка Адреса 2	AddressLine2	string	AddressLine2 этого locationApiModel.
Город	City	string	Город LocationApiModel.
Название региона	RegionName	string	Имя региона locationApiModel.
Почтовый индекс	PostalCode	string	Почтовый индекс LocationApiModel.
Код страны	CountryCode	string	Код ISO 3166-1 alpha-2.
SubRegionName	SubRegionName	string	SubRegion объекта LocationApiModel.
SubRegionCode	SubRegionCode	string	Код subRegion объекта LocationApiModel.
RegionCode	RegionCode	string	Код региона для LocationApiModel.

CustomerAPI.Models.Client.ContactApiModel

Имя	Путь	Тип	Описание
Имя	Name	string	Имя ContactApiModel.
Номер телефона	PhoneNumber	string	PhoneNumber объекта ContactApiModel.
Адрес электронной почты	Email	string	Электронная почта ContactApiModel.

System.Nullable_1_Actsoft.Core.Geo.LatLon_

Имя	Путь	Тип	Описание
Широта	Latitude	double
Долгота	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

Имя	Путь	Тип	Описание
Идентификатор	Id	integer	Идентификатор объекта.

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

Определяет модель API элементов списка настраиваемых определений списков.

Имя	Путь	Тип	Описание
CustomListId	CustomListId	integer	Пользовательский идентификатор списка.
Имя	Name	string	Имя настраиваемого списка.
Версия	Version	string	Пользовательская версия списка.

CustomerAPI.Models.CustomLists.CustomListApiModel

Пользовательская модель списка.

Имя	Путь	Тип	Описание
CustomListId	CustomListId	integer	Пользовательский идентификатор списка.
Имя	Name	string	Имя настраиваемого списка.
Версия	Version	string	Пользовательская версия списка.
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	Определяет модель API определения пользовательского списка.

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

Определяет модель API определения пользовательского списка.

Имя	Путь	Тип	Описание
Колонны	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	Настраиваемые столбцы списка.
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	Уникальный индекс столбца.

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

Определяет модель API настраиваемых определений списка.

Имя	Путь	Тип	Описание
Index	Index	integer	Индекс столбца.
Тип данных	DataType	integer	Тип данных столбца (текст: 0, числовой: 1, дата: 2, время: 3, dateTime: 4, электронная почта: 5).
Имя	Name	string	Имя столбца.

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

Контейнер для массива данных столбцов пользовательского списка.

Имя	Путь	Тип	Описание
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	Массив столбцов с данными.

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

Эта модель определяет значение столбца настраиваемого списка.

Имя	Путь	Тип	Описание
ColumnIndex	ColumnIndex	integer	Пользовательский индекс столбца списка.
Заголовок	Caption	string	Заголовок столбца настраиваемого списка.
Ценность	Value		Значение столбца настраиваемого списка.

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

Пользовательская модель определения событий.

Имя	Путь	Тип
Идентификатор	Id	string
Имя	Name	string
ReverseGeocode	ReverseGeocode	boolean
Параметры	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

Имя	Путь	Тип
Имя	Name	string
Тип	Type	integer
Заголовок	Caption	string
Обязательно	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

Имя	Путь	Тип	Описание
EventId	EventId	integer	Идентификатор события.
Тип события	EventType	integer
Код события	EventCode	string	Код события.
ВремяСобытия	EventTime	date-time	Формат ISO с локальным и смещением.
User	User	CustomerAPI.Models.UserReferenceApiModel
Транспортное средство	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	Если этот параметр включен, то назначаемый пользователем автомобиль события.
Местоположение	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	Идентификатор определения внешнего события.
EventParams	EventParams	object	Параметры события.

CustomerAPI.Models.UserReferenceApiModel

Имя	Путь	Тип	Описание
UserId	UserId	integer	UserId пользователя.
Имя	FirstName	string	Имя пользователя.
Фамилия	LastName	string	Фамилия пользователя.
НомерСотрудника	EmployeeNumber	string	Номер сотрудника пользователя.
GroupName	GroupName	string	Имя группы, назначенной пользователю.

CustomerAPI.Models.ReadVehicleApiModel

Имя	Путь	Тип	Описание
VehicleId	VehicleId	integer	Идентификатор BaseVehicleApiModel.
Имя	Name	string	Имя BaseVehicleApiModel.
VIN	VIN	string	Идентификационный номер транспортного средства BaseVehicleApiModel.
Название устройства	DeviceName	string	Имя GpsDeviceDto, связанное с BaseVehicleApiModel.
Серийный номер	SerialNumber	string	SerialNumber of the BaseVehicleApiModel.
GroupName	GroupName	string	Имя группы BaseVehicleApiModel.

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

Имя	Путь	Тип	Описание
GeofenceId	GeofenceId	integer	Идентификатор геозоны.
Имя	Name	string	Имя геозоны.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

Имя	Путь	Тип	Описание
ID подписки	SubscriptionId	string	Идентификатор webHookSubscriptionResultApiModel.

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

Имя	Путь	Тип	Описание
ID подписки	SubscriptionId	string
URL-адрес	Url	string
Состояние	Status	integer	Состояние подписки — (выполняется: 1, остановлено: 2).

CustomerAPI.Models.Forms.StandaloneFormApiModel

Имя	Путь	Тип	Описание
Идентификатор	Id	integer	Идентификатор, связанный с данным автономнымformApiModel — (устаревший комментарий: FormHeaderId).
FormId	FormId	integer	Идентификатор формы, на которую ссылается этот автономный форматFormApiModel.
FormName	FormName	string	Имя формы, на которую ссылается этот автономный форматFormApiModel.
Запись	EntryNumber	string	Номер записи данных формы.
Отзывы	Reviewed	boolean	Состояние проверки этого автономного объектаFormApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel
SubmittedTime	SubmittedTime	date-time	На момент времени отправки автономного объектаFormApiModel.
StartTime	StartTime	date-time	На момент начала автономной версииFormApiModel.
SubmittedLocation	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	Список полей, связанных с данным автономным форматомFormApiModel.
ApiModuleId	ApiModuleId	string	Идентификатор ApiModule, связанный с данным автономным форматомFormApiModel.
SharedUrl	SharedUrl	string	Общий URL-адрес этого автономного объектаFormApiModel.
ОбзорByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ПросмотрByTime	ReviewedByTime	date-time	Время проверки формы

CustomerAPI.Models.Forms.FormFieldDataApiModel

Имя	Путь	Тип	Описание
Повторяемые элементы	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Идентификатор	Id	string	Идентификатор FormFieldDataApiModel.
Ценность	Value		Значение FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue объекта FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	Значение точки во времени было записано в FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Заголовок	Caption	string	Содержимое заголовка FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	Идентификатор ApiField объекта FormFieldDataApiModel.

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

Имя	Путь	Тип	Описание
Идентификатор	Id	string	Идентификатор FormFieldDataApiModel.
Ценность	Value		Значение FormFieldDataApiModel.
DisplayValue	DisplayValue		DisplayValue объекта FormFieldDataApiModel.
CapturedTime	CapturedTime	date-time	Значение точки во времени было записано в FormFieldDataApiModel.
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
Заголовок	Caption	string	Содержимое заголовка FormFieldDataApiModel.
ApiFieldId	ApiFieldId	string	Идентификатор ApiField объекта FormFieldDataApiModel.

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

Имя	Путь	Тип	Описание
GeofenceId	GeofenceId	integer	GeofenceId объекта GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc объекта GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc объекта GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths объекта GeofenceApiModel.
Имя	Name	string	Имя GeofenceApiModelBase.
Тип	Type	string	Тип GeofenceApiModel.
Shape	Shape	integer	Фигура: 0 для круга и 1 для многоугольника.
Address	Address	CustomerAPI.Models.LocationApiModel
Радиус.	Radius	double	Радиус геозоныApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress объекта GeofenceApiModel.

Actsoft.Core.Geo.LatLon

Имя	Путь	Тип	Описание
Широта	Latitude	double
Долгота	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

Имя	Путь	Тип	Описание
GeofenceId	GeofenceId	integer	GeofenceId объекта GeofenceApiModel.
CreatedUtc	CreatedUtc	date-time	CreatedUtc объекта GeofenceApiModel.
ModifiedUtc	ModifiedUtc	date-time	ModifiedUtc объекта GeofenceApiModel.
GroupNames	GroupNames	array of string	GroupPaths объекта GeofenceApiModel.
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	Многоугольники. Должно быть заполнено, если фигура равна 1.
Имя	Name	string	Имя GeofenceApiModelBase.
Тип	Type	string	Тип GeofenceApiModel.
Shape	Shape	integer	Фигура: 0 для круга и 1 для многоугольника.
Address	Address	CustomerAPI.Models.LocationApiModel
Радиус.	Radius	double	Радиус геозоныApiModel.
UseGeofenceAddress	UseGeofenceAddress	boolean	UseGeofenceAddress объекта GeofenceApiModel.

CustomerAPI.Models.Order.OrderListItemApiModel

Имя	Путь	Тип	Описание
Идентификатор заказа	OrderId	integer	Идентификатор OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	External Use OrderId для клиента — свойство расширения API.
Дата выполнения	DueDate	date-time	Время выполнения orderBaseApiModel (устаревшее в версии 1.3).
StartTime	StartTime	date-time	На определенный момент времени этот OrderBaseApiModel должен начинаться (представлен в версии 1.3).
EndTime	EndTime	date-time	На определенный момент времени этот OrderBaseApiModel должен быть завершен (представлен в версии 1.3).
ServiceType	ServiceType	string	ServiceType, связанный с этим OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Время создания OrderBaseApiModel.
Номер заказа	OrderNumber	string	Номер заказа, связанный с данным OrderBaseApiModel.
IsClosed	IsClosed	boolean	Состояние, показывающее, закрыт ли OrderBaseApiModel.
Состояние	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Идентификатор внешнего использования для клиента — свойство расширения API.
ClientId	ClientId	integer	идентификатор внутреннего использования для клиента — свойство расширения API.
Клиент	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Идентификатор ApiService, связанного с данным OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Версия модуля настраиваемых полей.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

Имя	Путь	Тип	Описание
StatusIndex	StatusIndex	integer	Индекс OrderStatusApiModel.
ТипСтатуса	StatusType	integer	Состояние заказа: 0 для нового заказа, 1 для отправки, 2 для выполнения, 3 для завершения и 4 для отмененных.
StatusLabel	StatusLabel	string	Содержимое метки OrderStatusApiModel.
StatusId	StatusId	integer	Идентификатор OrderStatusApiModel.
StatusStartDateTime	StatusStartDateTime	date-time	Время начала OrderStatusApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

Имя	Путь	Тип	Описание
GroupNames	GroupNames	array of string	Имена иерархий группы клиентов.
Имя	Name	string	Имя клиента.
Address	Address	CustomerAPI.Models.LocationApiModel
Контакт	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

Имя	Путь	Тип	Описание
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	Список OrderStatusListItems, связанный с этим OrderApiModel.
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Идентификатор заказа	OrderId	integer	Идентификатор OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	External Use OrderId для клиента — свойство расширения API.
Дата выполнения	DueDate	date-time	Время выполнения orderBaseApiModel (устаревшее в версии 1.3).
StartTime	StartTime	date-time	На определенный момент времени этот OrderBaseApiModel должен начинаться (представлен в версии 1.3).
EndTime	EndTime	date-time	На определенный момент времени этот OrderBaseApiModel должен быть завершен (представлен в версии 1.3).
ServiceType	ServiceType	string	ServiceType, связанный с этим OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Время создания OrderBaseApiModel.
Номер заказа	OrderNumber	string	Номер заказа, связанный с данным OrderBaseApiModel.
IsClosed	IsClosed	boolean	Состояние, показывающее, закрыт ли OrderBaseApiModel.
Состояние	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Идентификатор внешнего использования для клиента — свойство расширения API.
ClientId	ClientId	integer	идентификатор внутреннего использования для клиента — свойство расширения API.
Клиент	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Идентификатор ApiService, связанного с данным OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Версия модуля настраиваемых полей.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

Имя	Путь	Тип	Описание
StatusStartDateTime	StatusStartDateTime	date-time	Время запуска этого состояния OrderStatusHistoryListItemApiModel.
StatusEndDateTime	StatusEndDateTime	date-time	Время окончания состояния OrderStatusHistoryListItemApiModel.
StatusId	StatusId	integer	Идентификатор, связанный с этим OrderStatusHistoryListItemApiModel.
StatusIndex	StatusIndex	integer	Индекс, связанный с этим OrderStatusHistoryListItemApiModel.
StatusLabel	StatusLabel	string	Содержимое метки, связанное с этим OrderStatusHistoryListItemApiModel.
ТипСтатуса	StatusType	integer	Состояние заказа: 0 для нового заказа, 1 для отправки, 2 для выполнения, 3 для завершения и 4 для отмененных.
ExternalOrderId	ExternalOrderId	string	External Use OrderId для клиента — свойство расширения API.
Идентификатор заказа	OrderId	integer	OrderId, связанный с этим OrderStatusHistoryListItemApiModel.
User	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
ApiServiceId	ApiServiceId	string	Идентификатор ApiService, связанный с данным OrderStatusHistoryListItemApiModel.
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

Имя	Путь	Тип	Описание
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
Идентификатор заказа	OrderId	integer	Идентификатор OrderBaseApiModel.
ExternalOrderId	ExternalOrderId	string	External Use OrderId для клиента — свойство расширения API.
Дата выполнения	DueDate	date-time	Время выполнения orderBaseApiModel (устаревшее в версии 1.3).
StartTime	StartTime	date-time	На определенный момент времени этот OrderBaseApiModel должен начинаться (представлен в версии 1.3).
EndTime	EndTime	date-time	На определенный момент времени этот OrderBaseApiModel должен быть завершен (представлен в версии 1.3).
ServiceType	ServiceType	string	ServiceType, связанный с этим OrderBaseApiModel.
CreatedUTCDate	CreatedUTCDate	date-time	Время создания OrderBaseApiModel.
Номер заказа	OrderNumber	string	Номер заказа, связанный с данным OrderBaseApiModel.
IsClosed	IsClosed	boolean	Состояние, показывающее, закрыт ли OrderBaseApiModel.
Состояние	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	Идентификатор внешнего использования для клиента — свойство расширения API.
ClientId	ClientId	integer	идентификатор внутреннего использования для клиента — свойство расширения API.
Клиент	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	Идентификатор ApiService, связанного с данным OrderBaseApiModel.
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	Версия модуля настраиваемых полей.
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

Имя	Путь	Тип	Описание
Идентификатор	Id	integer	Идентификатор записи timekeeping (устаревший комментарий: RootSubmittedStatusId).
User	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	На момент времени, когда пользователь часы в системе.
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	Время, когда пользователь вышел из системы.
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	Общее количество часов для этой записи временного хранения.
TotalBreakHours	TotalBreakHours	double	Общее количество часов перерыва (нерабочего) для этой записи временного хранения.
NetHours	NetHours	double	Общее количество часов, за которые взимается плата за эту запись времени хранения.
Утверждено	Approved	boolean	Состояние утверждения руководителя для этой записи временного хранения.
Перерывы	Breaks	array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData	ClockInFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData	ClockOutFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion	ModuleVersion	System.Version
CompanyModuleId	CompanyModuleId	integer	Идентификатор модуля компании, используемого для отправки этой записи времени.

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

Имя	Путь	Тип	Описание
Идентификатор	Id	integer	SubmittedStatusId.
StartTime	StartTime	date-time	Время начала.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	Время окончания.
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	Длительность в часах. Значение null может быть равно null, если EndTime имеет значение NULL.
ТипСтатуса	StatusType	integer	Тип состояния: 1 для перерыва и 2 для обеда.
StartLabel	StartLabel	string	Запустите метку.
EndLabel	EndLabel	string	Конечная метка.
Заголовок	Caption	string	Заголовок.

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

Имя	Путь	Тип
CompanyModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

Имя	Путь	Тип
_Майор	_Major	integer
_Несовершеннолетний	_Minor	integer
_Строить	_Build	integer
_Пересмотр	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

Имя	Путь	Тип	Описание
User	User	CustomerAPI.Models.UserReferenceApiModel
Транспортное средство	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	На момент начала работы этого состояния TripApiModel.
EndTime	EndTime	date-time	Время окончания этого состояния TripApiModel.
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
StartPrimaryGeofence	StartPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimaryGeofence	EndPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
TotalStopTime	TotalStopTime	double	Количество времени остановки в часах, сопоставленных с этим TripApiModel.
TotalIdleTime	TotalIdleTime	double	Количество времени простоя в часах, сопоставленных с этим TripApiModel.
TotalDuration	TotalDuration	double	Полный объем времени в часах, связанный с этим TripApiModel.
Расстояние	Distance	double	Расстояние, перемещаемое в локализованных единицах, связанных с этим TripApiModel.

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

Имя	Путь	Тип	Описание
Записи	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
Токен продолжения	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

Имя	Путь	Тип	Описание
User	User	CustomerAPI.Models.UserReferenceApiModel
Транспортное средство	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	TimeTag, связанный с этим gpsDataRecordApiModel.
Местоположение	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
Геозона	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Скорость	Speed	double	Скорость движения, связанная с этим GpsDataRecordApiModel.
Heading	Heading	double	Направление компаса в градусах, связанных с этим GpsDataRecordApiModel.
Состояние	Status	integer	ApiMovementStatus, связанный с OrderBaseApiModel - (остановлено: 1, бездействия: 2, перемещение: 3, NotTracking: 4) : OrderStatusApiModel.
Время состояния	StatusTime	string	Время установки состояния GpsDataRecordApiModel.
Расстояние	Distance	double	Расстояние, перемещаемое в локализованных единицах, связанных с этим TripApiModel.
IgnitionOn	IgnitionOn	boolean	Состояние зажигания транспортного средства, связанного с этим GpsDataRecordApiModel.
LocationProvider	LocationProvider	integer	Поставщик расположения API, связанный с этим gpsDataRecordApiModel - (GPS: 1, сеть: 2).

CustomerAPI.Models.User.ReadUserApiModel

Имя	Путь	Тип	Описание
Имя пользователя	UserName	string	Имя пользователя.
UserId	UserId	integer	Значение идентификатора пользователя.
GroupName	GroupName	string	Имя группы пользователя.
Имя	FirstName	string	Имя пользователя.
Фамилия	LastName	string	Фамилия пользователя.
НомерСотрудника	EmployeeNumber	string	Номер сотрудника пользователя.
Адрес электронной почты	Email	string	Адрес электронной почты пользователя.
Телефон	Phone	string	Номер телефона пользователя.
RoleId	RoleId	integer	RoleId пользователя — (администратор: 1, пользователь: 3, Power User: 5).
Активен	IsActive	boolean	Активное состояние пользователя.
EPTTEnabled	EPTTEnabled	boolean	Состояние расширенной функции push-to-Talk для пользователя: логическое значение.
EPTTNumber	EPTTNumber	string	Номер телефона для расширенной функции push-to-Talk для пользователя: строка.
EPTTWebMDN	EPTTWebMDN	string	Номер телефона, используемый для проверки подлинности пользователя в системе Kodiak EPTT, предоставленный Kodiak.
EPTTToken	EPTTToken	string	Маркер API, используемый для проверки подлинности пользователя в системе Kodiak EPTT, предоставляемый Kodiak.
GPSEnabled	GPSEnabled	boolean	Состояние функции GPS для пользователя.
MobileOnly	MobileOnly	boolean	Состояние доступа к классическому веб-приложению для CAB - (Нет WebApp Access: True, Full App Access: False).
LicenseType	LicenseType	integer	Тип лицензии, назначенной пользователю: — 0 для Undefined, 1 для Regular, 2 для WebOnly и 3 для сотрудников.

CustomerAPI.Models.User.ReadUserListItemApiModel

Имя	Путь	Тип	Описание
UserId	UserId	integer	Значение идентификатора пользователя.
Имя	FirstName	string	Имя пользователя.
Фамилия	LastName	string	Фамилия пользователя.
НомерСотрудника	EmployeeNumber	string	Номер сотрудника пользователя.
Адрес электронной почты	Email	string	Адрес электронной почты пользователя.
Телефон	Phone	string	Номер телефона пользователя.
RoleId	RoleId	integer	RoleId пользователя — (администратор: 1, пользователь: 3, Power User: 5).
Активен	IsActive	boolean	Активное состояние пользователя.
EPTTEnabled	EPTTEnabled	boolean	Состояние расширенной функции push-to-Talk для пользователя: логическое значение.
EPTTNumber	EPTTNumber	string	Номер телефона для расширенной функции push-to-Talk для пользователя: строка.
EPTTWebMDN	EPTTWebMDN	string	Номер телефона, используемый для проверки подлинности пользователя в системе Kodiak EPTT, предоставленный Kodiak.
EPTTToken	EPTTToken	string	Маркер API, используемый для проверки подлинности пользователя в системе Kodiak EPTT, предоставляемый Kodiak.
GPSEnabled	GPSEnabled	boolean	Состояние функции GPS для пользователя.
MobileOnly	MobileOnly	boolean	Состояние доступа к классическому веб-приложению для CAB - (Нет WebApp Access: True, Full App Access: False).
LicenseType	LicenseType	integer	Тип лицензии, назначенной пользователю: — 0 для Undefined, 1 для Regular, 2 для WebOnly и 3 для сотрудников.

CustomerAPI.Models.Vehicles.VehicleReadApi

Модель данных автомобиля.

Имя	Путь	Тип
InternalId	InternalId	integer
Number	Number	string
Имя	Name	string
Тип	Type	string
Тег	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
Делать	Make	string
Год	Year	integer
Модель	Model	string
Цвет	Color	string
VIN	VIN	string
Активен	IsActive	boolean
Тип устройства	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

целое число

Это базовый тип данных "целочисленное".

объект

Это тип object.

Поделиться через

TeamWherx

Создание подключения

По умолчанию

Ограничения регулирования

Действия

Активация пользователя

Параметры

Активация транспортного средства

Параметры

Возвращаемое значение

Деактивация транспортного средства

Параметры

Возвращаемое значение

Обновление заказа

Параметры

Возвращаемое значение

Обновление клиента

Параметры

Возвращаемое значение

Обновление пользователя

Параметры

Возвращаемое значение

Обновление состояния заказа

Параметры

Возвращаемое значение

Обновление существующей геозоны

Параметры

Возвращаемое значение

Обновление транспортного средства

Параметры

Возвращаемое значение

Обновление части пользователя

Параметры

Возвращаемое значение

Обратный вызов веб-перехватчика с веб-каналом событий

Параметры

Возвращаемое значение

Обратный вызов веб-перехватчика с каналом данных GPS

Параметры

Возвращаемое значение

Отключение пользователя

Параметры

Отмена подписки на веб-перехватчик данных GPS

Параметры

Отмена подписки на веб-перехватчик событий

Параметры

Отправка двоичного файла

Возвращаемое значение

Отправка события

Параметры

Отправка файла вложения

Возвращаемое значение

Подписка на веб-перехватчик данных GPS

Параметры

Возвращаемое значение

Подписка на веб-перехватчик событий

Параметры

Возвращаемое значение

Получение геозоны

Параметры

Возвращаемое значение

Получение дополнительной версии

Получение заказа

Параметры

Возвращаемое значение

Получение записей данных GPS

Параметры

Возвращаемое значение

Получение записи с временем

Параметры

Возвращаемое значение

Получение клиента

Параметры

Возвращаемое значение

Получение настраиваемого определения события по идентификатору

Параметры

Возвращаемое значение

Получение одной записи из пользовательского списка

Параметры