Page History

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:

#	Name	Key in headers	Description
1	Version of API	X-API-Version	Executed version of API If you didn't pass Version of API in request you can find here an executed default version for current environment
2	Basic authorization string	Authorization	Used credentials in request
3	Executed operation name	SOAPAction	Executed operation
4	Type of content	Content-Type	The content type of the response. Always "text/xml"
53	Conversation ID	X-API-Conversation	The identificatior of transaction. 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 of 0.35 version API on Test environment:

Code Block

linenumbers	true

Content-Type: text/xml
SOAPAction: "http://api.s7.ru/SearchFlights"
X-API-Version: 0.35
Authorization: Basic oV5zbWlyCx92X3M3dfS6dGFpbDpxLTE2OXFs
X-API-Conversation: ceec2d2d-8081-4d48-9df9-a712f6236220

Table of contents:

Table of Contents

Successful results

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

Code Block

language	xml
linenumbers	true

<?xml version="1.0" encoding="UTFutf-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="vI6FGb59SpQWElktM09l44tkt" session="eFvNjn2PKFDJVAs0RLbhhZITz" solutionCount="12" solutionSet="FoS0VzPw4UkLQExJm46znbA">
    <mso>
        <solution id="pFo605MVUMf0VZaw2xYIZZVO0" saleTotal="RUB24050">
            <ext link="https://travelwith.s7.ru/mseDeeplink.action?LAN=RU&partner=16f3d011b0&TA=2&TC=1&TI=1&SUP=SITA&CP=F&CUR=RUB&TF=24050&FLC=1&FSC1=1&FN1=179&AC1=S7&DD1=2017-12-06&DT1=11:15:00&AD1=2017-12-06&AT1=19:15:00&DA1=DME&AA1=OVB&SC1=Q">
                 <ns3:ItinReshopRS Version<SalePriceWithoutYQ amount="8600" currency="RUB"/>
              <ns3:Document>  <SalePriceWithoutYQAndYR amount="7100" currency="RUB"/>
                <ns3:Name>1.0</ns3:Name> <SalePriceWithoutYR amount="7100" currency="RUB"/>
            </ns3:Document>ext>
            <pricing paxCount="2">
                <ext>
            <ns3:Success        <SalePriceWithoutYQ amount="8600" currency="RUB"/>
             <ns3:Response>
				...
       <SalePriceWithoutYQAndYR amount="7100" currency="RUB"/>
                    <SalePriceWithoutYR amount="7100" currency="RUB"/>
                   </ns3:Response> <pax adults="2"/>
                </ns3:ItinReshopRS>ext>
            </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

language	xml
linenumbers	true

<?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>pricing>
            <pricing paxCount="1">
                <ext>
                    <SalePriceWithoutYQ amount="6850" currency="RUB"/>
                    <SalePriceWithoutYQAndYR amount="5350" currency="RUB"/>
                    <SalePriceWithoutYR amount="5350" currency="RUB"/>
                    <pax children="1"/>
                </ext>
            </pricing>
            <pricing paxCount="1">
                <ext>
                    <SalePriceWithoutYQ amount="0" currency="RUB"/>
        <ns3:ItinReshopRS Version=""            <SalePriceWithoutYQAndYR amount="0" currency="RUB"/>
            <ns3:Document>        <SalePriceWithoutYR amount="0" currency="RUB"/>
                <ns3:Name>1.0</ns3:Name></ext>
            </ns3:Document>pricing>
            <ns3:Errors><slice>
                <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>
<segment arrival="2017-12-06T19:15+07:00" cabin="COACH" carrier="S7" departure="2017-12-06T11:15+03:00" destination="OVB" duration="240" flight="S7179" origin="DME">
                    <ext operationalDisclosure="OPERATED BY GLOBUS LLC"/>
                    <ns3:Error<operationalDisclosure Typecarrier="MSG">System validation error. Please, check your request</ns3:Error>GH"/>
                </segment>
            </ns3:Errors>slice>
        </solution>
		<solution>
			...
		</ns3:ItinReshopRS>solution>
    </ns2:Body>mso>
</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.35 version):

Code Block

language	xml
linenumbers	true

<?xml version='1.0' encoding='UTF-8'?>
<result id="C08FNvhbikL0RLcXhWhWcE">
    <error type="input">
        <message>version: Unrecognized api version.</message>
    </error>
</result>

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

For more information about possible errors, check Errors pages divided by operation in Reference sectionreference.

Common questions

Excerpt Include

	Common FAQ \| S7 MSE API
	FAQ Common \| FAQS7 MSE API
nopanel	true

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Headers

Successful results

Unsuccessful results

Unsuccessful results

Common questions