ItineraryRemark Data Type

Remarks added by agents or automated systems about a trip. Most are typically not desired to be seen by the traveler/user.

Properties
name data type constraints description
number number   The position that the remark should be viewed.
text string max size: 512, min size: 0 The text of the remark.
itinerary Itinerary  
type string max size: 16, min size: 0 The type of remark. The important one is NOTE = agent notes to display to users.
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

{
  "number" : 12345,
  "text" : "...",
  "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" : "..."
    } ]
  },
  "type" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}