Инструменты пользователя

Инструменты сайта


Боковая панель

Прикрепление документов

Запрос прикрепляет документы к указанному рейсу.

Команда voyages/documents

Метод POST

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

https://api.logist-pro.su/api/voyages/documents

[
    {
        "number": "voyage_number",
        "shipper_code": 1
        "documents": [
            {
                "name": "документ 1",
                "mime": "application/pdf",
                "content": "JVBERi0xLjQKMSAw..."
            },
            {
                "name": "документ 2",
                "mime": "application/pdf",
                "content": "DTYYUTYdghtYE…."
            }
        ]
    }
]

Пример ответа

Успешный запрос:
{
    "status":"success",
    "result":[
        {
            "number":"voyage_number",
            "id":855
        },
        {
            "number":"voyage_number",
            "id":856
        }
    ]
}

Ошибка:
{
    "status": "failed",
    "errors": {
        "document_limit": [
            5
        ]
    }
}
Поля в запросе Обязательное поле Описание Тип поля Пример\комментарий
number обязательно Номер рейса string (1..100) Уникальный код рейса
shipper_code обязательно Значение кода (ID) грузоотправителя numeric Предоставляется после регистрации
documents обязательно блок с документами array()
documents.name обязательно Название документа string (1..100)
documents.mime обязательно Mime тип файла string (1..100)
documents.content обязательно Данные документа в кодировке Base64 text
Поля в ответе Описание Тип поля Пример\комментарий
status Статус запроса string (1..100) success/failed
result Блок прикрепленных документов, если запрос прошел успешно array()
result.number номер рейса к которому прикреплен документ string (1..100)
result.id идентификатор документа в системе numeric
errors Блок ошибок array()
errors.document_limit название и описание ошибки array()

Инструменты страницы