MVFv3 API Documentation
    Preparing search index...

    Type Alias EnterpriseVenueSchema

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

    type EnterpriseVenueSchema = {
        venue?: {
            defaultLanguage: { code: string; name: string };
            id: `ev_${string}`;
            languages: { code: string; name: string }[];
            slug: string;
            countrycode?: string;
            coverImage?: string;
            logo?: string;
            mappedinWebUrl?: 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;
            }[];
            topLocations?: `loc_${string}`[];
        } & {
            details: { name: string } & {
                description?: string;
                externalId?: string;
                icon?: string;
                shortName?: string;
            };
        } & { extra?: { [key: string]: unknown } };
    }
    Index

    Properties

    venue?

    Properties

    venue?: {
        defaultLanguage: { code: string; name: string };
        id: `ev_${string}`;
        languages: { code: string; name: string }[];
        slug: string;
        countrycode?: string;
        coverImage?: string;
        logo?: string;
        mappedinWebUrl?: 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;
        }[];
        topLocations?: `loc_${string}`[];
    } & {
        details: { name: string } & {
            description?: string;
            externalId?: string;
            icon?: string;
            shortName?: string;
        };
    } & { extra?: { [key: string]: unknown } }

    Type declaration

    • defaultLanguage: { code: string; name: string }

      The venue's default language name and code

    • id: `ev_${string}`

      The venue's unique identifier

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

    • slug: string

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

    • Optionalcountrycode?: string

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

      Eg. CA or US

    • OptionalcoverImage?: string

      The venue's cover image.

      uri

    • Optionallogo?: string

      The venue's logo

      uri

    • OptionalmappedinWebUrl?: string

      The base URL for Mappedin Web for this venue.

      uri

    • OptionaloperationHours?: {
          "@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.

    • OptionaltopLocations?: `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.

    • details: { name: string } & {
          description?: string;
          externalId?: string;
          icon?: string;
          shortName?: string;
      }
    • Optionalextra?: { [key: string]: unknown }

      {@inheritDoc utility-types/extra!Extra}

      Extra

    Settings

    Member Visibility

    On This Page

    Properties