Rezlynx API

cnb_GetFunctionBooking

Fetch all the details about a specific function booking.

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 Function booking reference

Returned data

Name Type Description
FunctionRef string Function booking reference
EventRef string Event reference
FunctionType string Function type
FunctionName string Function name
FunctionStatus string Function status (see below)
StartDate dateTime Function start date-time
EndDate dateTime Function end date-time
Delegates int Number of delegates
FunctionRoom string Function room reference
FunctionLayout string Function layout code
FunctionRate string Function rate
FunctionNotes string Applicable notes
FunRoomLayoutsForFunRoomID (object) Function room layouts, if applicable

Returned data (function room layout)

Name Type Description
FunctionRoomLayoutId int Layout ID
LayoutCode string Layout code
FunctionRoomId int Function room ID
MinCapacity int Minimum room capacity with this layout
MaxCapacity int Maximum room capacity with this layout
SetupTime int Layout set-up time
BreakdownTime int Layout breakdown time
PictureId int Picture ID, if applicable
LayoutDescription string Layout description
DefaultLayout Boolean Is this the default layout?

Function status is one of the following:

  • "ude_UserDefined1"
  • "ude_UserDefined2"
  • "ude_UserDefined3"
  • "ude_UserDefined4"
  • "ude_UserDefined5"
  • "ude_UserDefined6"
  • "ude_UserDefined7"
  • "ude_UserDefined8"
  • "ude_UserDefined9"
  • "ude_UserDefined10"
  • "ude_UserDefined11"
  • "ude_UserDefined12"
  • "ude_WaitList"
  • "ude_Cancelled"
  • "ude_Resident"
  • "ude_CheckedOut"
  • "ude_NoShow"

Request URL

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

Request headers

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

Request body

<cnb_GetFunctionBooking xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
  <bookRef>BK00000043</bookRef>
</cnb_GetFunctionBooking>

Responses

200 OK

Representations

<cnb_GetFunctionBookingResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
  <cnb_GetFunctionBookingResult>
    <FunctionRef>BK00000043</FunctionRef>
    <EventRef>EVNT00022</EventRef>
    <FunctionType>FDM</FunctionType>
    <FunctionName>Full Day Meeting</FunctionName>
    <FunctionStatus>ude_UserDefined1</FunctionStatus>
    <StartDate>2019-06-01T09:00:00</StartDate>
    <EndDate>2019-06-01T17:00:00</EndDate>
    <Delegates>100</Delegates>
    <FunctionRoom>1004</FunctionRoom>
    <FunctionLayout>CABERET</FunctionLayout>
    <FunctionRate>ROOM_HIRE</FunctionRate>
    <FunctionNotes />
    <FunRoomLayoutsForFunRoomID>
      <FunctionRoomLayoutsForFunRoomDTO>
        <FunctionRoomLayoutId>3</FunctionRoomLayoutId>
        <LayoutCode>CABERET</LayoutCode>
        <FunctionRoomId>4</FunctionRoomId>
        <MinCapacity>50</MinCapacity>
        <MaxCapacity>200</MaxCapacity>
        <SetupTime>60</SetupTime>
        <BreakdownTime>60</BreakdownTime>
        <PictureId>0</PictureId>
        <LayoutDescription>Caberet</LayoutDescription>
        <DefaultLayout>true</DefaultLayout>
      </FunctionRoomLayoutsForFunRoomDTO>
    </FunRoomLayoutsForFunRoomID>
  </cnb_GetFunctionBookingResult>
</cnb_GetFunctionBookingResponse>

Code samples

@ECHO OFF



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


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


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