Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This is a high-level overview of a typical response from S7 Agent API.

Headers

The following table describes the HTTP headers that you received in a S7

Agent

MSE API response:

#


3Executed operation nameSOAPActionExecuted operation4

Name

Key in headers

Description

1
Version of APIX-API-Version

Executed version of API

(warning) If you didn't pass Version of API in request you can find here an executed default version for current environment

2Basic authorization stringAuthorizationUsed credentials in request

Date and time

date

Date and time of request execution in GMT

2

Type of content

Content-Type

The content type of the response. Always "

text

application/xml"

5
3

Conversation ID

X

x-

API-Conversation

conversation

The identificatior of transaction.

(warning)

(warning) Pass it to our technical support

by JIRA if

by email at api.support@s7.ru if you faced problems with responses

The following example shows headers of a typical

SearchFlights operation

response of 0.

35

52 version API on Test environment:

Code Block
linenumberstrue
Date: Thu, 20 Jul 2023 13:18:39 GMT
Content-Type: 
text
application/xml
SOAPAction
Transfer-Encoding: 
"http://api.s7.ru/SearchFlights" X-API-Version: 0.35 Authorization: Basic oV5zbWlyCx92X3M3dfS6dGFpbDpxLTE2OXFs X-API-Conversation: ceec2d2d-8081-4d48-9df9-a712f6236220
chunked
Connection: keep-alive
X-Flow: 1ed1686b-cb2c-4f81-a5bd-fda6b5902042
X-Conversation: 58478262-ef5b-4e89-8c90-1d607917d413
vary: accept-encoding
Content-Encoding: gzip
Strict-Transport-Security: max-age=15724800; includeSubDomains


Table of contents:

Table of Contents

Successful results

Successful responses typically includes the following structurefollowing structure (actual for 0.35 52 version):

Expand


Code Block
languagexml
linenumberstrue
<?xml version="1.0" encoding="UTF-8" standalone="yes"?
> <ns2:Envelope xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://www.iata.org/IATA/EDIST"> <ns2:Body>
>
<result id="bd858aa6-e6e8-42b2-bd68-6b3416fc430a" session="0ff7767d-7505-48b5-9929-8992b627f898" solutionCount="4" solutionSet="ed0d5377-0037-46eb-89f0-abbce67b9896">
    <solutions>
        <itinerary>
            <solution id="0b124e58-d8cb-44f7-96e4-fdd406bf4bf7" saleTotal="RUB9673" preferredFareFamily="CHEAPEST FARE">
                <ext link="https://ibe.s7.ru/mseDeeplink.action?LAN=RU&partner={{your_partner_id}}&TA=1&TC=1&TI=0&SUP=XO&CP=F&CUR=RUB&TF=9673&FLC=1&FSC1=1&FN1=1010&AC1=S7&DD1=2023-12-15&DT1=12:15:00&AD1=2023-12-15&AT1=13:55:00&DA1=LED&AA1=DME&SC1=N&utm_campaign={{your_utm_campaign}}&utm_campaign={{your_utm_source}}&utm_medium=metasearch&FF1=B">
                    <SalePriceWithoutYQ amount="5062" currency="RUB"/>
                    <SalePriceWithoutYQAndYR amount="5062" currency="RUB"/>
                    <SalePriceWithoutYR amount="5062" currency="RUB"/>
                </ext>
                <pricing paxCount="1">
                    <ext>
                        <SalePriceWithoutYQ amount="5062" currency="RUB"/>
                        <SalePriceWithoutYQAndYR amount="5062" currency="RUB"/>
                        <SalePriceWithoutYR amount="5062" currency="RUB"/>
                        <pax adults="1"/>
                    </ext>
                </pricing>
        
<ns3:ItinReshopRS Version
        <pricing paxCount="1">
               
<ns3:Document>
     <ext>
                     
<ns3:Name>1.0</ns3:Name>
   <SalePriceWithoutYQ amount="4611" currency="RUB"/>
                        
</ns3:Document>
<SalePriceWithoutYQAndYR amount="4611" currency="RUB"/>
              
<ns3:Success/>
          <SalePriceWithoutYR amount="4611" currency="RUB"/>
                        
<ns3:Response> ...
<pax children="1"/>
                    </ext>
                </
ns3:Response>
pricing>
         
