Список манифестов прибытия в город агента на указанную дату (поддержка фильтрации и расширенных атрибутов)

ManifestInfoList

Функция ManifestInfoList возвращает список манифестов прибытия в город агента на указанную дату. Метод также заявлен как поддерживающий фильтрацию и расширенные атрибуты, однако в предоставленном описании SOAP-запроса фактически указан один входной параметр — дата манифестов.

Информация о манифесте включает:

  • номер и дату манифеста;
  • номер AWB и рейса;
  • данные города, агента и терминала отправления;
  • данные города, агента и терминала получения;
  • количество грузовых мест и накладных;
  • фактический и расчетный вес;
  • данные о сортировщике;
  • дату и время отправления манифеста;
  • информацию об изменениях и комментарии;
  • код и название статуса манифеста.

Получение списка манифестов за определенную дату

ОПИСАНИЕ ПАРАМЕТРОВ ЗАПРОСА

В предоставленном описании SOAP/WSDL не указаны значения minOccurs и maxOccurs, поэтому ниже приводится только тип параметра, фактически присутствующий в SOAP-примере.

ПараметрТипОписание
dateManifestsdateTimeДата манифестов, за которую выполняется выборка

SOAP 1.1

SOAP-запрос

POST /ShipmentService.asmx HTTP/1.1
Host: agents.major-express.ru
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/ManifestInfoList"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>
    <TicketHeader xmlns="http://tempuri.org/">
      <Ticket>string</Ticket>
      <UserName>string</UserName>
      <CheckSum>int</CheckSum>
      <inRole>boolean</inRole>
    </TicketHeader>
  </soap:Header>

  <soap:Body>
    <ManifestInfoList xmlns="http://tempuri.org/">
      <dateManifests>dateTime</dateManifests>
    </ManifestInfoList>
  </soap:Body>

</soap:Envelope>

Структура SOAP 1.1-запроса и параметр dateManifests непосредственно присутствуют в предоставленной спецификации метода.

ОПИСАНИЕ ПАРАМЕТРОВ ОТВЕТА

ПараметрТипОписание
ResCodeintКод результата выполнения запроса
ResTextstringТекст результата выполнения запроса
Itemsмассив ManifestInfoСписок найденных манифестов

Структура ответа содержит ResCode, ResText и массив Items, состоящий из объектов ManifestInfo.

ManifestInfo

Основные данные манифеста

ПараметрТипОписание
ManifestNumstringНомер манифеста
ManifestDateTimedateTimeДата и время манифеста
AWBNumstringНомер AWB
FlightNumstringНомер рейса

Данные отправления

ПараметрТипОписание
ShipperCityCodeintКод города отправления
ShipperCity_NamestringГород отправления
ShipperAgentCodeshortКод агента отправления
ShipperAgent_NamestringАгент отправления
ShipperTerminalCodeunsignedByteКод терминала отправления
ShipperTerminalstringТерминал отправления
ShipperTerminalCompstringКомпания терминала отправления

Данные получения

ПараметрТипОписание
ConsigneeCityCodeintКод города получения
ConsigneeCity_NamestringГород получения
ConsigneeAgentCodeshortКод агента получения
ConsigneeAgent_NamestringАгент получения
ConsigneeTerminalCodeunsignedByteКод терминала получения
ConsigneeTerminalstringТерминал получения

Груз и количество накладных

ПараметрТипОписание
NumberPartsshortКоличество грузовых мест
WeightRealdoubleФактический вес
WeightdoubleВес по накладным
VolumedoubleОбъем
NumberWBshortКоличество накладных / мест

Обработка и отправление манифеста

ПараметрТипОписание
SorterstringФИО сортировщика
DepartureDateTimedateTimeДата и время отправления манифеста

Дополнительная информация

ПараметрТипОписание
ChangesstringПодробности изменений / исправлений
CommentsstringКомментарий

Статус манифеста

ПараметрТипОписание
StatusunsignedByteКод статуса манифеста
ManifestStatusstringСтатус манифеста

