API электронной транспортной накладной (ЭТрН)

Последовательность вызовов для создания и отправки первого титула (титула грузоотправителя) ЭТрН

Создание ЭТрН
Сохранение данных первого титула (титула грузоотправителя)
Сохранение участников
Формирование XML-файла первого титула (титула грузоотправителя)
Отправка первого титула (титула грузоотправителя)

Последовательность вызовов для создания и отправки второго титула (титула перевозчика) ЭТрН

Сохранение данных второго титула (титула перевозчика)
Формирование XML-файла второго титула (титула перевозчика)
Отправка второго титула (титула перевозчика)

Последовательность вызовов для создания и отправки третьего титула (титула грузополучателя) ЭТрН

Сохранение данных третьего титула (титула грузополучателя)
Формирование XML-файла третьего титула (титула грузополучателя)
Отправка третьего титула (титула грузополучателя)

Последовательность вызовов для создания и отправки четвёртого титула (титула перевозчика) ЭТрН

Сохранение данных четвёртого титула (титула перевозчика)
Формирование XML-файла четвёртого титула (титула перевозчика)
Отправка четвёртого титула (титула перевозчика)

Получение информации по ЭТрН

Получение информации по участнику документооборота
Получение метаинформации по ЭТрН (подписанты, статус и т.д.)
Получение ключа доступа к печатной форме и QR-коду
Скачивание файла печатной формы и QR-кода

Работа с первым титулом (титулом грузоотправителя) ЭТрН

Создание ЭТрН

Позволяет создать пустой первый титул ЭТрН с данными грузоотправителя. С этого момента можно получать метаинформацию по документу.

Создание ЭТрН

post

/gw/epd/etrn/v1/docflows

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Сохранение черновика первого титула (титула грузоотправителя). JSON

Позволяет сохранить данные первого титула. В теле передаётся JSON в утверждённом законодательством формате. Параметр send_to_driver отвечает за отправку ЭТрН в приложение «АТИ Водитель» после успешного подписания первого титула.

Сохранение черновика первого титула

put

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1

docflow_id

string

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

send_to_driver

boolean

Отправка документа водителю

                    
                      Развернуть все
                      
                      Свернуть все
                      
body

                        object
                      
                      {
  "верс_форм": "5.01",
  "ид_пол_иной": [
    "string"
  ],
  "документ": {
    "кнд": "1110339",
    "наим_эк_суб_сост": "string",
    "осн_дов_орг_сост": "?",
    "сод_инф_го": "?"
  }
}

      {...}        
    
        верс_форм:
        enum
        
[5.01]

        ид_пол_иной:
        [string]
        
От (4 до 46 символов)

      документ:{...}        
    
        кнд:
        enum
        
[1110339]

        наим_эк_суб_сост:
        string
        
От (1 до 1000 символов)

        осн_дов_орг_сост:
        {missing-type-info}
        
        сод_инф_го:
        {missing-type-info}
        
}

}

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Сохранение участников ЭТрН

Сохраняет участников (подписантов) ЭТрН.

Сохранение участников ЭТрН

put

/gw/epd/etrn/v1/docflows/{docflow_id}/participants

docflow_id

string

Развернуть все Свернуть все

body

object

{...}

cargo_carrier:{...}

Информация о пользователе, где "cargo_sender" - это отправитель, "cargo_carrier" - перевозчик, "cargo_receiver" - получатель

firm_id*: string

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

contact_id*: integer

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

user_astral_id: string

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

}

cargo_receiver:{...}

Информация о пользователе, где "cargo_sender" - это отправитель, "cargo_carrier" - перевозчик, "cargo_receiver" - получатель

firm_id*: string

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

contact_id*: integer

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

user_astral_id: string

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

}

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Формирование первого титула (титула грузоотправителя). XML-файл

Позволяет создать XML-файл первого титула, чтобы в дальнейшем подписать и отправить его. Указывается отпечаток сертификата электронной подписи SHA-1 и номер МЧД (если есть).

Генерация первого титула (XML-файл)

post

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1/xml

docflow_id

string

export

boolean

Проставляет headers для автоматического скачивания.

Развернуть все Свернуть все

body

object

{...}

Схема тела запроса для генерации xml, необходимая для генерации полномочий подписанта

certificate_id*: string

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

power_of_attorney_id: string

Идентификатор МЧД

}

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отправка первого титула (титула грузоотправителя)

Позволяет отправить первый титул в ГИС (в Государственную информационную систему) и контрагентам. После отправки титула в ГИС, ЭТрН меняет свой статус на “title_1_waiting_operator”. После получения первого титула ГИС проводит валидацию титула:

если валидация пройдена успешно — титул поступает контрагентам, а статус ЭТрН меняется на “title_1_success”;
если валидация не пройдена — статус ЭТрН меняется вновь на “draft” и первый титул контрагентам не поступает. При отправке необходимо указать строку подписи прикладываемого XML-файла первого титула в формате base64.

Отправка первого титула

post

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1/send

docflow_id

string

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

sign

string

document

binary

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Работа со вторым титулом ЭТрН (титулом перевозчика)

Сохранение черновика второго титула (титула перевозчика). JSON

Позволяет сохранить данные второго титула. В теле передаётся JSON в утверждённом законодательством формате.

Сохранение черновика второго титула

put

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2

docflow_id

string

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

                    
                      Развернуть все
                      
                      Свернуть все
                      
