experienceevent-reservation-search.schema.json

{
    "meta:license": [
        "Copyright 2020 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/xdm/mixins/experience-event/industry-verticals/experienceevent-reservation-search",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Reservation Search",
    "type": "object",
    "meta:extensible": true,
    "meta:abstract": true,
    "meta:tags": {
        "industry": [
            "travel_and_hospitality"
        ]
    },
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/context/experienceevent"
    ],
    "description": "Reservation search details such as flexibility, product code, rate type, and internal search information.",
    "definitions": {
        "reservations": {
            "properties": {
                "xdm:reservationSearch": {
                    "type": "object",
                    "properties": {
                        "xdm:couponCode": {
                            "title": "Coupon Code",
                            "type": "string",
                            "description": "Coupon/promo code string used in a reservation search.",
                            "meta:titleId": "experienceevent-reservation-search##xdm:couponCode##title##21791",
                            "meta:descriptionId": "experienceevent-reservation-search##xdm:couponCode##description##16101"
                        },
                        "xdm:groupCode": {
                            "title": "Group Code",
                            "type": "string",
                            "description": "Group code string used in a reservation search.",
                            "meta:titleId": "experienceevent-reservation-search##xdm:groupCode##title##57461",
                            "meta:descriptionId": "experienceevent-reservation-search##xdm:groupCode##description##75501"
                        },
                        "xdm:isFlexible": {
                            "title": "Reservation Search Is Flexibile",
                            "type": "boolean",
                            "description": "Tracks if a visitor selects a flexible date option for their reservation search.",
                            "meta:titleId": "experienceevent-reservation-search##xdm:isFlexible##title##12891",
                            "meta:descriptionId": "experienceevent-reservation-search##xdm:isFlexible##description##19571"
                        },
                        "xdm:productCode": {
                            "title": "Corporate Code",
                            "type": "string",
                            "description": "Corporate code string used in a reservation search.",
                            "meta:titleId": "experienceevent-reservation-search##xdm:productCode##title##19761",
                            "meta:descriptionId": "experienceevent-reservation-search##xdm:productCode##description##99621"
                        },
                        "xdm:rateType": {
                            "title": "Rate Type",
                            "type": "string",
                            "enum": [
                                "aaa",
                                "aarp",
                                "senior",
                                "government",
                                "corporate"
                            ],
                            "description": "Type of rate included in a reservation search.",
                            "meta:titleId": "experienceevent-reservation-search##xdm:rateType##title##78831",
                            "meta:descriptionId": "experienceevent-reservation-search##xdm:rateType##description##30871",
                            "meta:enum": {
                                "aaa": "AAA",
                                "aarp": "AARP",
                                "senior": "Senior",
                                "government": "Government",
                                "corporate": "Corporate"
                            }
                        },
                        "xdm:startDate": {
                            "title": "Start Date",
                            "type": "string",
                            "format": "date-time",
                            "description": "The start pick-up/outbound/check-in date of the reservation search.",
                            "meta:titleId": "experienceevent-reservation-search##xdm:startDate##title##86451",
                            "meta:descriptionId": "experienceevent-reservation-search##xdm:startDate##description##26861"
                        },
                        "xdm:endDate": {
                            "title": "End Date",
                            "type": "string",
                            "format": "date-time",
                            "description": "The end drop-off/return/check-out date of the reservation search.",
                            "meta:titleId": "experienceevent-reservation-search##xdm:endDate##title##25411",
                            "meta:descriptionId": "experienceevent-reservation-search##xdm:endDate##description##6181"
                        },
                        "xdm:reservationSearch": {
                            "title": "Site Search",
                            "$ref": "https://ns.adobe.com/xdm/datatypes/internal-site-search",
                            "description": "Extension of internalSearch data type.",
                            "meta:titleId": "experienceevent-reservation-search##xdm:reservationSearch##title##2131",
                            "meta:descriptionId": "experienceevent-reservation-search##xdm:reservationSearch##description##3271"
                        }
                    }
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/reservations"
        }
    ],
    "meta:status": "stable",
    "meta:createdDate": "2021-03-15",
    "meta:titleId": "experienceevent-reservation-search##title##50481",
    "meta:descriptionId": "experienceevent-reservation-search##description##7971",
    "examples": [
        {}
    ]
}