Общие структуры запросов

Эти структуры переиспользуются в различных API-вызовах.

Адрес

Поле Тип JSON-тип Обязательно Может быть null Описание

formatted

Строка

Строка

Нет

Нет

Полный адрес одной строкой. До 5000 символов

apartment

Строка

Строка

Нет

Да

Номер квартиры или офиса. До 50 символов

floor

Строка

Строка

Нет

Да

Этаж. До 50 символов

entrance_no

Строка

Строка

Нет

Да

Подъезд. До 50 символов

description

Строка

Строка

Да

Да

Примечание к адресу. Это поле обычно содержит информацию, помогающую найти адрес исполнителю. До 500 символов

geolocation

Геокоординаты

Объект

Нет

Нет

Геокоординаты

Существующий клиент

Вы можете указать клиента по идентификатору (uuid) или по внешнему идентификатору (external_id). Эти поля взаимоисключающие, должно быть передано только одно.

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор клиента

external_id

Строка

Строка

Нет

Нет

Внешний идентификатор

Новый клиент

Клиент — это физическое или юридическое лицо (организация)

Схема запроса для юрлиц (организаций)

Все поля необязательны кроме organization_name и organization, которое должно быть true.

Поле Тип JSON-тип Обязательно Может быть null Описание

organization

Булев

Булев

Да

Нет

Должно быть true

organization_name

Строка

Строка

Да

Нет

Название юрлица. Ограничено 5000 символов

external_id

Строка

Строка

Нет

Нет

Внешний идентификатор

site_address

Адрес

Объект

Нет

Нет

Адрес

contacts

[Контакт]

Массив

Нет

Нет

Список контактов

Схема запроса для физлиц

Все поля необязательные кроме organization, которое должно быть false. В дополнение хотя бы одно из полей first_name, last_name, middle_name должно быть непустым.

Поле Тип JSON-тип Обязательно Может быть null Описание

organization

Булев

Булев

Да

Нет

Должно быть false

first_name

Строка

Строка

Нет

Да

Имя. Ограничено 50 символами

last_name

Строка

Строка

Нет

Да

Фамилия. Ограничено 50 символами

middle_name

Строка

Строка

Нет

Да

Отчество. Ограничено 50 символами

external_id

Строка

Строка

Нет

Нет

Внешний идентификатор

site_address

Адрес

Объект

Нет

Нет

Адрес

contacts

[Контакт]

Массив

Нет

Нет

Список контактов

Существующий объект

Вы можете указать объект по идентификатору (uuid) или по внешнему идентификатору (external_id). Эти поля взаимоисключающие, должно быть передано только одно.

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор объекта

external_id

Строка

Строка

Нет

Нет

Внешний идентификатор

New Site

Все поля кроме названия (name) необязательны.

Поле Тип JSON-тип Обязательно Может быть null Описание

name

Строка

Строка

Да

Нет

Название объекта. Ограничено 300 символами

external_id

Строка

Строка

Нет

Да

Внешний идентификатор

description

Строка

Строка

Нет

Да

Описание объекта. Ограничено 1000 символов

client

Существующий клиент

Объект

Нет

Да

Клиент

address

Адрес

Объект

Нет

Нет

Адрес

contacts

[Контакт]

Массив

Нет

Нет

Список контактов

Исполнитель

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

Поле Тип JSON-тип Обязательно Может быть null Описание

worker

Структура

Объект

Нет

Нет

worker.uuid

UUID

Строка

Нет

Нет

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

worker.email

Email

Строка

Нет

Нет

Email пользователя

team

Структура

Объект

Нет

Нет

team.uuid

UUID

Строка

Нет

Нет

Идентификатор бригады

team.name

Строка

Строка

Нет

Нет

Название бригады

Множественный исполнитель

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

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

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

access

Строка

Строка

Нет

Нет

Может быть edit или view

Шаблон наряда

Поле Type JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор шаблона

name

Строка

Строка

Нет

Нет

Название шаблона

Тип наряда

Поле Type JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

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

code

Строка

Строка

Нет

Нет

Название типа

Контакт

Поле Тип JSON-тип Обязательно Может быть null Описание

name

Строка

Строка

Нет

Да

Имя контакта. Ограничено 50 символами

value

Строка

Строка

Нет

Да

Значение контакта. Ограничено 50 символами.
Для добавления нескольких телефонов, передавайте их как разные элементы массива в поле contacts. В этом случае каждое значение будет отображаться как отдельный номер для вызова в мобильном приложении исполнителя

type

Строка

Строка

Да

Нет

Тип контакта. В настоящее время поддерживается только "phone"

Резолюция

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор резолюции

name

Строка

Строка

Нет

Нет

Название резолюции

Участок

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор участка

name

Строка

Строка

Нет

Нет

Название участка

Навык

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор навыка

name

Строка

Строка

Нет

Нет

Название навыка

Единица измерения

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор единицы

name

Строка

Строка

Нет

Нет

Название единицы

Категория

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор категории

name

Строка

Строка

Нет

Нет

Название категории

Значение из списка

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор значения

name

Строка

Строка

Нет

Нет

Название значения

Дополнительное поле

Для задания значения в дополнительном поле передайте его идентификатор (uuid) или название (name). Идентификаторы полей можно узнать через API шаблонов.

Поле Тип JSON-тип Обязательно Может быть null Описание

uuid

UUID

Строка

Нет

Нет

Идентификатор поля

name

Строка

Строка

Нет

Нет

Название поля

value

Смешанный

Смешанный

Да

Нет

value type depends on data_type value of the field
Table 1. Формат value в зависимости от значения data_type
data_type JSON-тип value Может быть null Описание

string

Строка

Да

dictionary

Значение из списка

Да

Значение из списка, указанное по uuid или name

attachment

Файл

Да

Файл

Поле Тип JSON-тип Обязательно Может быть null Описание

name

Строка

Строка

Да

Нет

Название файла

base64_content

Строка

Строка

Да

Нет

Содержимое файла в формате Base64