SOAP-ответ

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>
    <ManifestInfoListResponse xmlns="http://tempuri.org/">
      <ManifestInfoListResult>

        <ResCode>int</ResCode>
        <ResText>string</ResText>

        <Items>

          <ManifestInfo>
            <ManifestNum>string</ManifestNum>
            <ManifestDateTime>dateTime</ManifestDateTime>
            <AWBNum>string</AWBNum>
            <FlightNum>string</FlightNum>

            <ShipperCityCode>int</ShipperCityCode>
            <ShipperCity_Name>string</ShipperCity_Name>
            <ShipperAgentCode>short</ShipperAgentCode>
            <ShipperAgent_Name>string</ShipperAgent_Name>
            <ShipperTerminalCode>unsignedByte</ShipperTerminalCode>
            <ShipperTerminal>string</ShipperTerminal>
            <ShipperTerminalComp>string</ShipperTerminalComp>

            <ConsigneeCityCode>int</ConsigneeCityCode>
            <ConsigneeCity_Name>string</ConsigneeCity_Name>
            <ConsigneeAgentCode>short</ConsigneeAgentCode>
            <ConsigneeAgent_Name>string</ConsigneeAgent_Name>
            <ConsigneeTerminalCode>unsignedByte</ConsigneeTerminalCode>
            <ConsigneeTerminal>string</ConsigneeTerminal>

            <NumberParts>short</NumberParts>
            <WeightReal>double</WeightReal>
            <Weight>double</Weight>
            <Volume>double</Volume>
            <NumberWB>short</NumberWB>

            <Sorter>string</Sorter>
            <DepartureDateTime>dateTime</DepartureDateTime>

            <Changes>string</Changes>
            <Comments>string</Comments>

            <Status>unsignedByte</Status>
            <ManifestStatus>string</ManifestStatus>
          </ManifestInfo>

        </Items>

      </ManifestInfoListResult>
    </ManifestInfoListResponse>
  </soap:Body>

</soap:Envelope>

Структура SOAP 1.1-ответа с ManifestInfoListResponse, ManifestInfoListResult, Items и объектами ManifestInfo приведена в исходной спецификации метода.

SOAP 1.2

SOAP-запрос

POST /ShipmentService.asmx HTTP/1.1
Host: agents.major-express.ru
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                 xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Header>
    <TicketHeader xmlns="http://tempuri.org/">
      <Ticket>string</Ticket>
      <UserName>string</UserName>
      <CheckSum>int</CheckSum>
      <inRole>boolean</inRole>
    </TicketHeader>
  </soap12:Header>

  <soap12:Body>
    <ManifestInfoList xmlns="http://tempuri.org/">
      <dateManifests>dateTime</dateManifests>
    </ManifestInfoList>
  </soap12:Body>

</soap12:Envelope>

В SOAP 1.2 используется application/soap+xml и пространство имён SOAP 1.2; структура Header и Body при этом соответствует SOAP 1.1-варианту метода.

SOAP-ответ

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                 xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>
    <ManifestInfoListResponse xmlns="http://tempuri.org/">
      <ManifestInfoListResult>

        <ResCode>int</ResCode>
        <ResText>string</ResText>

        <Items>

          <ManifestInfo>
            <ManifestNum>string</ManifestNum>
            <ManifestDateTime>dateTime</ManifestDateTime>
            <AWBNum>string</AWBNum>
            <FlightNum>string</FlightNum>

            <ShipperCityCode>int</ShipperCityCode>
            <ShipperCity_Name>string</ShipperCity_Name>
            <ShipperAgentCode>short</ShipperAgentCode>
            <ShipperAgent_Name>string</ShipperAgent_Name>
            <ShipperTerminalCode>unsignedByte</ShipperTerminalCode>
            <ShipperTerminal>string</ShipperTerminal>
            <ShipperTerminalComp>string</ShipperTerminalComp>

            <ConsigneeCityCode>int</ConsigneeCityCode>
            <ConsigneeCity_Name>string</ConsigneeCity_Name>
            <ConsigneeAgentCode>short</ConsigneeAgentCode>
            <ConsigneeAgent_Name>string</ConsigneeAgent_Name>
            <ConsigneeTerminalCode>unsignedByte</ConsigneeTerminalCode>
            <ConsigneeTerminal>string</ConsigneeTerminal>

            <NumberParts>short</NumberParts>
            <WeightReal>double</WeightReal>
            <Weight>double</Weight>
            <Volume>double</Volume>
            <NumberWB>short</NumberWB>

            <Sorter>string</Sorter>
            <DepartureDateTime>dateTime</DepartureDateTime>

            <Changes>string</Changes>
            <Comments>string</Comments>

            <Status>unsignedByte</Status>
            <ManifestStatus>string</ManifestStatus>
          </ManifestInfo>

        </Items>

      </ManifestInfoListResult>
    </ManifestInfoListResponse>
  </soap12:Body>

</soap12:Envelope>

Структура SOAP 1.2-ответа полностью представлена в исходном описании метода и содержит тот же набор данных ManifestInfo, что и SOAP 1.1.

Примечание по WSDL: в предоставленном материале для ManifestInfoList приведены SOAP 1.1 и SOAP 1.2 примеры, но не приведены явные значения minOccurs / maxOccurs для параметров. Поэтому эти атрибуты в документации выше намеренно не выдуманы.