RezLynx Web Service Router Web Service

RezLynx Web Service Router

Click here for a complete list of operations.

pmsint_GetResidents

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /rlxsoap.asmx HTTP/1.1
Host: rlxsoap.eu.guestline.app
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetResidents"

<?xml version="1.0" encoding="utf-8"?>
<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>
    <pmsint_GetResidents xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <SessionID>string</SessionID>
      <FromDate>dateTime</FromDate>
      <ToDate>dateTime</ToDate>
      <BookingType>bkt_Bedroom or bkt_FunctionRoom or bkt_NRA or bkt_Master</BookingType>
      <GetResidents>
        <Residents>
          <cpmsint_GetResidents_ResidentItem>
            <DepositPaid>decimal</DepositPaid>
            <DepositDue>decimal</DepositDue>
            <Infants>int</Infants>
            <Children>int</Children>
            <Adults>int</Adults>
            <RoomType>string</RoomType>
            <Package>string</Package>
            <Company>string</Company>
            <Notes>string</Notes>
            <BookRef>string</BookRef>
            <BookRefRoomRef>string</BookRefRoomRef>
            <ETA>dateTime</ETA>
            <Arrival>dateTime</Arrival>
            <Departure>dateTime</Departure>
            <Salutation>string</Salutation>
            <Surname>string</Surname>
            <Forename>string</Forename>
            <RoomID>string</RoomID>
            <MovieAccess>string</MovieAccess>
            <PrivateNotes>string</PrivateNotes>
            <PublicNotes>string</PublicNotes>
            <CustomNotes1>string</CustomNotes1>
            <CustomNotes2>string</CustomNotes2>
            <CustomNotes3>string</CustomNotes3>
            <ExternalNotes>string</ExternalNotes>
            <Master>boolean</Master>
          </cpmsint_GetResidents_ResidentItem>
          <cpmsint_GetResidents_ResidentItem>
            <DepositPaid>decimal</DepositPaid>
            <DepositDue>decimal</DepositDue>
            <Infants>int</Infants>
            <Children>int</Children>
            <Adults>int</Adults>
            <RoomType>string</RoomType>
            <Package>string</Package>
            <Company>string</Company>
            <Notes>string</Notes>
            <BookRef>string</BookRef>
            <BookRefRoomRef>string</BookRefRoomRef>
            <ETA>dateTime</ETA>
            <Arrival>dateTime</Arrival>
            <Departure>dateTime</Departure>
            <Salutation>string</Salutation>
            <Surname>string</Surname>
            <Forename>string</Forename>
            <RoomID>string</RoomID>
            <MovieAccess>string</MovieAccess>
            <PrivateNotes>string</PrivateNotes>
            <PublicNotes>string</PublicNotes>
            <CustomNotes1>string</CustomNotes1>
            <CustomNotes2>string</CustomNotes2>
            <CustomNotes3>string</CustomNotes3>
            <ExternalNotes>string</ExternalNotes>
            <Master>boolean</Master>
          </cpmsint_GetResidents_ResidentItem>
        </Residents>
      </GetResidents>
    </pmsint_GetResidents>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<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>
    <pmsint_GetResidentsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <pmsint_GetResidentsResult>
        <ExceptionCode>int</ExceptionCode>
        <ExceptionDescription>string</ExceptionDescription>
      </pmsint_GetResidentsResult>
      <GetResidents>
        <Residents>
          <cpmsint_GetResidents_ResidentItem>
            <DepositPaid>decimal</DepositPaid>
            <DepositDue>decimal</DepositDue>
            <Infants>int</Infants>
            <Children>int</Children>
            <Adults>int</Adults>
            <RoomType>string</RoomType>
            <Package>string</Package>
            <Company>string</Company>
            <Notes>string</Notes>
            <BookRef>string</BookRef>
            <BookRefRoomRef>string</BookRefRoomRef>
            <ETA>dateTime</ETA>
            <Arrival>dateTime</Arrival>
            <Departure>dateTime</Departure>
            <Salutation>string</Salutation>
            <Surname>string</Surname>
            <Forename>string</Forename>
            <RoomID>string</RoomID>
            <MovieAccess>string</MovieAccess>
            <PrivateNotes>string</PrivateNotes>
            <PublicNotes>string</PublicNotes>
            <CustomNotes1>string</CustomNotes1>
            <CustomNotes2>string</CustomNotes2>
            <CustomNotes3>string</CustomNotes3>
            <ExternalNotes>string</ExternalNotes>
            <Master>boolean</Master>
          </cpmsint_GetResidents_ResidentItem>
          <cpmsint_GetResidents_ResidentItem>
            <DepositPaid>decimal</DepositPaid>
            <DepositDue>decimal</DepositDue>
            <Infants>int</Infants>
            <Children>int</Children>
            <Adults>int</Adults>
            <RoomType>string</RoomType>
            <Package>string</Package>
            <Company>string</Company>
            <Notes>string</Notes>
            <BookRef>string</BookRef>
            <BookRefRoomRef>string</BookRefRoomRef>
            <ETA>dateTime</ETA>
            <Arrival>dateTime</Arrival>
            <Departure>dateTime</Departure>
            <Salutation>string</Salutation>
            <Surname>string</Surname>
            <Forename>string</Forename>
            <RoomID>string</RoomID>
            <MovieAccess>string</MovieAccess>
            <PrivateNotes>string</PrivateNotes>
            <PublicNotes>string</PublicNotes>
            <CustomNotes1>string</CustomNotes1>
            <CustomNotes2>string</CustomNotes2>
            <CustomNotes3>string</CustomNotes3>
            <ExternalNotes>string</ExternalNotes>
            <Master>boolean</Master>
          </cpmsint_GetResidents_ResidentItem>
        </Residents>
      </GetResidents>
    </pmsint_GetResidentsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /rlxsoap.asmx HTTP/1.1