body

                        object
                      
                      {
  "верс_форм": "5.01",
  "ид_пол_иной": [
    "string"
  ],
  "документ": {
    "кнд": "1110340",
    "сод_инф_прв_прием": {
      "зам_прв_прием": {
        "зам_дат_вр_приб": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
        "нал_коор_точ_вр_прб": "0",
        "зам_дат_вр_убыт": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
        "нал_коор_точ_вр_уб": "0",
        "зам_дат_вр_пос_прием": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
        "нал_коор_точ_вр_прм": "0",
        "зам_сост_груз": "string",
        "зам_масс": "string",
        "зам_кол_мест": "string",
        "зам_погр_раб": "string",
        "инф_пол": [
          {
            "ид_файл_инф_пол": "string",
            "текст_инф": [
              {
                "идентиф": "string",
                "значение": "string"
              }
            ]
          }
        ]
      },
      "отмет_прв_прием": [
        {
          "дат_вр_отмет": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
          "нал_коор_точ_вр_отм": "0",
          "обст_отмет": "string",
          "отм_акт_взв": "string",
          "св_акт": [
            {
              "наим_док": "string",
              "номер_док": "string",
              "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})",
              "ид_док": "string",
              "доп_свед_док": "string",
              "ид_рек_сост": [
                {
                  "иннюл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}",
                  "иннфл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}",
                  "данн_ино": {
                    "ид_стат": "ЮЛ",
                    "стран": "string",
                    "наим": "string",
                    "идентиф": "string",
                    "иные_свед": "string",
                    "уд_личн_ин_фл": {
                      "вид_док": "string",
                      "ном_док": "string",
                      "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"
                    }
                  },
                  "наим_оив": "string"
                }
              ]
            }
          ],
          "разм_штр": [
            {
              "факт_кол_ед_изм": "string",
              "итог_разм_штр_рф": 0.5,
              "код_окв": "[0-9]{3}",
              "наим_окв": "string",
              "итог_разм_штр_ин": 0.5,
              "дата_курс_вал": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})",
              "курс_вал": 0.5,
              "расч_штр": "string"
            }
          ],
          "инф_пол": [
            {
              "ид_файл_инф_пол": "string",
              "текст_инф": [
                {
                  "идентиф": "string",
                  "значение": "string"
                }
              ]
            }
          ]
        }
      ],
      "инф_пол": [
        {
          "ид_файл_инф_пол": "string",
          "текст_инф": [
            {
              "идентиф": "string",
              "значение": "string"
            }
          ]
        }
      ]
    }
  }
}

      {...}        
    
        верс_форм:
        enum
        
[5.01]

        ид_пол_иной:
        [string]
        
От (4 до 46 символов)

      документ:{...}        
    
        кнд:
        enum
        
[1110340]

      сод_инф_прв_прием:{...}        
    
      зам_прв_прием:{...}        
    
        зам_дат_вр_приб:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_прб:
        enum
        
[0, 1]

        зам_дат_вр_убыт:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_уб:
        enum
        
[0, 1]

        зам_дат_вр_пос_прием:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_прм:
        enum
        
[0, 1]

        зам_сост_груз:
        string
        
От (1 до 10000 символов)

        зам_масс:
        string
        
От (1 до 1000 символов)

        зам_кол_мест:
        string
        
От (1 до 1000 символов)

        зам_погр_раб:
        string
        
От (1 до 1000 символов)

      инф_пол:[{...}]        
    
        ид_файл_инф_пол:
        string
        
От (36 до 36 символов)

      текст_инф:[{...}]        
    
        идентиф:
        string
        
От (1 до 50 символов)

        значение:
        string
        
От (1 до 2000 символов)

}]

}]

}

      отмет_прв_прием:[{...}]        
    
        дат_вр_отмет:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_отм:
        enum
        
[0, 1]

        обст_отмет:
        string
        
От (1 до 2000 символов)

        отм_акт_взв:
        string
        
От (1 до 1000 символов)

      св_акт:[{...}]        
    
        наим_док:
        string
        
От (1 до 255 символов)

        номер_док:
        string
        
От (1 до 255 символов)

        дата_док:
        string
        
От (10 до 10 символов)

        ид_док:
        string
        
От (1 до 255 символов)

        доп_свед_док:
        string
        
От (1 до 2000 символов)

      ид_рек_сост:[{...}]        
    
        иннюл:
        string
        
От (10 до 10 символов)

        иннфл:
        string
        
От (12 до 12 символов)

      данн_ино:{...}        
    
        ид_стат:
        enum
        
[ЮЛ, ФЛ]

        стран:
        string
        
От (1 до 255 символов)

        наим:
        string
        
От (1 до 1000 символов)

        идентиф:
        string
        
От (1 до 255 символов)

        иные_свед:
        string
        
От (1 до 255 символов)

      уд_личн_ин_фл:{...}        
    
        вид_док:
        string
        
От (1 до 1000 символов)

        ном_док:
        string
        
От (1 до 100 символов)

        дата_док:
        string
        
От (10 до 10 символов)

}

}

        наим_оив:
        string
        
От (1 до 255 символов)

}]

}]

      разм_штр:[{...}]        
    
        факт_кол_ед_изм:
        string
        
От (1 до 255 символов)

        итог_разм_штр_рф:
        number
        
        код_окв:
        string
        
От (3 до 3 символов)

        наим_окв:
        string
        
От (1 до 100 символов)

        итог_разм_штр_ин:
        number
        
        дата_курс_вал:
        string
        
От (10 до 10 символов)

        курс_вал:
        number
        
        расч_штр:
        string
        
От (1 до 1000 символов)

}]

      инф_пол:[{...}]        
    
        ид_файл_инф_пол:
        string
        
От (36 до 36 символов)

      текст_инф:[{...}]        
    
        идентиф:
        string
        
От (1 до 50 символов)

        значение:
        string
        
От (1 до 2000 символов)

}]

}]

}]

      инф_пол:[{...}]        
    
        ид_файл_инф_пол:
        string
        
От (36 до 36 символов)

      текст_инф:[{...}]        
    
        идентиф:
        string
        
От (1 до 50 символов)

        значение:
        string
        
От (1 до 2000 символов)

}]

}]

}

}

}

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Формирование второго титула (титула перевозчика). XML-файл

Позволяет создать XML-файл второго титула, чтобы в дальнейшем подписать и отправить его. Указывается отпечаток сертификата электронной подписи SHA-1 и номер МЧД (если есть).

Генерация второго титула (XML-файл)

post

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2/xml

docflow_id

string

export

boolean

Проставляет headers для автоматического скачивания.

Развернуть все Свернуть все

body

object

{...}

Схема тела запроса для генерации xml, необходимая для генерации полномочий подписанта

certificate_id*: string

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

power_of_attorney_id: string

Идентификатор МЧД

}

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отправка второго титула (титула перевозчика)

Позволяет отправить второй титул ЭТрН в ГИС (в Государственную информационную систему) и контрагентам. После отправки титула в ГИС, ЭТрН меняет свой статус на “title_2_waiting_operator”. После получения второго титула ГИС проводит валидацию титула:

если валидация пройдена успешно — титул поступает контрагентам, статус ЭТрН меняется на “title_2_success”;
если валидация не пройдена — статус ЭТрН меняется вновь на “title_1_success” и второй титул контрагентам не поступает. При отправке необходимо указать строку подписи прикладываемого XML-файла второго титула в формате base64.

