{"@context": "https://schema.org", "@type": "WebAPI", "name": "hetras Hotel API Version 0 API", "description": "hetras Hotel API Version 0, an HTTP API described by an OpenAPI document.", "provider": {"@type": "Organization", "name": "hetras-certification.net"}, "documentation": "https://developer.hetras.com/swagger/spec/HotelAPIv0.json"}
hetras Hotel API Version 0, an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.hetras-certification.net
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
hetras Hotel API Version 0, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/hotel/v0/hotels | Get a list of all the hotels of a chain your application has access to. Load the details about all the hotels |
GET | /api/hotel/v0/hotels/{hotelId} | Get the details of the hotel with the speccified hotel id. Load the details about the specified hotel. Hotels |
GET | /api/hotel/v0/hotels/{hotelId}/codes | Get a list of codes for the specified hotel either filtered by type or code. With this call you can find codes |
GET | /api/hotel/v0/hotels/{hotelId}/codes/{id} | Get all the details for a specific code available for the hotel. Read the details about a specific code availa |
GET | /api/hotel/v0/hotels/{hotelId}/rateplans | Get a list of rateplans for the specified hotel id matching the filter criteria. With this call you can find r |
GET | /api/hotel/v0/hotels/{hotelId}/rateplans/$count | Get the count of all rateplans in the hotel matching the given filter criteria. RatePlans |
PUT | /api/hotel/v0/hotels/{hotelId}/rateplans/batch/$rates | Update a list of base rateplans for a given period and a given base price for single occupancy. Currently this |
GET | /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode} | Get all the details for a specific rateplan in the hotel. Read the details about a specific rateplan for the d |
GET | /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates | Get the setup of the daily rates for a specific rateplan and a defined timeperiod. With this call you can read |
PATCH | /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates | Partially update a rate of the specified rateplan for the defined time period. The hetras API is using this Pa |
GET | /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/$count | Get the count of all active and loaded daily rates for the defined rateplan in a specified time period. RatePl |
GET | /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/{businessDay} | Get the setup of a daily rate for a specific business day and rateplan. Read the setup of the daily rate for t |
PATCH | /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/{businessDay} | Partially update a rate of the specified rateplan for a defined business day. The hetras API is using this Pat |
GET | /api/hotel/v0/hotels/{hotelId}/room_types | Get a list with the details of all room types for for the specified hotel id. With this call you can load the |
GET | /api/hotel/v0/hotels/{hotelId}/room_types/{code} | Get all the details for a specific room type in the hotel. With this call you can load the details about a spe |
GET | /api/hotel/v0/hotels/{hotelId}/rooms | Get a list of rooms using the provided filtering and pagination criteria. Find all rooms for the hotel that ma |
GET | /api/hotel/v0/hotels/{hotelId}/rooms/$count | Get the count of all rooms in the hotel matching the given filter criteria. Rooms |
GET | /api/hotel/v0/hotels/{hotelId}/rooms/available | Request available rooms using a given criteria. Rooms |
GET | /api/hotel/v0/hotels/{hotelId}/rooms/{roomNumber} | Get all the details for a specific room in the hotel. With this call you can load the details about a specific |
PATCH | /api/hotel/v0/hotels/{hotelId}/rooms/{roomNumber} | Partially updates a room. The hetras API is using this Patch Specification to partially update an |
PUT | /api/hotel/v0/hotels/{hotelId}/yieldable_rateplans/{rateplanCode}/$rates | Saves Yieldable Rate Prices for existing Yieldable Rateplan. Saves Yieldable Rate Prices for existing Yieldabl |
specification origin: https://developer.hetras.com/swagger/spec/HotelAPIv0.json
hetras Booking API Version 0, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/booking/v0/addons | Get a list of offers for addon services for the specified guest stay details. With the addons request you can |
GET | /api/booking/v0/availability | Gets the availability and occupancy for a specific hotel and timespan. Read past occupancy and future availabi |
GET | /api/booking/v0/blocks | Gets a list of blocks. With this endpoint you can request a list of blocks for the hotel chain. Currently we o |
GET | /api/booking/v0/blocks/$count | Get total blocks count that match the given filter criteria. Blocks |
GET | /api/booking/v0/blocks/{blockCode} | Gets the details for a specific block. Read all informationen about a block including the numbers of blocked r |
GET | /api/booking/v0/bookings | Find bookings matching the given filter criteria. Here you can easily find bookings matching various criteria. |
POST | /api/booking/v0/bookings | Create a new booking. Create a new booking as defined in the requests payload. You can get more information ab |
GET | /api/booking/v0/bookings/$count | Get total count of bookings matchung the given filter criteria. Get the count of all bookings matching your cr |
GET | /api/booking/v0/bookings/{confirmationId} | Load all reservations for one booking by confirmation id. A booking groups all reservations done in one single |
GET | /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber} | Load a specific reservation from a booking. With this request you can load one specific reservation done with |
PATCH | /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber} | Partially updates a reservation. The hetras API is using this Patch Specification to partially up |
POST | /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/assign_room | Assign a room to a reservation. By default this API call assigns a random room, which has the proper room type |
POST | /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/cancel | Cancel one reservation. This request will cancel one specific reservation. It will show up in the hetras UI in |
POST | /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/check_in | Performs a check in operation for a reservation. With this call you can set a reservation to the status inhous |
POST | /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/check_out | Performs a check out operation for a reservation. With this call you can set a reservation to the checkout sta |
PUT | /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/payment_token | Post a payment token for a reservation. TBD. For more details on how the API responds to errors p |
POST | /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/pre_authorize | Performs a chip and pin credit card authorization for a reservation. With this call you can trigger a terminal |
GET | /api/booking/v0/daily_rates | Get a list of daily rates given a hotel Id, a channel code and a date range. With the rates request you can ge |
GET | /api/booking/v0/rates | Get a list of room offers for the specified guest stay details. With the rates request you can get a list of d |
specification origin: https://developer.hetras.com/swagger/spec/BookingAPIv0.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.