MVFv3 API Documentation
    Preparing search index...

    Type Alias CMSExtensionSchema

    The CMS Extension adds a number of properties to the MVF, all under the base cms property This extra data is only available to certain CMS clients, and should not be used directly without discussing the implications with your Mappedin representative.

    In particular, everything in this extension is OPTIONAL, because much of it will eventually be promoted to more stable standalone MVF extensions, and deprecated out of this one.

    If you every see a piece of information available in the CMS Extension and another extension, USE THE OTHER EXTENSION.

    type CMSExtensionSchema = {
        cms?: {
            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"?: (...) | (...);
                    closes?: (...) | (...);
                    dayOfWeek?:
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    opens?: (...) | (...);
                    validFrom?: (...) | (...);
                    validThrough?: (...) | (...);
                }[];
                topLocations?: `loc_${string}`[];
            } & {
                details: { name: string } & {
                    description?: string;
                    externalId?: string;
                    icon?: string;
                    shortName?: string;
                };
            } & { extra?: { [key: string]: unknown } };
        } & {
            locations?: {
                cmsId: string;
                id: `el_${string}`;
                locationId: `loc_${string}`;
                sortOrder: number;
                type: string;
                amenity?: string;
                gallery?: {
                    image: string;
                    caption?: (...)
                    | (...);
                    embeddedUrl?: (...) | (...);
                }[];
                picture?: string;
                primaryCategory?: `lcat_${string}`;
                showFloatingLabelWhenImagePresent?: boolean;
                showLogo?: boolean;
                siblingGroups?: { label: string; siblings: (...)[] }[];
                states?: {
                    type: (...) | (...) | (...) | (...) | (...) | (...);
                    end?: (...) | (...);
                    start?: (...) | (...);
                }[];
                tags?: string[];
            }[];
        } & {
            locationInstances?: (
                {
                    id: `eli_${string}`;
                    locationInstanceId: `loci_${string}`;
                    parentId: `el_${string}`;
                } & {
                    amenity?: string;
                    cmsId?: string;
                    gallery?: { image: ...; caption?: ...; embeddedUrl?: ... }[];
                    picture?: string;
                    primaryCategory?: `lcat_${string}`;
                    showFloatingLabelWhenImagePresent?: boolean;
                    showLogo?: boolean;
                    siblingGroups?: { label: ...; siblings: ... }[];
                    sortOrder?: number;
                    states?: { type: ...; end?: ...; start?: ... }[];
                    tags?: string[];
                    type?: string;
                }
            )[];
        } & {
            categories?: {
                categoryId: `lcat_${string}`;
                id: `ec_${string}`;
                sortOrder: number;
                color?: string;
                iconFromDefaultList?: null
                | string;
                picture?: string;
            }[];
        } & {
            textures?: {
                [key: `f_${string}`]: (
                    {
                        bounds: [number, number, number, number];
                        face: "unknown" | "top" | "side";
                        offset: { u: number; v: number };
                        path: string;
                        repeat: { u: number; v: number };
                        rotation: number;
                        surface: "unknown" | "inside" | "outside" | "both";
                    } & { geometryId: `g_${string}` }
                )[];
            };
        } & {
            floorText?: {
                [key: `f_${string}`]: {
                    features: {
                        geometry: { coordinates: [(...), (...)]; type: "Point" };
                        properties: (...) & (...) | (...) & (...);
                        type: "Feature";
                    }[];
                    type: "FeatureCollection";
                };
            };
        } & {
            layers?: Partial<
                { [key: `f_${string}`]: Partial<{ [key: `g_${string}`]: string }> },
            >;
        } & {
            textAreas?: {
                [key: `f_${string}`]: {
                    features: {
                        geometry: { coordinates: [(...), (...)]; type: "Point" };
                        properties: (...) & (...) | (...) & (...);
                        type: "Feature";
                    }[];
                    type: "FeatureCollection";
                };
            };
        };
    }
    Index

    Properties

    Properties

    cms?: {
        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"?: (...) | (...);
                closes?: (...) | (...);
                dayOfWeek?:
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...)
                    | (...);
                opens?: (...) | (...);
                validFrom?: (...) | (...);
                validThrough?: (...) | (...);
            }[];
            topLocations?: `loc_${string}`[];
        } & {
            details: { name: string } & {
                description?: string;
                externalId?: string;
                icon?: string;
                shortName?: string;
            };
        } & { extra?: { [key: string]: unknown } };
    } & {
        locations?: {
            cmsId: string;
            id: `el_${string}`;
            locationId: `loc_${string}`;
            sortOrder: number;
            type: string;
            amenity?: string;
            gallery?: {
                image: string;
                caption?: (...)
                | (...);
                embeddedUrl?: (...) | (...);
            }[];
            picture?: string;
            primaryCategory?: `lcat_${string}`;
            showFloatingLabelWhenImagePresent?: boolean;
            showLogo?: boolean;
            siblingGroups?: { label: string; siblings: (...)[] }[];
            states?: {
                type: (...) | (...) | (...) | (...) | (...) | (...);
                end?: (...) | (...);
                start?: (...) | (...);
            }[];
            tags?: string[];
        }[];
    } & {
        locationInstances?: (
            {
                id: `eli_${string}`;
                locationInstanceId: `loci_${string}`;
                parentId: `el_${string}`;
            } & {
                amenity?: string;
                cmsId?: string;
                gallery?: { image: ...; caption?: ...; embeddedUrl?: ... }[];
                picture?: string;
                primaryCategory?: `lcat_${string}`;
                showFloatingLabelWhenImagePresent?: boolean;
                showLogo?: boolean;
                siblingGroups?: { label: ...; siblings: ... }[];
                sortOrder?: number;
                states?: { type: ...; end?: ...; start?: ... }[];
                tags?: string[];
                type?: string;
            }
        )[];
    } & {
        categories?: {
            categoryId: `lcat_${string}`;
            id: `ec_${string}`;
            sortOrder: number;
            color?: string;
            iconFromDefaultList?: null
            | string;
            picture?: string;
        }[];
    } & {
        textures?: {
            [key: `f_${string}`]: (
                {
                    bounds: [number, number, number, number];
                    face: "unknown" | "top" | "side";
                    offset: { u: number; v: number };
                    path: string;
                    repeat: { u: number; v: number };
                    rotation: number;
                    surface: "unknown" | "inside" | "outside" | "both";
                } & { geometryId: `g_${string}` }
            )[];
        };
    } & {
        floorText?: {
            [key: `f_${string}`]: {
                features: {
                    geometry: { coordinates: [(...), (...)]; type: "Point" };
                    properties: (...) & (...) | (...) & (...);
                    type: "Feature";
                }[];
                type: "FeatureCollection";
            };
        };
    } & {
        layers?: Partial<
            { [key: `f_${string}`]: Partial<{ [key: `g_${string}`]: string }> },
        >;
    } & {
        textAreas?: {
            [key: `f_${string}`]: {
                features: {
                    geometry: { coordinates: [(...), (...)]; type: "Point" };
                    properties: (...) & (...) | (...) & (...);
                    type: "Feature";
                }[];
                type: "FeatureCollection";
            };
        };
    }