Отправка второго титула

post

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2/send

docflow_id

string

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

sign

string

document

binary

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Работа с третьим титулом ЭТрН (титулом грузополучателя)

Сохранение черновика третьего титула (титула грузополучателя). JSON

Позволяет сохранить данные третьего титула. В теле передаётся JSON в утверждённом законодательством формате.

Сохранение черновика третьего титула

put

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3

docflow_id

string

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

                    
                      Развернуть все
                      
                      Свернуть все
                      
body

                        object
                      
                      {
  "верс_форм": "5.01",
  "ид_пол_иной": [
    "string"
  ],
  "документ": {
    "кнд": "1110341",
    "наим_экон_суб_сост": "string",
    "осн_довер_орг_сост": {
      "наим_док": "string",
      "номер_док": "string",
      "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})",
      "ид_док": "string",
      "доп_свед_док": "string",
      "ид_рек_сост": [
        {
          "иннюл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}",
          "иннфл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}",
          "данн_ино": {
            "ид_стат": "ЮЛ",
            "стран": "string",
            "наим": "string",
            "идентиф": "string",
            "иные_свед": "string",
            "уд_личн_ин_фл": {
              "вид_док": "string",
              "ном_док": "string",
              "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"
            }
          },
          "наим_оив": "string"
        }
      ]
    },
    "сод_инф_гп": {
      "сод_оп_отк": "string",
      "прич_отк": "string",
      "испр_тр_н": {
        "ном_испр": 0.5,
        "дата_испр": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"
      },
      "прием_груз_гп": {
        "ф_дат_вр_приб": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
        "нал_коор_точ_вр_ф_пр": "0",
        "ф_дат_вр_убыт": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
        "нал_коор_точ_вр_ф_уб": "0",
        "заяв_дат_вр_приб": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
        "нал_коор_точ_вр_з_пр": "0",
        "мет_опр_масс": "01",
        "кол_мест_прием_ч": 0.5,
        "общ_св_сост": "string",
        "мас_брут_знач_прием": 0.5,
        "мас_нет_знач_прием": 0.5,
        "объем": 0.5,
        "адр_выгруз": {
          "адр_коммент": "string",
          "глн": "string",
          "коорд": {
            "широта": "string",
            "долгота": "string"
          },
          "адрес_рф": {
            "индекс": "string",
            "код_регион": "[0-9]{2}",
            "район": "string",
            "город": "string",
            "насел_пункт": "string",
            "улица": "string",
            "дом": "string",
            "корпус": "string",
            "кварт": "string"
          },
          "адрес_инф": {
            "код_стр": "[0-9]{3}",
            "адр_текст": "string"
          },
          "код_гар": "string"
        },
        "св_прин_по_наим": [
          {
            "наим_груз": "string",
            "сост_груз": "string",
            "плотн": 0.5,
            "объем": 0.5,
            "кол_мест": 0.5,
            "пер_марк": [
              "string"
            ],
            "мас_груз": {
              "мас_нет_знач": 0.5,
              "мас_брут_знач": 0.5,
              "кол_палл": 0.5
            }
          }
        ],
        "инф_пол": [
          {
            "ид_файл_инф_пол": "string",
            "текст_инф": [
              {
                "идентиф": "string",
                "значение": "string"
              }
            ]
          }
        ]
      },
      "отмет_гп": [
        {
          "дат_вр_отмет": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
          "нал_коор_точ_вр_отм": "0",
          "обст_отмет": "string",
          "св_акт": [
            {
              "наим_док": "string",
              "номер_док": "string",
              "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})",
              "ид_док": "string",
              "доп_свед_док": "string",
              "ид_рек_сост": [
                {
                  "иннюл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}",
                  "иннфл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}",
                  "данн_ино": {
                    "ид_стат": "ЮЛ",
                    "стран": "string",
                    "наим": "string",
                    "идентиф": "string",
                    "иные_свед": "string",
                    "уд_личн_ин_фл": {
                      "вид_док": "string",
                      "ном_док": "string",
                      "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"
                    }
                  },
                  "наим_оив": "string"
                }
              ]
            }
          ],
          "разм_штр": [
            {
              "факт_кол_ед_изм": "string",
              "итог_разм_штр_рф": 0.5,
              "код_окв": "[0-9]{3}",
              "наим_окв": "string",
              "итог_разм_штр_ин": 0.5,
              "дата_курс_вал": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})",
              "курс_вал": 0.5,
              "расч_штр": "string"
            }
          ],
          "св_акт_взв": [
            {
              "наим_док": "string",
              "номер_док": "string",
              "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})",
              "ид_док": "string",
              "доп_свед_док": "string",
              "ид_рек_сост": [
                {
                  "иннюл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}",
                  "иннфл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}",
                  "данн_ино": {
                    "ид_стат": "ЮЛ",
                    "стран": "string",
                    "наим": "string",
                    "идентиф": "string",
                    "иные_свед": "string",
                    "уд_личн_ин_фл": {
                      "вид_док": "string",
                      "ном_док": "string",
                      "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"
                    }
                  },
                  "наим_оив": "string"
                }
              ]
            }
          ],
          "инф_пол": [
            {
              "ид_файл_инф_пол": "string",
              "текст_инф": [
                {
                  "идентиф": "string",
                  "значение": "string"
                }
              ]
            }
          ]
        }
      ],
      "инф_пол": [
        {
          "ид_файл_инф_пол": "string",
          "текст_инф": [
            {
              "идентиф": "string",
              "значение": "string"
            }
          ]
        }
      ]
    }
  }
}

      {...}        
    
        верс_форм:
        enum
        
[5.01]

        ид_пол_иной:
        [string]
        
От (4 до 46 символов)

      документ:{...}        
    
        кнд:
        enum
        
[1110341]

        наим_экон_суб_сост:
        string
        
От (1 до 1000 символов)

      осн_довер_орг_сост:{...}        
    
        наим_док:
        string
        
От (1 до 255 символов)

        номер_док:
        string
        
От (1 до 255 символов)

        дата_док:
        string
        
От (10 до 10 символов)

        ид_док:
        string
        
От (1 до 255 символов)

        доп_свед_док:
        string
        
От (1 до 2000 символов)

      ид_рек_сост:[{...}]        
    
        иннюл:
        string
        
От (10 до 10 символов)

        иннфл:
        string
        
