Rezlynx API

pmscfg_GetAttributeConfiguration

This method can be used to get the attribute configuration for companies, enquiries, profiles, reservation and rooms

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
systemArea string Optional. We can filter the data on the server, passing a comma separated list of system areas (ex. profiles,company). When left blank it will return all the data

Returned data

  • Search results consisting of a set of attribute configuration objects

Returned data collection of (AttributeConfiguration)

Name Type Description
SystemArea string Origin of the system area (Company, Profile, Enquiry, Reservation or Room)
Code string Attribute code
Description string Attribute description
FieldType string Type of the field (SmallText, LargeText, Number, Date, YesNo or List)
DefaultValue string Default value for this attribute
ListOptions object Only for type List. Represents a set of ListOption objects
> ListOption object Only for type List. Represents a specific ListOption object
>> Value string Only for type List. Represents a text set for this ListOption object

Request URL

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

Request headers

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

Request body

<pmscfg_GetAttributeConfiguration xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
    <systemArea>profile,company</systemArea>    
</pmscfg_GetAttributeConfiguration>

Responses

200 OK

Representations

<pmscfg_GetAttributeConfigurationResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
    <pmscfg_GetAttributeConfigurationResult>
        <ResponseCode>0</ResponseCode>
        <ResponseDescription>No error</ResponseDescription>
        <AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Company</SystemArea>
                <Code>DATE</Code>
                <Description>Date</Description>
                <FieldType>Date</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Company</SystemArea>
                <Code>LARGE</Code>
                <Description>Large</Description>
                <FieldType>LargeText</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Company</SystemArea>
                <Code>LIST</Code>
                <Description>List</Description>
                <FieldType>List</FieldType>
                <DefaultValue />
                <ListOptions>
                    <ListOption>
                        <Value />
                    </ListOption>
                    <ListOption>
                        <Value>1</Value>
                    </ListOption>
                    <ListOption>
                        <Value>2</Value>
                    </ListOption>
                    <ListOption>
                        <Value>3</Value>
                    </ListOption>
                </ListOptions>
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Company</SystemArea>
                <Code>NUMBER</Code>
                <Description>Number</Description>
                <FieldType>Number</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Company</SystemArea>
                <Code>SMALL</Code>
                <Description>Small</Description>
                <FieldType>SmallText</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Company</SystemArea>
                <Code>YES_NO</Code>
                <Description>Yes / No</Description>
                <FieldType>YesNo</FieldType>
                <DefaultValue>Yes</DefaultValue>
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Profile</SystemArea>
                <Code>SMALL</Code>
                <Description>Small</Description>
                <FieldType>SmallText</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Profile</SystemArea>
                <Code>LARGE</Code>
                <Description>Large</Description>
                <FieldType>LargeText</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Profile</SystemArea>
                <Code>DATE</Code>
                <Description>Date</Description>
                <FieldType>Date</FieldType>
                <DefaultValue>01/01/0001</DefaultValue>
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Profile</SystemArea>
                <Code>NUMBER</Code>
                <Description>Number</Description>
                <FieldType>Number</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Profile</SystemArea>
                <Code>YES_NO</Code>
                <Description>Yes / No</Description>
                <FieldType>YesNo</FieldType>
                <DefaultValue>Yes</DefaultValue>
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Profile</SystemArea>
                <Code>LIST</Code>
                <Description>List</Description>
                <FieldType>List</FieldType>
                <DefaultValue />
                <ListOptions>
                    <ListOption>
                        <Value />
                    </ListOption>
                    <ListOption>
                        <Value>1</Value>
                    </ListOption>
                    <ListOption>
                        <Value>2</Value>
                    </ListOption>
                    <ListOption>
                        <Value>3</Value>
                    </ListOption>
                </ListOptions>
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Reservation</SystemArea>
                <Code>DATE</Code>
                <Description>Date</Description>
                <FieldType>Date</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Reservation</SystemArea>
                <Code>LARGE</Code>
                <Description>Large</Description>
                <FieldType>LargeText</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Reservation</SystemArea>
                <Code>LIST</Code>
                <Description>List</Description>
                <FieldType>List</FieldType>
                <DefaultValue />
                <ListOptions>
                    <ListOption>
                        <Value />
                    </ListOption>
                    <ListOption>
                        <Value>1</Value>
                    </ListOption>
                    <ListOption>
                        <Value>2</Value>
                    </ListOption>
                    <ListOption>
                        <Value>3</Value>
                    </ListOption>
                </ListOptions>
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Reservation</SystemArea>
                <Code>NUMBER</Code>
                <Description>Number</Description>
                <FieldType>Number</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Reservation</SystemArea>
                <Code>SMALL</Code>
                <Description>Small</Description>
                <FieldType>SmallText</FieldType>
                <DefaultValue />
            </AttributeConfiguration>
            <AttributeConfiguration>
                <SystemArea>Reservation</SystemArea>
                <Code>YES_NO</Code>
                <Description>Yes / No</Description>
                <FieldType>YesNo</FieldType>
                <DefaultValue>Yes</DefaultValue>
            </AttributeConfiguration>
        </AttributeConfiguration>
    </pmscfg_GetAttributeConfigurationResult>
</pmscfg_GetAttributeConfigurationResponse>

Code samples

@ECHO OFF



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


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


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