Rezlynx API

pmsint_GetRoomsByStatusCode

Get a list of all rooms based on their occupancy status, e.g. all occupied rooms or all out-of-service rooms.

Parameters

Name Type Description
SessionID string Session ID, obtained at log-in
StatusCode int Room status code to search against (numeric code)

Room status codes are as follows:

  • 2000 = Out of service
  • 2001 = Occupied
  • 2002 = Vacant
More Room Status codes

Returned data (per room)

Name Type Description
strRoomID string Room reference (room name or number)
iRFlag long (internal flag, indicates if record marked for deletion)
strRoomDescription string Room description
strSubGroupCode string Sub-group
strOwnerCode string Owner
strRoomTypeCode string Room type
dtAvailableFrom dateTime Date from when room available
iStatus long Room occupancy status code (numeric)
iHKStatus long Housekeeping status code (numeric)
strHKCode string Housekeeping status code (text)
iAAPriority long Auto-Allocate priority number (highest numbers allocated first)
strNextToRoomID string Adjacent room reference, if used
strTelNo1 string Telephone extension number #1
strTelNo2 string Telephone extension number #2
strTelNo3 string Telephone extension number #3
strTelNo4 string Telephone extension number #4
strTag1 string Tag #1
strTag2 string Tag #2
iSmoke long Smoking room flag
iPAX long Capacity, in number of persons
iRoomIDClass long Room class
iParam2 long Parameter #2 (number)
strNotes string Notes
iParam1 long Parameter #1 (number)

Request URL

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

Request headers

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

Request body

<pmsint_GetRoomsByStatusCode xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
  <SessionID>918d8ea2-0276-4816-9c73-6af50e8de0a4</SessionID>
  <StatusCode>2100</StatusCode>
</pmsint_GetRoomsByStatusCode>

Responses

200 OK

Representations

<pmsint_GetRoomsByStatusCodeResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
  <pmsint_GetRoomsByStatusCodeResult>
    <ExceptionCode>0</ExceptionCode>
    <ExceptionDescription>No error</ExceptionDescription>
  </pmsint_GetRoomsByStatusCodeResult>
  <GetStatusCodes>
    <Rooms>
      <cpmsint_GetRoomsByStatusCode_Room>
        <strRoomID>102</strRoomID>
        <iRFlag>0</iRFlag>
        <strRoomDescription>Daisy Room</strRoomDescription>
        <strSubGroupCode>DAISY</strSubGroupCode>
        <strOwnerCode />
        <strRoomTypeCode>DBL_SUPERIOR</strRoomTypeCode>
        <dtAvailableFrom>1899-12-30T00:00:00</dtAvailableFrom>
        <iStatus>2100</iStatus>
        <iHKStatus>1300</iHKStatus>
        <strHKCode />
        <iAAPriority>0</iAAPriority>
        <strNextToRoomID>101</strNextToRoomID>
        <strTelNo1 />
        <strTelNo2 />
        <strTelNo3 />
        <strTelNo4 />
        <strTag1 />
        <strTag2 />
        <iSmoke>0</iSmoke>
        <iPAX>2</iPAX>
        <iRoomIDClass>0</iRoomIDClass>
        <iParam2>0</iParam2>
        <strNotes />
        <iParam1>0</iParam1>
      </cpmsint_GetRoomsByStatusCode_Room>
      <cpmsint_GetRoomsByStatusCode_Room>
        <strRoomID>103</strRoomID>
        <iRFlag>0</iRFlag>
        <strRoomDescription>Primrose Room</strRoomDescription>
        <strSubGroupCode>PRIMROSE</strSubGroupCode>
        <strOwnerCode />
        <strRoomTypeCode>DBL_SUPERIOR</strRoomTypeCode>
        <dtAvailableFrom>1899-12-30T00:00:00</dtAvailableFrom>
        <iStatus>2100</iStatus>
        <iHKStatus>1300</iHKStatus>
        <strHKCode />
        <iAAPriority>0</iAAPriority>
        <strNextToRoomID>102</strNextToRoomID>
        <strTelNo1 />
        <strTelNo2 />
        <strTelNo3 />
        <strTelNo4 />
        <strTag1 />
        <strTag2 />
        <iSmoke>0</iSmoke>
        <iPAX>2</iPAX>
        <iRoomIDClass>0</iRoomIDClass>
        <iParam2>0</iParam2>
        <strNotes />
        <iParam1>0</iParam1>
      </cpmsint_GetRoomsByStatusCode_Room>
      <cpmsint_GetRoomsByStatusCode_Room>
        <strRoomID>901</strRoomID>
        <iRFlag>0</iRFlag>
        <strRoomDescription>The Ballroom</strRoomDescription>
        <strSubGroupCode>FUNCTIONS</strSubGroupCode>
        <strOwnerCode />
        <strRoomTypeCode>FUNCTION</strRoomTypeCode>
        <dtAvailableFrom>1899-12-30T00:00:00</dtAvailableFrom>
        <iStatus>2100</iStatus>
        <iHKStatus>1200</iHKStatus>
        <strHKCode />
        <iAAPriority>0</iAAPriority>
        <strNextToRoomID />
        <strTelNo1 />
        <strTelNo2 />
        <strTelNo3 />
        <strTelNo4 />
        <strTag1 />
        <strTag2 />
        <iSmoke>0</iSmoke>
        <iPAX>0</iPAX>
        <iRoomIDClass>50</iRoomIDClass>
        <iParam2>0</iParam2>
        <strNotes />
        <iParam1>0</iParam1>
      </cpmsint_GetRoomsByStatusCode_Room>
      <cpmsint_GetRoomsByStatusCode_Room>
        <strRoomID>BLUEROOM</strRoomID>
        <iRFlag>0</iRFlag>
        <strRoomDescription>Blue Room</strRoomDescription>
        <strSubGroupCode>FIRST_FLOOR</strSubGroupCode>
        <strOwnerCode />
        <strRoomTypeCode>DBL_SUPERIOR</strRoomTypeCode>
        <dtAvailableFrom>1899-12-30T00:00:00</dtAvailableFrom>
        <iStatus>2100</iStatus>
        <iHKStatus>1300</iHKStatus>
        <strHKCode />
        <iAAPriority>0</iAAPriority>
        <strNextToRoomID />
        <strTelNo1 />
        <strTelNo2 />
        <strTelNo3 />
        <strTelNo4 />
        <strTag1 />
        <strTag2 />
        <iSmoke>0</iSmoke>
        <iPAX>0</iPAX>
        <iRoomIDClass>0</iRoomIDClass>
        <iParam2>0</iParam2>
        <strNotes />
        <iParam1>0</iParam1>
      </cpmsint_GetRoomsByStatusCode_Room>
    </Rooms>
  </GetStatusCodes>
</pmsint_GetRoomsByStatusCodeResponse>

Code samples

@ECHO OFF



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


            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_GetRoomsByStatusCode" + $.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_GetRoomsByStatusCode";
    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_GetRoomsByStatusCode');
$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_GetRoomsByStatusCode%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_GetRoomsByStatusCode&%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_GetRoomsByStatusCode')


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