You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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


Table of contents:

Headers

The following table describes the HTTP headers that you received in a S7 Agent API response:

#NameKey in headersDescription
1Version 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
3Executed operation nameSOAPActionExecuted operation
4Type of contentContent-TypeThe content type of the response. Always "text/xml"
5Conversation IDX-API-Conversation

The identificatior of transaction.

(warning) Pass it to our technical support by JIRA if you faced problems with responses

The following example shows headers of a typical SearchFlights operation of 0.35 version API on Test environment:

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

Successful results

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

<?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>
        <ns3:ItinReshopRS Version="">
            <ns3:Document>
                <ns3:Name>1.0</ns3:Name>
            </ns3:Document>
            <ns3:Success/>
            <ns3:Response>
				...
            </ns3:Response>
        </ns3:ItinReshopRS>
    </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):

<?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>
        <ns3:ItinReshopRS Version="">
            <ns3:Document>
                <ns3:Name>1.0</ns3:Name>
            </ns3:Document>
            <ns3:Errors>
                <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>
                <ns3:Error Type="MSG">System validation error. Please, check your request</ns3:Error>
            </ns3:Errors>
        </ns3:ItinReshopRS>
    </ns2:Body>
</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

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

Common questions



Question

Answer

1

How to access the product environment?

If you are newbie, just follow the steps, which provides the simplest way to quickly get an access to API

Or you already adopted your systems to our test environment? Notify our technical support by Kaiten for final testing under the supervision of our technologists and proceed to signing of the contract of EDS

2

How to access the test environment?

Follow steps to quickly get an access to API

3

Which endpoints should be used?

Explore the ways of submitting requests:




TestProduction
#VersionEndpointEndpoint
10.52WSDL

WSDL

2up torefund&deleteTST&schedule&split&postsalerefund&deleteTST&schedule
3up to

queue

queue

 

4

How does the standard ticketing scenario looks?

Simple operation flow: searchFlightsJourney (AirShoppingRQ) → book (OrderCreateRQ) → reprice (ItinReshopRQ) → demandTickets (AirDocIssueRQ)

Discover more scenarios from simplest flows to best practices

5

Is it possible to use social categories of passengers: pensioners, youth, sailors, students, etc.?

What types of passengers are available in the API?

No, only 3 types of passengers are available:

  • adult (ADT) —  passengers 12 years old and older

  • child (CHD) — passengers between 2 (inclusive) and 12 years old (exclusive)

    • 2-year-old passenger is a child

    • 12-year-old passenger is an adult

  • infant in a lap (INF) —  passengers under 2 years

6

How can I get information about flights commissions and manage agency fees?

For any financial questions you have to contact S7's sales department or your account manager via at vm@s7.ru

7

Is the Multi-City method implemented in API?

Yes, check searchFlights operation overview to find out. Samples will be available soon!

8

Is the refund method implemented in API?

No, the refunds are not implemented

9

Can I get an S7 route map?

There is no such request in API

10

Are all S7 fares branded?

Yes, all fares are split into 3 fare families, from the cheapest to the most equipped fare:

  • Economy Basic

  • Economy Standard

  • Economy Plus

  • Business Standard

  • Business Plus

11

Can I get a terminal text view of the current PNR data? Or just build a template from an XML response?

No, only XML display is available for input and output

12

Does the service support queues?

All requests to API are synchronous, queues are not used

13

I recieve "Unknown operation" in response, while requests executed in SoapUI

Check using of correct HTTP header of your requests:

  • X-API-Version — e.g. 0.52 or other

  • SOAPAction — e.g. "http://api.s7.ru/Reprice" or other

  • Content-Type: text/xml

Also you can find out how to handle with unsuccessful result and common access errors

14

When I try the link https://qa-gaia.s7.ru/agent-api/wsdl/0.52?wsdl

I get an error: "400 Bad Request. No required SSL certificate was sent."

You didn't use a right SSL certificate to download API's WSDL. Check you used certificate for the test environment (not for production):

Also you can find out how to handle with unsuccessful result and common access errors

15

I always recieve an error: "Can not perform operation without valid RequestorID" 

Probably, you used incorrect Agent credentials in Party tag. Contact to S7 API support with used credentials

Also you can find out how to handle with unsuccessful result and common access errors

  • No labels