От (12 до 12 символов)

      данн_ино:{...}        
    
        ид_стат:
        enum
        
[ЮЛ, ФЛ]

        стран:
        string
        
От (1 до 255 символов)

        наим:
        string
        
От (1 до 1000 символов)

        идентиф:
        string
        
От (1 до 255 символов)

        иные_свед:
        string
        
От (1 до 255 символов)

      уд_личн_ин_фл:{...}        
    
        вид_док:
        string
        
От (1 до 1000 символов)

        ном_док:
        string
        
От (1 до 100 символов)

        дата_док:
        string
        
От (10 до 10 символов)

}

}

        наим_оив:
        string
        
От (1 до 255 символов)

}]

}

      сод_инф_гп:{...}        
    
        сод_оп_отк:
        string
        
От (1 до 255 символов)

        прич_отк:
        string
        
От (1 до 2000 символов)

      испр_тр_н:{...}        
    
        ном_испр:
        number
        
        дата_испр:
        string
        
От (10 до 10 символов)

}

      прием_груз_гп:{...}        
    
        ф_дат_вр_приб:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_ф_пр:
        enum
        
[0, 1]

        ф_дат_вр_убыт:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_ф_уб:
        enum
        
[0, 1]

        заяв_дат_вр_приб:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_з_пр:
        enum
        
[0, 1]

        мет_опр_масс:
        enum
        
[01, 02, 03]

        кол_мест_прием_ч:
        number
        
        общ_св_сост:
        string
        
От (1 до 10000 символов)

        мас_брут_знач_прием:
        number
        
        мас_нет_знач_прием:
        number
        
        объем:
        number
        
      адр_выгруз:{...}        
    
        адр_коммент:
        string
        
От (1 до 2000 символов)

        глн:
        string
        
От (13 до 13 символов)

      коорд:{...}        
    
        широта:
        string
        
От (15 до 17 символов)

        долгота:
        string
        
От (15 до 18 символов)

}

      адрес_рф:{...}        
    
        индекс:
        string
        
От (6 до 6 символов)

        код_регион:
        string
        
От (2 до 2 символов)

        район:
        string
        
От (1 до 50 символов)

        город:
        string
        
От (1 до 50 символов)

        насел_пункт:
        string
        
От (1 до 50 символов)

        улица:
        string
        
От (1 до 50 символов)

        дом:
        string
        
От (1 до 20 символов)

        корпус:
        string
        
От (1 до 20 символов)

        кварт:
        string
        
От (1 до 20 символов)

}

      адрес_инф:{...}        
    
        код_стр:
        string
        
От (3 до 3 символов)

        адр_текст:
        string
        
От (1 до 1000 символов)

}

        код_гар:
        string
        
От (1 до 36 символов)

}

      св_прин_по_наим:[{...}]        
    
        наим_груз:
        string
        
От (1 до 1000 символов)

        сост_груз:
        string
        
От (1 до 10000 символов)

        плотн:
        number
        
        объем:
        number
        
        кол_мест:
        number
        
        пер_марк:
        [string]
        
От (1 до 1000 символов)

      мас_груз:{...}        
    
        мас_нет_знач:
        number
        
        мас_брут_знач:
        number
        
        кол_палл:
        number
        
}

}]

      инф_пол:[{...}]        
    
        ид_файл_инф_пол:
        string
        
От (36 до 36 символов)

      текст_инф:[{...}]        
    
        идентиф:
        string
        
От (1 до 50 символов)

        значение:
        string
        
От (1 до 2000 символов)

}]

}]

}

      отмет_гп:[{...}]        
    
        дат_вр_отмет:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_отм:
        enum
        
[0, 1]

        обст_отмет:
        string
        
От (1 до 2000 символов)

      св_акт:[{...}]        
    
        наим_док:
        string
        
От (1 до 255 символов)

        номер_док:
        string
        
От (1 до 255 символов)

        дата_док:
        string
        
От (10 до 10 символов)

        ид_док:
        string
        
От (1 до 255 символов)

        доп_свед_док:
        string
        
От (1 до 2000 символов)

      ид_рек_сост:[{...}]        
    
        иннюл:
        string
        
От (10 до 10 символов)

        иннфл:
        string
        
От (12 до 12 символов)

      данн_ино:{...}        
    
        ид_стат:
        enum
        
[ЮЛ, ФЛ]

        стран:
        string
        
От (1 до 255 символов)

        наим:
        string
        
От (1 до 1000 символов)

        идентиф:
        string
        
От (1 до 255 символов)

        иные_свед:
        string
        
От (1 до 255 символов)

      уд_личн_ин_фл:{...}        
    
        вид_док:
        string
        
От (1 до 1000 символов)

        ном_док:
        string
        
От (1 до 100 символов)

        дата_док:
        string
        
От (10 до 10 символов)

}

}

        наим_оив:
        string
        
От (1 до 255 символов)

}]

}]

      разм_штр:[{...}]        
    
        факт_кол_ед_изм:
        string
        
От (1 до 255 символов)

        итог_разм_штр_рф:
        number
        
        код_окв:
        string
        
От (3 до 3 символов)

        наим_окв:
        string
        
От (1 до 100 символов)

        итог_разм_штр_ин:
        number
        
        дата_курс_вал:
        string
        
От (10 до 10 символов)

        курс_вал:
        number
        
        расч_штр:
        string
        
От (1 до 1000 символов)

}]

      св_акт_взв:[{...}]        
    
        наим_док:
        string
        
От (1 до 255 символов)

        номер_док:
        string
        
От (1 до 255 символов)

        дата_док:
        string
        
От (10 до 10 символов)

        ид_док:
        string
        
От (1 до 255 символов)

        доп_свед_док:
        string
        
От (1 до 2000 символов)

      ид_рек_сост:[{...}]        
    
        иннюл:
        string
        
От (10 до 10 символов)

        иннфл:
        string
        
От (12 до 12 символов)

      данн_ино:{...}        
    
        ид_стат:
        enum
        
[ЮЛ, ФЛ]

        стран:
        string
        
От (1 до 255 символов)

        наим:
        string
        
От (1 до 1000 символов)

        идентиф:
        string
        
От (1 до 255 символов)

        иные_свед:
        string
        
От (1 до 255 символов)

      уд_личн_ин_фл:{...}        
    
        вид_док:
        string
        
От (1 до 1000 символов)

        ном_док:
        string
        
