Type Alias EnterpriseLocationsSchema

Type declaration

• cmsId: string

  The original CMS ID of the EnterpriseLocation

• id: `el_${string}`

• locationId: `loc_${string}`

  The ID of the Location that has most of the EnterpriseLocation's data

• sortOrder: number

• type: string

  The type of the location, like amenity, tenant, etc.

• Optionalamenity?: string

  The location's amenity type. Only set if the location is an amenity

• Optionalgallery?: { image: string; caption?: string; embeddedUrl?: string }[]

  A gallery of images for a location. May be a mix of promotional images, or images of the location itself. Caption should be supplied for accessibility purposes, since it will not be clear from context what the image represents.

• Optionalpicture?: string

  A photograph of the location, used as a visual aid during navigation.

  Format

  uri

• OptionalprimaryCategory?: `lcat_${string}`

  The main category of the location. It must be one of the categories in the Location's categories array

• OptionalshowFloatingLabelWhenImagePresent?: boolean

  Whether to show the flat label when an image is present on the polygon a location is anchored to. This is often set to false for anchor stores in malls, since they often have a large logo image placed directly on their polygon.

• OptionalshowLogo?: boolean

  Whether to show the logo of the location

• OptionalsiblingGroups?: { label: string; siblings: `loc_${string}`[] }[]

  Locations that are related to this location in some manner (described by the label).

  In airports, locations will typically get SiblingGroups with a label of "REFERENCE_POINT" linking to locations like "Terminal 1" and "Airside" to indicate which zone they are in, but SiblingGroups can be used for any type of relationship between locations.

  Note this links to the LocationId, not the EnterpriseLocationId.

• Optionalstates?: {
      type:
          | "closed-temporarily"
          | "new"
          | "pop-up"
          | "coming-soon"
          | "relocated"
          | "unknown";
      end?: string;
      start?: string;
  }[]

  The location's state. No more than one state should be active at a time, and all but at most one should have dates set

• Optionaltags?: string[]

  Tags are used primarily as keywords to match against when searching. They are typically not used for display.