Метод ListMBex при работе с веб-сервисом Ediweb

Данный метод возвращает статус документов, которые были доставлены пользователю платформы EDI Platform.

Метод ListMBex за раз возвращает 10 тысяч строк данных. Для работы с большим объёмом данных необходимо выполнить запрос последовательно несколько раз.

Аргументы метода ListMBex

В методе ListMBex используются следующие аргументы (Табл. 1).
 

Табл. 1. Описание аргументов
Аргументы Описание Обязательность
name ID пользователя на EDI Platform M
password Пароль пользователя M
partnerILN ID партнера, от которого был получен документ O
documentType Тип документа (например INVOIC) M
dateFrom Опциональный O
dateTo Опциональный O
itemFrom Опциональный O
itemTo Опциональный O
documentStatus Диапазон статусов выбираемых документов N – только новые документы R – только прочтенные документы (статус read(R)) Любое другое или пустое значение вернёт список всех документов. O

При вызове метода ListMBex, аргументы: PartnerIln, DocumentType используют значения, возвращаемые методом Relationship для данного пользователя, соответственно: partner-iln, document-type.

DateFrom/To – задает промежуток времени для выбранного документа.

ItemFrom/To – задает диапазон документов. Номер 1 – документ, который был отправлен позже всех.

Формат даты rrrr-mm-dd (rrrr – year, mm - month, dd - day).

По умолчанию метод возвращает 100 последних документов.

Значение, возвращаемое платформой EDI Platform

Ответ метода ListMBex содержит следующие поля (Табл. 2).
 

Табл. 2. Описание полей ответа
Тег Описание
<partner-iln> ID партнера, от которого был получен документ
<tracking-id> Идентификатор документа на EDI Platform
<document-type> Тип документа (например INVOIC)
<document-status> Статус документа (N – new, R – read)
<document-number> Номер документа в самом документе
<document-date> Дата документа
<document-control-number> Контрольный номер документа
<file-name> Имя файла
<receive-date> Дата, когда документ был получен

Пример формирования запроса

Пример формирования запроса метода ListMBex
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:wsedi">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:listMBEx>
        <name>2000000000123</name>
         <password>1234qwe</password>
         <partnerILN>2000000000321</partnerILN>
         <documentType>INVOICE</documentType>  
         <dateFrom></dateFrom>
         <dateTo></dateTo>
         <itemFrom></itemFrom>
         <itemTo></itemTo>
         <documentStatus>N</documentStatus>
      </urn:listMBEx>
   </soapenv:Body>
</soapenv:Envelope>

19 июня 2024 г.