RezLynx Web Service Router Web Service

RezLynx Web Service Router

Click here for a complete list of operations.

sync_GetCIMDocuments

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/sync_GetCIMDocuments"

<?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>
    <sync_GetCIMDocuments xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <SessionID>string</SessionID>
      <AfterTimestamp>dateTime</AfterTimestamp>
      <AfterKey>int</AfterKey>
      <DocumentList>
        <Items>
          <Document>
            <DocumentHeaderId>int</DocumentHeaderId>
            <AccountRef>string</AccountRef>
            <DocumentSetId>int</DocumentSetId>
            <CreatedTimestamp>dateTime</CreatedTimestamp>
            <CreatedBy>string</CreatedBy>
            <ModifiedTimestamp>dateTime</ModifiedTimestamp>
            <ModifiedBy>string</ModifiedBy>
            <DocumentType>ProFormaInvoice or Invoice or CreditNote or Payment</DocumentType>
            <LinkMode>int</LinkMode>
            <GrossTotal>decimal</GrossTotal>
            <NettTotal>decimal</NettTotal>
            <BalanceRemaining>decimal</BalanceRemaining>
            <Details xsi:nil="true" />
            <DocumentSetSequenceNo>int</DocumentSetSequenceNo>
            <Status>int</Status>
            <Description>string</Description>
            <OriginalDescription>string</OriginalDescription>
            <UserText>string</UserText>
            <DocumentRef>string</DocumentRef>
            <DueDate>dateTime</DueDate>
            <ForDate>dateTime</ForDate>
            <CRSBookRef>string</CRSBookRef>
            <CRSRoomPickId>int</CRSRoomPickId>
            <CRSSegmentNo>int</CRSSegmentNo>
            <PMSBookRef>string</PMSBookRef>
            <PMSFolioId>int</PMSFolioId>
            <PMSFolioSplitId>int</PMSFolioSplitId>
            <PMSRoomPickId>int</PMSRoomPickId>
            <PMSSiteId>string</PMSSiteId>
          </Document>
          <Document>
            <DocumentHeaderId>int</DocumentHeaderId>
            <AccountRef>string</AccountRef>
            <DocumentSetId>int</DocumentSetId>
            <CreatedTimestamp>dateTime</CreatedTimestamp>
            <CreatedBy>string</CreatedBy>
            <ModifiedTimestamp>dateTime</ModifiedTimestamp>
            <ModifiedBy>string</ModifiedBy>
            <DocumentType>ProFormaInvoice or Invoice or CreditNote or Payment</DocumentType>
            <LinkMode>int</LinkMode>
            <GrossTotal>decimal</GrossTotal>
            <NettTotal>decimal</NettTotal>
            <BalanceRemaining>decimal</BalanceRemaining>
            <Details xsi:nil="true" />
            <DocumentSetSequenceNo>int</DocumentSetSequenceNo>
            <Status>int</Status>
            <Description>string</Description>
            <OriginalDescription>string</OriginalDescription>
            <UserText>string</UserText>
            <DocumentRef>string</DocumentRef>
            <DueDate>dateTime</DueDate>
            <ForDate>dateTime</ForDate>
            <CRSBookRef>string</CRSBookRef>
            <CRSRoomPickId>int</CRSRoomPickId>
            <CRSSegmentNo>int</CRSSegmentNo>
            <PMSBookRef>string</PMSBookRef>
            <PMSFolioId>int</PMSFolioId>
            <PMSFolioSplitId>int</PMSFolioSplitId>
            <PMSRoomPickId>int</PMSRoomPickId>
            <PMSSiteId>string</PMSSiteId>
          </Document>
        </Items>
      </DocumentList>
    </sync_GetCIMDocuments>
  </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>
    <sync_GetCIMDocumentsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <sync_GetCIMDocumentsResult>
        <ExceptionCode>int</ExceptionCode>
        <ExceptionDescription>string</ExceptionDescription>
      </sync_GetCIMDocumentsResult>
      <DocumentList>
        <Items>
          <Document>
            <DocumentHeaderId>int</DocumentHeaderId>
            <AccountRef>string</AccountRef>
            <DocumentSetId>int</DocumentSetId>
            <CreatedTimestamp>dateTime</CreatedTimestamp>
            <CreatedBy>string</CreatedBy>
            <ModifiedTimestamp>dateTime</ModifiedTimestamp>
            <ModifiedBy>string</ModifiedBy>
            <DocumentType>ProFormaInvoice or Invoice or CreditNote or Payment</DocumentType>
            <LinkMode>int</LinkMode>
            <GrossTotal>decimal</GrossTotal>
            <NettTotal>decimal</NettTotal>
            <BalanceRemaining>decimal</BalanceRemaining>
            <Details xsi:nil="true" />
            <DocumentSetSequenceNo>int</DocumentSetSequenceNo>
            <Status>int</Status>
            <Description>string</Description>
            <OriginalDescription>string</OriginalDescription>
            <UserText>string</UserText>
            <DocumentRef>string</DocumentRef>
            <DueDate>dateTime</DueDate>
            <ForDate>dateTime</ForDate>
            <CRSBookRef>string</CRSBookRef>
            <CRSRoomPickId>int</CRSRoomPickId>
            <CRSSegmentNo>int</CRSSegmentNo>
            <PMSBookRef>string</PMSBookRef>
            <PMSFolioId>int</PMSFolioId>
            <PMSFolioSplitId>int</PMSFolioSplitId>
            <PMSRoomPickId>int</PMSRoomPickId>
            <PMSSiteId>string</PMSSiteId>
          </Document>
          <Document>
            <DocumentHeaderId>int</DocumentHeaderId>
            <AccountRef>string</AccountRef>
            <DocumentSetId>int</DocumentSetId>
            <CreatedTimestamp>dateTime</CreatedTimestamp>
            <CreatedBy>string</CreatedBy>
            <ModifiedTimestamp>dateTime</ModifiedTimestamp>
            <ModifiedBy>string</ModifiedBy>
            <DocumentType>ProFormaInvoice or Invoice or CreditNote or Payment</DocumentType>
            <LinkMode>int</LinkMode>
            <GrossTotal>decimal</GrossTotal>
            <NettTotal>decimal</NettTotal>
            <BalanceRemaining>decimal</BalanceRemaining>
            <Details xsi:nil="true" />
            <DocumentSetSequenceNo>int</DocumentSetSequenceNo>
            <Status>int</Status>
            <Description>string</Description>
            <OriginalDescription>string</OriginalDescription>
            <UserText>string</UserText>
            <DocumentRef>string</DocumentRef>
            <DueDate>dateTime</DueDate>
            <ForDate>dateTime</ForDate>
            <CRSBookRef>string</CRSBookRef>
            <CRSRoomPickId>int</CRSRoomPickId>
            <CRSSegmentNo>int</CRSSegmentNo>
            <PMSBookRef>string</PMSBookRef>
            <PMSFolioId>int</PMSFolioId>
            <PMSFolioSplitId>int</PMSFolioSplitId>
            <PMSRoomPickId>int</PMSRoomPickId>
            <PMSSiteId>string</PMSSiteId>
          </Document>
        </Items>
      </DocumentList>
    </sync_GetCIMDocumentsResponse>
  </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>
    <sync_GetCIMDocuments xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <SessionID>string</SessionID>
      <AfterTimestamp>dateTime</AfterTimestamp>
      <AfterKey>int</AfterKey>
      <DocumentList>
        <Items>
          <Document>
            <DocumentHeaderId>int</DocumentHeaderId>
            <AccountRef>string</AccountRef>
            <DocumentSetId>int</DocumentSetId>
            <CreatedTimestamp>dateTime</CreatedTimestamp>
            <CreatedBy>string</CreatedBy>
            <ModifiedTimestamp>dateTime</ModifiedTimestamp>
            <ModifiedBy>string</ModifiedBy>
            <DocumentType>ProFormaInvoice or Invoice or CreditNote or Payment</DocumentType>
            <LinkMode>int</LinkMode>
            <GrossTotal>decimal</GrossTotal>
            <NettTotal>decimal</NettTotal>
            <BalanceRemaining>decimal</BalanceRemaining>
            <Details xsi:nil="true" />
            <DocumentSetSequenceNo>int</DocumentSetSequenceNo>
            <Status>int</Status>
            <Description>string</Description>
            <OriginalDescription>string</OriginalDescription>
            <UserText>string</UserText>
            <DocumentRef>string</DocumentRef>
            <DueDate>dateTime</DueDate>
            <ForDate>dateTime</ForDate>
            <CRSBookRef>string</CRSBookRef>
            <CRSRoomPickId>int</CRSRoomPickId>
            <CRSSegmentNo>int</CRSSegmentNo>
            <PMSBookRef>string</PMSBookRef>
            <PMSFolioId>int</PMSFolioId>
            <PMSFolioSplitId>int</PMSFolioSplitId>
            <PMSRoomPickId>int</PMSRoomPickId>
            <PMSSiteId>string</PMSSiteId>
          </Document>
          <Document>
            <DocumentHeaderId>int</DocumentHeaderId>
            <AccountRef>string</AccountRef>
            <DocumentSetId>int</DocumentSetId>
            <CreatedTimestamp>dateTime</CreatedTimestamp>
            <CreatedBy>string</CreatedBy>
            <ModifiedTimestamp>dateTime</ModifiedTimestamp>
            <ModifiedBy>string</ModifiedBy>
            <DocumentType>ProFormaInvoice or Invoice or CreditNote or Payment</DocumentType>
            <LinkMode>int</LinkMode>
            <GrossTotal>decimal</GrossTotal>
            <NettTotal>decimal</NettTotal>
            <BalanceRemaining>decimal</BalanceRemaining>
            <Details xsi:nil="true" />
            <DocumentSetSequenceNo>int</DocumentSetSequenceNo>
            <Status>int</Status>
            <Description>string</Description>
            <OriginalDescription>string</OriginalDescription>
            <UserText>string</UserText>
            <DocumentRef>string</DocumentRef>
            <DueDate>dateTime</DueDate>
            <ForDate>dateTime</ForDate>
            <CRSBookRef>string</CRSBookRef>
            <CRSRoomPickId>int</CRSRoomPickId>
            <CRSSegmentNo>int</CRSSegmentNo>
            <PMSBookRef>string</PMSBookRef>
            <PMSFolioId>int</PMSFolioId>
            <PMSFolioSplitId>int</PMSFolioSplitId>
            <PMSRoomPickId>int</PMSRoomPickId>
            <PMSSiteId>string</PMSSiteId>
          </Document>
        </Items>
      </DocumentList>
    </sync_GetCIMDocuments>
  </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>
    <sync_GetCIMDocumentsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
      <sync_GetCIMDocumentsResult>
        <ExceptionCode>int</ExceptionCode>
        <ExceptionDescription>string</ExceptionDescription>
      </sync_GetCIMDocumentsResult>
      <DocumentList>
        <Items>
          <Document>
            <DocumentHeaderId>int</DocumentHeaderId>
            <AccountRef>string</AccountRef>
            <DocumentSetId>int</DocumentSetId>
            <CreatedTimestamp>dateTime</CreatedTimestamp>
            <CreatedBy>string</CreatedBy>
            <ModifiedTimestamp>dateTime</ModifiedTimestamp>
            <ModifiedBy>string</ModifiedBy>
            <DocumentType>ProFormaInvoice or Invoice or CreditNote or Payment</DocumentType>
            <LinkMode>int</LinkMode>
            <GrossTotal>decimal</GrossTotal>
            <NettTotal>decimal</NettTotal>
            <BalanceRemaining>decimal</BalanceRemaining>
            <Details xsi:nil="true" />
            <DocumentSetSequenceNo>int</DocumentSetSequenceNo>
            <Status>int</Status>
            <Description>string</Description>
            <OriginalDescription>string</OriginalDescription>
            <UserText>string</UserText>
            <DocumentRef>string</DocumentRef>
            <DueDate>dateTime</DueDate>
            <ForDate>dateTime</ForDate>
            <CRSBookRef>string</CRSBookRef>
            <CRSRoomPickId>int</CRSRoomPickId>
            <CRSSegmentNo>int</CRSSegmentNo>
            <PMSBookRef>string</PMSBookRef>
            <PMSFolioId>int</PMSFolioId>
            <PMSFolioSplitId>int</PMSFolioSplitId>
            <PMSRoomPickId>int</PMSRoomPickId>
            <PMSSiteId>string</PMSSiteId>
          </Document>
          <Document>
            <DocumentHeaderId>int</DocumentHeaderId>
            <AccountRef>string</AccountRef>
            <DocumentSetId>int</DocumentSetId>
            <CreatedTimestamp>dateTime</CreatedTimestamp>
            <CreatedBy>string</CreatedBy>
            <ModifiedTimestamp>dateTime</ModifiedTimestamp>
            <ModifiedBy>string</ModifiedBy>
            <DocumentType>ProFormaInvoice or Invoice or CreditNote or Payment</DocumentType>
            <LinkMode>int</LinkMode>
            <GrossTotal>decimal</GrossTotal>
            <NettTotal>decimal</NettTotal>
            <BalanceRemaining>decimal</BalanceRemaining>
            <Details xsi:nil="true" />
            <DocumentSetSequenceNo>int</DocumentSetSequenceNo>
            <Status>int</Status>
            <Description>string</Description>
            <OriginalDescription>string</OriginalDescription>
            <UserText>string</UserText>
            <DocumentRef>string</DocumentRef>
            <DueDate>dateTime</DueDate>
            <ForDate>dateTime</ForDate>
            <CRSBookRef>string</CRSBookRef>
            <CRSRoomPickId>int</CRSRoomPickId>
            <CRSSegmentNo>int</CRSSegmentNo>
            <PMSBookRef>string</PMSBookRef>
            <PMSFolioId>int</PMSFolioId>
            <PMSFolioSplitId>int</PMSFolioSplitId>
            <PMSRoomPickId>int</PMSRoomPickId>
            <PMSSiteId>string</PMSSiteId>
          </Document>
        </Items>
      </DocumentList>
    </sync_GetCIMDocumentsResponse>
  </soap12:Body>
</soap12:Envelope>