Host: rlxsoap.eu.guestline.app
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <pmsint_GetResidents xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <SessionID>string</SessionID>
      <FromDate>dateTime</FromDate>
      <ToDate>dateTime</ToDate>
      <BookingType>bkt_Bedroom or bkt_FunctionRoom or bkt_NRA or bkt_Master</BookingType>
      <GetResidents>
        <Residents>
          <cpmsint_GetResidents_ResidentItem>
            <DepositPaid>decimal</DepositPaid>
            <DepositDue>decimal</DepositDue>
            <Infants>int</Infants>
            <Children>int</Children>
            <Adults>int</Adults>
            <RoomType>string</RoomType>
            <Package>string</Package>
            <Company>string</Company>
            <Notes>string</Notes>
            <BookRef>string</BookRef>
            <BookRefRoomRef>string</BookRefRoomRef>
            <ETA>dateTime</ETA>
            <Arrival>dateTime</Arrival>
            <Departure>dateTime</Departure>
            <Salutation>string</Salutation>
            <Surname>string</Surname>
            <Forename>string</Forename>
            <RoomID>string</RoomID>
            <MovieAccess>string</MovieAccess>
            <PrivateNotes>string</PrivateNotes>
            <PublicNotes>string</PublicNotes>
            <CustomNotes1>string</CustomNotes1>
            <CustomNotes2>string</CustomNotes2>
            <CustomNotes3>string</CustomNotes3>
            <ExternalNotes>string</ExternalNotes>
            <Master>boolean</Master>
          </cpmsint_GetResidents_ResidentItem>
          <cpmsint_GetResidents_ResidentItem>
            <DepositPaid>decimal</DepositPaid>
            <DepositDue>decimal</DepositDue>
            <Infants>int</Infants>
            <Children>int</Children>
            <Adults>int</Adults>
            <RoomType>string</RoomType>
            <Package>string</Package>
            <Company>string</Company>
            <Notes>string</Notes>
            <BookRef>string</BookRef>
            <BookRefRoomRef>string</BookRefRoomRef>
            <ETA>dateTime</ETA>
            <Arrival>dateTime</Arrival>
            <Departure>dateTime</Departure>
            <Salutation>string</Salutation>
            <Surname>string</Surname>
            <Forename>string</Forename>
            <RoomID>string</RoomID>
            <MovieAccess>string</MovieAccess>
            <PrivateNotes>string</PrivateNotes>
            <PublicNotes>string</PublicNotes>
            <CustomNotes1>string</CustomNotes1>
            <CustomNotes2>string</CustomNotes2>
            <CustomNotes3>string</CustomNotes3>
            <ExternalNotes>string</ExternalNotes>
            <Master>boolean</Master>
          </cpmsint_GetResidents_ResidentItem>
        </Residents>
      </GetResidents>
    </pmsint_GetResidents>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <pmsint_GetResidentsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <pmsint_GetResidentsResult>
        <ExceptionCode>int</ExceptionCode>
        <ExceptionDescription>string</ExceptionDescription>
      </pmsint_GetResidentsResult>
      <GetResidents>
        <Residents>
          <cpmsint_GetResidents_ResidentItem>
            <DepositPaid>decimal</DepositPaid>
            <DepositDue>decimal</DepositDue>
            <Infants>int</Infants>
            <Children>int</Children>
            <Adults>int</Adults>
            <RoomType>string</RoomType>
            <Package>string</Package>
            <Company>string</Company>
            <Notes>string</Notes>
            <BookRef>string</BookRef>
            <BookRefRoomRef>string</BookRefRoomRef>
            <ETA>dateTime</ETA>
            <Arrival>dateTime</Arrival>
            <Departure>dateTime</Departure>
            <Salutation>string</Salutation>
            <Surname>string</Surname>
            <Forename>string</Forename>
            <RoomID>string</RoomID>
            <MovieAccess>string</MovieAccess>
            <PrivateNotes>string</PrivateNotes>
            <PublicNotes>string</PublicNotes>
            <CustomNotes1>string</CustomNotes1>
            <CustomNotes2>string</CustomNotes2>
            <CustomNotes3>string</CustomNotes3>
            <ExternalNotes>string</ExternalNotes>
            <Master>boolean</Master>
          </cpmsint_GetResidents_ResidentItem>
          <cpmsint_GetResidents_ResidentItem>
            <DepositPaid>decimal</DepositPaid>
            <DepositDue>decimal</DepositDue>
            <Infants>int</Infants>
            <Children>int</Children>
            <Adults>int</Adults>
            <RoomType>string</RoomType>
            <Package>string</Package>
            <Company>string</Company>
            <Notes>string</Notes>
            <BookRef>string</BookRef>
            <BookRefRoomRef>string</BookRefRoomRef>
            <ETA>dateTime</ETA>
            <Arrival>dateTime</Arrival>
            <Departure>dateTime</Departure>
            <Salutation>string</Salutation>
            <Surname>string</Surname>
            <Forename>string</Forename>
            <RoomID>string</RoomID>
            <MovieAccess>string</MovieAccess>
            <PrivateNotes>string</PrivateNotes>
            <PublicNotes>string</PublicNotes>
            <CustomNotes1>string</CustomNotes1>
            <CustomNotes2>string</CustomNotes2>
            <CustomNotes3>string</CustomNotes3>
            <ExternalNotes>string</ExternalNotes>
            <Master>boolean</Master>
          </cpmsint_GetResidents_ResidentItem>
        </Residents>
      </GetResidents>
    </pmsint_GetResidentsResponse>
  </soap12:Body>
</soap12:Envelope>