От (1 до 100 символов)

        дата_док:
        string
        
От (10 до 10 символов)

}

}

        наим_оив:
        string
        
От (1 до 255 символов)

}]

}]

      инф_пол:[{...}]        
    
        ид_файл_инф_пол:
        string
        
От (36 до 36 символов)

      текст_инф:[{...}]        
    
        идентиф:
        string
        
От (1 до 50 символов)

        значение:
        string
        
От (1 до 2000 символов)

}]

}]

}]

      инф_пол:[{...}]        
    
        ид_файл_инф_пол:
        string
        
От (36 до 36 символов)

      текст_инф:[{...}]        
    
        идентиф:
        string
        
От (1 до 50 символов)

        значение:
        string
        
От (1 до 2000 символов)

}]

}]

}

}

}

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Формирование третьего титула (титула грузополучателя). XML-файл

Позволяет создать XML-файл третьего титула, чтобы в дальнейшем подписать и отправить его. Указывается отпечаток сертификата электронной подписи SHA-1 и номер МЧД (если есть).

Генерация третьего титула (XML-файл)

post

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3/xml

docflow_id

string

export

boolean

Проставляет headers для автоматического скачивания.

Развернуть все Свернуть все

body

object

{...}

Схема тела запроса для генерации xml, необходимая для генерации полномочий подписанта

certificate_id*: string

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

power_of_attorney_id: string

Идентификатор МЧД

}

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отправка третьего титула (титула грузополучателя)

Позволяет отправить третий титул ЭТрН в ГИС (в Государственную информационную систему) и контрагентам. После отправки титула в ГИС, ЭТрН меняет свой статус на “title_3_waiting_operator”. После получения третьего титула ГИС проводит валидацию титула:

если валидация пройдена — титул поступает контрагентам, статус ЭТрН меняется на “title_3_success”;
если валидация не пройдена — статус ЭТрН меняется вновь на “title_2_success” и третий титул контрагентам не поступает. При отправке необходимо указать строку подписи прикладываемого XML-файла третьего титула в формате base64.

Отправка третьего титула

post

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3/send

docflow_id

string

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

sign

string

document

binary

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Работа с четвёртым титулом ЭТрН (титулом перевозчика)

Сохранение черновика четвёртого титула (титула перевозчика). JSON

Позволяет сохранить данные четвёртого титула. В теле передаётся JSON в утверждённом законодательством формате.

Сохранение черновика четвёртого титула

put

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4

docflow_id

string

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

                    
                      Развернуть все
                      
                      Свернуть все
                      
body

                        object
                      
                      {
  "верс_форм": "5.01",
  "ид_пол_иной": [
    "string"
  ],
  "документ": {
    "кнд": "1110342",
    "сод_прв_выд": {
      "зам_прв_выд": {
        "зам_дата_вр_приб": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
        "нал_коор_точ_вр_пр": "0",
        "зам_дат_вр_убыт": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
        "нал_коор_точ_вр_уб": "0",
        "зам_дат_вр_пос_выгр": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
        "нал_коор_точ_вр_выгр": "0",
        "зам_сост_груз": "string",
        "зам_раб_выгр": "string",
        "инф_пол": [
          {
            "ид_файл_инф_пол": "string",
            "текст_инф": [
              {
                "идентиф": "string",
                "значение": "string"
              }
            ]
          }
        ]
      },
      "отмет_прв_выд": [
        {
          "дат_вр_отмет": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))",
          "нал_коор_точ_вр_отм": "0",
          "обст_отмет": "string",
          "отм_акт_взв": "string",
          "св_акт": [
            {
              "наим_док": "string",
              "номер_док": "string",
              "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})",
              "ид_док": "string",
              "доп_свед_док": "string",
              "ид_рек_сост": [
                {
                  "иннюл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}",
                  "иннфл": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}",
                  "данн_ино": {
                    "ид_стат": "ЮЛ",
                    "стран": "string",
                    "наим": "string",
                    "идентиф": "string",
                    "иные_свед": "string",
                    "уд_личн_ин_фл": {
                      "вид_док": "string",
                      "ном_док": "string",
                      "дата_док": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})"
                    }
                  },
                  "наим_оив": "string"
                }
              ]
            }
          ],
          "разм_штр": [
            {
              "факт_кол_ед_изм": "string",
              "итог_разм_штр_рф": 0.5,
              "код_окв": "[0-9]{3}",
              "наим_окв": "string",
              "итог_разм_штр_ин": 0.5,
              "дата_курс_вал": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})",
              "курс_вал": 0.5,
              "расч_штр": "string"
            }
          ],
          "инф_пол": [
            {
              "ид_файл_инф_пол": "string",
              "текст_инф": [
                {
                  "идентиф": "string",
                  "значение": "string"
                }
              ]
            }
          ]
        }
      ],
      "инф_пол": [
        {
          "ид_файл_инф_пол": "string",
          "текст_инф": [
            {
              "идентиф": "string",
              "значение": "string"
            }
          ]
        }
      ]
    }
  }
}

      {...}        
    
        верс_форм:
        enum
        
[5.01]

        ид_пол_иной:
        [string]
        
От (4 до 46 символов)

      документ:{...}        
    
        кнд:
        enum
        
[1110342]

      сод_прв_выд:{...}        
    
      зам_прв_выд:{...}        
    
        зам_дата_вр_приб:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_пр:
        enum
        
[0, 1]

        зам_дат_вр_убыт:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_уб:
        enum
        
[0, 1]

        зам_дат_вр_пос_выгр:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_выгр:
        enum
        
[0, 1]

        зам_сост_груз:
        string
        
От (1 до 10000 символов)

        зам_раб_выгр:
        string
        
От (1 до 10000 символов)

      инф_пол:[{...}]        
    
        ид_файл_инф_пол:
        string
        
От (36 до 36 символов)

      текст_инф:[{...}]        
    
        идентиф:
        string
        
От (1 до 50 символов)

        значение:
        string
        
От (1 до 2000 символов)

}]

}]

}

      отмет_прв_выд:[{...}]        
    
        дат_вр_отмет:
        string
        
От (25 до 25 символов)

        нал_коор_точ_вр_отм:
        enum
        
[0, 1]

        обст_отмет:
        string
        
От (1 до 2000 символов)

        отм_акт_взв:
        string
        
От (1 до 1000 символов)

      св_акт:[{...}]        
    
        наим_док:
        string
        
