Skip to main content

CancelRs

Represents the response for a hotel booking cancellation operation.

Properties

NameTypeDescription
AuditDataProviderAuditGets or sets the audit data provided by the supplier or system for the operation.
AuditData/RequestArray<ProviderAuditRq>Collection of audit entries for provider requests.Each entry contains details about a specific request made to the provider.
AuditData/Request/SendAtStringThe timestamp indicating when the request was sent.
AuditData/Request/DataStringThe payload data included in the request.
AuditData/Request/UrlStringThe URL of the provider endpoint to which the request is sent.
AuditData/Request/HeadersObjectA collection of headers included in the request.
AuditData/Request/HttpMethodHttpMethodThe HTTP method used to send the request.
AuditData/Request/HttpMethod
Method
StringNo description available.
AuditData/ResponseArray<ProviderAuditRs>Collection of audit entries for provider responses.Each entry contains details about a specific response received from the provider.
AuditData/Response/ReceivedAtStringThe timestamp indicating when the response was received.
AuditData/Response/DataStringThe payload data contained in the provider's response.
AuditData/Response/HeadersObjectA collection of headers included in the provider's response.
AuditData/Response/StatusCodeIntegerThe HTTP status code returned by the provider.
AdviseMessagesArray<AdviseMessage>Gets the collection of advise messages related to the cancellation operation.
AdviseMessages/CodeAdviseMessageCodeGets the code that represents the message type.
AdviseMessages/LevelAdviseMessageLevelGets the severity level of the message (e.g., Error, Warning, or Info).
AdviseMessages/DescriptionStringGets the message description providing additional context.
AdviseMessages/CorrelationIdStringGets a unique identifier for correlating the message with specific operations.
AdviseMessages/ExternalExternalGets additional external details associated with the message.
AdviseMessages/External/CodeStringThe supplier's internal code for identifying the nature of the response or error.
AdviseMessages/External
Message
StringA descriptive message returned by the supplier.
AdviseMessages/External
HttpStatusCode
IntegerThe HTTP status code of the supplier's response.
ReferenceReferenceGets the reference information associated with the booking.
Reference/ClientLocatorStringThe booking locator provided by the client.This is typically used to match the booking in the client's internal systems.
Reference/SupplierLocatorStringThe booking locator provided by the supplier.This identifier is used to reference the booking in the supplier's system.
Reference/HotelLocatorStringThe booking locator specific to the hotel, provided by the supplier. (Optional)This may be required in cases where the hotel system uses its own unique identifiers.
CancelLocatorStringGets or sets the cancel locator value specific to the cancellation operation.
StatusBookStatusGets the status of the booking after the cancellation operation. Possible values: Unknown, Ko, Ok, OnRequest, Cancelled or PendingCommit.
BookPricePriceGets or sets the original booking price before cancellation.
BookPrice/CurrencyCurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
BookPrice/BindingBooleanIndicates whether the price is binding.
BookPrice/NetDoubleThe net price paid by the buyer to the seller.
BookPrice/GrossDoubleThe gross price, which includes the net price and the buyer's commission.
BookPrice/NetSpecifiedBooleanIndicates whether the net price is explicitly specified.
BookPrice/MinimumSellingPriceDoubleThe minimum selling price.
CancelPricePriceGets or sets the price associated with the cancellation operation.
CancelPrice/CurrencyCurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
CancelPrice/BindingBooleanIndicates whether the price is binding.
CancelPrice/NetDoubleThe net price paid by the buyer to the seller.
CancelPrice/GrossDoubleThe gross price, which includes the net price and the buyer's commission.
CancelPrice/NetSpecifiedBooleanIndicates whether the net price is explicitly specified.
CancelPrice
MinimumSellingPrice
DoubleThe minimum selling price.
AddOnsObjectGets or sets additional supplier information as key-value pairs.