Единичный доступ

Режим Единичного доступа позволяет за одно обращение к Сервису отслеживания получить информацию по одному регистрируемому почтовому отправлению (РПО). Возможны следующие запросы:

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

• получение информации об операциях с наложенным платежом, который связан с отправлением (метод PostalOrderEventsForMail).

Протокол Единичного доступа реализован на основе SOAP (Simple Object Access Protocol).

1. Основная информация по использованию API

2. Метод getOperationHistory

Метод getOperationHistory используется для получения информации о конкретном отправлении. Метод возвращает подробную информацию по всем операциям, совершенным над отправлением.

2.1. Запрос

2.2. Ответ

Ответ метода getOperationHistory содержит список элементов historyRecord. Каждый из них содержит информацию об одной операции над отправлением. Если над отправлением еще не зарегистрировано ни одной операции, то возвращается пустой список элементов historyRecord.

По каждой операции в ответе обязательно присутствует следующая информация:

• Дата операции (OperDate);

• Место проведения операции (OperationAddress);

• Операция (OperType) и ее атрибут (OperAttr).

Прочая информация возвращается при её наличии в Сервисе отслеживания.

2.3. Возможные ошибки

2.4. Пример запроса и ответа

Пример запроса:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:oper="http://russianpost.org/operationhistory" xmlns:data="http://russianpost.org/operationhistory/data" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Header/>
   <soap:Body>
      <oper:getOperationHistory>
         <data:OperationHistoryRequest>
            <data:Barcode>RA644000001RU</data:Barcode>
            <data:MessageType>0</data:MessageType>
            <data:Language>RUS</data:Language>
         </data:OperationHistoryRequest>
         <data:AuthorizationHeader soapenv:mustUnderstand="1">
            <data:login>my_login</data:login>
            <data:password>my_password</data:password>
         </data:AuthorizationHeader>
      </oper:getOperationHistory>
   </soap:Body>
</soap:Envelope>

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

<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns7:getOperationHistoryResponse xmlns:ns2="http://russianpost.org/sms-info/data" xmlns:ns3="http://russianpost.org/operationhistory/data" xmlns:ns4="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns5="http://www.russianpost.org/custom-duty-info/data" xmlns:ns6="http://www.russianpost.org/RTM/DataExchangeESPP/Data" xmlns:ns7="http://russianpost.org/operationhistory">
         <ns3:OperationHistoryData>
            <ns3:historyRecord>
               <ns3:AddressParameters>
                  <ns3:DestinationAddress>
                     <ns3:Index>663300</ns3:Index>
                     <ns3:Description>Норильск Почтамт</ns3:Description>
                  </ns3:DestinationAddress>
                  <ns3:OperationAddress>
                     <ns3:Index>111555</ns3:Index>
                     <ns3:Description>Москва 555</ns3:Description>
                  </ns3:OperationAddress>
                  <ns3:MailDirect>
                     <ns3:Id>643</ns3:Id>
                     <ns3:Code2A>RU</ns3:Code2A>
                     <ns3:Code3A>RUS</ns3:Code3A>
                     <ns3:NameRU>Российская Федерация</ns3:NameRU>
                     <ns3:NameEN>Russian Federation</ns3:NameEN>
                  </ns3:MailDirect>
                  <ns3:CountryOper>
                     <ns3:Id>643</ns3:Id>
                     <ns3:Code2A>RU</ns3:Code2A>
                     <ns3:Code3A>RUS</ns3:Code3A>
                     <ns3:NameRU>Российская Федерация</ns3:NameRU>
                     <ns3:NameEN>Russian Federation</ns3:NameEN>
                  </ns3:CountryOper>
               </ns3:AddressParameters>
               <ns3:FinanceParameters>
                  <ns3:Payment>2500000</ns3:Payment>
                  <ns3:Value>2500000</ns3:Value>
                  <ns3:MassRate>152000</ns3:MassRate>
                  <ns3:InsrRate>25000</ns3:InsrRate>
                  <ns3:AirRate>0</ns3:AirRate>
                  <ns3:Rate>0</ns3:Rate>
               </ns3:FinanceParameters>
               <ns3:ItemParameters>
                  <ns3:Barcode>EA123456789RU</ns3:Barcode>
                  <ns3:ValidRuType>true</ns3:ValidRuType>
                  <ns3:ValidEnType>false</ns3:ValidEnType>
                  <ns3:PostMark>
                     <ns3:Id>0</ns3:Id>
                     <ns3:Name>Без отметки</ns3:Name>
                  <ns3:MailRank>
                     <ns3:Id>0</ns3:Id>
                     <ns3:Name>Без разряда</ns3:Name>
                  </ns3:MailRank>
                  <ns3:PostMark>
                     <ns3:Id>0</ns3:Id>
                     <ns3:Name>Без отметки</ns3:Name>
                  </ns3:PostMark>
                  <ns3:MailType>
                     <ns3:Id>7</ns3:Id>
                     <ns3:Name>Отправление EMS</ns3:Name>
                  </ns3:MailType>
                  <ns3:MailCtg>
                     <ns3:Id>4</ns3:Id>
                     <ns3:Name>С объявленной ценностью и наложенным платежом</ns3:Name>
                  </ns3:MailCtg>
                  <ns3:Mass>2281</ns3:Mass>
               </ns3:ItemParameters>
               <ns3:OperationParameters>
                  <ns3:OperType>
                     <ns3:Id>1</ns3:Id>
                     <ns3:Name>Прием</ns3:Name>
                  </ns3:OperType>
                  <ns3:OperAttr>
                     <ns3:Id>1</ns3:Id>
                     <ns3:Name>Единичный</ns3:Name>
                  </ns3:OperAttr>
                  <ns3:OperDate>2015-07-09T18:08:00.000+03:00</ns3:OperDate>
               </ns3:OperationParameters>
               <ns3:UserParameters>
                  <ns3:SendCtg>
                     <ns3:Id>1</ns3:Id>
                     <ns3:Name>Население</ns3:Name>
                  </ns3:SendCtg>
                  <ns3:Sndr>ИВАНОВ И Н</ns3:Sndr>
                  <ns3:Rcpn>ПЕТРОВ Н И</ns3:Rcpn>
               </ns3:UserParameters>
            </ns3:historyRecord>
             <ns3:historyRecord>
             …
             </ns3:historyRecord>
             …
         </ns3:OperationHistoryData>
      </ns7:getOperationHistoryResponse>
   </S:Body>