</ns3:ItinReshopRS>
   </solution>
            <slice>
                <segment arrival="2023-12-15T13:55+03:00" carrier="S7" departure="2023-12-15T12:15+03:00" destination="DME" duration="100" flight="S71010" origin="LED"/>
            </
ns2:Body> </ns2:Envelope>

For more information about received data in successful response, check RQ pages divided by operation in Reference section.

Unsuccessful results

Unsuccessful responses typically includes the following structure (actual for 0.35 version):

Code Block
languagexml
linenumberstrue
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:Envelope xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://www.iata.org/IATA/EDIST"> <ns2:Body>
slice>
        </itinerary>
        <itinerary> >
        <itinerary> >
        <itinerary> >
        <itinerary>
            <solution id="0f4e91c7-897a-425e-bf40-dd14a3f10943" saleTotal="RUB9673" preferredFareFamily="CHEAPEST FARE">
                <ext link="https://ibe.s7.ru/mseDeeplink.action?LAN=RU&partner={{your_partner_id}}&TA=1&TC=1&TI=0&SUP=XO&CP=F&CUR=RUB&TF=9673&FLC=1&FSC1=1&FN1=1016&AC1=S7&DD1=2023-12-15&DT1=20:35:00&AD1=2023-12-15&AT1=22:15:00&DA1=LED&AA1=DME&SC1=N&utm_campaign={{your_utm_campaign}}&utm_campaign={{your_utm_source}}&utm_medium=metasearch&FF1=B">
                    <SalePriceWithoutYQ amount="5062" currency="RUB"/>
                    <SalePriceWithoutYQAndYR amount="5062" currency="RUB"/>
                    <SalePriceWithoutYR amount="5062" currency="RUB"/>
                </ext>
                <pricing paxCount="1">
                    <ext>
                        <SalePriceWithoutYQ amount="5062" currency="RUB"/>
                        <SalePriceWithoutYQAndYR amount="5062" currency="RUB"/>
                        
<ns3:ItinReshopRS Version
<SalePriceWithoutYR amount="5062" currency="RUB"/>
            
<ns3:Document>
            <pax adults="1"/>
                
<ns3:Name>1.0</ns3:Name>
    </ext>
            
</ns3:Document>
    </pricing>
                <pricing paxCount="1">
            
<ns3:Errors>
        <ext>
                    
<ns3:Error Type="101" Status="Incomplete" Owner="S7 NDC API">Adult passenger Traveler-ADT-1 must be over 12 years of age at the time of the first departure</ns3:Error>
    <SalePriceWithoutYQ amount="4611" currency="RUB"/>
                        <SalePriceWithoutYQAndYR amount="4611" currency="RUB"/>
                        <SalePriceWithoutYR amount="4611" currency="RUB"/>
                        <pax children="1"/>
                    </ext>
                </pricing>
            </solution>
            <slice>
                
<ns3:Error Type="MSG">System validation error. Please, check your request</ns3:Error>
<segment arrival="2023-12-15T22:15+03:00" carrier="S7" departure="2023-12-15T20:35+03:00" destination="DME" duration="100" flight="S71016" origin="LED"/>
            </
ns3:Errors>
slice>
        </
ns3:ItinReshopRS>
itinerary>
    </
ns2:Body>
solutions>
</
ns2:Envelope>

For an unsuccessful responses, API returns Errors sections in the body of the HTTP message:

  • Error with technical info — Type <> "MSG", can be multiple
  • Error with message for user — Type = "MSG", always single for a response

A technical error typically includes the following basic elements:

  • Type — Error code
  • Status — Status of operation
  • Owner — Application which execution resulted with an error (S7 Agent API or other external system)
  • Value — Error description
result>


For more information about received data in successful response, check RQ pages divided by operation in reference.

Unsuccessful results

Unsuccessful responses typically includes the following structure (actual for 0.52 version):

Expand


Code Block
languagexml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result solutionCount="0">
    <error type="input">
        <message>date.is.more.than.359.days.in.future</message>
    </error>
</result>


For an unsuccessful responses, API returns Errors with technical info in the message tag.

Сheck Errors page for more information about possible errorsFor more information about possible errors, check Errors pages divided by operation in Reference section.

Common questions

Excerpt Include
Common FAQ | S7 MSE API
FAQ Common | FAQnopaneltrue| S7 MSE API