TravelGroupRequest Data Type

A request for a group trip, where multiple travelers want to travel using a special one-time contract

Properties
name data type constraints description
status TravelGroupRequestStatus   The status that this request is currently in.
name string   The unique name of the trip.
departureDate string   The start date of the trip.
returnDate string   The finish date of the trip.
coordinatorName string   The name of the coordinator.
coordinatorPhone string   The phone number of the coordinator.
coordinatorEmail string   The email of the coordinator.
agent EmployeeInfo   The agent that will be booking this request.
client Client required The account that will pay for the trip.
air boolean   Whether or not flights are requested in this request.
hotel boolean   Whether or not a hotel stay is requested.
ground boolean   Whether or not ground transportation is requested.
meeting boolean   Whether or not meeting space is requested.
equipment boolean   Whether or not equipment is requested.
departures array of TravelGroupRequestDeparture   A set of origination airports that the travelers will depart from.
group TravelGroup   The original group that intends to go on this trip.
destinations array of TravelGroupRequestDestination   A set of destinations that the travelers will arrive at.
destinationName string   The name of the destination that the travelers intend to go to.
hotels array of TravelGroupRequestHotel   A set of hotels that the travelers will rest at.
grounds array of TravelGroupRequestGround   A set of ground segments that the travelers wish to endure.
attachmentUrls array of TravelGroupRequestAttachmentUrl   A set of locations of files that vendors and coordinators sign after negotiating prices.
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