</S:Envelope>

3. Метод PostalOrderEventsForMail

Метод PostalOrderEventsForMail позволяет получить информацию об операциях с наложенным платежом, который связан с конкретным почтовым отправлением.

3.1. Запрос

3.2. Ответ

3.3. Возможные ошибки

3.4. Пример запроса и ответа

Пример запроса:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:oper="http://russianpost.org/operationhistory" xmlns:data="http://russianpost.org/operationhistory/data" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:data1="http://www.russianpost.org/RTM/DataExchangeESPP/Data">
   <soap:Header/>
   <soap:Body>
      <oper:PostalOrderEventsForMail>
         <data:AuthorizationHeader soapenv:mustUnderstand="1">
            <data:login>my_login</data:login>
            <data:password>my_password</data:password>
         </data:AuthorizationHeader>
         <data1:PostalOrderEventsForMailInput Barcode="14102192069353" Language="ENG"/>
      </oper:PostalOrderEventsForMail>
   </soap:Body>
</soap:Envelope>

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

<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns7:PostalOrderEventsForMailResponse xmlns:ns2="http://russianpost.org/sms-info/data" xmlns:ns3="http://russianpost.org/operationhistory/data" xmlns:ns4="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns5="http://www.russianpost.org/custom-duty-info/data" xmlns:ns6="http://www.russianpost.org/RTM/DataExchangeESPP/Data" xmlns:ns7="http://russianpost.org/operationhistory">
         <ns6:PostalOrderEventsForMaiOutput>
            <PostalOrderEvent Number="96598" EventDateTime="2015-12-11T15:04:37.000+03:00" EventType="1" EventName="Приём" IndexTo="141021" IndexEvent="298300" SumPaymentForward="234000" CountryEventCode="RU" CountryToCode="RU"/>
            <PostalOrderEvent Number="96598" EventDateTime="2015-12-12T16:49:13.000+03:00" EventType="3" EventName="Оплата" IndexTo="141021" IndexEvent="141021" SumPaymentForward="234000" CountryEventCode="RU" CountryToCode="RU"/>
         </ns6:PostalOrderEventsForMaiOutput>
      </ns7:PostalOrderEventsForMailResponse>
   </S:Body>
</S:Envelope>