API ########### .. hint:: Всі запити нижче перерахованих API методів сервісу "ЕТТН" направляються на адресу: https://edo-v2.edin.ua Авторизація ============== +-----------+-----------------------------+-------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+=============================+=================================================================================================+ | POST | ``/api/authorization/hash`` | `Авторизація `__ | +-----------+-----------------------------+-------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/Authorization Methods/AuthCheck Робота з е-ТТН ============================ +-----------+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+============================================+===========================================================================================================================================================+ | POST | ``/api/ettn/eds/ettn/consignor`` | `Створення чернетки нової е-ТТН `__ | +-----------+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/doc/v2/xml`` | `Створення XML документа для подальшого підписання `__ | +-----------+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/v2/eds/doc/body`` | `Отримання (завантаження) документа сервісу «ЕТТН» в JSON/XML/PDF/ZIP форматі `__ | | | | | | | ``/api/ettn/doc/xml`` | `Отримання (завантаження) документа сервісу «ЕТТН» в JSON/XML/PDF/ZIP форматі `__ | +-----------+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/doc/xml/v2/sign`` | `Підписання даних сервісу "ЕТТН" (збереження підпису) `__ | +-----------+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/ettn/eds/doc/read`` | `Відмітити документ, як "прочитаний" `__ | +-----------+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/v2/eds/doc/body/final`` | `Отримання фінальної версії е-ТТН (разом зі змінами, що були внесені актами) `__ | +-----------+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/v2/eds/doc/processing_status`` | `Відправка статуса обробки документа ТТН `__ | +-----------+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/CreateConsignorETTN Methods/CreateEttnV2XML Methods/GetDocumentBodyV2 Methods/GetDocArchive Methods/SaveEttnV2Sign Methods/MarkDocumentAsRead Methods/GetEttnBodyFinal Methods/SetProcessingStatus Робота з іншими документами сервісу "ЕТТН" ============================================ +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+========================================+========================================================================================================================================================+ | POST | ``/api/ettn/eds/doc/attachment`` | `Створення вкладення до документа `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/eds/doc/attachment`` | `Отримання вкладення документа сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | DELETE | ``/api/ettn/eds/doc/attachment`` | `Видалення вкладення документа сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/booking`` | `Створення/редагування чернетки "Заявка на транспортування" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/booking/confirmation`` | `Створення/редагування чернетки "Підтвердження транспортування" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/acceptance`` | `Створення/редагування чернетки "Акта приймання-передавання" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/discrepancy`` | `Створення/редагування чернетки "Акта розбіжностей" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/completion`` | `Створення/редагування чернетки "Акта виконаних робіт" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/ettn/eds/doc/from_draft`` | `Створення документу еТТН на основі чернетки, створеної контрагентом `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/ettn/eds/doc/send`` | `Відправка документа сервісу "ЕТТН" з Чернеток `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/ettn/eds/docs`` | `Видалення документів сервісу "ЕТТН" з "Чернеток" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/ettn/eds/doc/clone`` | `Створити копію документа сервісу "ЕТТН" / Замінити документ е-ТТН `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/eds/doc`` | `Отримання документа сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/eds/chain`` | `Отримання ланцюжка документів сервісу "ЕТТН" по id ланцюжка чи id документа `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/eds/doc/body`` | `Отримання тіла документа сервісу "ЕТТН" в json форматі `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/eds/doc/signers`` | `Отримання даних підписантів документа сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/eds/doc/links`` | `Отримання пов'язаних документів сервісу "ETTN" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/eds/doc/xml/ticket`` | `Отримання даних документа сервісу "ЕТТН" для підписання `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/eds/doc/tickets`` | `Отримання всіх квитанцій вказаного документа `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/ettn/eds/doc/confirm`` | `Підтвердити документ сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | PUT | ``/api/ettn/eds/doc/reject`` | `Відмовити в підписанні документа сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/chains/search`` | `Отримання списку ланцюжків документів сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/docs/search`` | `Отримання списку документів сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/doc/xml/sign`` | `Підписання даних сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/ettn/eds/chains/archive`` | `Заархівувати всі документи у вказаному ланцюжку `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/doc/comment`` | `Додати коментар до документа сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/ettn/eds/doc/comments`` | `Отримання коментарів до документу сервісу "ЕТТН" `__ | +-----------+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/CreateDocAttachment Methods/GetDocAttachment Methods/DelDocAttachment Methods/CreateBooking Methods/CreateBookingConfirmation Methods/CreateAcceptance Methods/CreateDiscrepancy Methods/CreateCompletion Methods/CreateFromDraftDocument Methods/DocSend Methods/DelDocs Methods/DocClone Methods/GetDoc Methods/GetChain Methods/GetDocBody Methods/GetSignersInfo Methods/GetLinks Methods/GetTicket Methods/GetTickets Methods/DocConfirm Methods/DocReject Methods/GetChainsList Methods/GetDocList Methods/SaveSignedData Methods/ArcChains Methods/AddComment Methods/GetComments Робота з актами ("Акт перевантаження", "Акт розбіжностей до ТТН") ---------------------------------------------------------------------------------------------------- +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+====================================+=======================================================================================================================================================================+ | POST | ``/api/ettn/eds/reload`` | `Створення/редагування чернетки "Акта перевантаження" `__ | +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/disagreement`` | `Створення/редагування чернетки "Акта розбіжностей" до е-ТТН `__ | +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/warehouse_change`` | `Створення/редагування чернетки "Акта про заміну пункту призначення вантажу" до е-ТТН `__ | +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/adjustment`` | `Створення/редагування чернетки "Акта коригування" до е-ТТН `__ | +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/act/xml`` | `Створення XML Акта для подальшого підписання `__ | +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/ettn/eds/act/sign`` | `Підписання "Акта" `__ | +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/ettn/eds/act/send`` | `Відправка "Акта" `__ | +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PUT | ``/api/ettn/eds/act/reject`` | `Відхилити "Акт" `__ | +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/CreateReload Methods/CreateDisagreement Methods/CreateWarehouseChange Methods/CreateAdjustment Methods/CreateActXml Methods/SaveActSign Methods/SendAct Methods/RejectAct Робота з довідниками ============================ +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+==========================================+==============================================================================================================================================================================+ | POST | ``/api/oas/v2/exdata`` | `Отримання даних компанії, співробітників, адрес з довідників сервісу "ЕТТН" `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/oas/v2/company/search`` | `Отримання даних про компанію за назвою / ІНН / ЄДРПОУ `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/oas/v2/company/employees/search`` | `Отримання даних співробіника компанії за прізвищем / ІПН / номером посвідчення водія `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/oas/v2/company/addresses/search`` | `Отримання адреси з довідника компанії за назвою / містом / вулицею / кодом КОАТУУ / кодом КАТОТТГ `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/oas/v2/katottg/search`` | `Отримання данних КАТОТТГ за кодом / назвою населеного пункту `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/oas/v2/company`` | `Отримання даних про компанію по ідентифікатору компанії `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/oas/invitation`` | `Отримання запрошення для незареєстрованого користувача в сервісі ЕТТН `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PUT | ``/api/oas/v2/employee`` | `Створення співробітника `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PUT | ``/api/oas/v2/employee/join/company`` | `Приєднання/від'єднання співробітника до/від компанії `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PUT | ``/api/oas/v2/employee/update`` | `Оновлення даних співробітника `__ | +-----------+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/ExtraData Methods/CompanySearch Methods/EmployeesSearch Methods/AddressesSearch Methods/SearchKatottg Methods/GetCompany Methods/GetInvitation Methods/PutEmployee Methods/JoinEmployeeToCompany Methods/UpdateEmployee --------------------------------- .. _ttnv2-errors: Опис помилок сервісу "ЕТТН" v2 ========================================================================================= .. csv-table:: :file: /API_ETTNv3_1/new_ttn_errors.csv :widths: 10, 20, 20, 40 :stub-columns: 0 --------------------------------- .. _main-errors: Загальні помилки при роботі з API (всі сервіси EDIN) ========================================================================================= .. csv-table:: :file: /_constant/common_api_errors.csv :widths: 10, 20, 20, 40 :stub-columns: 0 .. csv-table:: :file: /_constant/main_api_errors.csv :widths: 10, 20, 60 :stub-columns: 0 .. old auto list (deprecated) .. toctree:: :hidden: :glob: Methods/*