get Reservation Summaries

GET {{HostName}}/fof/v1/hotels/{{HotelId}}/reservationSummaries?searchType=Arrival&reservationId=string&blockId=string&arrivalStart=date&arrivalEnd=date&departureStart=date&departureEnd=date&stayOnStart=date&stayOnEnd=date&createOnStart=date&createOnEnd=date&reservationIdContext=string&reservationIdType=string&blockIdContext=string&blockIdType=string&depositDateEnd=date&depositDateStart=date&dateCriteriaExpectedArrivalEndTime=date-time&dateCriteriaExpectedArrivalStartTime=date-time&depositDueDateEnd=date&depositDueDateStart=date&expectedReturnEndTime=date-time&expectedReturnStartTime=date-time&membershipNumber=string&anyVIPStatus=boolean&vipStatusCodes&roomId=string&lastName=string&firstName=string&blockCode=string&companyName=string&travelAgentName=string&creditCardNumber=string&customReference=string&externalReference=string&attributeName=Room&attributeName=Name&attributeName=ArrivalTime&attributeName=DepartureTime&attributeName=ArrivalDate&attributeName=DepartureDate&orderType=Asc&orderType=Dsc&expectedArrivalEndTime=date&expectedArrivalStartTime=date&roomTypes=string&roomStatuses=Clean&roomStatuses=Dirty&roomStatuses=Pickup&roomStatuses=Inspected&roomStatuses=OutofOrder&roomStatuses=OutofService&paymentMethod=string&indicator=InHouse&fetchSummaryInstructions=ReservationPaymentMethods&fetchSummaryInstructions=RoomDetails&fetchSummaryInstructions=BlockReservationDetails&allowedAction=EnrollInProgress&allowedAction=EnrollToPrimaryMembership&allowedAction=Cancel&allowedAction=Move&allowedAction=PreCharge&allowedAction=PostCharge&allowedAction=FacilitySchedule&allowedAction=Upsell&allowedAction=PreCheckIn&allowedAction=PostToNoShowCancel&allowedAction=NoShow&allowedAction=NameChange&allowedAction=Discount&allowedAction=HouseKeeping

Request Params

Key	Datatype	Description
`searchType`	string	"Any", "DayUse", "Arrival", "Arrived", "Departure", "WaitList", "Cancellation", "CheckedOut", "NoShow", "Complimentary", "InHouse", "PostStayPendingBalance", "PreRegistered", "PostToRoom", "OpenFolio", "ScheduledCheckOut", "Queued", "MobileCheckout", "RegisteredAndInHouse", "ResvBlockTraces", "GuestMessages", "MassCancellation", "Operator", "Turndown", "WalkIn", "AdvanceCheckedIn", "OpenBalance", "AutoFolioSettlement", "Routing", "PlayerSnapshot"
`reservationId`	string	A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation
`blockId`	string	A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation
`arrivalStart`	string	The starting value of the date range
`arrivalEnd`	string	The ending value of the date range
`departureStart`	string	The starting value of the date range
`departureEnd`	string	The ending value of the date range
`stayOnStart`	string	The starting value of the date range
`stayOnEnd`	string	The ending value of the date range
`createOnStart`	string	The starting value of the date range
`createOnEnd`	string	The ending value of the date range
`reservationIdContext`	string	Used to identify the source of the identifier (e.g., IATA, ABTA)
`reservationIdType`	string	A reference to the type of object defined by the UniqueID element
`blockIdContext`	string	Used to identify the source of the identifier (e.g., IATA, ABTA)
`blockIdType`	string	A reference to the type of object defined by the UniqueID element
`depositDateEnd`	string	The ending value of the date range
`depositDateStart`	string	The starting value of the date range
`dateCriteriaExpectedArrivalEndTime`	string	The ending value of the time span
`dateCriteriaExpectedArrivalStartTime`	string	The starting value of the time span
`depositDueDateEnd`	string	The ending value of the date range
`depositDueDateStart`	string	The starting value of the date range
`expectedReturnEndTime`	string	The ending value of the time span
`expectedReturnStartTime`	string	The starting value of the time span
`membershipNumber`	string	Lookup reservations with this membership number
`anyVIPStatus`	string	VIP status of the customer
`vipStatusCodes`	null	VIP status of the customer
`roomId`	string	Wildcard Search value to lookup reservation with this room number
`lastName`	string	Wildcard Search value to lookup reservations with this Last Name
`firstName`	string	Wildcard Search value to lookup reservations with this First Name
`blockCode`	string	Wildcard Search value to lookup reservation with this block code.
`companyName`	string	Lookup reservations with this company name.
`travelAgentName`	string	Lookup reservations with this travel agent name
`creditCardNumber`	string	Lookup reservations which has this credit card attached
`customReference`	string	Lookup reservations with this custom reference number
`externalReference`	string	Lookup reservations with this external reference id
`attributeName`	string	"Room", "Name", "ArrivalTime", "DepartureTime", "ArrivalDate", "DepartureDate"
`attributeName`	string	"Room", "Name", "ArrivalTime", "DepartureTime", "ArrivalDate", "DepartureDate"
`attributeName`	string	"Room", "Name", "ArrivalTime", "DepartureTime", "ArrivalDate", "DepartureDate"
`attributeName`	string	"Room", "Name", "ArrivalTime", "DepartureTime", "ArrivalDate", "DepartureDate"
`attributeName`	string	"Room", "Name", "ArrivalTime", "DepartureTime", "ArrivalDate", "DepartureDate"
`attributeName`	string	"Room", "Name", "ArrivalTime", "DepartureTime", "ArrivalDate", "DepartureDate"
`orderType`	string	Order Type
`orderType`	string	Order Type
`expectedArrivalEndTime`	string	The ending value of the date range
`expectedArrivalStartTime`	string	The starting value of the date range
`roomTypes`	string	Room Types
`roomStatuses`	string	Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
`roomStatuses`	string	Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
`roomStatuses`	string	Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
`roomStatuses`	string	Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
`roomStatuses`	string	Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
`roomStatuses`	string	Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService
`paymentMethod`	string	Payment Method to search the reservation
`indicator`	string	"Package", "Message", "Attachments", "Share", "Routing", "Itinerary", "Trace", "ServiceRequests", "Locator", "Comment", "AuthorizedBilling", "StayRevenue", "Preference", "ProfileNote", "NoPost", "DepositCancellation", "FixedCharge", "RateChange", "QmsTask", "Activity", "Queue", "Member", "CancelReason", "Extension", "OpenFolio", "PreStay", "PostStay", "WakeUpCall", "Alert", "ExternalQms", "Transport", "TrackIt", "Award", "ItemInventory", "Waitlist", "HistoryFuture", "Communication", "PrepaidCards", "WebRegistrationCards"
`fetchSummaryInstructions`	string	Simple type for reservation summary instructions that can be used in requests to fetch summary
`fetchSummaryInstructions`	string	Simple type for reservation summary instructions that can be used in requests to fetch summary
`fetchSummaryInstructions`	string	Simple type for reservation summary instructions that can be used in requests to fetch summary
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation
`allowedAction`	string	Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string
`x-hotelid`	string
`x-app-key`	string