ClientAirAvailabilitySetting Data Type

Client air availability settings are various settings per the account that determine the formats retrieved for air availability searches. Created by nick on 3/23/17.

Properties
name data type constraints description
usdOnly boolean required boolean USD only ensures that all values are automatically converted to USD.
sharedInterlineOnly boolean required boolean Interline only ensures that only flights with connections between the same airline are returned.
sortType number required int The sort type defines how the flights are organized in the response.
client Client   The account that uses these settings.
requestUrlFormat string   A URL format that should be applied to every option as a way for travelers to select an option.
stateOrProvince Region   The region that employees of the client are employees of. This is for use with government owned accounts.
negotiatedAirlines array of AirVendor   A set of airlines that this account has negotiated fares with. These are the only airlines that will accept government fares. If this is empty then AirAvailability will allow all airlines.
showBasicEconomyFares boolean required boolean Whether or not to display basic economy fares. Basic economy fares are fares that don't get assigned / reserved seats until check in. They get a high rate of losing their seats and having to take a later flight. They are also non-refundable. Yay!
sortDeviation number   The amount of tolerated deviance in pricing when sorting in specific sort modes.
allowAlternateAirports boolean required boolean Whether or not we should return alternate airports, if alternate airports are available in the city.
Properties inherited from BaseHibernateEntity
id number   The unique internal ID of the object.
version number   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from BaseEntity
violations array of SimpleViolation   A list of constraint violations, if any, that this object has.

Example

{
  "usdOnly" : true,
  "sharedInterlineOnly" : true,
  "sortType" : 12345,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "requestUrlFormat" : "...",
  "stateOrProvince" : {
    "name" : "...",
    "code" : "...",
    "country" : {
      "name" : "...",
      "code" : "...",
      "codeAlt" : "...",
      "phoneCode" : 12345,
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "position" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "negotiatedAirlines" : [ {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "showBasicEconomyFares" : true,
  "sortDeviation" : 12345.0,
  "allowAlternateAirports" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}