Rezlynx API
pmsbkg_GetReservation
This is a lightweight version of the BookingSearch method and it is used to retrieve information for a certain reservation.
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
- Search results consisting of a single reservation
Returned data (Reservation)
Name | Type | Description |
---|---|---|
RoomId | string | Room ID (room number or name) |
BookRef | string | Booking or reservation reference |
RoomPickID | int | Integer indicating which of a multi-room reservation this is (1,2,3,...) |
BookingType | string | Booking or reservation type (see below) |
BookingStatus | int | Integer indicating the corresponding BookingStatus Id in Rezlynx |
RoomTypeCode | string | Room type code |
Arrival | dateTime | Guest planned arrival date (reservation start) |
Departure | dateTime | Guest planned departure date (reservation finish) |
Creation | dateTime | Reservation creation date |
GroupAllotmentRef | string | Group Allotment reference |
MultiRoomReference | string | Free text description field used as a heading for multi-room reservations |
Contact | (object) | Contact person details. If there is a profile linked to the booking, we only return ProfileRef code else we return Salutation, Forename, Surname and Name. |
Company | string | Reference code for company through which reservation made, if applicable. |
Agent | string | Reference code for agent through which reservation made, if applicable. |
Source | string | Reference code for reservation source, if applicable |
Ledger | string | Reference code for ledger, if applicable. |
PostsAllowed | string | Indicates any posting restrictions for the reservation: either "All" (all postings allowed), "None" (no postings allowed) or "CallsOnly" (only phone postings allowed) |
BookRefRoomPickID | string | Long-form booking reference, including Room Pick ID, e.g. "BK000034/1" |
AlarmCall | string | Alarm call time, if set |
MovieAccess | string | Movie Access code, if used |
FunctionBookingDescription | string | Description if function room reservation |
AllowRoomMoves | boolean | Flag to indicate if room moves are allowed |
MarketSegment | string | Market segment, for marketing purposes |
TotalCostNett | decimal | Total cost of the booking (nett of tax) |
TotalCostGross | decimal | Total cost of the booking (gross, including tax) |
LastEdited | dateTime | Date-time the reservation was last edited or changed (not including changes made at a room block, group or multi-room level) |
GDSRef | string | GDS reference, if booking came via an external GDS |
CRSRef1 | string | Rezlynx CRS reference |
CRSRef2 | string | External CRS reference, if reservation came via an external CRS |
SystemSource | string | System origin of this reservation (see below) |
DistributionChannelId | int | Distribution Channel ID, if the reservation came via a distribution channel |
PreCheckIn | boolean | Flag to indicate if pre-checked-in or not (if applicable) |
RezlynxCRS | string | Rezlynx CRS reference |
Booking type must be one of the following:
- "Bedroom" = normal bedroom reservation
- "Function" = function room reservation
- "Nra" = non-resident account, i.e. not linked to a room
- "Master" = master booking
!new in 1.500!
Note Master bookings are dummy room reservations, similar to an NRA but linked to a group or multi-room reservation. Both master bookings and NRAs can be useful for managing accounts. |
SystemSource must be one of the following:
- "Unknown"
- "Rezlynx"
- "PublicPortal"
- "AgentPortal"
- "CorporatePortal"
- "Roomlynx"
- "CRS"
- "BWCRS"
- "WebService"
- "CentralInvoicing"
- "SalesAndCatering"
Request URL
https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservationRequest headers
Name | Type | Description |
---|---|---|
(optional) | string | Media type of the body sent to the API. |
Request body
<pmsbkg_GetReservation xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK0000006273</bookRef>
<roomPickId>1</roomPickId>
</pmsbkg_GetReservation>
Responses
200 OK
Representations
<pmsbkg_GetReservationResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_GetReservationResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
<Reservation>
<BookRef>BK06165</BookRef>
<RoomPickId>1</RoomPickId>
<BookingType>BedRoom</BookingType>
<BookingStatus>1</BookingStatus>
<RoomTypeCode>DOUBLE</RoomTypeCode>
<Arrival>2019-05-03T00:00:00</Arrival>
<Departure>2019-05-04T00:00:00</Departure>
<Creation>2019-05-03T08:14:23</Creation>
<Contact>
<ProfileRef>PF00899</ProfileRef>
</Contact>
<PostsAllowed>All</PostsAllowed>
<BookRefRoomPickID>BK06165/1</BookRefRoomPickID>
<MovieAccess>Children</MovieAccess>
<AllowRoomMoves>true</AllowRoomMoves>
<MarketSegment>MARKETSEGMEN</MarketSegment>
<TotalCostNett>83.3300</TotalCostNett>
<TotalCostGross>100.0000</TotalCostGross>
<LastEdited>2019-05-03T08:14:23</LastEdited>
<SystemSource>Rezlynx</SystemSource>
<DistributionChannelId>1</DistributionChannelId>
<PreCheckIn>false</PreCheckIn>
</Reservation>
</pmsbkg_GetReservationResult>
</pmsbkg_GetReservationResponse>
Code samples
@ECHO OFF
curl -v -X POST "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsbkg_GetReservation"
-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_GetReservation&" + 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_GetReservation");
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_GetReservation" + $.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_GetReservation";
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_GetReservation');
$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_GetReservation%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_GetReservation&%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_GetReservation')
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