Rezlynx API
pmsbkg_GetReservationProducts
This method retrieves the products added to a booking, that are NOT part of the rate plan used.
Note! This API method uses SOAP header authentication, it does not use a Session ID obtained from LogIn method like most PMS methods. See Common to all API methods. |
Parameters
Name | Type | Description |
---|---|---|
bookRef | string | Booking or reservation reference |
roomPickID | int | Integer indicating which of a multi-room reservation this is (1,2,3,...) |
Returned data collection of (ReservationProduct)
Name | Type | Description |
---|---|---|
Id | int | Id of this specific reservation's product |
ProductCode | string | Product code |
Quantity | int | Quantity, for Custom PostingMode it will be set to 0 |
Value | decimal | Net value, for Custom PostingMode it will be set to 0 |
ChargeMode | string | Product charge mode (basis on which product is charged, e.g. per adult or per room) |
PostingMode | object | Object that aggregates the PostingMode selected in Rezlynx for that specific Product |
> Simple | object | If the Product for the Reservation is created using Simple mode, it will be represented by this object |
>> DayOfArrival | boolean | Flag to indicate if Product is sold for the day of arrival |
>> ResidentDays | boolean | Flag to indicate if Product is sold for the resident days |
>> DayOfCheckout | boolean | Flag to indicate if Product is sold for the day of checkout |
>> Custom | object | If the Product for the Reservation is created using Custom mode, it will be represented by this object |
>> PostingItems | object | Collection of posting details |
>>> PostingItem | object | Each combination of date, quantity and value will be represented by this object |
>>>> ForDate | dateTime | Date used for this specific quantity and value combination |
>>>> Quantity | int | Quantity |
>>>> Value | decimal | Net value |
> Rhythm | object | If the Product for the Reservation is created using Rhythm mode, it will be represented by this object |
>> Night1 | boolean | Flag to indicate if Product is sold for the first night |
>> Night2 | boolean | Flag to indicate if Product is sold for the second night |
>> Night3 | boolean | Flag to indicate if Product is sold for the third night |
>> Night4 | boolean | Flag to indicate if Product is sold for the fourth night |
>> Night5 | boolean | Flag to indicate if Product is sold for the fifth night |
>> Night6 | boolean | Flag to indicate if Product is sold for the sixth night |
>> Night7 | boolean | Flag to indicate if Product is sold for the seventh night |
>> Night8 | boolean | Flag to indicate if Product is sold for the eighth night |
>> Night9 | boolean | Flag to indicate if Product is sold for the ninth night |
>> Night10 | boolean | Flag to indicate if Product is sold for the tenth night |
>> Night11 | boolean | Flag to indicate if Product is sold for the eleventh night |
>> Night12 | boolean | Flag to indicate if Product is sold for the twelfth night |
>> Night13 | boolean | Flag to indicate if Product is sold for the thirteenth night |
>> Night14 | boolean | Flag to indicate if Product is sold for the fourteenth night |
ChargeMode must be one of the following:
- "PerRoom"
- "PerPerson"
- "PerAdult"
- "PerChild"
- "PerInfant"
- "SingleCharge"
- "DailyPerRoom"
- "DailyPerDelegate"
- "HourlyPerRoom"
- "HourlyPerDelegate"
- "FunctionSingleCharge"
Request URL
https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservationProductsRequest headers
Name | Type | Description |
---|---|---|
(optional) | string | Media type of the body sent to the API. |
Request body
<pmsbkg_GetReservationProducts xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK0000006313</bookRef>
<roomPickId>1</roomPickId>
</pmsbkg_GetReservationProducts>
Responses
200 OK
Representations
<pmsbkg_GetReservationProductsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_GetReservationProductsResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
<ReservationProducts>
<ReservationProduct>
<Id>5071</Id>
<ProductCode>CHIO</ProductCode>
<Quantity>2</Quantity>
<Value>3.2000</Value>
<ChargeMode>PerRoom</ChargeMode>
<PostingMode>
<Simple>
<DayOfArrival>true</DayOfArrival>
<ResidentDays>true</ResidentDays>
<DayOfCheckout>false</DayOfCheckout>
</Simple>
</PostingMode>
</ReservationProduct>
<ReservationProduct>
<Id>5072</Id>
<ProductCode>COKE</ProductCode>
<Quantity>1</Quantity>
<Value>2.0000</Value>
<ChargeMode>PerRoom</ChargeMode>
<PostingMode>
<Rhythm>
<Night1>true</Night1>
<Night2>false</Night2>
<Night3>false</Night3>
<Night4>false</Night4>
<Night5>false</Night5>
<Night6>false</Night6>
<Night7>false</Night7>
<Night8>false</Night8>
<Night9>false</Night9>
<Night10>false</Night10>
<Night11>false</Night11>
<Night12>false</Night12>
<Night13>false</Night13>
<Night14>false</Night14>
</Rhythm>
</PostingMode>
</ReservationProduct>
<ReservationProduct>
<Id>5073</Id>
<ProductCode>LAPTE</ProductCode>
<Quantity>0</Quantity>
<Value>0</Value>
<ChargeMode>PerRoom</ChargeMode>
<PostingMode>
<Custom>
<PostingItems>
<PostingItem>
<ForDate>2019-09-24T00:00:00</ForDate>
<Quantity>1</Quantity>
<Value>15.0000</Value>
</PostingItem>
<PostingItem>
<ForDate>2019-09-25T00:00:00</ForDate>
<Quantity>1</Quantity>
<Value>15.0000</Value>
</PostingItem>
</PostingItems>
</Custom>
</PostingMode>
</ReservationProduct>
</ReservationProducts>
</pmsbkg_GetReservationProductsResult>
</pmsbkg_GetReservationProductsResponse>
Code samples
@ECHO OFF
curl -v -X POST "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservationProducts"
-H "Content-Type: text/xml"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
var uri = "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservationProducts&" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservationProducts");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "text/xml");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservationProducts" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","text/xml");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservationProducts";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"text/xml" forHTTPHeaderField:@"Content-Type"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservationProducts');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'text/xml',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'text/xml',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx')
conn.request("POST", "pmsbkg_GetReservationProducts%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'text/xml',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('developers.azure-api.net')
conn.request("POST", "/rezlynx-web-service/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsbkg_GetReservationProducts&%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservationProducts')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'text/xml'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body