City Data Type

An element representing City codes in Airportal.

Properties
name data type constraints description
code string   Three character code for each city.
countryCode string   Two character code for this cities country.
latitude number   Latitude of the cities location.
longitude number   Longitude of the cities location.
name string   The name of the city.
stateOrCountry string   The name of the Country(if international) or two character code of the State(if domestic)
airportName string   The name of the closest airport of the city.
region Region   The state or province that this city is located in.
timeZone TimeZone   The time zone that this city witnesses.
retentionOnly boolean required boolean A flag to let the services know that this city code is only used by airlines for documenting refunds/exchanges.
position number  
unique boolean required boolean Whether or not this is a unique city label. Non-unique city labels are alternate airports of the same city.
alias boolean required boolean Whether or not this is an alias. Also known as city code. It means that this code has no physical location, but instead represents many airports in the same area.
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

{
  "code" : "...",
  "countryCode" : "...",
  "latitude" : 12345.0,
  "longitude" : 12345.0,
  "name" : "...",
  "stateOrCountry" : "...",
  "airportName" : "...",
  "region" : {
    "name" : "...",
    "code" : "...",
    "country" : {
      "name" : "...",
      "code" : "...",
      "codeAlt" : "...",
      "phoneCode" : 12345,
      "position" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "position" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "timeZone" : {
    "name" : "...",
    "offset" : 12345.0,
    "daylightSavingsOffset" : 12345.0,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "retentionOnly" : true,
  "position" : 12345,
  "unique" : true,
  "alias" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}