Цифра ↔ 1С

Создание объектов строительства

Метод для создания или обновления объектов строительства в Цифре из 1С.

Запрос

POST /api/construction_object/create

Параметры запроса

Параметр Тип Обязательный Описание
SecretKey string Да Секретный ключ
Data array Да Массив объектов строительства для создания/обновления
Структура Data[]

Структура Data[]

Поле Тип Обязательное Описание
Guid string Да Идентификатор в 1C
Name string Да Наименование объекта строительства
Company object Нет Компания-заказчик
Структура Company
Managers array Нет Массив контактных лиц
Структура Managers[]
Addresses array Нет Массив адресов объекта
Структура Addresses[]

Структура Company

Поле Тип Обязательное Описание
Guid string Да Идентификатор компании в 1С
Name string Да Наименование компании
Inn string Нет ИНН компании

Структура Managers[]

Поле Тип Обязательное Описание
Name string Да ФИО контактного лица
Phone string Да Телефон, с 7, без "+", без пробелов (например: 79998887766)

Структура Addresses[]

Поле Тип Обязательное Описание
Address string Да Адрес
Name string Нет Название (например, "Площадка 1", "Главный корпус")

Пример запроса

{
  "SecretKey": "2akgzOCYsAxLwpNl",
  "Data": [
    {
      "Guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "Name": "ЖК Солнечный",
      "Company": {
        "Guid": "22db4291-154f-11ec-973e-244bfecb4e0a",
        "Name": "ООО СтройИнвест",
        "Inn": "7604377806"
      },
      "Managers": [
        {
          "Name": "Петров Петр Петрович",
          "Phone": "79998887766"
        }
      ],
      "Addresses": [
        {
          "Address": "г. Москва, ул. Строителей, д. 15",
          "Name": "Площадка 1"
        }
      ]
    }
  ]
}

Ответ

Коды ответов

Код Описание
201 Успешное создание. Все данные обработаны без ошибок (success: true)
207 Частичный успех. Часть данных обработана, но есть ошибки (success: true)
401 Ошибка ключа. Секретный ключ не найден (success: false)
422 Ошибка валидации. Data должен быть массивом (success: false)
500 Ошибка сервера. Внутренняя ошибка обработки (success: false)

Структура ответа

Поле Тип Описание
success boolean Успешность операции
message string Сообщение об успешных операциях (объекты, компании, представители, адреса)
data_id integer ID записи в логе
errors array Массив ошибок (только при наличии ошибок)

Успешный ответ (201)

{
  "success": true,
  "message": "Создано объектов: 1. Создано компаний: 1. Создано представителей: 1. Создано адресов: 1",
  "data_id": 123
}

Частичный успех с ошибками (207)

{
  "success": true,
  "message": "Создано объектов: 1. Обновлено компаний: 1. Создано представителей: 2. Обновлено адресов: 1",
  "data_id": 123,
  "errors": [
    "Объектов без GUID: 1",
    "Объектов без названия: 2"
  ]
}

Ошибка ключа (401)

{
  "success": false,
  "message": "Секретный ключ не найден",
  "data_id": null
}

Ошибка валидации данных (422)

{
  "success": false,
  "message": "Неверный тип данных",
  "data_id": 123
}

Ошибка сервера (500)

{
  "success": false,
  "message": "Произошла ошибка: подробное описание ошибки",
  "data_id": 123
}

Примечания

См. также