TravelPolicy Data Type

The travel policy for a client/division/group. This should define when the specific rules should be applied as well as common terminology that should be applied on rules. If you see references to LLF or Lowest Logical Fare, what that means is that property is restricting the possibilities for searching for the lowest logical fare. Created by nick on 1/27/15.

Properties
name data type constraints description
client Client required The client that this policy belongs to.
name string   The name of this travel policy, to differentiate it from others.
modified number   The last modified date of this travel policy.
ruleClasses array of TravelPolicyRuleClass   The classes that consist of this policy. For an itinerary to pass, it must pass all rule classes.
domesticCountries array of Country   A list of countries that are considered domestic by the client.
stopsLLF ClientTravelPolicyStops   The number of allowed connections (or stops) when checking for the lowest logical fare.
contractCarriersOnlyLLF boolean   Whether or not to check for the lowest logical fare in non-preferred carriers.
timeWindowLLF number   The allowed difference in hours when checking for the lowest logical fare.
advancedPurchaseLLF number   The allowed days of how far into the future to check for the lowest logical fare.
defaultAction TravelPolicyAction   The default action that should be taken for trips that this policy are applied to.
refundabilityLLF TravelPolicyRefundableOption   The refundability requirement of the flights when checking for lowest logical fare. For instance, whether the policy requires that all bookings are refundable.
defaultReviewer TravelPolicyReviewer   The default user that will take responsibility for the action if the trip fails policy.
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

{
  "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" : "..."
    } ]
  },
  "name" : "...",
  "modified" : 12345,
  "ruleClasses" : [ {
    "message" : "...",
    "action" : {
      "name" : "...",
      "description" : "...",
      "possibleReviewers" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "rules" : [ {
      "type" : { },
      "operator" : { },
      "value" : "...",
      "unit" : { },
      "airlines" : [ { }, { } ],
      "carClasses" : [ { }, { } ],
      "carTypes" : [ { }, { } ],
      "hotelProperties" : [ { }, { } ],
      "classOfServiceLevels" : [ { }, { } ],
      "countries" : [ { }, { } ],
      "cities" : [ { }, { } ],
      "hotelVendors" : [ { }, { } ],
      "carVendors" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "type" : { },
      "operator" : { },
      "value" : "...",
      "unit" : { },
      "airlines" : [ { }, { } ],
      "carClasses" : [ { }, { } ],
      "carTypes" : [ { }, { } ],
      "hotelProperties" : [ { }, { } ],
      "classOfServiceLevels" : [ { }, { } ],
      "countries" : [ { }, { } ],
      "cities" : [ { }, { } ],
      "hotelVendors" : [ { }, { } ],
      "carVendors" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "reviewer" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "addMessage" : true,
    "queue" : {
      "number" : 12345,
      "category" : "...",
      "pcc" : "...",
      "description" : "...",
      "gds" : { },
      "sorts" : [ { }, { } ],
      "airtineraryQueue" : true,
      "importQueue" : true,
      "availableTimeRange" : "...",
      "maximumPops" : 12345,
      "overrideSortCategory" : "...",
      "failureQueue" : 12345,
      "failureCategory" : "...",
      "agentQueue" : true,
      "agent" : { },
      "failurePcc" : "...",
      "agentExclusions" : [ { }, { } ],
      "ticketingQueue" : true,
      "validationQueue" : true,
      "type" : { },
      "hplQueue" : true,
      "logEnabled" : true,
      "airselectQueue" : true,
      "defaultQueue" : { },
      "autoScheduleChange" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "override" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "message" : "...",
    "action" : {
      "name" : "...",
      "description" : "...",
      "possibleReviewers" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "rules" : [ {
      "type" : { },
      "operator" : { },
      "value" : "...",
      "unit" : { },
      "airlines" : [ { }, { } ],
      "carClasses" : [ { }, { } ],
      "carTypes" : [ { }, { } ],
      "hotelProperties" : [ { }, { } ],
      "classOfServiceLevels" : [ { }, { } ],
      "countries" : [ { }, { } ],
      "cities" : [ { }, { } ],
      "hotelVendors" : [ { }, { } ],
      "carVendors" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "type" : { },
      "operator" : { },
      "value" : "...",
      "unit" : { },
      "airlines" : [ { }, { } ],
      "carClasses" : [ { }, { } ],
      "carTypes" : [ { }, { } ],
      "hotelProperties" : [ { }, { } ],
      "classOfServiceLevels" : [ { }, { } ],
      "countries" : [ { }, { } ],
      "cities" : [ { }, { } ],
      "hotelVendors" : [ { }, { } ],
      "carVendors" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "reviewer" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "addMessage" : true,
    "queue" : {
      "number" : 12345,
      "category" : "...",
      "pcc" : "...",
      "description" : "...",
      "gds" : { },
      "sorts" : [ { }, { } ],
      "airtineraryQueue" : true,
      "importQueue" : true,
      "availableTimeRange" : "...",
      "maximumPops" : 12345,
      "overrideSortCategory" : "...",
      "failureQueue" : 12345,
      "failureCategory" : "...",
      "agentQueue" : true,
      "agent" : { },
      "failurePcc" : "...",
      "agentExclusions" : [ { }, { } ],
      "ticketingQueue" : true,
      "validationQueue" : true,
      "type" : { },
      "hplQueue" : true,
      "logEnabled" : true,
      "airselectQueue" : true,
      "defaultQueue" : { },
      "autoScheduleChange" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "override" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "domesticCountries" : [ {
    "name" : "...",
    "code" : "...",
    "codeAlt" : "...",
    "phoneCode" : 12345,
    "position" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "name" : "...",
    "code" : "...",
    "codeAlt" : "...",
    "phoneCode" : 12345,
    "position" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "stopsLLF" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "contractCarriersOnlyLLF" : true,
  "timeWindowLLF" : 12345,
  "advancedPurchaseLLF" : 12345,
  "defaultAction" : {
    "name" : "...",
    "description" : "...",
    "possibleReviewers" : [ {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "refundabilityLLF" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "defaultReviewer" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}