Accessing AWD Data through the API

Size: px

Start display at page:

Download "Accessing AWD Data through the API"

Kimberly Gilbert
5 years ago
Views:

1 Accessing AWD Data thrugh the API API URL: Prductin: Frmats Supprted: jsn Required Headers: apikey=[prvided api key] Request Endpints & Parameters: Sample URL urceid=12345&maxfares=25&srtfield=price Tp Fares: retrieve the tp fares (lwest price) acrss all arrival/departure cities URL: /fares/tp Parameters: ame Type Descriptin Required? Default maxfares srtdirectin srtfield surceid number f ttal fares t retrieve, 1-n pssible values: 'ascending', 'descending' pssible values: 'price', 'arrivalcity', 'departurecity' surce ID fr the partner API request 25 'ascending' 'price' Departure/Arrival Fares: retrieve fares t r frm specific arrival r departure city r cities using airprt cdes URL: /fares/{directio}/{code1[,code2[,code3...]]} Parameters: ame Type Descriptin Required? Default DIRECTIO path CODES maxfares path srtdirectin srtfield path parameter fr city fare directin; pssible values 'frm', 't' path parameter fr airprt cde(s), example 'BOS,LGA,JFK' number f ttal fares t retrieve, 1-n pssible values: 'ascending', 'descending' pssible values: 'price', 'arrivalcity', 'departurecity' 25 'ascending' 'price'

2 surceid surce ID fr the partner API request Departure/Arrival Fares: retrieve fares t r frm specific arrival r departure city r cities using airprt cdes URL(s): 1. /fares/frm/{code1}/t/{code2} 2. /fares/byrute/{routepair1[,routepair2[,routepai R3...]]} Parameters: CODE1 CODE2 ame Type Descriptin Required? Default path path ROUTEPAIRS path maxfares srtdirectin srtfield surceid path parameter fr rute departure airprt cde path parameter fr rute destinatin airprt cde path parameter fr rute pairs - each rute pair is a 6-letter cmbinatin f airprt cdes. Example 'BOSSFO,BOSLAX' number f ttal fares t retrieve, 1-n pssible values: 'ascending', 'descending' pssible values: 'price', 'arrivalcity', 'departurecity' surce ID fr the partner API request (fr URL 1) (fr URL 1) (fr URL 2) 25 'ascending' 'price' Respnse XML: fareurl: URL that links t the crrespnding fare details page n Airfarewatchdg Includes partner specific surce cde fr tracking Example: departureairprtcde: Unique 3 letter cde fr departure airprt Example: BOS departureairprtdisplay: City, State/Cuntry (Airprt Cde) fr departure airprt Example: Bstn, MA (BOS) departurecitydisplay:

3 City, State/Cuntry fr departure city Example: Bstn, MA arrivalairprtcde: Unique 3 letter cde fr arrival airprt Example: CDG arrivalairprtdisplay: City, State/Cuntry (Airprt Cde) fr arrival airprt Example: Paris, France, (CDG) arrivalcitydisplay: City, State/Cuntry fr arrival city Example: Paris, France price: Lwest rund-trip price (USD) fund fr a given rute including taxes, but excluding add-n fees such as luggage fees flighttype: Rundtrip r neway Shuld always be rundtrip faretype: Standard r weekend firstdayfarrival: First date f travel that the fare is available Example: ) lastdayfarrival: Last date f travel that the fare is available Example: purchasebydate: If the fare is available with a specific expiratin date, this shws that expiratin date Example: status: Determines if the fare is currently available r nt Active r inactive Shuld always be active new: Determines if the fare is new tday r nt True r false nnstp: Determines if the fare is fr a flight that is nn-stp r nt True r false airlines: Determines airline r airlines that are ffering the fare at the current price flightsearchtype: Rundtrip r neway Shuld always be rundtrip weekend: Determines if the fare is specifically fr weekend travel r nt

4 True r false unadvertised: Determines if the fare is an unadvertised special r part f a bradly marketed fare sale True r false dmestic: Determines if the fare is fr dmestic travel r nt True r false minimumstay: If a fare has a minimum stay assciated with the deal, this will shw the number f minimum stay days Example: 2 maxiumumstay: If a fare has a maximum stay assciated with the deal, this will shw the number f maximum stay days Example: 30 dayofweek: If a fare is nly available fr specific days f travel, this will shw the days f the week Example: Mn, Tue, Wed advancedpurchase: If a fare requires an advanced purchase f a specific number f days, this will shw the number f days in advance the fare must be purchased Example: 21 therstayrequirements: If a fare requires additinal stay requirements, this will explain thse rules Example: Saturday night stay required cmments: Open field ntes frm ur expert fare analyst based n their research an analysis Varies in length depending n specific fare details incentives: Mre pen field ntes frm ur expert fare analysts based n their research an analysis Varies in length depending n specific fare details Seats: Bilerplate language fr all fares Cpy: Seats are nt available n all flights r all dates f travel. u may need t have flexible travel dates t find this fare. Fares fr travel n hlidays may be higher. Integratin Examples

Three new ways to fly Agency how to guide

Three new ways to fly Agency how to guide V1 13 March 2018 Three new ways t fly Agency hw t guide Recgnising that ne size desn t fit all, frm spring 2018 Virgin Atlantic will intrduce three new ways t fly ecnmy Ecnmy Light, Ecnmy Classic r Ecnmy