{
  "status" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "name" : "...",
  "departureDate" : "...",
  "returnDate" : "...",
  "coordinatorName" : "...",
  "coordinatorPhone" : "...",
  "coordinatorEmail" : "...",
  "agent" : {
    "user" : {
      "answer" : "...",
      "emailed" : true,
      "newUser" : true,
      "temporaryPassword" : "...",
      "question" : "...",
      "obeUserName" : "...",
      "obePassword" : "...",
      "obeSyncId" : "...",
      "created" : 12345,
      "emailedWhen" : 12345,
      "travelgpaLogin" : "...",
      "groups" : [ { }, { } ],
      "active" : true,
      "prefix" : "...",
      "firstName" : "...",
      "lastName" : "...",
      "middleName" : "...",
      "suffix" : "...",
      "email" : "...",
      "tripitAuthorized" : true,
      "supportTitle" : "...",
      "automatedNotifications" : true,
      "enableHotelAttachment" : true,
      "atHomeNotificationMethod" : { },
      "inTravelNotificationMethod" : { },
      "cellPhoneNumber" : "...",
      "defaultClient" : { },
      "defaultPlannerGroup" : { },
      "showWelcomeDialog" : true,
      "siteTour" : true,
      "unusedTicketEmail" : true,
      "surveyEmail" : true,
      "wt0EmailEnabled" : true,
      "wt0EmailDaily" : true,
      "wt0EmailDay" : 12345,
      "wt0EmailHour" : 12345,
      "marketingSubscribed" : true,
      "responsive" : true,
      "businessPhoneNumber" : "...",
      "homePhoneNumber" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "agentCode" : "...",
    "office" : {
      "pcc" : "...",
      "name" : "...",
      "address1" : "...",
      "address2" : "...",
      "address3" : "...",
      "city" : "...",
      "state" : "...",
      "zip" : "...",
      "parentCompany" : { },
      "active" : "...",
      "branch" : "...",
      "clientPrefix" : "...",
      "profileSettings" : { },
      "afterHoursNumber" : "...",
      "collectVoidLogs" : true,
      "gds" : { },
      "arcNumber" : "...",
      "logo" : "...",
      "logoLink" : "...",
      "afterHoursInternationalNumber" : "...",
      "tollFreeNumber" : "...",
      "phoneNumber" : "...",
      "onlineOffice" : { },
      "showTmcAppLinks" : true,
      "vipTollFree" : "...",
      "vipAfterHours" : "...",
      "cityCode" : { },
      "tmcHeadQuarters" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "workEmail" : "...",
    "active" : "...",
    "type" : "...",
    "emailList" : "...",
    "category" : "...",
    "directLine" : "...",
    "hours" : "...",
    "onlineAgent" : true,
    "recheckEmails" : true,
    "serviceFeesPct" : 12345.0,
    "otherServiceFeesPct" : 12345.0,
    "internationalAirCommissionPct" : 12345.0,
    "miscCommissionPct" : 12345.0,
    "airCommissionPct" : 12345.0,
    "hotelCommissionPct" : 12345.0,
    "carCommissionPct" : 12345.0,
    "employeeType" : {
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "ticketingAgent" : true,
    "supportAgent" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "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" : "..."
    } ]
  },
  "air" : true,
  "hotel" : true,
  "ground" : true,
  "meeting" : true,
  "equipment" : true,
  "departures" : [ {
    "airport" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "travelers" : [ {
      "id" : 12345,
      "user" : { },
      "firstName" : "...",
      "lastName" : "...",
      "middleName" : "...",
      "dateOfBirth" : "...",
      "leader" : true,
      "gender" : "...",
      "knownTravelerNumber" : "...",
      "email" : "...",
      "phone" : "...",
      "weight" : 12345,
      "client" : { },
      "groups" : [ { }, { } ],
      "loyaltyPrograms" : [ { }, { } ],
      "passports" : [ { }, { } ],
      "travelGroups" : [ { }, { } ],
      "violations" : [ { }, { } ],
      "type" : { },
      "request" : { },
      "origination" : { }
    }, {
      "id" : 12345,
      "user" : { },
      "firstName" : "...",
      "lastName" : "...",
      "middleName" : "...",
      "dateOfBirth" : "...",
      "leader" : true,
      "gender" : "...",
      "knownTravelerNumber" : "...",
      "email" : "...",
      "phone" : "...",
      "weight" : 12345,
      "client" : { },
      "groups" : [ { }, { } ],
      "loyaltyPrograms" : [ { }, { } ],
      "passports" : [ { }, { } ],
      "travelGroups" : [ { }, { } ],
      "violations" : [ { }, { } ],
      "type" : { },
      "request" : { },
      "origination" : { }
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "airport" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "travelers" : [ {
      "id" : 12345,
      "user" : { },
      "firstName" : "...",
      "lastName" : "...",
      "middleName" : "...",
      "dateOfBirth" : "...",
      "leader" : true,
      "gender" : "...",
      "knownTravelerNumber" : "...",
      "email" : "...",
      "phone" : "...",
      "weight" : 12345,
      "client" : { },
      "groups" : [ { }, { } ],
      "loyaltyPrograms" : [ { }, { } ],
      "passports" : [ { }, { } ],
      "travelGroups" : [ { }, { } ],
      "violations" : [ { }, { } ],
      "type" : { },
      "request" : { },
      "origination" : { }
    }, {
      "id" : 12345,
      "user" : { },
      "firstName" : "...",
      "lastName" : "...",
      "middleName" : "...",
      "dateOfBirth" : "...",
      "leader" : true,
      "gender" : "...",
      "knownTravelerNumber" : "...",
      "email" : "...",
      "phone" : "...",
      "weight" : 12345,
      "client" : { },
      "groups" : [ { }, { } ],
      "loyaltyPrograms" : [ { }, { } ],
      "passports" : [ { }, { } ],
      "travelGroups" : [ { }, { } ],
      "violations" : [ { }, { } ],
      "type" : { },
      "request" : { },
      "origination" : { }
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "group" : {
    "groupName" : "...",
    "client" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "destinations" : [ {
    "locationName" : "...",
    "locationAddress1" : "...",
    "locationPhone" : "...",
    "arrivalTime" : "...",
    "transport" : "...",
    "cityName" : "...",
    "zip" : "...",
    "departureTime" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "locationName" : "...",
    "locationAddress1" : "...",
    "locationPhone" : "...",
    "arrivalTime" : "...",
    "transport" : "...",
    "cityName" : "...",
    "zip" : "...",
    "departureTime" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "destinationName" : "...",
  "hotels" : [ {
    "position" : 12345,
    "date" : 12345,
    "queens" : 12345,
    "king" : 12345,
    "suite" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "position" : 12345,
    "date" : 12345,
    "queens" : 12345,
    "king" : 12345,
    "suite" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "grounds" : [ {
    "text" : "...",
    "urls" : [ {
      "url" : "...",
      "name" : "...",
      "creationDate" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "url" : "...",
      "name" : "...",
      "creationDate" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "text" : "...",
    "urls" : [ {
      "url" : "...",
      "name" : "...",
      "creationDate" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "url" : "...",
      "name" : "...",
      "creationDate" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "attachmentUrls" : [ {
    "url" : "...",
    "name" : "...",
    "creationDate" : "...",
    "signed" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "url" : "...",
    "name" : "...",
    "creationDate" : "...",
    "signed" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}