Rezlynx API
pmsprf_UpdateProfileSummaryV3
This is used to amend profile details directly in the PMS.
Updating individual fields Setting a field value will overwrite the current value with the new value; fields which are blank in the request message will not cause any change in the field value, these will not be overwritten; to clear the contents of a field, set the field value to '*' in the request message. |
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. |
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 |
---|---|---|
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" |
StreetAddress | string | Address street |
AreaAddress | string | Address area |
Town | string | Address town or city |
County | string | Address county or state |
Country | string | Address country |
Postcode | string | Address postcode or zip code |
TelNumber | string | Telephone number |
FaxNumber | string | Fax number |
MobileNo | string | Mobile telephone number |
string | E-mail address | |
ExcludeFromMailings | Boolean | Indicates if person chose to be excluded from general marketing mailings |
Password | string | Password to secure access to the profile |
CompanyRef | string | Company reference |
Salutation | string | Title e.g. "Mr" or "Ms" |
Forename | string | Forename |
Surname | string | Surname |
Greeting | string | Preferred form of address |
Vip | int | Integer VIP level |
BlackListed | int | Blacklisted or not |
TypeOfPerson | int | Code to indicate adult, child or infant status |
Nationality | string | Nationality |
Language | string | Language |
DOB | dateTime | Date of birth |
ProfileType | int | Code to indicate profile type |
Smoker | int | Smoker or not |
LoyaltyID | string | Loyalty ID |
StudentID | string | Student ID, if applicable |
Gender | string | Gender |
PassportNumber | string | Passport number |
PreferredRoomType | string | Preferred room type |
ExcludeFromThirdPartyMailings | Boolean | Indicates if person chose to be excluded from third-party mailings |
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
- None
Request URL
https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsprf_UpdateProfileSummaryV3Request headers
Name | Type | Description |
---|---|---|
(optional) | string | Media type of the body sent to the API. |
Request body
<pmsprf_UpdateProfileSummaryV3 xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<ProfileRequestor>
<ProfileUniqueId>PV00067</ProfileUniqueId>
<ProfileUniqueIdAuthenticatorValue />
<AuthenticationMethod>PD</AuthenticationMethod>
<AuthenticationCode>Surname</AuthenticationCode>
<AuthenticationValue>McCormick</AuthenticationValue>
</ProfileRequestor>
<StreetAddress />
<AreaAddress />
<Town>Shrewsbury1</Town>
<County />
<Country />
<Postcode />
<TelNumber />
<FaxNumber />
<MobileNo />
<Email />
<ExcludeFromMailings>false</ExcludeFromMailings>
<Password />
<CompanyRef />
<Salutation />
<Forename />
<Surname />
<Greeting />
<VIP>0</VIP>
<Blacklisted>0</Blacklisted>
<TypeOfPerson>0</TypeOfPerson>
<Nationality />
<Language />
<DOB>2017-10-17T16:46:45.757975+01:00</DOB>
<Smoker>0</Smoker>
<ProfileType>-1</ProfileType>
<LoyaltyID />
<StudentID />
<Gender />
<PassportNumber />
<PreferredRoomType />
<ExcludeFromThirdPartyMailings>false</ExcludeFromThirdPartyMailings>
<PublicNotes />
<PrivateNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
</pmsprf_UpdateProfileSummaryV3>
Responses
200 OK
Representations
<pmsprf_UpdateProfileSummaryV3Response xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_UpdateProfileSummaryV3Result>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprf_UpdateProfileSummaryV3Result>
</pmsprf_UpdateProfileSummaryV3Response>
Code samples
@ECHO OFF
curl -v -X POST "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsprf_UpdateProfileSummaryV3"
-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=pmsprf_UpdateProfileSummaryV3&" + 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=pmsprf_UpdateProfileSummaryV3");
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=pmsprf_UpdateProfileSummaryV3" + $.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=pmsprf_UpdateProfileSummaryV3";
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=pmsprf_UpdateProfileSummaryV3');
$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", "pmsprf_UpdateProfileSummaryV3%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/pmsprf_UpdateProfileSummaryV3&%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=pmsprf_UpdateProfileSummaryV3')
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