Rezlynx API

pmsped_PostZRead

This allows the posting of an ePOS Z-read, including both Sales and Payments codes within a single method.

A Z-read is a tally of sales and payments put through an ePOS till (often referred to as 'cashing up'). It is common practice to run a z-read report at the end of a shift or work period and clear it down ready for the next shift. This information is posted to the PMS so that the PMS can account for all of the different sales and payment items and pass this information on to the accounting system for the property, for analysis purposes.

It is possible to post a Z-read after each set of till transactions, however this can generate a lot of data overhead so in general it is preferred to post a Z-read at the end of each shift or work period.

Note the total of Sales and Payments must sum to zero or else the z-read will be rejected with an error code.

Parameters

Name	Type	Description
SessionID	string	Session ID, obtained at log-in
PaymentsList	object	List of ZReadPayments items (see below)
SalesList	object	List of ZReadSales items (see below)

Parameters (ZReadPayment)

Name	Type	Description
PayTypeCode	string	Payment type code (codes can be obtained through the API using pmscfg_PayTypeList)
Amount	decimal	Financial amount
Description	string	Text description of item
UserTag1	string	Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes)
UserTag2	string	Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes)

Parameters (ZReadSale)

Name	Type	Description
AnalysisCode	string	Sales analysis code (codes can be obtained through the API using pmscfg_AnalList)
Amount	decimal	Financial amount
Description	string	Text description of item
UserTag1	string	Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes)
UserTag2	string	Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes)

Returned data

None

Request URL

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

Request headers

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

Request body

text/xml

Sample

<pmsped_PostZRead xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
    <SessionID>74e9307d-628a-42ae-b166-87f98875ecfe</SessionID>
    <PaymentsList>
        <Payments>
            <ZReadPayment>
                <PayTypeCode>CASH</PayTypeCode>
                <Amount>16</Amount>
            </ZReadPayment>
            <ZReadPayment>
                <PayTypeCode>VISA</PayTypeCode>
                <Amount>4</Amount>
            </ZReadPayment>
            <ZReadPayment>
                <PayTypeCode>MC</PayTypeCode>
                <Amount>2</Amount>
            </ZReadPayment>
        </Payments>
    </PaymentsList>
    <SalesList>
        <Sales>
            <ZReadSale>
                <AnalysisCode>FOOD</AnalysisCode>
                <Amount>12</Amount>
                <Description>Food Sales</Description>
            </ZReadSale>
            <ZReadSale>
                <AnalysisCode>BARDRINK</AnalysisCode>
                <Amount>10</Amount>
                <Description>Bar Drinks Sales</Description>
            </ZReadSale>
        </Sales>
    </SalesList>
</pmsped_PostZRead>

Responses

200 OK

Representations

text/xml

Sample

<pmsped_PostZReadResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
  <pmsped_PostZReadResult>
    <ExceptionCode>0</ExceptionCode>
    <ExceptionDescription>No error</ExceptionDescription>
  </pmsped_PostZReadResult>
</pmsped_PostZReadResponse>

Code samples

@ECHO OFF



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


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


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