### Retrieve Hotel List Request Examples (URL)
Source: https://api.ezeetechnosys.com/index
Examples of GET requests to retrieve hotel lists for single properties and chain properties. These include the base URL, request type, authentication, and language parameters.
```url
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=HotelList&HotelCode=XXXX&APIKey=XXXXXX&language=en
```
```url
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=HotelList&GroupCode=XXXXXX&APIKey=XXXXXX&language=en
```
--------------------------------
### Room List API Request Example
Source: https://api.ezeetechnosys.com/check-availability
This is an example of a GET request to the RoomList API endpoint. It includes parameters for hotel code, API key, dates, occupancy, and other filtering options. Ensure all required parameters are correctly provided for a successful query.
```http
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=RoomList&HotelCode=XX&APIKey=XXXXXX&check_in_date= 2015-07-13&check_out_date=&num_nights=2&number_adults=1 &number_children=0&num_rooms=1&promotion_code=&property_configuration_info=0&showtax=0&show_only_available_rooms=0&language=en&roomtypeunkid=XXXX&packagefor=DESKTOP&promotionfor=DESKTOP
```
--------------------------------
### PHP cURL API Authentication Example
Source: https://api.ezeetechnosys.com/category/fnb
A PHP example demonstrating API authentication using cURL. It shows how to set up a cURL request, including the username and password for Basic Authentication, and send a POST request with JSON data.
```php
```
--------------------------------
### Retrieve Room Rates API Request Example
Source: https://api.ezeetechnosys.com/author/admin
This example demonstrates how to retrieve room rates and availability using the getdataAPI.php endpoint. It requires an HTTP POST request with an XML Content-Type header.
```http
POST https://live.ipms247.com/pmsinterface/getdataAPI.php
Content-Type: application/xml
```
--------------------------------
### Example Request for Confirming a Booking
Source: https://api.ezeetechnosys.com/post-create-bookings-actions
This example demonstrates a sample HTTP GET request to confirm a booking. It includes the necessary parameters and a JSON payload for the Process_Data field, specifying the action and reservation details.
```http
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=ProcessBooking&HotelCode=XXX&APIKey=XXX&Process_Data={"Action":"ConfirmBooking","ReservationNo":"RES522","Inventory_Mode":"XXX","Error_Text":""}
```
--------------------------------
### Get Sales Data API Request Example
Source: https://api.ezeetechnosys.com/menu-copy-copy-copy
This snippet demonstrates how to construct a POST request to the Get Sales Data API endpoint. It includes the endpoint URL, required headers (Content-Type and Authorization), and a sample JSON payload with parameters like hotel_code, fromdate, and todate.
```http
POST /v1/fas/get_sales_data HTTP/1.1
Host: api.ipos247.com
Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}
{
"hotel_code": "XXXX",
"fromdate": "2024-05-16",
"todate": "2024-05-16",
"exclude_roomposting": "0",
"exclude_nocharge": "0"
}
```
--------------------------------
### Example API Request for Booking Insertion
Source: https://api.ezeetechnosys.com/create-a-booking-copy
This is an example of a complete HTTP GET request to the Ezeetechnosys API for inserting a booking. It includes placeholder values for HotelCode and APIKey, and a sample BookingData JSON object with specific reservation details.
```HTTP
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=InsertBooking&HotelCode=xxxxx&APIKey=XXXXXXXXXXXXXXXX&BookingData={"Room_Details":{"Room_1":{"Rateplan_Id":"1872700000000000002","Ratetype_Id":"1872700000000000001","Roomtype_Id":"1872700000000000002","baserate":"3500","extradultrate":"500","extrachildrate":"500","number_adults":"2","number_children":"1","ExtraChild_Age":"2","Title":"","First_Name":"ABC","Last_Name":"Joy","Gender":"","SpecialRequest":""}},"check_in_date":"2021-02-22","check_out_date":"2021-02-23","Booking_Payment_Mode":"","Email_Address":"abc@gmail.com","Source_Id":"","MobileNo":"","Address":"","State":"","Country":"","City":"","Zipcode":"","Fax":"","Device":"","Languagekey":"","paymenttypeunkid":""}
```
--------------------------------
### Room List API Request Example
Source: https://api.ezeetechnosys.com/index
This is an example of a GET request to the RoomList API endpoint. It includes parameters for hotel code, API key, dates, occupancy, and other filtering options. The system calculates per-room rates and does not automatically account for extra adult or child charges.
```HTTP
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=RoomList&HotelCode=XX&APIKey=XXXXXX&check_in_date=2015-07-13&check_out_date=&num_nights=2&number_adults=1 &number_children=0&num_rooms=1&promotion_code=&property_configuration_info=0&showtax=0&show_only_available_rooms=0&language=en&roomtypeunkid=XXXX&packagefor=DESKTOP&promotionfor=DESKTOP
```
--------------------------------
### Get Sales Data API Request Example
Source: https://api.ezeetechnosys.com/category/fnb
This snippet demonstrates how to construct a request to the 'get_sales_data' API endpoint. It includes the endpoint URL, necessary headers, and a sample JSON payload with parameters for hotel code, date range, and exclusion flags.
```HTTP
POST https://api.ipos247.com/v1/fas/get_sales_data
Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}
{
"hotel_code": "XXXX",
"fromdate": "2024-05-16",
"todate": "2024-05-16",
"exclude_roomposting": "0",
"exclude_nocharge": "0"
}
```
--------------------------------
### JavaScript Fetch API Authentication Example
Source: https://api.ezeetechnosys.com/api-authentication-guide
Shows how to use the Fetch API in JavaScript to make a request with HTTP Basic Authentication. It encodes credentials using btoa and sets the Authorization header.
```javascript
const username = "your_username_here";
const password = "your_password_here";
const auth = btoa(`${username}:${password}`);
fetch("https://api.yourdomain.com/v1/resource", {
headers: {
"Authorization": `Basic ${auth}`,
"Accept": "application/json"
}
})
.then(res => res.json())
.then(console.log);
```
--------------------------------
### Making API Calls with C#
Source: https://api.ezeetechnosys.com/index
Presents a C# code example for making API requests to Ezeetechnosys using HttpWebRequest. It shows how to construct the XML payload, set request headers, send the request, and read the response.
```csharp
using System.Net;
using System.IO;
using System.Text;
HttpWebRequest httpRequest = null;
HttpWebResponse httpResponse = null;
Stream httpPostStream = null;
BinaryReader httpResponseStream = null;
string values = "xxxxxxxxxxxxxxxxxgethotelinfo";
byte[] postBytes = null;
string postUrl = "https://live.ipms247.com/index.php/page/service.pos2pms";
httpRequest = (HttpWebRequest)WebRequest.Create(postUrl);
httpRequest.Method = "POST";
httpRequest.ContentType = "application/xml";
postBytes = Encoding.UTF8.GetBytes(values);
httpRequest.ContentLength = postBytes.Length;
httpPostStream = httpRequest.GetRequestStream();
httpPostStream.Write(postBytes, 0, postBytes.Length);
httpPostStream.Close();
httpPostStream = null;
httpResponse = (HttpWebResponse)httpRequest.GetResponse();
httpResponseStream = new BinaryReader(httpResponse.GetResponseStream(), Encoding.UTF8);
byte[] readData;
string text = "";
while (true)
{
readData = httpResponseStream.ReadBytes(4096);
text = text + Encoding.UTF8.GetString(readData, 0, readData.Length);
if (readData.Length == 0)
break;
}
```
--------------------------------
### Example Request for Payment Gateways
Source: https://api.ezeetechnosys.com/retrieve-payment-gateways
An example of a complete HTTP GET request to the payment gateways API. Replace 'XX' with your actual API key and hotel code.
```text
https://live.ipms247.com/booking/reservation_api/listing.php?APIKey=XX&request_type=ConfiguredPGList&HotelCode=XX
```
--------------------------------
### API Ezeetechnosys Response Examples (JSON)
Source: https://api.ezeetechnosys.com/tag/pms-connectivity
Provides example JSON responses for successful and error scenarios when updating room rates via the API. The success response confirms the update, while error responses indicate specific issues like unauthorized requests.
```json
{
"Success": {
"SuccessMsg": " Room Rates Successfully Updated"
},
"Errors": {
"ErrorCode": "0",
"ErrorMessage": "Success"
}
}
```
```json
{
"Errors": {
"ErrorCode": "301",
"ErrorMessage": "Unauthorized Request. Please check hotel code and authentication code"
}
}
```
--------------------------------
### PHP cURL API Authentication Example
Source: https://api.ezeetechnosys.com/api-authentication-guide
Provides an example using PHP cURL to make a POST request with HTTP Basic Authentication. It sets the Authorization header implicitly using CURLOPT_USERPWD.
```php
```
--------------------------------
### GET /listing.php
Source: https://api.ezeetechnosys.com/category/finance
Fetches a list of extra charges for a specified hotel. Requires hotel code, API key, and language.
```APIDOC
## GET /listing.php
### Description
Fetches a list of extra charges applicable to a hotel. This endpoint requires the hotel's unique code, a valid API key for authentication, and the desired language for the charge information.
### Method
GET
### Endpoint
`https://live.ipms247.com/booking/reservation_api/listing.php`
### Parameters
#### Query Parameters
- **request_type** (string) - Required - Specifies the type of request, should be 'ExtraCharges'.
- **HotelCode** (string) - Required - The unique identifier code for the hotel.
- **APIKey** (string) - Required - The API key for authentication.
- **language** (string) - Optional - The language code for the response (e.g., 'en'). Defaults to English if not provided.
### Request Example
```
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=ExtraCharges&HotelCode=XXX&APIKey=XXX&language=en
```
### Response
#### Success Response (200)
- **ExtraChargeId** (string) - Unique identifier for the extra charge.
- **ShortCode** (string) - A short code or name for the extra charge.
- **charge** (string) - The name or description of the extra charge.
- **description** (string) - A detailed description of the extra charge (can be null).
- **Rate** (string) - The rate or price of the extra charge.
- **ChargeRule** (string) - The rule for applying the charge (e.g., 'PERQUANTITY', 'PERBOOKING').
- **PostingRule** (string) - The rule for posting the charge (e.g., 'ONLYCHECKOUT', 'ONLYCHECKIN').
- **ValidFrom** (string) - The date from which the charge is valid (can be null).
- **ValidTo** (string) - The date until which the charge is valid (can be null).
- **ischargealways** (string) - Indicates if the charge is always applied ('0' or '1').
- **applyon_rateplan** (string) - Rate plan(s) on which the charge applies.
- **applyon_special** (string) - Special conditions on which the charge applies.
#### Response Example
```json
[
{
"ExtraChargeId": "XXXXXXXXXXXXXXXXXX",
"ShortCode": "Bottle of Wine on Arrival",
"charge": "Bottle of Wine on Arrival",
"description": null,
"Rate": "500.0000",
"ChargeRule": "PERQUANTITY",
"PostingRule": "ONLYCHECKOUT",
"ValidFrom": null,
"ValidTo": null,
"ischargealways": "0",
"applyon_rateplan": "XXXXXXXXXXXXXXXXXX",
"applyon_special": ""
},
{
"ExtraChargeId": "XXXXXXXXXXXXXXXXXX",
"ShortCode": "Transport",
"charge": "Transport Services",
"description": null,
"Rate": "500.0000",
"ChargeRule": "PERBOOKING",
"PostingRule": "ONLYCHECKIN",
"ValidFrom": null,
"ValidTo": null,
"ischargealways": "0",
"applyon_rateplan": "ALL",
"applyon_special": "ALL"
}
]
```
#### Error Response
(Specific error codes and messages are not detailed in the provided text, but standard HTTP error codes would apply.)
```
--------------------------------
### API Request Example - Service Menu
Source: https://api.ezeetechnosys.com/category/fnb
Demonstrates how to construct a request to the Service Menu endpoint. It includes the necessary URL, headers, and a sample JSON payload with required and optional parameters. The endpoint is used to fetch menu details like outlets, categories, subcategories, and items.
```HTTP
POST https://api.ipos247.com/v1/service/menu
Content-Type: application/json
Authorization: Basic {Base64 encoded username:password}
{
"hotel_code": "XXXX", // Required
"outlet_name": "MainOutlet" // Optional
}
```
--------------------------------
### Getting Started with Sandbox
Source: https://api.ezeetechnosys.com/index
Guidance on setting up and using the YCS Connectivity API with a sandbox property for testing.
```APIDOC
## Getting Started
### Tutorial: Registration – Get a sandbox property
This tutorial guides you through using the YCS Connectivity API with a sandbox property, assuming you are at the "Ready to Test" stage, meaning the property has sufficient content for automated checks.
### Target Audience:
1. Developers working for companies needing to communicate between YCS Cloud Applications and external systems.
2. Developers working for other cloud services that utilize YCS property data (e.g., revenue management systems, cloud POS systems).
3. Developers of on-site applications that mediate communication between YCS and local devices (e.g., POS systems, printers, kiosks).
### Before You Start:
Ensure you have the necessary prerequisites as outlined in the full documentation.
### Trial Period
You will use our YCS Connectivity API with a sandbox property during a trial period. The "About to Expire" stage indicates that API access will cease after a certain point.
### Expire Trial Period
A sandbox account is available for 30 days. After this period, it will expire, and API access will be revoked.
### Trial Period Extension
If you are unable to complete your study or development within the given sandbox period, you may be eligible for an extension. Contact YCS support for details.
```
--------------------------------
### Making API Calls with PHP
Source: https://api.ezeetechnosys.com/index
Offers a PHP code snippet for interacting with the API Ezeetechnosys using cURL. This example demonstrates setting up the URL, data payload, and HTTP headers for a POST request, and handling the response.
```php
xxxxxxxxxxxxxgethotelinfo';
$method = 'POST';
$curl = curl_init();
switch ($method){
case "POST":
curl_setopt($curl, CURLOPT_POST, 1);
if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
break;
case "PUT":
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT");
if ($data)
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
break;
default:
if ($data)
$url = sprintf("%s?%s", $url, http_build_query($data));
}
// OPTIONS:
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
'Content-Type: application/xml',
));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
// EXECUTE:
$result = curl_exec($curl);
if(!$result){die("Connection Failure");}
curl_close($curl);
return $result;
?>
```
--------------------------------
### API Authentication Guide
Source: https://api.ezeetechnosys.com/index
Explains how to authenticate API requests using HTTP Basic Authentication with provided username and password.
```APIDOC
## API Authentication Guide
All F&B API requires **HTTP Basic Authentication**. You will be given a **username** and **password**. Use them in every API request.
### Step 1 — Credentials
```
Username: your_username_here
Password: your_password_here
```
### Step 2 — Authorisation Header
Combine username:password, encode it in Base64, and send it in the header:
```
Authorization: Basic
```
**Example:**
```
Authorization: Basic dGVzdHVzZXI6bXlwYXNzd29yZDEyMw==
```
### Example: JavaScript (Fetch)
```javascript
const username = "your_username_here";
const password = "your_password_here";
const auth = btoa(`${username}:${password}`);
fetch("https://api.yourdomain.com/v1/resource", {
headers: {
"Authorization": `Basic ${auth}`,
"Accept": "application/json"
}
})
.then(res => res.json())
.then(console.log);
```
### Example: PHP (cURL)
```php
```
```
--------------------------------
### GET Bookings - Cancel a Booking
Source: https://api.ezeetechnosys.com/author/admin
This API allows you to cancel bookings in the system. It requires specific request types, hotel codes, API keys, and reservation numbers. The API responds to HTTP GET requests.
```APIDOC
## GET Bookings - Cancel a Booking
### Description
This API allows you to cancel bookings in the system. It requires specific request types, hotel codes, API keys, and reservation numbers. The API responds to HTTP GET requests.
### Method
GET
### Endpoint
[BaseUrl]booking/reservation_api/listing.php?request_type=[Request_Type]&HotelCode=[Hotel_Code]&APIKey=[API_KEY]&ResNo=[ResNo]
### Parameters
#### Query Parameters
- **request_type** (string) - Required - The type of request, should be 'CancelBooking'.
- **HotelCode** (string) - Required - The code of the hotel.
- **APIKey** (string) - Required - Your API key.
- **ResNo** (string) - Required - The reservation number to cancel.
- **language** (string) - Optional - The language for the response (e.g., 'en').
- **SubNo** (string) - Optional - Sub-reservation number, if applicable.
### Request Example
```
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=CancelBooking&HotelCode=xxxx&APIKey=xxxxxxxxxxxxxxxx&language=en&ResNo=167&SubNo=&language=en
```
### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the cancellation (e.g., "Successful").
#### Response Example
```json
{"status":"Successful"}
```
```
--------------------------------
### Example API Request for Booking List
Source: https://api.ezeetechnosys.com/retrieve-a-booking-based-on-parameters
An example of a complete HTTP GET request to the booking listing endpoint. This specific request filters bookings by arrival dates and requires authentication via an API Key.
```HTTP
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=BookingList&HotelCode=XXX&APIKey=XXX&arrival_from=XXX&arrival_to=XXX&EmailId=
```
--------------------------------
### GET /listing.php
Source: https://api.ezeetechnosys.com/check-availability
Retrieves a list of rooms with their rates and availability based on specified criteria.
```APIDOC
## GET /listing.php
### Description
Retrieves a list of available rooms for a hotel, including details on rates, occupancy, and availability for specified dates.
### Method
GET
### Endpoint
`https://live.ipms247.com/booking/reservation_api/listing.php`
### Parameters
#### Query Parameters
- **request_type** (string) - Required - Specifies the type of request, should be 'RoomList'.
- **HotelCode** (string) - Required - The unique identifier for the hotel.
- **APIKey** (string) - Required - Your API key for authentication.
- **check_in_date** (string) - Required - The check-in date in 'YYYY-MM-DD' format.
- **check_out_date** (string) - Optional - The check-out date in 'YYYY-MM-DD' format. If not provided, `num_nights` will be used.
- **num_nights** (integer) - Optional - The number of nights for the stay. Used if `check_out_date` is not provided.
- **number_adults** (integer) - Required - The number of adults.
- **number_children** (integer) - Required - The number of children.
- **num_rooms** (integer) - Required - The number of rooms requested.
- **promotion_code** (string) - Optional - A code for any applicable promotion.
- **property_configuration_info** (integer) - Optional - Flag to include property configuration details (e.g., 0 or 1).
- **showtax** (integer) - Optional - Flag to show tax information (e.g., 0 or 1).
- **show_only_available_rooms** (integer) - Optional - Flag to show only available rooms (e.g., 0 or 1).
- **language** (string) - Optional - The language code for the response (e.g., 'en').
- **roomtypeunkid** (string) - Optional - Unique ID for a specific room type.
- **packagefor** (string) - Optional - Specifies the package context (e.g., 'DESKTOP').
- **promotionfor** (string) - Optional - Specifies the promotion context (e.g., 'DESKTOP').
### Request Example
```
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=RoomList&HotelCode=XX&APIKey=XXXXXX&check_in_date=2015-07-13&check_out_date=&num_nights=2&number_adults=1&number_children=0&num_rooms=1&promotion_code=&property_configuration_info=0&showtax=0&show_only_available_rooms=0&language=en&roomtypeunkid=XXXX&packagefor=DESKTOP&promotionfor=DESKTOP
```
### Response
#### Success Response (200)
An array of room objects, where each object contains details about a specific room type, including its name, description, occupancy limits, rates for different dates, and availability.
#### Response Example
```json
[
{
"Room_Name": "Deluxe EP",
"Room_Description": "Deluxe EP",
"Roomtype_Name": "Deluxe",
"Roomtype_Short_code": "DL",
"Package_Description": "",
"Specials_Desc": "",
"specialconditions": "",
"specialhighlightinclusion": "",
"hotelcode": "XXXX",
"roomtypeunkid": "114000000000000005",
"ratetypeunkid": "114000000000000001",
"roomrateunkid": "114000000000000011",
"base_adult_occupancy": "2",
"base_child_occupancy": "1",
"max_adult_occupancy": "3",
"max_child_occupancy": "2",
"max_occupancy": "",
"inclusion": "dsfsdf",
"available_rooms": {
"2020-11-01": "3",
"2020-11-02": "3"
},
"min_ava_rooms": "3",
"room_rates_info": {
"before_discount_inclusive_tax_adjustment": [],
"exclusive_tax": {
"2020-11-01": "1300.0000",
"2020-11-02": "1300.0000"
},
"exclusivetax_baserate": {
"2020-11-01": "1300.0000",
"2020-11-02": "1300.0000"
},
"tax": [],
"adjustment": {
"2020-11-01": 0,
"2020-11-02": 0
},
"inclusive_tax_adjustment": {
"2020-11-01": 1300,
"2020-11-02": 1300
},
"rack_rate": "1300.0000",
"totalprice_room_only": 2600,
"totalprice_inclusive_all": 2600,
"avg_per_night_before_discount": "",
"avg_per_night_after_discount": 1300,
"avg_per_night_without_tax": 1300,
"day_wise_baserackrate": [
"1300.0000",
"1300.0000"
],
"day_wise_beforediscount": [
"1300.0000",
"1300.0000"
]
},
"extra_adult_rates_info": {
"exclusive_tax": {
"2020-11-01": "800.0000",
"2020-11-02": "800.0000"
},
"tax": [],
"adjustment": {
"2020-11-01": 0,
"2020-11-02": 0
},
"inclusive_tax_adjustment": {
"2020-11-01": 800,
"2020-11-02": 800
},
"rack_rate": "800.0000"
},
"extra_child_rates_info": {
"exclusive_tax": {
"2020-11-01": "500.0000",
"2020-11-02": "500.0000"
},
"tax": [],
"adjustment": {
"2020-11-01": 0,
"2020-11-02": 0
},
"inclusive_tax_adjustment": {
"2020-11-01": 500,
"2020-11-02": 500
},
"rack_rate": "500.0000"
},
"min_nights": {
"2020-11-01": 1,
"2020-11-02": 1
},
"Hotel_amenities": "[]",
"Avg_min_nights": 1,
"max_nights": {
"2020-11-01": "",
"2020-11-02": ""
},
"Avg_max_nights": "",
"check_in_time": "12:00",
"check_out_time": "12:00",
"TaxName": [],
"ShowPriceFormat": "Average Per Night Rate",
"DefaultDisplyCurrencyCode": null,
"deals": "",
"IsPromotion": false,
"Promotion_Code": null,
"Promotion_Description": null,
"Promotion_Name": null,
"Promotion_Id": null,
"Package_Name": "",
"Package_Id": "",
"currency_code": "INR",
"currency_sign": "₹",
"localfolder": "shafinhotels",
"CalDateFormat": "dd-mm-yy",
"ShowTaxInclusiveExclusiveSettings": "1",
"hidefrommetasearch": "",
"prepaid_noncancel_nonrefundable": "0",
"cancellation_deadline": "",
"digits_after_decimal": "2",
"visiblity_nights": "false",
"BookingEngineURL": "/booking/book-rooms-shafinhotels",
"RoomAmenities": "Bed,TV,Refrigerator,AC",
"room_main_image": ""
}
]
```
```
--------------------------------
### GET Bookings - Read a Booking
Source: https://api.ezeetechnosys.com/author/admin
This API helps you to read booking details for a given booking ID. It requires specific request types, hotel codes, API keys, and reservation numbers. The API responds to HTTP GET requests.
```APIDOC
## GET Bookings - Read a Booking
### Description
This API helps you to read booking details for a given booking ID. It requires specific request types, hotel codes, API keys, and reservation numbers. The API responds to HTTP GET requests.
### Method
GET
### Endpoint
[BaseUrl]booking/reservation_api/listing.php?request_type=[Request_Type]&HotelCode=[Hotel_Code]&APIKey=[API_KEY]&ResNo=[ResNo]
### Parameters
#### Query Parameters
- **request_type** (string) - Required - The type of request, should be 'ReadBooking'.
- **HotelCode** (string) - Required - The code of the hotel.
- **APIKey** (string) - Required - Your API key.
- **ResNo** (string) - Required - The reservation number to read.
### Request Example
```
https://live.ipms247.com/booking/reservation_api/listing.php?request_type=ReadBooking&HotelCode=xxxx&APIKey=xxxxxxxxxxxxxxxx&ResNo=167
```
### Response
#### Success Response (200)
- **booking_details** (object) - An object containing the booking details. (Specific fields depend on the actual response structure, which is not fully provided in the input.)
#### Response Example
(Example response structure would be detailed here if provided in the input.)
```
--------------------------------
### HTTP Basic Authentication Header Construction
Source: https://api.ezeetechnosys.com/api-authentication-guide
Demonstrates how to construct the Authorization header for HTTP Basic Authentication by combining username and password, encoding it in Base64.
```General
Authorization: Basic
```
--------------------------------
### GET /v1/service/menu
Source: https://api.ezeetechnosys.com/category/fnb
Retrieves the menu structure including outlets, categories, subcategories, and items for a given hotel code.
```APIDOC
## GET /v1/service/menu
### Description
Retrieves the menu structure including outlets, categories, subcategories, and items for a given hotel code. An optional outlet name can be provided to filter results.
### Method
GET
### Endpoint
https://api.ipos247.com/v1/service/menu
### Parameters
#### Query Parameters
- **hotel_code** (string) - Required - The unique identifier for the hotel.
- **outlet_name** (string) - Optional - The name of the outlet to filter menu items.
### Request Example
```
GET https://api.ipos247.com/v1/service/menu?hotel_code=XXXX&outlet_name=MainOutlet
```
### Headers
- **Content-Type**: application/json
- **Authorization**: Basic {Base64 encoded username:password}
### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the response (e.g., "success").
- **statusCode** (integer) - The HTTP status code (e.g., 200).
- **data** (object) - Contains the menu details:
- **outlets** (array) - List of available outlets.
- **categories** (array) - List of menu categories.
- **subcategories** (array) - List of menu subcategories.
- **items** (array) - List of menu items with their details.
#### Response Example
```json
{
"status": "success",
"statusCode": 200,
"data": {
"outlets": [
{
"outlet_name": "MainOutlet",
"ref_id": "10000000001"
}
],
"categories": [
{
"category_name": "Hot Drinks",
"ref_id": "10000000001"
}
],
"subcategories": [
{
"subcategory_name": "Classic",
"ref_id": "10000000001"
}
],
"items": [
{
"item_name": "Blueberry",
"Item Code": "376",
"Unit Price": "75.2381",
"category_ref_id": [
"10000000001"
],
"subcategory_ref_id": [
"10000000001"
],
"outlet_ref_id": [
"10000000001"
],
"description": ""
}
]
}
}
```
#### Error Response (400)
- **status** (string) - Indicates the status of the response (e.g., "warning").
- **statusCode** (integer) - The HTTP status code (e.g., 400).
- **message** (string) - A message describing the error.
#### Error Response Example
```json
{
"status": "warning",
"statusCode": 400,
"message": "Please Enter Valid Outlet Name"
}
```
```
--------------------------------
### Create Booking Payload Example
Source: https://api.ezeetechnosys.com/retrieve-all-bookings
This JSON object represents the payload structure for creating a new booking. It includes details about the reservation, guest information, and payment method. The 'IsChannelBooking' field indicates if the booking originated from a channel.
```json
{
"Reservations": [
{
"Reservation": {
"LocationId": "1234",
"UniqueID": "12345254",
"BookedBy": "BookingEye",
"Salutation": "Ms.",
"FirstName": "Valentina",
"LastName": "Riter",
"Gender": "Female",
"Address": "",
"City": "Charlotte",
"State": "Charlotte",
"Country": "NC",
"Zipcode": "28202",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "ValentinaNRiter@jourrapide.com",
"Source": "BookingEye",
"PaymentMethod": "Cash",
"IsChannelBooking": "1"
},
"RoomDetails": [
{
"Child": "2",
"RentPreTax": "250.00",
"Rent": "305.00",
"Discount": "0.00"
}
]
}
]
}
```