Rezlynx API

pmsfoh_GetDeparturesExtended

Retrieve a list of all departures on a specified date, i.e. resident guests scheduled to check-out on that day, but also with some additional information such as email address, arrival date, departure date and number of nights. A profile attribute parameter can also be specified to fetch custom attribute values stored against the guest profile.

Parameters

NameTypeDescription
SessionIDstringSession ID, obtained at log-in
DepartureDatedateTimeDeparture date
ProfileAttributestringName of profile attribute (optional)

Returned data (departure)

NameTypeDescription
DepositPaiddecimalAmount of any deposit paid
InfantsintNumber of infants
ChildrenintNumber of children
AdultsintNumber of adults
RoomTypestringRoom type
PackagestringPackage code
CompanystringCompany name, if applicable
NotesstringNotes
BookRefstringBooking or reservation reference, e.g. 'BK000070'
BookRefRoomRefstringLong-format booking or reservation reference, e.g. 'BK000070/1'
ETAdateTimeEstimated time of arrival
SalutationstringGuest form of address or title
SurnamestringGuest surname
ForenamestringGuest forename
RoomIDstringRoom reference (room name or number)
EmailstringE-mail address
ProfileReferencestringProfile reference
ArrivaldateTimeDate of arrival
DeparturedateTimeDate of departure
TotalNightsintTotal number of nights of stay
AttributeValuestringProfile attribute value for specified profile attribute, if requested
ETDdateTimeEstimated time of departure
PrivateNotesstringNotes (private)
PublicNotesstringNotes (public)
CustomNotes1stringNotes (custom #1)
CustomNotes2stringNotes (custom #2)
CustomNotes3stringNotes (custom #3)
ExternalNotesstringNotes (external)
MasterbooleanFlag set to true if master booking
RoomBalancedecimalAmount of balance due
BookingType"Bedroom", "Function" or "Nra"Booking type (bedroom, function room or non-resident account)

Request URL

https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsfoh_GetDeparturesExtended

Request headers

Name Type Description
(optional) string Media type of the body sent to the API.

Request body

<pmsfoh_GetDeparturesExtended  xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
  <SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
  <DepartureDate>2018-06-14T15:14:00</DepartureDate>
  <ProfileAttribute>???</ProfileAttribute>
  <GetDeparturesListExtended />
</pmsfoh_GetDeparturesExtended>

Responses

200 OK

Representations

<pmsfoh_GetDeparturesExtendedResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
  <pmsfoh_GetDeparturesExtendedResult>
    <ExceptionCode>0</ExceptionCode>
    <ExceptionDescription>No error</ExceptionDescription>
  </pmsfoh_GetDeparturesExtendedResult>
  <GetDeparturesListExtended>
    <ReservationDepartureItemExtended>
      <DepositPaid>0</DepositPaid>
      <Infants>0</Infants>
      <Children>0</Children>
      <Adults>1</Adults>
      <RoomType>COTTAGE_1</RoomType>
      <Package>24_HOUR</Package>
      <Company />
      <Notes />
      <BookRef>BK000073</BookRef>
      <BookRefRoomRef>BK000073/1</BookRefRoomRef>
      <ETA>1899-12-30T00:00:00</ETA>
      <Salutation>Mr</Salutation>
      <Surname>Jones</Surname>
      <ForeName>Chris</ForeName>
      <RoomID />
      <ProfileReference />
      <Arrival>2018-06-28T00:00:00</Arrival>
      <Departure>2018-06-29T00:00:00</Departure>
      <TotalNights>1</TotalNights>
      <ETD>1899-12-30T00:00:00</ETD>
      <PrivateNotes />
      <PublicNotes />
      <CustomNotes1 />
      <CustomNotes2 />
      <CustomNotes3 />
      <ExternalNotes />
      <Master>false</Master>
      <RoomBalance>0</RoomBalance>
      <BookingType>Bedroom</BookingType>
    </ReservationDepartureItemExtended>
  </GetDeparturesListExtended>
</pmsfoh_GetDeparturesExtendedResponse>

Code samples

@ECHO OFF



curl -v -X POST "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsfoh_GetDeparturesExtended"
-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=pmsfoh_GetDeparturesExtended&" + 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=pmsfoh_GetDeparturesExtended");


            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=pmsfoh_GetDeparturesExtended" + $.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=pmsfoh_GetDeparturesExtended";
    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=pmsfoh_GetDeparturesExtended');
$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", "pmsfoh_GetDeparturesExtended%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/pmsfoh_GetDeparturesExtended&%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=pmsfoh_GetDeparturesExtended')


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