От (1 до 255 символов)

        номер_док:
        string
        
От (1 до 255 символов)

        дата_док:
        string
        
От (10 до 10 символов)

        ид_док:
        string
        
От (1 до 255 символов)

        доп_свед_док:
        string
        
От (1 до 2000 символов)

      ид_рек_сост:[{...}]        
    
        иннюл:
        string
        
От (10 до 10 символов)

        иннфл:
        string
        
От (12 до 12 символов)

      данн_ино:{...}        
    
        ид_стат:
        enum
        
[ЮЛ, ФЛ]

        стран:
        string
        
От (1 до 255 символов)

        наим:
        string
        
От (1 до 1000 символов)

        идентиф:
        string
        
От (1 до 255 символов)

        иные_свед:
        string
        
От (1 до 255 символов)

      уд_личн_ин_фл:{...}        
    
        вид_док:
        string
        
От (1 до 1000 символов)

        ном_док:
        string
        
От (1 до 100 символов)

        дата_док:
        string
        
От (10 до 10 символов)

}

}

        наим_оив:
        string
        
От (1 до 255 символов)

}]

}]

      разм_штр:[{...}]        
    
        факт_кол_ед_изм:
        string
        
От (1 до 255 символов)

        итог_разм_штр_рф:
        number
        
        код_окв:
        string
        
От (3 до 3 символов)

        наим_окв:
        string
        
От (1 до 100 символов)

        итог_разм_штр_ин:
        number
        
        дата_курс_вал:
        string
        
От (10 до 10 символов)

        курс_вал:
        number
        
        расч_штр:
        string
        
От (1 до 1000 символов)

}]

      инф_пол:[{...}]        
    
        ид_файл_инф_пол:
        string
        
От (36 до 36 символов)

      текст_инф:[{...}]        
    
        идентиф:
        string
        
От (1 до 50 символов)

        значение:
        string
        
От (1 до 2000 символов)

}]

}]

}]

      инф_пол:[{...}]        
    
        ид_файл_инф_пол:
        string
        
От (36 до 36 символов)

      текст_инф:[{...}]        
    
        идентиф:
        string
        
От (1 до 50 символов)

        значение:
        string
        
От (1 до 2000 символов)

}]

}]

}

}

}

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Формирование четвёртого титула (титула перевозчика). XML-файл

Позволяет создать XML-файл четвёртого титула, чтобы в дальнейшем подписать и отправить его. Указывается отпечаток сертификата электронной подписи SHA-1 и номер МЧД (если есть).

Генерация четвёртого титула (XML-файл)

post

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4/xml

docflow_id

string

export

boolean

Проставляет headers для автоматического скачивания.

Развернуть все Свернуть все

body

object

{...}

Схема тела запроса для генерации xml, необходимая для генерации полномочий подписанта

certificate_id*: string

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

power_of_attorney_id: string

Идентификатор МЧД

}

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отправка четвёртого титула (титула перевозчика)

Позволяет отправить четвёртый титул ЭТрН в ГИС (в Государственную информационную систему) и контрагентам. После отправки титула в ГИС, ЭТрН меняет свой статус на “title_4_waiting_operator”. После получения четвёртого титула ГИС проводит валидацию титула:

если валидация пройдена успешно, то титул поступает контрагентам, статус ЭТрН меняется на “title_4_success”;
если валидация не пройдена — статус ЭТрН меняется вновь на “title_3_success” и четвёртый титул контрагентам не поступает. При отправке необходимо указывать строку подписи прикладываемого XML-файла четвёртого титула в формате base64.

Отправка четвёртого титула

post

/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4/send

docflow_id

string

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

sign

string

document

binary

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id документооборота

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение информации по ЭТрН

Поиск участников документооборота по ИНН

Позволяет получить данные участника документооборота по ИНН. По умолчанию astral_stand = real. Для тестового стенда astral_stand = fake

Поиск участников по ИНН

get

/gw/epd/users/v1/participants

inn

string

astral_stand

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"astral_user_id":"string",

"firm_id":"string",

"name":"string",

"account_id":"string",

"default_contact_id":0

}

]

[{...}]

astral_user_id*: string

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

firm_id*: string

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

name*: string

Наименование участника

account_id*: string

Идентификатор аккаунта АТИ

default_contact_id*: integer

Идентификатор контакта аккаунта по умолчанию

}]

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение метаинформации по ЭТрН

Позволяет получить метаинформацию по ЭТрН (подписанты, статус и т. д.).

Получение метаинформации по ЭТрН

get

/gw/epd/etrn/v1/docflows/{docflow_id}

docflow_id

string

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string",

"state":"draft",

"participants":{...},

"cargo_sender":{...},

"inn":"string",

"first_name":"string",

"last_name":"string",

"patronymic":"string",

"full_name":"string",

"kpp":"string",

"ati_id":"string",

"default":false,

"is_roaming_user":false,

"id":"string",

"roaming_operator_id":"string",

"created_at":"1970-01-01T00:00:00.000Z",

"certificates":[...],

{...}

"id":"string",

"valid_from":"1970-01-01T00:00:00.000Z",

"valid_until":"1970-01-01T00:00:00.000Z",

"serial":"string",

"issuer":{...},

"OGRN":"string",

"INN":"string",

"CN":"string"

"components":{...},

"SNILS":"string",

"OGRN":"string",

"INN":"string",

"emailAddress":"string",

"C":"string",

"ST":"string",

"L":"string",

"O":"string",

"CN":"string",

"street":"string",

"unstructuredName":"string",

"title":"string",

"GN":"string",

"SN":"string"

"title":"string",

"body":"string",

"created_at":"1970-01-01T00:00:00.000Z"

}

"signatory_credentials":[...]

{...}

"scope_of_authority":{...},

"sender":"0",

"receiver":"1"

"status":"3",

"foundation_for_trust":"string",

"foundation_for_trust_organization":"string",

"position":"string",

"certificate_id":"string"

}

]

"cargo_carrier":{...},

"inn":"string",

"first_name":"string",

"last_name":"string",

"patronymic":"string",

"full_name":"string",

"kpp":"string",

"ati_id":"string",

"default":false,

"is_roaming_user":false,

"id":"string",

"roaming_operator_id":"string",

"created_at":"1970-01-01T00:00:00.000Z",

"certificates":[...],

{...}

"id":"string",

"valid_from":"1970-01-01T00:00:00.000Z",

