MVFv3 API Documentation
    Preparing search index...

    Type Alias EnterpriseLocationInstancesSchema

    Enterprise Location Instances are a way to describe an Enterprise Location that has some properties different from the parent. Eg, it may have different siblingGroups or state. These must be linked to BOTH an EnterpriseLocation and a LocationInstance.

    It is otherwise a Partial.

    Usage example:

    • An EnterpriseLocation representing a kiosk in several places. One of them is new, and has an EnterpriseLocationInstance with the new location state.
    type EnterpriseLocationInstancesSchema = {
        locationInstances?: (
            {
                id: `eli_${string}`;
                locationInstanceId: `loci_${string}`;
                parentId: `el_${string}`;
            } & {
                amenity?: string;
                cmsId?: string;
                gallery?: { image: string; caption?: string; embeddedUrl?: string }[];
                picture?: string;
                primaryCategory?: `lcat_${string}`;
                showFloatingLabelWhenImagePresent?: boolean;
                showLogo?: boolean;
                siblingGroups?: { label: string; siblings: `loc_${string}`[] }[];
                sortOrder?: number;
                states?: {
                    type:
                        | "closed-temporarily"
                        | "new"
                        | "pop-up"
                        | "coming-soon"
                        | "relocated"
                        | "unknown";
                    end?: string;
                    start?: string;
                }[];
                tags?: string[];
                type?: string;
            }
        )[];
    }
    Index

    Properties

    locationInstances?

    Properties

    locationInstances?: (
        {
            id: `eli_${string}`;
            locationInstanceId: `loci_${string}`;
            parentId: `el_${string}`;
        } & {
            amenity?: string;
            cmsId?: string;
            gallery?: { image: string; caption?: string; embeddedUrl?: string }[];
            picture?: string;
            primaryCategory?: `lcat_${string}`;
            showFloatingLabelWhenImagePresent?: boolean;
            showLogo?: boolean;
            siblingGroups?: { label: string; siblings: `loc_${string}`[] }[];
            sortOrder?: number;
            states?: {
                type:
                    | "closed-temporarily"
                    | "new"
                    | "pop-up"
                    | "coming-soon"
                    | "relocated"
                    | "unknown";
                end?: string;
                start?: string;
            }[];
            tags?: string[];
            type?: string;
        }
    )[]

    Type declaration

    • id: `eli_${string}`

      The unique ID for this Enterprise Location Instance. This ID might be ephemeral and is really only for localization.

    • locationInstanceId: `loci_${string}`

      The LocationInstance that will have any Location instance properties set, in particular geometryAnchors.

    • parentId: `el_${string}`

      The parent Enterprise Location for this Enterprise Location Instance.

    • Optionalamenity?: string

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

    • OptionalcmsId?: string

      The original CMS ID of the EnterpriseLocation

    • 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.

      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.

    • OptionalsortOrder?: number
    • 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.

    • Optionaltype?: string

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

    Settings

    Member Visibility

    On This Page

    Properties