POST api/GatewaySearch/StartFlightAvailabilitySearch

Request Information

URI Parameters

None.

Body Parameters

FPApiFlightSearchRequest
NameDescriptionTypeAdditional information
FlightSearchRequest

FlightSearchRequest

None.

ResponseVersion

SearchVersion

None.

ClientMachine

string

None.

AccessToken

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FlightSearchRequest": {
    "Adults": 64,
    "Child": 64,
    "Seniors": 64,
    "InfantInLap": 64,
    "InfantOnSeat": 64,
    "Youths": 64,
    "Kid": 64,
    "TypeOfTrip": 0,
    "ClassOfService": 0,
    "SegmentDetails": [
      {
        "Origin": "sample string 1",
        "Destination": "sample string 2",
        "DepartureDate": "2018-07-17T05:43:56.4774567-04:00",
        "DepartureTime": "sample string 4",
        "SearchWithTimePreference": true
      },
      {
        "Origin": "sample string 1",
        "Destination": "sample string 2",
        "DepartureDate": "2018-07-17T05:43:56.4774567-04:00",
        "DepartureTime": "sample string 4",
        "SearchWithTimePreference": true
      }
    ],
    "IsInsuranceRequired": true,
    "IsTravelAssistRequired": true,
    "BPC": true,
    "BPCType": 64,
    "ClientIP": "sample string 12",
    "AffiliateCode": "sample string 13",
    "SearchAlternateDates": true,
    "AirLinePreferences": [
      "sample string 1",
      "sample string 2"
    ],
    "CAID": 15,
    "Browser": "sample string 16",
    "OS": "sample string 17",
    "Keyword": "sample string 18",
    "ClientDetail": {
      "ClientIp": "sample string 1",
      "Keyword": "sample string 2",
      "Browser": "sample string 3",
      "OS": "sample string 4",
      "CampaignId": "sample string 5",
      "AdGroupId": "sample string 6",
      "Gclid": "sample string 7",
      "CampaignName": "sample string 8",
      "CampaignTerm": "sample string 9",
      "CampaignSource": "sample string 10",
      "CampaignMedium": "sample string 11",
      "FpAffiliate": "sample string 12",
      "SubAffiliate": "sample string 13",
      "UserId": 14,
      "InternalCampaignSource": "sample string 15",
      "InternalCampaignName": "sample string 16",
      "HitGuid": "sample string 17",
      "PersonGuid": "sample string 18",
      "Uid": "sample string 19",
      "KeywordId": "sample string 20"
    },
    "UserProfileToken": "sample string 27",
    "UserAuthType": 0
  },
  "ResponseVersion": 0,
  "ClientMachine": "sample string 1",
  "AccessToken": "sample string 2"
}

text/html

Sample:
{"FlightSearchRequest":{"Adults":64,"Child":64,"Seniors":64,"InfantInLap":64,"InfantOnSeat":64,"Youths":64,"Kid":64,"TypeOfTrip":0,"ClassOfService":0,"SegmentDetails":[{"Origin":"sample string 1","Destination":"sample string 2","DepartureDate":"2018-07-17T05:43:56.4774567-04:00","DepartureTime":"sample string 4","SearchWithTimePreference":true},{"Origin":"sample string 1","Destination":"sample string 2","DepartureDate":"2018-07-17T05:43:56.4774567-04:00","DepartureTime":"sample string 4","SearchWithTimePreference":true}],"IsInsuranceRequired":true,"IsTravelAssistRequired":true,"BPC":true,"BPCType":64,"ClientIP":"sample string 12","AffiliateCode":"sample string 13","SearchAlternateDates":true,"AirLinePreferences":["sample string 1","sample string 2"],"CAID":15,"Browser":"sample string 16","OS":"sample string 17","Keyword":"sample string 18","ClientDetail":{"ClientIp":"sample string 1","Keyword":"sample string 2","Browser":"sample string 3","OS":"sample string 4","CampaignId":"sample string 5","AdGroupId":"sample string 6","Gclid":"sample string 7","CampaignName":"sample string 8","CampaignTerm":"sample string 9","CampaignSource":"sample string 10","CampaignMedium":"sample string 11","FpAffiliate":"sample string 12","SubAffiliate":"sample string 13","UserId":14,"InternalCampaignSource":"sample string 15","InternalCampaignName":"sample string 16","HitGuid":"sample string 17","PersonGuid":"sample string 18","Uid":"sample string 19","KeywordId":"sample string 20"},"UserProfileToken":"sample string 27","UserAuthType":0},"ResponseVersion":0,"ClientMachine":"sample string 1","AccessToken":"sample string 2"}

application/xml, text/xml

