GroupTraveler Data Type

An object that defines the group traveler travelling.

Version
1.0
Properties
name data type constraints description
firstName string required The first name of the traveler.
lastName string required The last name of the traveler.
middleName string   The middle name of the traveler.
dateOfBirth string required The day the traveler was born on.
gender string required The gender of the traveler.
knownTravelerNumber string   The number TSA uses to identify the traveler.
email string   The traveler's email.
phone string   The traveler's phone number.
weight number   The weight of the traveler.
client Client required Identifer for orphan traveler, thats yet to be setup in group
travelGroups array of TravelGroup   The travelGroups that this traveler belongs to.
loyaltyPrograms array of GroupTravelerLoyaltyProgram  
passports array of GroupTravelerPassport  
type GroupTravelerType   The type of traveler this is. Probably indicative of leadership level or responsibilities.
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

{
  "firstName" : "...",
  "lastName" : "...",
  "middleName" : "...",
  "dateOfBirth" : "...",
  "gender" : "...",
  "knownTravelerNumber" : "...",
  "email" : "...",
  "phone" : "...",
  "weight" : 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" : "..."
    } ]
  },
  "travelGroups" : [ {
    "groupName" : "...",
    "client" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "groupName" : "...",
    "client" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "loyaltyPrograms" : [ {
    "id" : 12345,
    "airVendor" : {
      "airlineNumber" : 12345,
      "checkinLink" : "...",
      "baggageLink" : "...",
      "alliance" : { },
      "lowCostCarrier" : true,
      "longCode" : "...",
      "manualTicketingOnly" : true,
      "airTicketsUseOrigIssueDate" : true,
      "mcoTicketsUseOrigIssueDate" : true,
      "minDomesticValue" : 12345,
      "minIntlValue" : 12345,
      "position" : 12345,
      "imageUrl" : "...",
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "programId" : "...",
    "programName" : "..."
  }, {
    "id" : 12345,
    "airVendor" : {
      "airlineNumber" : 12345,
      "checkinLink" : "...",
      "baggageLink" : "...",
      "alliance" : { },
      "lowCostCarrier" : true,
      "longCode" : "...",
      "manualTicketingOnly" : true,
      "airTicketsUseOrigIssueDate" : true,
      "mcoTicketsUseOrigIssueDate" : true,
      "minDomesticValue" : 12345,
      "minIntlValue" : 12345,
      "position" : 12345,
      "imageUrl" : "...",
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "programId" : "...",
    "programName" : "..."
  } ],
  "passports" : [ {
    "id" : 12345,
    "nationality" : "...",
    "number" : "...",
    "dateIssued" : "...",
    "countryIssued" : "...",
    "expiration" : "..."
  }, {
    "id" : 12345,
    "nationality" : "...",
    "number" : "...",
    "dateIssued" : "...",
    "countryIssued" : "...",
    "expiration" : "..."
  } ],
  "type" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}