"valid_until":"1970-01-01T00:00:00.000Z",

"serial":"string",

"issuer":{...},

"OGRN":"string",

"INN":"string",

"CN":"string"

"components":{...},

"SNILS":"string",

"OGRN":"string",

"INN":"string",

"emailAddress":"string",

"C":"string",

"ST":"string",

"L":"string",

"O":"string",

"CN":"string",

"street":"string",

"unstructuredName":"string",

"title":"string",

"GN":"string",

"SN":"string"

"title":"string",

"body":"string",

"created_at":"1970-01-01T00:00:00.000Z"

}

"signatory_credentials":[...]

{...}

"scope_of_authority":{...},

"sender":"0",

"receiver":"1"

"status":"3",

"foundation_for_trust":"string",

"foundation_for_trust_organization":"string",

"position":"string",

"certificate_id":"string"

}

]

"cargo_receiver":{...}

"inn":"string",

"first_name":"string",

"last_name":"string",

"patronymic":"string",

"full_name":"string",

"kpp":"string",

"ati_id":"string",

"default":false,

"is_roaming_user":false,

"id":"string",

"roaming_operator_id":"string",

"created_at":"1970-01-01T00:00:00.000Z",

"certificates":[...],

{...}

"id":"string",

"valid_from":"1970-01-01T00:00:00.000Z",

"valid_until":"1970-01-01T00:00:00.000Z",

"serial":"string",

"issuer":{...},

"OGRN":"string",

"INN":"string",

"CN":"string"

"components":{...},

"SNILS":"string",

"OGRN":"string",

"INN":"string",

"emailAddress":"string",

"C":"string",

"ST":"string",

"L":"string",

"O":"string",

"CN":"string",

"street":"string",

"unstructuredName":"string",

"title":"string",

"GN":"string",

"SN":"string"

"title":"string",

"body":"string",

"created_at":"1970-01-01T00:00:00.000Z"

}

"signatory_credentials":[...]

{...}

"scope_of_authority":{...},

"sender":"0",

"receiver":"1"

"status":"3",

"foundation_for_trust":"string",

"foundation_for_trust_organization":"string",

"position":"string",

"certificate_id":"string"

}

]

}

"flags":[...],

"string"

"history":[...],

{...}

"state":"string",

"ati_id":"string",

"contact_id":0,

"firm_name":"string",

"contact_name":"string",

"user_astral_id":"string",

"user_astral_name":"string",

"timestamp":"1970-01-01T00:00:00.000Z",

"sign_info":{...}

"title":"string",

"valid_from":"string",

"valid_until":"string",

"id":"string",

"components":{...}

"any-key":"string"

}

"driver_data":{...},

"phone":"^[0-9]{11,13}$",

"driver_decision":"accepted",

"decision_timestamp":"1970-01-01T00:00:00.000Z",

"rejection_reason":"string",

"send_in_title_1":true,

"is_sent_to_driver":false,

"loading_point":{...},

"arrival_timestamp":"1970-01-01T00:00:00.000Z",

"departure_timestamp":"1970-01-01T00:00:00.000Z",

"timestamp":"1970-01-01T00:00:00.000Z",

"notes":"string"

"unloading_point":{...}

"arrival_timestamp":"1970-01-01T00:00:00.000Z",

"departure_timestamp":"1970-01-01T00:00:00.000Z",

"timestamp":"1970-01-01T00:00:00.000Z",

"notes":"string"

}

"number":"string",

"date":"01.04.2023",

"payment_history":{...},

"title_1":[...],

{...}

"document_id":"string",

"is_completed":false

}

"title_2":[...],

{...}

"document_id":"string",

"is_completed":false

}

"title_3":[...],

{...}

"document_id":"string",

"is_completed":false

}

"title_4":[...],

{...}

"document_id":"string",

"is_completed":false

}

"title_5":[...],

{...}

"document_id":"string",

"is_completed":false

}

"title_6":[...],

{...}

"document_id":"string",

"is_completed":false

}

"title_7":[...],

{...}

"document_id":"string",

"is_completed":false

}

"title_8":[...]

{...}

"document_id":"string",

"is_completed":false

}

]

"astral_stand":"fake",

"template_name":"string"

}

{...}

Общая информация о документообороте

id*: string

state*: enum

[draft, title_1_accepted, title_1_waiting_operator, title_1_success, title_2_accepted, title_2_waiting_operator, title_2_success, title_3_accepted, title_3_waiting_operator, title_3_success, title_4_accepted, title_4_waiting_operator, title_4_success, title_7_requested, title_7_accepted, title_7_waiting_operator, title_7_success, title_8_accepted, title_8_waiting_operator, title_8_success, operator_failed]

Все возможные состояния для документооборота ЭТрН

participants*:{...}

cargo_sender*:{...}

Грузоотправитель

inn*: string

first_name: string

last_name: string

patronymic: string

full_name: string

kpp: string

ati_id: string

default: boolean

is_roaming_user: boolean

id: string

roaming_operator_id: string

created_at: date-time

certificates:[{...}]

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

id*: string

valid_from*: date-time

valid_until*: date-time

serial: string

issuer*:{...}

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

OGRN*: string

INN*: string

CN*: string

}

components*:{...}

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

SNILS: string

OGRN: string

INN*: string

emailAddress: string

C: string

ST: string

L: string

O: string

CN*: string

street: string

unstructuredName: string

title: string

GN*: string

SN*: string

}

title*: string

body: string

created_at: date-time

}]

signatory_credentials:[{...}]

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

scope_of_authority*:{...}

Область полномочий

sender*: enum

[0, 1, 2, 3, 4, 5, 6]

An enumeration.

receiver*: enum

[1, 2, 3, 29]

An enumeration.

}

status*: enum

[3, 4, 5, 6]

An enumeration.

foundation_for_trust*: string

От (1 до 255 символов)

Основные полномочия

foundation_for_trust_organization: string

От (1 до 255 символов)

Основные полномочия организации

position*: string

От (1 до 128 символов)

Должность

certificate_id*: string

}]

}

cargo_carrier:{...}

Перевозчик

inn*: string

first_name: string

last_name: string

patronymic: string

full_name: string

kpp: string

ati_id: string

default: boolean

is_roaming_user: boolean

id: string

roaming_operator_id: string

created_at: date-time

certificates:[{...}]

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

id*: string

valid_from*: date-time

valid_until*: date-time

