Rezlynx API


This method retrieves a guest profile, including custom attributes. It is based on pmsprf_GetProfileSummaryV3 but with the addition of custom attributes in the response object.

(note however that this method uses SessionID like pmsprf_GetProfileSummaryV2 and not SOAP header authentication like pmsprf_GetProfileSummaryV3)

Profile requestor authentication Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them.


Name Type Description
SessionID string Session ID, obtained at log-in
ProfileRequestor (object)
> ProfileUniqueId string Unique profile ID, must be either a profile reference, unique email address or loyalty ID
> ProfileUniqueIdAuthenticatorValue string The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below
> AuthenticationMethod "PD" "PD" stands for "Person Details" and should always be set to this
> AuthenticationCode string The method of second line authentication to be used i.e. "Forename", "Surname" or "PostCode"
> AuthenticationValue string The authentication value, e.g. if the method is "Surname" and the profile is under the name of "Jones" then the value will be "Jones", if the method is "PostCode" then the value will be "SY26LG"
Filters "Checked Out", "Resident" or "Future" Optional filter to filter results according to the reservation status
ProfileSearchMode "Contact", "Guest" or "Both" Used to indicate whether searching for a reservation contact, reservation guest or both

Returned data (profile)

Name Type Description
ProfileRef string Profile reference
Salutation string Title
Forename string Forename
Surname string Surname
EMailAddress string E-mail address
Gender string Gender
Street string Address street
Area string Address area
Town string Address town or city
County string Address county or state
PostCode string Address postcode or zip code
Country string Address country
TelephoneNo string Telephone number
FaxNo string Fax number
MobileNo string Mobile telephone number
Nationality string Nationality
Language string Language
CompanyRef string Company reference, if applicable
Vip int Integer VIP level (e.g. 1,2,3...)
DateOfBirth dateTime Date of birth
StudentID string Student ID, if applicable
TypeOfPerson "Adult", "Child" or "Infant" Adult status
PassportNumber string Passport number
PreferredRoomType string Preferred room type
ExcludeFromMailings Boolean Indicates if person chose to be excluded from general marketing mailings
Smoker int Smoker or not
BlackListed int Blacklisted or not
LoyaltyID string Loyalty ID
ProfileType "Private", "Agents", "Corporate", "TourGroup" or "TourSeries" Profile type
ExcludeFromThirdPartyMailings Boolean Indicates if person chose to be excluded from third-party mailings
Suffix string Name suffix
MiddleName string Middle name
AddressLine1 string Address line 1
AddressLine2 string Address line 2
State string Address state
PublicNotes string Notes (public)
PrivateNotes string Notes (private)
CustomNotes1 string Notes (custom 1)
CustomNotes2 string Notes (custom 2)
CustomNotes3 string Notes (custom 3)

Returned data (custom attribute)

Name Type Description
AttributeCode string Attribute field type (see below)
Value string (please ignore this field)
Param1 string Parameter #1, if applicable
Param2 string Parameter #2, if applicable
ProfileAttributeCode string Name of this custom attribute
ProfileAttributeDescription string Description or label for this custom attribute
ProfileAttributeValue string Value of this custom attribute

Attribute field type can be one of the following:

  • "SMALL" (a small text box)
  • "LARGE" (a large text box)
  • "DATE" (a date)
  • "NUMBER" (an integer number)
  • "YES_NO" (a yes/no flag)
  • "LIST" (a list-box)
Note some care is needed with the custom attribute values, as they depend on the attribute field type. For example, values for field type "YES_NO" are '1' for 'Yes' and '0' for 'No'.
Note in the case of attributes of field type "LIST", Param2 contains the list options, e.g. "[],[1],[2],[3]" indicates possible values for the attribute are <blank>, '1', '2' or '3'.

Request URL

Request headers

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

Request body

<pmsprf_GetProfileSummaryWithAttributes xmlns="">
        <ProfileUniqueIdAuthenticatorValue />


200 OK


<pmsprf_GetProfileSummaryWithAttributesResponse xmlns="">
        <ExceptionDescription>No error</ExceptionDescription>
        <Street>Guestline House Shrewsbury Business Park</Street>
        <Area>Sitka Drive</Area>
        <PostCode>SY2 6LG</PostCode>
        <Country>United Kingdom</Country>
        <FaxNo />
        <MobileNo />
        <CompanyRef />
        <StudentID />
        <PassportNumber />
        <PreferredRoomType />
        <LoyaltyID />
        <Suffix />
        <MiddleName />
        <AddressLine1 />
        <AddressLine2 />
        <State />
        <PublicNotes />
        <PrivateNotes />
        <CustomNotes2>No Duvet</CustomNotes2>
        <CustomNotes3 />
            <Value>Small text</Value>
            <Param1 />
            <Param2 />
            <ProfileAttributeValue>Small text</ProfileAttributeValue>
            <Value />
            <Param1 />
            <Param2 />
            <ProfileAttributeValue />
            <Value />
            <Param1 />
            <Param2 />
            <ProfileAttributeValue />
            <Param1 />
            <Param2 />
            <Param1 />
            <Param2 />
            <ProfileAttributeDescription>Yes / No</ProfileAttributeDescription>
            <Param1 />

Code samples


curl -v -X POST ""
-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()
            Console.WriteLine("Hit ENTER to exit...");
        static async void MakeRequest()
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers

            var uri = "" + 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 (
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();


            URIBuilder builder = new URIBuilder("");

            URI uri =;
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "text/xml");

            // Request body
            StringEntity reqEntity = new StringEntity("{body}");

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
        catch (Exception e)

<!DOCTYPE html>
    <script src=""></script>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters

            url: "" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            type: "POST",
            // Request body
            data: "{body}",
        .done(function(data) {
        .fail(function() {
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    NSString* path = @"";
    NSArray* array = @[
                         // Request parameters
    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);
        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;
// This sample uses the Apache HTTP client from HTTP Components (
require_once 'HTTP/Request2.php';

$request = new Http_Request2('');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'text/xml',


$parameters = array(
    // Request parameters



// Request body

    $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({

    conn = httplib.HTTPSConnection('')

    conn.request("POST", "pmsprf_GetProfileSummaryWithAttributes%s" % params, "{body}", headers)
    response = conn.getresponse()
    data =
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({

    conn = http.client.HTTPSConnection('')
    conn.request("POST", "/rezlynx-web-service/?soapAction=" % params, "{body}", headers)
    response = conn.getresponse()
    data =
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

require 'net/http'

uri = URI('')

request =
# Request headers
request['Content-Type'] = 'text/xml'
# Request body
request.body = "{body}"

response = Net::HTTP.start(, uri.port, :use_ssl => uri.scheme == 'https') do |http|

puts response.body