# /api/lite/orders/worksheet

### Запрос анкеты FBM по заказу

/api/lite/orders/worksheet?orderId=TS100307

параметр orderId - ИД заказа в Кактусе, обязательный.

<table class="relative-table wrapped confluenceTable tablesorter tablesorter-default" id="bkmrk-%D0%9F%D0%BE%D0%BB%D0%B5-%D0%A2%D0%B8%D0%BF-%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5-id" role="grid"><tbody aria-live="polite" aria-relevant="all"><tr style="height: 28px;"><td style="width: 24.9383%; height: 28px;">**Поле**

</td><td style="width: 18.2715%; height: 28px;">**Тип**</td><td style="width: 56.7902%; height: 28px;">**Описание**</td></tr><tr role="row" style="height: 44px;"><td class="confluenceTd" style="width: 24.9383%; height: 44px;">id</td><td class="confluenceTd" style="width: 18.2715%; height: 44px;">string</td><td class="confluenceTd" style="width: 56.7902%; height: 44px;">ИД поля анкеты в Кактусе.</td></tr><tr role="row" style="height: 44px;"><td class="confluenceTd" style="width: 24.9383%; height: 44px;">extId</td><td class="confluenceTd" style="width: 18.2715%; height: 44px;">string</td><td class="confluenceTd" style="width: 56.7902%; height: 44px;">Внешний ИД поля анкеты. Используется для сопоставления при передаче во внешние системы</td></tr><tr><td style="width: 24.9383%;">name</td><td style="width: 18.2715%;"> string</td><td style="width: 56.7902%;">Вопрос, который отображается над полем</td></tr><tr><td style="width: 24.9383%;">tooltip</td><td style="width: 18.2715%;"> string</td><td style="width: 56.7902%;">Подсказка к полю (всплывайка при наведении на символ (?))

Если null, или отсутствует, то символ подсказки не отображается

</td></tr><tr><td style="width: 24.9383%;">value</td><td style="width: 18.2715%;">string</td><td style="width: 56.7902%;">Значение поля по умолчанию

</td></tr><tr><td style="width: 24.9383%;">mandatory</td><td style="width: 18.2715%;">boolean</td><td style="width: 56.7902%;">Обязательность заполнения поля. При дальнейшей валидации, проверяется заполненность value

</td></tr><tr><td style="width: 24.9383%;">inputType</td><td style="width: 18.2715%;">string</td><td style="width: 56.7902%;">Тип поля ввода. Влияет на отрисовку на форме.

Значения: INPUT, TEXTAREA

</td></tr></tbody></table>

#### **Пример результата запроса**

**Если анкета заполнялась:**

```json
{
    "success": true,
    "orderId": "1000",
    "form_content": [
        {
            "id": "1000",
            "extId":"WB000001"
            "name": "Порядковый номер палеты",
            "tooltip": "Подсказка к полю (всплывайка при наведении на символ (?))"
            "value": "23445",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1001",
            "name": "Количество палет в поставке",
            "value": "5",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1002",
            "name": "Количество коробов на данной палете",
            "value": "2",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1003",
            "name": "Номер поставки",
            "value": "4433221",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1004",
            "name": "Склад назначения (а при транзите также транзитный склад)",
            "value": "ООО Вектор, ул. Складская, стр.1",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1005",
            "name": "Тип коробов (моно, микс)",
            "value": "моно",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1006",
            "name": "Наименование юридического лица",
            "value": "ООО Вектор",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1007",
            "name": "Дата поставки",
            "value": "20.07.2021",
            "mandatory": true,
            "inputType": "INPUT"
        }
    ]
}
```

**Либо, если анкета не заполнялась:**

```json
{
    "success": true,
    "orderId": "1000",
    "form_content": null
}
```

### Создание/редактирование анкеты FBM по заказу

/api/lite/orders/worksheet

**orderId - ИД заказа в Кактусе, следует обязательно указывать.**

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

```json
{
    "success": true,
    "orderId": "1000",
    "form_content": [
        {
            "id": "1000",
            "extId":"WB000001"
            "name": "Порядковый номер палеты",
            "tooltip": "Подсказка к полю (всплывайка при наведении на символ (?))"
            "value": "23445",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1001",
            "name": "Количество палет в поставке",
            "value": "5",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1002",
            "name": "Количество коробов на данной палете",
            "value": "2",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1003",
            "name": "Номер поставки",
            "value": "4433221",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1004",
            "name": "Склад назначения (а при транзите также транзитный склад)",
            "value": "ООО Вектор, ул. Складская, стр.1",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1005",
            "name": "Тип коробов (моно, микс)",
            "value": "моно",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1006",
            "name": "Наименование юридического лица",
            "value": "ООО Вектор",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1007",
            "name": "Дата поставки",
            "value": "20.07.2021",
            "mandatory": true,
            "inputType": "INPUT"
        }
    ]
}
```

#### **Ошибка:**

```json
{
  "success": false,
  "errors": [
    {
    "code": 0,
    "message": "Текст ошибки"
    }
  ]
}
```

### Массовое получение данных анкет по списку заказов

/api/lite/orders/worksheet/batch/get

**Параметр orders - список номеров заказов.**

**Ограничение - не более 500 номеров в запросе**

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

```json
{
  "orders": [
    "444555",
    "555666"
  ]
}
```

#### **Пример результата запроса**

```json
{
  "orders": [
    {
      "form_content": [],
      "orderId": "444555",
      "success": true
    },
    {
      "form_content": [
        {
          "id": "1000",
          "inputType": "INPUT",
          "mandatory": true,
          "name": "Поставщик",
          "value": "ООО 123"
        },
        {
          "id": "1001",
          "inputType": "INPUT",
          "mandatory": true,
          "name": "Номер поставки МП",
          "value": "77777"
        },
        {
          "id": "shipment_warehouse_destination",
          "inputType": "INPUT",
          "mandatory": true,
          "name": "Склад назначения",
          "value": "Склад Москва"
        },
        {
          "id": "shipment_date",
          "inputType": "INPUT",
          "mandatory": true,
          "name": "Дата и время поставки",
          "value": "01.12"
        }
      ],
      "orderId": "555666",
      "success": true
    }
  ],
  "success": true
}
```

####  

#### **Ошибка:**

```json
{
  "success": false,
  "errors": [
    {
    "code": 0,
    "message": "Текст ошибки"
    }
  ]
}
```

## ``