Sample:
<FPApiFlightSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PowerXML.Models">
  <AccessToken>sample string 2</AccessToken>
  <ClientMachine>sample string 1</ClientMachine>
  <FlightSearchRequest xmlns:d2p1="http://schemas.datacontract.org/2004/07/FPWebBox.BusinessObjects">
    <d2p1:Adults>64</d2p1:Adults>
    <d2p1:AffiliateCode>sample string 13</d2p1:AffiliateCode>
    <d2p1:AirLinePreferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:AirLinePreferences>
    <d2p1:BPC>true</d2p1:BPC>
    <d2p1:BPCType>64</d2p1:BPCType>
    <d2p1:Browser>sample string 16</d2p1:Browser>
    <d2p1:CAID>15</d2p1:CAID>
    <d2p1:Child>64</d2p1:Child>
    <d2p1:ClassOfService>ALL</d2p1:ClassOfService>
    <d2p1:ClientDetail>
      <d2p1:ClientIp>sample string 1</d2p1:ClientIp>
      <d2p1:Keyword>sample string 2</d2p1:Keyword>
      <d2p1:Browser>sample string 3</d2p1:Browser>
      <d2p1:OS>sample string 4</d2p1:OS>
      <d2p1:CampaignId>sample string 5</d2p1:CampaignId>
      <d2p1:AdGroupId>sample string 6</d2p1:AdGroupId>
      <d2p1:Gclid>sample string 7</d2p1:Gclid>
      <d2p1:CampaignName>sample string 8</d2p1:CampaignName>
      <d2p1:CampaignTerm>sample string 9</d2p1:CampaignTerm>
      <d2p1:CampaignSource>sample string 10</d2p1:CampaignSource>
      <d2p1:CampaignMedium>sample string 11</d2p1:CampaignMedium>
      <d2p1:FpAffiliate>sample string 12</d2p1:FpAffiliate>
      <d2p1:SubAffiliate>sample string 13</d2p1:SubAffiliate>
      <d2p1:UserId>14</d2p1:UserId>
      <d2p1:InternalCampaignSource>sample string 15</d2p1:InternalCampaignSource>
      <d2p1:InternalCampaignName>sample string 16</d2p1:InternalCampaignName>
      <d2p1:HitGuid>sample string 17</d2p1:HitGuid>
      <d2p1:PersonGuid>sample string 18</d2p1:PersonGuid>
      <d2p1:Uid>sample string 19</d2p1:Uid>
      <d2p1:KeywordId>sample string 20</d2p1:KeywordId>
    </d2p1:ClientDetail>
    <d2p1:ClientIP>sample string 12</d2p1:ClientIP>
    <d2p1:InfantInLap>64</d2p1:InfantInLap>
    <d2p1:InfantOnSeat>64</d2p1:InfantOnSeat>
    <d2p1:IsInsuranceRequired>true</d2p1:IsInsuranceRequired>
    <d2p1:IsTravelAssistRequired>true</d2p1:IsTravelAssistRequired>
    <d2p1:Keyword>sample string 18</d2p1:Keyword>
    <d2p1:Kid>64</d2p1:Kid>
    <d2p1:OS>sample string 17</d2p1:OS>
    <d2p1:SearchAlternateDates>true</d2p1:SearchAlternateDates>
    <d2p1:SegmentDetails>
      <d2p1:FlightSegmentDetails>
        <d2p1:DepartureDate>2018-07-17T05:43:56.4774567-04:00</d2p1:DepartureDate>
        <d2p1:DepartureTime>sample string 4</d2p1:DepartureTime>
        <d2p1:Destination>sample string 2</d2p1:Destination>
        <d2p1:Origin>sample string 1</d2p1:Origin>
        <d2p1:SearchWithTimePreference>true</d2p1:SearchWithTimePreference>
      </d2p1:FlightSegmentDetails>
      <d2p1:FlightSegmentDetails>
        <d2p1:DepartureDate>2018-07-17T05:43:56.4774567-04:00</d2p1:DepartureDate>
        <d2p1:DepartureTime>sample string 4</d2p1:DepartureTime>
        <d2p1:Destination>sample string 2</d2p1:Destination>
        <d2p1:Origin>sample string 1</d2p1:Origin>
        <d2p1:SearchWithTimePreference>true</d2p1:SearchWithTimePreference>
      </d2p1:FlightSegmentDetails>
    </d2p1:SegmentDetails>
    <d2p1:Seniors>64</d2p1:Seniors>
    <d2p1:TypeOfTrip>ONEWAYTRIP</d2p1:TypeOfTrip>
    <d2p1:UserAuthType>None</d2p1:UserAuthType>
    <d2p1:UserProfileToken>sample string 27</d2p1:UserProfileToken>
    <d2p1:Youths>64</d2p1:Youths>
  </FlightSearchRequest>
  <ResponseVersion>NONE</ResponseVersion>
</FPApiFlightSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FPStartFlightSearchResponse
NameDescriptionTypeAdditional information
ErrorReport

FPErrorReport

None.

CntKey

string

None.

ServerName

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorReport": {
    "ErrorCode": "sample string 1",
    "ErrorDescription": "sample string 2"
  },
  "CntKey": "sample string 1",
  "ServerName": "sample string 2"
}

text/html

Sample:
{"ErrorReport":{"ErrorCode":"sample string 1","ErrorDescription":"sample string 2"},"CntKey":"sample string 1","ServerName":"sample string 2"}

application/xml, text/xml

Sample:
<FPStartFlightSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FareportalResponse">
  <CntKey>sample string 1</CntKey>
  <ErrorReport>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorDescription>sample string 2</ErrorDescription>
  </ErrorReport>
  <ServerName>sample string 2</ServerName>
</FPStartFlightSearchResponse>