Цифра ↔ 1С

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

Метод для создания или обновления транспортных средств в Цифре из 1С.

Запрос

POST /api/car/create

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

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

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

Поле Тип Обязательное Описание
Guid string Да Идентификатор в 1C
Number string Да Государственный номер (используется для валидации и как имя по умолчанию)
Name string Нет Наименование ТС (если не указано, используется значение Number)
Type string Нет Тип: mix, pump, semi, truck, excavator, loader, crane, car
Подробнее о типах
Rent boolean Нет Арендное или нет
Pickup boolean Нет Используется для самовывоза
Volume float Нет Вместимость миксера (м³)
Length float Нет Длина насоса (м)
RentCompany array Нет Информация о компании-арендодателе (если Rent = true)
Структура RentCompany[]

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

Поле Тип Обязательное Описание
Guid string Да Идентификатор компании в 1C
Name string Да Наименование компании
ShortName string Нет Краткое наименование
Inn string Нет ИНН компании
Type string Нет Вид компании (например, "Юридическое лицо")
CompanyType string Нет seller или client (по умолчанию client)

Типы транспортных средств

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

{
  "SecretKey": "2akgzOCYsAxLwpNl",
  "Data": [
    {
      "Guid": "22db4291-154f-11ec-973e-244bfecb4e0a",
      "Name": "Камаз 700 ТК",
      "Number": "В700ТК797",
      "Type": "mix",
      "Rent": false,
      "Pickup": false,
      "Volume": 8
    },
    {
      "Guid": "33ab5192-265g-22fc-a84f-355cgfdc5f1b",
      "Name": "Насос 42м",
      "Number": "А123БВ456",
      "Type": "pump",
      "Rent": true,
      "Length": 42,
      "RentCompany": [
        "Guid": "44cd6203-376h-33gd-b95g-466dghde6g2c",
        "Name": "ООО Аренда Техники",
        "Inn": "7604377806"
      ]
    }
  ]
}

Ответ

Коды ответов

Код Описание
200 Частичный успех. Часть данных обработана, но есть ошибки валидации (success: true)
201 Успешное создание. Все данные обработаны без ошибок (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": "Создано транспортных средств: 2",
  "data_id": 123
}

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

{
  "success": true,
  "message": "Создано транспортных средств: 1",
  "data_id": 123,
  "errors": [
    "ТС без GUID: 1",
    "ТС без номера: 1"
  ]
}

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

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

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

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

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

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

Примечания

См. также