API Docs for: 1.3.12
Show:

LodgingReservation Class

Schema.org/LodgingReservation A reservation for lodging at a hotel, motel, inn, etc.\n\nNote: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations.

Methods

getDescription

() String

Returns the description of the thing

Returns:

String:

description of Thing

getName

() String

Returns the name of the thing

Returns:

String:

name of Thing

setDescription

(
  • description
)

Method to set Thing description

Parameters:

  • description String

    Description to set for its Thing

setName

(
  • name
)

Method to set Thing name

Parameters:

  • name String

    Name to set for this Thing

Properties

additionalType

URL

Schema.org/additionalType An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

alternateName

Text

Schema.org/alternateName An alias for the item.

bookingAgent

Organization

Schema.org/bookingAgent 'bookingAgent' is an out-dated term indicating a 'broker' that serves as a booking agent.

bookingTime

DateTime

Schema.org/bookingTime The date and time the reservation was booked.

broker

Person

Schema.org/broker An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.

checkinTime

DateTime

Schema.org/checkinTime The earliest someone may check into a lodging establishment.

checkoutTime

DateTime

Schema.org/checkoutTime The latest someone may check out of a lodging establishment.

description

Text

Schema.org/description A description of the item.

disambiguatingDescription

Text

Schema.org/disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

identifier

Schema, URL | schema,Text | schema,PropertyValue

Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.

image

Schema, URL | schema,ImageObject

Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

lodgingUnitDescription

Text

Schema.org/lodgingUnitDescription A full description of the lodging unit.

lodgingUnitType

Text

Schema.org/lodgingUnitType Textual description of the unit type (including suite vs. room, size of bed, etc.).

mainEntityOfPage

Schema, URL | schema,CreativeWork

Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

modifiedTime

DateTime

Schema.org/modifiedTime The date and time the reservation was modified.

name

Text

Schema.org/name The name of the item.

numAdults

Integer

Schema.org/numAdults The number of adults staying in the unit.

numChildren

Integer

Schema.org/numChildren The number of children staying in the unit.

potentialAction

Action

Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

priceCurrency

Text

Schema.org/priceCurrency The currency (in 3-letter ISO 4217 format) of the price or a price component, when attached to [[PriceSpecification]] and its subtypes.

programMembershipUsed

ProgramMembership

Schema.org/programMembershipUsed Any membership in a frequent flyer, hotel loyalty program, etc. being applied to the reservation.

provider

Person

Schema.org/provider The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

reservationFor

Thing

Schema.org/reservationFor The thing -- flight, event, restaurant,etc. being reserved.

reservationId

Text

Schema.org/reservationId A unique identifier for the reservation.

reservationStatus

ReservationStatusType

Schema.org/reservationStatus The current status of the reservation.

reservedTicket

Ticket

Schema.org/reservedTicket A ticket associated with the reservation.

sameAs

URL

Schema.org/sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

totalPrice

Number

Schema.org/totalPrice The total price for the reservation or ticket, including applicable taxes, shipping, etc.

underName

Organization

Schema.org/underName The person or organization the reservation or ticket is for.

url

URL

Schema.org/url URL of the item.