Данный метод возвращает значения статусов отправленных документов.
Аргументы метода ListPBEx
В методе ListPBEx используются следующие аргументы (Табл. 1).
| Аргументы |
Описание |
Обязательность |
| name |
ID пользователя на EDI Platform |
M |
| password |
Пароль пользователя |
M |
| partnerILN |
ID партнера, которому был послан документ |
O |
| documentType |
Тип документа (например INVOIC) |
M |
| documentVersion |
Версия спецификации (например EDISOFTV0R1) |
O |
| documentStandard |
Стандарт документа (например EDIFACT,XML) |
O |
| documentTest |
Статус документа (T – тест, P – продуктивный) |
O |
| dateFrom |
Опциональный |
O |
| dateTo |
Опциональный |
O |
| itemFrom |
Опциональный, начиная с нуля |
O |
| itemTo |
Опциональный |
O |
| orderBy |
Опциональный |
O |
| timeout |
Таймаут на выполнение вызова метода |
M |
Табл. 1. Описание аргументов
При вызове метода, аргументы: partnerILN, documentType, documentVersion, documentStandard, documentTest используют значения, возвращаемые методом Relationship для данного пользователя, соответственно: partner-iln, document-type, document-version, document-standard, document-test.
DateFrom/To – задает промежуток времени для выбранного документа. Даты ожидаются в формете: yyyy-MM-dd HH:mm:ss
ItemFrom/To – задает диапазон документов. Номер 1 – документ, который был отправлен позже всех.
По умолчанию, метод возвращает 100 последних документов.
Значение, возвращаемое платформой EDI Platform
Ответ метода ListPBEx содержит следующие поля (Табл. 2).
| Тег |
Описание |
| <partner-iln> |
ID партнера, которому отправляется документ |
| <buyer-iln> |
Покупатель по документу |
| <seller-iln> |
Продавец по документу |
| <delivery-iln> |
Точка доставки по документу |
| <document-type> |
Тип документа (например INVOIC) |
| <document-version> |
Версия спецификации (например EDISOFTV0R1) |
| <document-standard> |
Стандарт документа (например EDIFACT,XML) |
| <document-test> |
Статус документа (T – тест, P – продуктивный) |
| <document-number> |
Бизнес-номер документа |
| <document-date> |
Дата документа |
| <document-status> |
Статус обработки документа |
| <document-status-description> |
Описание статуса обработки документа |
| <tracking-id> |
Идентификатор документа на EDI Platform |
| <submission-date> |
Дата отправки документа |
| <submission-handle> |
ID документа |
| <control-number> |
Контрольный номер передачи сообщения |
| <document-status-date> |
Дата отчёта о документе (документа STATUS) |
| <package-id> |
Уникальный идентификатор пакета |
Табл. 2. Описание полей ответа
Пример формирования запроса
Пример формирования запроса метода ListPBEx
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:wsedi">
<soapenv:Header/>
<soapenv:Body>
<urn:listPBEx>
<name>2000000000123</name>
<password>1234qwe</password>
<partnerILN>2000000000321</partnerILN>
<documentType>INVOICE</documentType>
<documentVersion>EDISOFTV0R2</documentVersion>
<documentStandard>XML</documentStandard>
<documentTest>T</documentTest>
<dateFrom></dateFrom>
<dateTo></dateTo>
<itemFrom></itemFrom>
<itemTo>0</itemTo>
<orderBy>5</orderBy>
<timeout>5000</timeout>
</urn:listPBEx>
</soapenv:Body>
</soapenv:Envelope>