serial: string

issuer*:{...}

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

OGRN*: string

INN*: string

CN*: string

}

components*:{...}

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

SNILS: string

OGRN: string

INN*: string

emailAddress: string

C: string

ST: string

L: string

O: string

CN*: string

street: string

unstructuredName: string

title: string

GN*: string

SN*: string

}

title*: string

body: string

created_at: date-time

}]

signatory_credentials:[{...}]

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

scope_of_authority*:{...}

Область полномочий

sender*: enum

[0, 1, 2, 3, 4, 5, 6]

An enumeration.

receiver*: enum

[1, 2, 3, 29]

An enumeration.

}

status*: enum

[3, 4, 5, 6]

An enumeration.

foundation_for_trust*: string

От (1 до 255 символов)

Основные полномочия

foundation_for_trust_organization: string

От (1 до 255 символов)

Основные полномочия организации

position*: string

От (1 до 128 символов)

Должность

certificate_id*: string

}]

}

cargo_receiver:{...}

Грузополучатель

inn*: string

first_name: string

last_name: string

patronymic: string

full_name: string

kpp: string

ati_id: string

default: boolean

is_roaming_user: boolean

id: string

roaming_operator_id: string

created_at: date-time

certificates:[{...}]

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

id*: string

valid_from*: date-time

valid_until*: date-time

serial: string

issuer*:{...}

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

OGRN*: string

INN*: string

CN*: string

}

components*:{...}

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

SNILS: string

OGRN: string

INN*: string

emailAddress: string

C: string

ST: string

L: string

O: string

CN*: string

street: string

unstructuredName: string

title: string

GN*: string

SN*: string

}

title*: string

body: string

created_at: date-time

}]

signatory_credentials:[{...}]

Описывает схему документа в MongoDB. Все вложенные в схему документы должны наследоваться от этого класса.

scope_of_authority*:{...}

Область полномочий

sender*: enum

[0, 1, 2, 3, 4, 5, 6]

An enumeration.

receiver*: enum

[1, 2, 3, 29]

An enumeration.

}

status*: enum

[3, 4, 5, 6]

An enumeration.

foundation_for_trust*: string

От (1 до 255 символов)

Основные полномочия

foundation_for_trust_organization: string

От (1 до 255 символов)

Основные полномочия организации

position*: string

От (1 до 128 символов)

Должность

certificate_id*: string

}]

}

flags*: [string]

Список флагов

history*:[{...}]

Схема с историей документа в методе получения мета информации

state*: string

ati_id*: string

contact_id*: integer

firm_name: string

contact_name: string

user_astral_id: string

user_astral_name: string

timestamp*: date-time

sign_info:{...}

Информация о подписи в истории

title*: string

valid_from*: string

valid_until*: string

id*: string

components*:{...}

any-key: string

}

}]

driver_data*:{...}

Информация относящаяся к интеграции с водителем

phone: string

Телефон выбранного водителя

driver_decision: enum

[accepted, rejected]

Возможные решения водителя по этрн

decision_timestamp: date-time

Дата и время принятия решения водителем

rejection_reason: string

Причина отказа водителя

send_in_title_1: boolean

Нужно ли отправлять ЭТРН в АТИ Водитель автоматически при подписании первого титула

is_sent_to_driver: boolean

Отправлен ли уже ЭТРН в АТИ Водитель

loading_point:{...}

Точка погрузки

arrival_timestamp: date-time

Дата и время прибытия в точку

departure_timestamp: date-time

Дата и время отбытия из точки

timestamp*: date-time

Дата и время изменения статуса

notes: string

Примечание, формат key1=value1;key2=value2

}

unloading_point:{...}

Точка разгрузки

arrival_timestamp: date-time

Дата и время прибытия в точку

departure_timestamp: date-time

Дата и время отбытия из точки

timestamp*: date-time

Дата и время изменения статуса

notes: string

Примечание, формат key1=value1;key2=value2

}

number: string

Номер ЭТРН

date: string

Дата заполнения ЭТРН

payment_history*:{...}

История платежей

title_1:[{...}]

document_id*: string

is_completed*: boolean

Завершен ли флоу для титула успешно

}]

title_2:[{...}]

document_id*: string

is_completed*: boolean

Завершен ли флоу для титула успешно

}]

title_3:[{...}]

document_id*: string

is_completed*: boolean

Завершен ли флоу для титула успешно

}]

title_4:[{...}]

document_id*: string

is_completed*: boolean

Завершен ли флоу для титула успешно

}]

title_5:[{...}]

document_id*: string

is_completed*: boolean

Завершен ли флоу для титула успешно

}]

title_6:[{...}]

document_id*: string

is_completed*: boolean

Завершен ли флоу для титула успешно

}]

title_7:[{...}]

document_id*: string

is_completed*: boolean

Завершен ли флоу для титула успешно

}]

title_8:[{...}]

document_id*: string

is_completed*: boolean

Завершен ли флоу для титула успешно

}]

}

astral_stand*: enum

[fake, real]

An enumeration.

template_name: string

Имя шаблона

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение ключа доступа к печатной форме и QR-коду

Позволяет получить ключ доступа, необходимый для скачивания файлов печатной формы и QR-кода. Если файл печатной формы или QR-кода ранее не генерировался, то для успешного ответа потребуется время — вызов метода надо будет повторить.

Получение ключа доступа для скачивания печатной формы и QR-кода

post

/gw/epd/etrn/v1/docflows/{docflow_id}/files/{doc_type}

doc_type

string

docflow_id

string

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"string"

}

{...}

Возвращает id файла

id*: string

}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Скачивание файла печатной формы и QR-кода

Позволяет скачивать файлы печатной формы и QR-кода. Требуется ключ доступа из метода выше.

Скачивание файлов печатной формы и QR-кода

get

/gw/epd/etrn/v1/docflows/{docflow_id}/files/{file_key}

file_key

string

docflow_id

string

CURL

Копировать

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

Ответ

200 Successful Response

Развернуть все Свернуть все

Пример

Модель

{missing-type-info}

422 Validation Error

Развернуть все Свернуть все

Пример

Модель

{...}

"detail":[...]

{...}

"loc":[...],

"string"

"msg":"string",

"type":"string"

}

]

}

{...}

detail:[{...}]

loc*: [string]

Путь до поля, вызвавшего ошибку

msg*: string

Расшифровка ошибки

type*: string

Тип ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...