HotelSegment Data Type

A hotel segment is a period of time that a traveler stays in a hotel.

Properties
name data type constraints description
confirmationNumber string max size: 32, min size: 0 The confirmation number for the reservation.
frequentGuestNumber string max size: 25, min size: 0 The frequent guest number of the guest.
corporateDiscountNumber string max size: 35, min size: 0 The discount number for the guest.
guestName string max size: 150, min size: 0 The name of the guest.
travelerName string  
numberOfRooms number   The number of rooms rented.
notes string max size: 150, min size: 0 Any notes about the segment.
checkIn string   The check in time for the guest.
checkOut string   The check out time for the guest.
roomDescription string max size: 256, min size: 0 The description of the room.
roomType string max size: 16, min size: 0 The type of room rented.
cancellationNumber string max size: 32, min size: 0 The cancellation number for the stay.
cancellationPolicy string max size: 256, min size: 0 The cancellation policy.
guaranteeRequirements string max size: 256, min size: 0 The requirements for a guarantee.
guaranteeInformation string max size: 128, min size: 0 The information about the guarantee.
checkOutPenalty string max size: 128, min size: 0 The penalty incurred for an untimely check out.
numberOfGuests number   The number of occupants for the room.
numberOfChildren number   The number of children staying in the room.
hotel HotelLocation   The hotel property that the guest is staying at.
rateInfo string  
rateDesc string  
totalAmount number  
taxRate number  
taxCharge number   This should not be confused with tax amount, tax rate, or tax percentage. This is a tax charge that is applied in addition to other applicable charges.
addCharge number  
specialPrint string max size: 128, min size: 0
commissionAmount number  
inGds boolean   Whether or not the segment is stored in the GDS.
utcCheckIn number  
utcCheckOut number  
Properties inherited from AirportalSegment
number number   The ordering number of the segment.
status SegmentStatus   The status of the segment, like if it is confirmed or on wait list.
startDate string   The start date of the segment.
endDate string   The end date of the segment
UTCStartDate number   The start date of the segment in UTC.
UTCEndDate number   The end date of the segment in UTC.
startTimeZoneName string  
endTimeZoneName string  
startCity City   Get the starting city of the segment.
endCity City   The ending city of the segment.
domestic boolean   Whether this segment is domestic or not.
postTravel boolean   Whether this segment is in the past or not.
inGds boolean   Whether or not the segment is stored in the GDS.
itinerary Itinerary   Get the itinerary that this segment is connected to.
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

{
  "confirmationNumber" : "...",
  "frequentGuestNumber" : "...",
  "corporateDiscountNumber" : "...",
  "guestName" : "...",
  "travelerName" : "...",
  "numberOfRooms" : 12345,
  "notes" : "...",
  "checkIn" : "...",
  "checkOut" : "...",
  "roomDescription" : "...",
  "roomType" : "...",
  "cancellationNumber" : "...",
  "cancellationPolicy" : "...",
  "guaranteeRequirements" : "...",
  "guaranteeInformation" : "...",
  "checkOutPenalty" : "...",
  "numberOfGuests" : 12345,
  "numberOfChildren" : 12345,
  "hotel" : {
    "address1" : "...",
    "address2" : "...",
    "phone1" : "...",
    "phone2" : "...",
    "fax" : "...",
    "zip" : "...",
    "city" : {
      "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" : [ { }, { } ]
    },
    "vendor" : {
      "longCode" : "...",
      "commissionRate" : 12345.0,
      "family" : { },
      "position" : 12345,
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "propertyName" : "...",
    "propertyCodes" : [ {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "rateInfo" : "...",
  "rateDesc" : "...",
  "totalAmount" : 12345.0,
  "taxRate" : 12345.0,
  "taxCharge" : 12345.0,
  "addCharge" : 12345.0,
  "specialPrint" : "...",
  "commissionAmount" : 12345.0,
  "inGds" : true,
  "utcCheckIn" : 12345,
  "utcCheckOut" : 12345,
  "number" : 12345,
  "status" : {
    "code" : "...",
    "description" : "...",
    "accepted" : true,
    "confirmed" : true,
    "virtual" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "startDate" : "...",
  "endDate" : "...",
  "UTCStartDate" : 12345,
  "UTCEndDate" : 12345,
  "startTimeZoneName" : "...",
  "endTimeZoneName" : "...",
  "startCity" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "endCity" : {
    "code" : "...",
    "countryCode" : "...",
    "latitude" : 12345.0,
    "longitude" : 12345.0,
    "name" : "...",
    "stateOrCountry" : "...",
    "airportName" : "...",
    "region" : {
      "name" : "...",
      "code" : "...",
      "country" : { },
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "timeZone" : {
      "name" : "...",
      "offset" : 12345.0,
      "daylightSavingsOffset" : 12345.0,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "retentionOnly" : true,
    "position" : 12345,
    "unique" : true,
    "alias" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "domestic" : true,
  "postTravel" : true,
  "itinerary" : {
    "recordLocator" : "...",
    "agentName" : "...",
    "client" : {
      "status" : { },
      "parentClient" : { },
      "accountNumber" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "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" : [ { }, { } ]
    },
    "departureDate" : 12345,
    "completionDate" : 12345,
    "importDate" : 12345,
    "gds" : {
      "code" : "...",
      "oldCode" : "...",
      "name" : "...",
      "agressoCode" : "...",
      "enabled" : true,
      "profileSyncEnabled" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "hide" : true,
    "citySummary" : "...",
    "departureCity" : {
      "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" : [ { }, { } ]
    },
    "arrivalCity" : {
      "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" : [ { }, { } ]
    },
    "arrivalDate" : 12345,
    "utcArrivalDate" : 12345,
    "startDate" : 12345,
    "endDate" : 12345,
    "purpose" : "...",
    "explanation" : "...",
    "authorizationCode" : "...",
    "costCenterCode" : "...",
    "departmentCode" : "...",
    "clientCode" : "...",
    "regionCode" : "...",
    "billable" : "...",
    "travelerCode" : "...",
    "managerCode" : "...",
    "projectCode" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}