Quick start

Assuming you have valid account credentials (see What you need to connect), you should be able to connect to the web service using the LogIn method.

You can use a tool like Postman to test the API. Set up a POST method with body content type set to text/xml, request URL set as per API endpoints and with body content set to the following:

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LogIn xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <SiteID>insert Site ID here</SiteID>
      <InterfaceID>insert Interface ID here</InterfaceID>
      <OperatorCode>insert OperatorCode here</OperatorCode>
      <Password>insert Password here</Password>
    </LogIn>
  </soap:Body>
</soap:Envelope>

Send the request and you should get a response back something like this:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <LogInResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
            <LogInResult>
                <ExceptionCode>0</ExceptionCode>
                <ExceptionDescription>No error</ExceptionDescription>
            </LogInResult>
            <SessionID>723c4f82-22cc-47a8-ba77-f87bbe53f045</SessionID>
        </LogInResponse>
    </soap:Body>
</soap:Envelope>

That Session ID can now be pasted into any other method you are authorised to use, e.g. pmscfg_AnalList as follows.

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <pmscfg_AnalList xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <SessionID>723c4f82-22cc-47a8-ba77-f87bbe53f045</SessionID>
      <AnalysisCodeList>
      </AnalysisCodeList>
    </pmscfg_AnalList>
  </soap:Body>
</soap:Envelope>

This method returns with a list of all the sales analysis codes set up in Rezlynx.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <pmscfg_AnalListResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
            <pmscfg_AnalListResult>
                <ExceptionCode>0</ExceptionCode>
                <ExceptionDescription>No error</ExceptionDescription>
            </pmscfg_AnalListResult>
            <AnalysisCodeList>
                <AnalCodes>
                    <cpmscfg_AnalList_AnalItem>
                        <AnalCode>ACCOM</AnalCode>
                        <Description>Accommodation</Description>
                        <GroupCode>ACCOM</GroupCode>
                        <TaxRule>VAT_20</TaxRule>
                        <Usage>acr_NoRestrictions</Usage>
                    </cpmscfg_AnalList_AnalItem>
                    <cpmscfg_AnalList_AnalItem>
                        <AnalCode>ACCOM_4</AnalCode>
                        <Description>Accommodation 4% VAT</Description>
                        <GroupCode>ACCOM</GroupCode>
                        <TaxRule>VAT_04</TaxRule>
                        <Usage>acr_NoRestrictions</Usage>
                    </cpmscfg_AnalList_AnalItem>
                    <cpmscfg_AnalList_AnalItem>
                        <AnalCode>BAR</AnalCode>
                        <Description>Bar Items</Description>
                        <GroupCode>CATERING</GroupCode>
                        <TaxRule>VAT_20</TaxRule>
                        <Usage>acr_NoRestrictions</Usage>
                    </cpmscfg_AnalList_AnalItem>
                    <cpmscfg_AnalList_AnalItem>
                        <AnalCode>WEDD_WINE</AnalCode>
                        <Description>Wedding Wine</Description>
                        <GroupCode>WEDDING</GroupCode>
                        <TaxRule>VAT_20</TaxRule>
                        <Usage>acr_NoRestrictions</Usage>
                    </cpmscfg_AnalList_AnalItem>
                </AnalCodes>
            </AnalysisCodeList>
        </pmscfg_AnalListResponse>
    </soap:Body>
</soap:Envelope>

(this is a shortened version of the response, with just a few of the analysis codes)

And off you go!

NextTypical workflows