Rezlynx API
pmsint_GetResidents
Retrieves a list of resident bookings, either currently resident (if no dates are provided), or over a specified period (if dates are given).
Parameters
Name | Type | Description |
---|---|---|
SessionID | string | Session ID, obtained at log-in |
FromDate | dateTime | Optional from-date |
ToDate | dateTime | Optional to-date |
BookingType | "bkt_Bedroom", "bkt_FunctionRoom" or "bkt_NRA" | Booking type - either bedroom, function room, NRA (Non Resident Account), or all (if nothing specified) |
Returned data (resident)
Name | Type | Description |
---|---|---|
DepositPaid | decimal | Amount of deposit already paid |
DepositDue | decimal | Amount of deposit due |
Infants | int | Number of infants |
Children | int | Number of children |
Adults | int | Number of adults |
RoomType | string | Room type code |
Package | string | Package code |
Company | string | Company name |
Notes | string | Optional notes |
BookRef | string | Reservation or booking reference |
BookRefRoomRef | string | Long-format reservation reference, e.g. "BK000054/1" |
ETA | dateTime | Estimated time of arrival |
Arrival | dateTime | Arrival date |
Departure | dateTime | Departure date |
Salutation | string | Guest form of address |
Surname | string | Guest surname |
Forename | string | Guest forename |
RoomID | string | Room reference (room number or name) |
MovieAccess | string | Movie Access code |
PrivateNotes | string | Notes (private) |
PublicNotes | string | Notes (public) |
CustomNotes1 | string | Notes (custom #1) |
CustomNotes2 | string | Notes (custom #2) |
CustomNotes3 | string | Notes (custom #3) |
ExternalNotes | string | Notes (external) |
Master | boolean | Master reservation flag |
Request URL
https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetResidentsRequest headers
Name | Type | Description |
---|---|---|
(optional) | string | Media type of the body sent to the API. |
Request body
<pmsint_GetResidents xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>918d8ea2-0276-4816-9c73-6af50e8de0a4</SessionID>
<FromDate>2018-05-01T10:31:59</FromDate>
<ToDate>2018-05-31T10:31:59</ToDate>
<BookingType xsi:nil="true" />
</pmsint_GetResidents>
Responses
200 OK
Representations
<pmsint_GetResidentsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetResidentsResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetResidentsResult>
<GetResidents>
<Residents>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>PENTHOUSE</RoomType>
<Package>BAR_BB</Package>
<Company />
<Notes />
<BookRef>BK000051</BookRef>
<BookRefRoomRef>BK000051/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-05T00:00:00</Arrival>
<Departure>2018-05-08T00:00:00</Departure>
<Salutation />
<Surname>Galli</Surname>
<Forename>Matteo</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>-7.7700</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_2</RoomType>
<Package>BAR_BB</Package>
<Company />
<Notes />
<BookRef>BK000052</BookRef>
<BookRefRoomRef>BK000052/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-09T00:00:00</Arrival>
<Departure>2018-05-16T00:00:00</Departure>
<Salutation>Mr</Salutation>
<Surname>Adams</Surname>
<Forename>Mike</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>BAR_RO</Package>
<Company />
<Notes />
<BookRef>BK000053</BookRef>
<BookRefRoomRef>BK000053/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-16T00:00:00</Arrival>
<Departure>2018-05-19T00:00:00</Departure>
<Salutation />
<Surname>Galli</Surname>
<Forename>Matteo</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>BAR_RO</Package>
<Company />
<Notes />
<BookRef>BK000054</BookRef>
<BookRefRoomRef>BK000054/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-15T00:00:00</Arrival>
<Departure>2018-05-18T00:00:00</Departure>
<Salutation />
<Surname>Galli</Surname>
<Forename>Matteo</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>INC_FULL</Package>
<Company />
<Notes />
<BookRef>BK000055</BookRef>
<BookRefRoomRef>BK000055/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-10T00:00:00</Arrival>
<Departure>2018-05-11T00:00:00</Departure>
<Salutation />
<Surname>Adams</Surname>
<Forename />
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>INC_FULL</Package>
<Company>Boots The Chemist</Company>
<Notes />
<BookRef>BK000044</BookRef>
<BookRefRoomRef>BK000044/3</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-01T00:00:00</Arrival>
<Departure>2018-05-03T00:00:00</Departure>
<Salutation />
<Surname>Adams Doggie</Surname>
<Forename />
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_1</RoomType>
<Package>FLOWER_SHOW</Package>
<Company />
<Notes />
<BookRef>BK000058</BookRef>
<BookRefRoomRef>BK000058/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-23T00:00:00</Arrival>
<Departure>2018-05-24T00:00:00</Departure>
<Salutation>Mr</Salutation>
<Surname>Smith</Surname>
<Forename />
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_1</RoomType>
<Package>24_HOUR</Package>
<Company />
<Notes />
<BookRef>BK000059</BookRef>
<BookRefRoomRef>BK000059/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-29T00:00:00</Arrival>
<Departure>2018-05-30T00:00:00</Departure>
<Salutation>Mrs</Salutation>
<Surname>Windsor</Surname>
<Forename>Elizabeth</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_SUPERIOR</RoomType>
<Package>INC_FULL</Package>
<Company />
<Notes />
<BookRef>BK000050</BookRef>
<BookRefRoomRef>BK000050/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-01T00:00:00</Arrival>
<Departure>2018-05-02T00:00:00</Departure>
<Salutation>Ms</Salutation>
<Surname>Bobbin</Surname>
<Forename>Claire</Forename>
<RoomID>104</RoomID>
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>FUNCTION</RoomType>
<Package>FUNC_RO_HALF</Package>
<Company />
<Notes />
<BookRef>BK000056</BookRef>
<BookRefRoomRef>BK000056/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-10T09:00:00</Arrival>
<Departure>2018-05-18T00:00:00</Departure>
<Salutation>Mr</Salutation>
<Surname>Adams</Surname>
<Forename>Mike</Forename>
<RoomID>901</RoomID>
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_1</RoomType>
<Package>24_HOUR</Package>
<Company />
<Notes>guest likes extra pillows</Notes>
<BookRef>BK000057</BookRef>
<BookRefRoomRef>BK000057/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-17T00:00:00</Arrival>
<Departure>2018-05-18T00:00:00</Departure>
<Salutation>Mr</Salutation>
<Surname>Agg</Surname>
<Forename>James</Forename>
<RoomID>COTAMARYLLIS</RoomID>
<MovieAccess />
<PrivateNotes>guest likes extra pillows</PrivateNotes>
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
</Residents>
</GetResidents>
</pmsint_GetResidentsResponse>
Code samples
@ECHO OFF
curl -v -X POST "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetResidents"
-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=pmsint_GetResidents&" + 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=pmsint_GetResidents");
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=pmsint_GetResidents" + $.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=pmsint_GetResidents";
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=pmsint_GetResidents');
$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", "pmsint_GetResidents%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/pmsint_GetResidents&%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=pmsint_GetResidents')
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