MVFv3 API Documentation
    Preparing search index...

    Type Alias EnterpriseVenue

    An Enterprise Venue adds extra enterprise data to the Enterprise Venue the MVF describes

    type EnterpriseVenue = {
        countrycode?: string;
        logo?: string;
        mappedinWebUrl?: string;
        topLocations?: `loc_${string}`[];
        operationHours?: {
            "@type"?: "OpeningHoursSpecification";
            closes?: string;
            dayOfWeek?:
                | "Sunday"
                | "Monday"
                | "Tuesday"
                | "Wednesday"
                | "Thursday"
                | "Friday"
                | "Saturday"
                | "PublicHolidays"
                | (
                    | "Sunday"
                    | "Monday"
                    | "Tuesday"
                    | "Wednesday"
                    | "Thursday"
                    | "Friday"
                    | "Saturday"
                    | "PublicHolidays"
                )[];
            opens?: string;
            validFrom?: string;
            validThrough?: string;
        }[];
        coverImage?: string;
        id: `ev_${string}`;
        slug: string;
        defaultLanguage: { code: string; name: string };
        languages: { code: string; name: string }[];
        details: { name: string } & {
            description?: string;
            externalId?: string;
            icon?: string;
            shortName?: string;
        };
        extra?: { [key: string]: unknown };
    }
    Index

    Properties

    countrycode? logo? mappedinWebUrl? topLocations? operationHours? coverImage? id slug defaultLanguage languages details extra?

    Properties

    countrycode?: string

    The ISO 3166-1 alpha-2 country code of the venue, if known

    Eg. CA or US

    logo?: string

    The venue's logo

    uri

    mappedinWebUrl?: string

    The base URL for Mappedin Web for this venue.

    uri

    topLocations?: `loc_${string}`[]

    The locations that are considered the "top" locations for this venue.

    Usually used in a quick-access menu in applications to show the most important locations in the venue.

    Note: These point to Locations not the EnterpriseLocations.

    operationHours?: {
        "@type"?: "OpeningHoursSpecification";
        closes?: string;
        dayOfWeek?:
            | "Sunday"
            | "Monday"
            | "Tuesday"
            | "Wednesday"
            | "Thursday"
            | "Friday"
            | "Saturday"
            | "PublicHolidays"
            | (
                | "Sunday"
                | "Monday"
                | "Tuesday"
                | "Wednesday"
                | "Thursday"
                | "Friday"
                | "Saturday"
                | "PublicHolidays"
            )[];
        opens?: string;
        validFrom?: string;
        validThrough?: string;
    }[]

    The venue's operation hours.

    Type declaration

    • Optional@type?: "OpeningHoursSpecification"

      The type of opening hours

      'OpeningHoursSpecification'
    • Optionalcloses?: string

      The time the opening hours end

    • OptionaldayOfWeek?:
          | "Sunday"
          | "Monday"
          | "Tuesday"
          | "Wednesday"
          | "Thursday"
          | "Friday"
          | "Saturday"
          | "PublicHolidays"
          | (
              | "Sunday"
              | "Monday"
              | "Tuesday"
              | "Wednesday"
              | "Thursday"
              | "Friday"
              | "Saturday"
              | "PublicHolidays"
          )[]

      The days of the week the opening hours apply to

    • Optionalopens?: string

      The time the opening hours start

    • OptionalvalidFrom?: string

      The date the opening hours start, in ISO 8601 format

      date-time

    • OptionalvalidThrough?: string

      The date the opening hours end, in ISO 8601 format

      date-time

    coverImage?: string

    The venue's cover image.

    uri

    id: `ev_${string}`

    The venue's unique identifier

    slug: string

    The venue's unique slug. This is typically the key used to identify the venue.

    defaultLanguage: { code: string; name: string }

    The venue's default language name and code

    languages: { code: string; name: string }[]

    The venue's supported languages. Includes the default language. Typically if a venue has multiple languages, at least SOME data will be set in each language, which means there will generally be a Locale Pack for each language.

    However, there is no guarantee that localized data has actually been added in a given language.

    details: { name: string } & {
        description?: string;
        externalId?: string;
        icon?: string;
        shortName?: string;
    }

    Type declaration

    • name: string

      The name of the entity.

    • Optionaldescription?: string

      A description of the entity.

    • OptionalexternalId?: string

      An identifier that can be used to link this entity to data outside of the MVF.

    • Optionalicon?: string

      A URL to an icon for the entity.

    • OptionalshortName?: string

      A short name for the entity. Usually a handful characters (eg; R303, F1, L, etc.) For display in places a full name would be too long or cumbersome.

    extra?: { [key: string]: unknown }

    {@inheritDoc utility-types/extra!Extra}

    Extra

    Settings

    Member Visibility

    On This Page

    Properties