Общие структуры ответов
Здесь приведены структуры ответов, используемые API. Они имеют одинаковую форму и правила для всех вызовов.
Контакт
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
Строка |
Строка |
Да |
Имя контакта. Ограничено 50 символами |
|
Строка |
Строка |
Да |
Значение контакта. Ограничено 50 символами |
|
Строка |
Строка |
Нет |
Тип контакта. В настоящее время поддерживается только |
Адрес
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
Строка |
Строка |
Да |
Полный адрес одной строкой |
|
Строка |
Строка |
Да |
Номер квартиры или офиса. До 50 символов |
|
Строка |
Строка |
Да |
Этаж. До 50 символов |
|
Строка |
Строка |
Да |
Подъезд. До 50 символов |
|
Строка |
Строка |
Да |
Примечание к адресу. Это поле обычно содержит информацию, помогающую найти адрес исполнителю. До 500 символов |
|
Объект |
Да |
Геокоординаты |
Выездной сотрудник
Выездной сотрудник — это пользователь с правами на выполнение нарядов.
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор сотрудника |
|
Строка |
Строка |
Нет |
Email сотрудника |
Бригада
Бригада — это группа сотрудников.
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор бригады |
|
Строка |
Строка |
Нет |
Название бригады |
Исполнитель
Наряды и шаблоны нарядов могут иметь исполнителей. Исполнитель — это одиночный сотрудник или бригада сотрудников.
Поля team и worker взаимно исключают друг друга, должно быть передано только одно.
|
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
Объект |
Нет |
Бригада |
|
|
Объект |
Нет |
Сотрудник |
Идентификатор исполнителя
Поля team_uuid и worker_uuid взаимно исключают друг друга, должно быть передано только одно.
|
Поле | Type | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор бригады |
|
UUID |
Строка |
Нет |
Идентификатор сотрудника |
Клиент
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор клиета |
|
Строка |
Строка |
Да |
Участок
Участок это область, где работает исполнитель.
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор участка |
|
Строка |
Строка |
Нет |
Название участка |
Значение из списка
Список значений состоит из элементов, которые могут быть выбраны в качестве значений дополнительных полей наряда.
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор |
|
Строка |
Строка |
Нет |
Название |
Резолюция
Резолюция это результат выполнения наряда. Резолюция может быть успешной или неуспешной.
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор резолюции |
|
Строка |
Строка |
Нет |
Название резолючии |
|
Булев |
Булев |
Нет |
Является ли резолюция успешной |
|
Строка |
Строка |
Да |
Комментарий, заполненный исполнителем при завершении наряда. Это поле присутствует только в резолюции завершенного наряда |
Дополнительное поле
Дополнительные поля добавляются в наряды через шаблоны. В наряде существует две секции с дополнительными полями: поля наряда (custom_fields
) и поля отчета (report_fields
). Поля наряда заполняются диспетчером при добавлении нового наряда. Для исполнителя эти поля доступны только на чтение. Поля отчета заполняются исполнителем во время выполнения наряда.
Тип поля value зависит от значения полей field_type и data_type .
|
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор поля |
|
Строка |
Строка |
Нет |
Название поля |
|
Строка |
Строка |
Нет |
|
|
Строка |
Строка |
Нет |
|
|
Булев |
Булев |
Нет |
Является ли поле обязательным. |
|
Смешанный |
Смешанный |
Да |
Значение дополнительного поля. Это поле всегда присутствует в API нарядов, но в API шаблонов оно присутствует только у полей, которые могут быть предзаполнены (например, поле типа «файл» ( |
|
Строка |
Нет |
Временная метка, когда значение было изменено в последний раз. Это поле присутствует только для полей отчета с непустым значением |
Поддерживаемые комбинации
Различные комбинации типа поля и типа данных по-разному поддерживаются полями наряда (custom_fields
) и полями отчета (report_fields
). Ниже «ПН» («поле наряда») и «ПО» («поле отчета») показывают допустимость комбинации типа поля (field_type
) и типа данных (data_type
) для полей наряда и полей отчета соответственно.
field_type |
data_type |
ПН | ПО | Тип value |
Может быть null |
Описание |
---|---|---|---|---|---|---|
|
|
Да |
Да |
Строка |
Да |
Текстовое поле (одна строка) |
|
|
Нет |
Да |
Строка |
Да |
Многострочное текстовое поле |
|
|
Нет |
Да |
Булев |
Да |
Действие |
|
|
Нет |
Да |
Булев |
Да |
Да/нет |
|
|
Нет |
Да |
Строка |
Да |
Штрихкод/QR-код |
|
|
Да |
Нет |
Строка |
Да |
Файл |
|
|
Нет |
Да |
[Строка] |
Нет |
Список изображений |
|
|
Да |
Да |
Да |
Список значений |
Значения типа attachment содержат URL для загрузки файла.
|
Права пользователя
Объект с правами пользователя. Он описывает то, какие действия может выполнять пользователь.
Поле | Тип | JSON-тип | Обязательно | Может быть null |
Описание |
---|---|---|---|---|---|
|
Структура |
Объект |
Нет |
Нет |
Права в веб-приложении |
|
Структура |
Объект |
Нет |
Нет |
Права в мобильном приложении |
Пример объекта с правами пользователя
{
"web": {
"login": true,
"jobs": {
"view": true,
"edit": true,
"delete": true
},
"clients": {
"view": true,
"edit": true
},
"schedule": {
"view": true,
"edit": true
},
"map": {
"edit": false
},
"shifts": {
"edit": false
},
"teams": {
"view": true,
"edit": true
},
"jobs_export": false
},
"mobile": {
"login": true,
"jobs": {
"view": true,
"complete": true
}
}
}
Товар
Объект, содержащий информацию о товаре.
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор товара |
|
Строка |
Строка |
Нет |
Название товара |
|
Строка |
Строка |
Да |
Внешний идентификатор |
Услуга
Объект, содержащий информацию об услуге.
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор услуги |
|
Строка |
Строка |
Нет |
Название услуги |
|
Строка |
Строка |
Да |
Внешний идентификатор |
Единица измерения
Объект, содержащий информацию о единице измерения.
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор единицы измерения |
|
Строка |
Строка |
Нет |
Название единицы измерения |
|
Строка |
Строка |
Нет |
Код единицы измерения |
|
Строка |
Строка |
Да |
Внешний идентификатор |
Категория
Объект, содержащий информацию о категории.
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Идентификатор категории |
|
Строка |
Строка |
Нет |
Название категории |
|
Строка |
Строка |
Да |
Внешний идентификатор |
Доступная сущность каталога
Поле | Тип | JSON-тип | Обязательно | Может быть null |
Описание |
---|---|---|---|---|---|
|
Строка |
Строка |
Да |
Нет |
Либо |
|
Объект |
Нет |
Нет |
Информация о категории. Возвращается только для категорий |
|
|
Объект |
Нет |
Нет |
Информация об услуге. Возвращается только для услуг |
|
|
Булев |
Булев |
Нет |
Нет |
Является ли услуга обязательной. Возвращается только для услуг |
|
Булев |
Булев |
Нет |
Нет |
Является ли услуга предварительно заказанной. Возвращается только для услуг |
Заказанная услуга
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
Объект |
Нет |
Информация об услуге |
|
|
Булев |
Булев |
Нет |
Является ли услуга обязательной |
|
UUID |
Строка |
Нет |
Идентификатор заказанной услуги (отличается от |
Предоставленная услуга
Поле | Тип | JSON-тип | Обязательно | Может быть null |
Описание |
---|---|---|---|---|---|
|
Объект |
Да |
Нет |
Информация об услуге |
|
|
UUID |
Строка |
Нет |
Нет |
Идентификатор заказанной услуги |
|
UUID |
Строка |
Да |
Нет |
Идентификатор предоставленной услуги (отличается от |
|
Строка |
Строка |
Да |
Нет |
Код валюты по ISO 4217 |
|
Строка |
Строка |
Нет |
Да |
Число в строковом формате |
|
Строка |
Строка |
Нет |
Да |
Число в строковом формате |
Использованный материал
Поле | Тип | JSON-тип | Обязательно | Может быть null |
Описание |
---|---|---|---|---|---|
|
Объект |
Да |
Нет |
Информация о товаре |
|
|
Объект |
Да |
Нет |
Информация об единице измерения |
|
|
Объект |
Да |
Нет |
Информация об услуге |
|
|
UUID |
Строка |
Да |
Нет |
Идентификатор предоставленной услуги |
|
Строка |
Строка |
Да |
Нет |
Код валюты по ISO 4217 |
|
Строка |
Строка |
Да |
Нет |
Число в строковом формате |
|
Строка |
Строка |
Нет |
Да |
Число в строковом формате (для одной позиции) |
|
Строка |
Строка |
Нет |
Да |
Число в строковом формате ( |