WSTerminalData


Click here for a complete list of operations.

GetTerminalSummary

returns multiple information tables for a Terminal.

use blnReturnAllTables to get all tables or pass boolean for each table needed.

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 /WSTerminalData.asmx HTTP/1.1
Host: qa.cmws.columbusdata.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://columbusdata.net/GetTerminalSummary"

<?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:Header>
    <clsUserCredentials xmlns="http://columbusdata.net/">
      <strIOSID>string</strIOSID>
      <strUsername>string</strUsername>
      <strLoginName>string</strLoginName>
      <strAPIKey>string</strAPIKey>
    </clsUserCredentials>
  </soap:Header>
  <soap:Body>
    <GetTerminalSummary xmlns="http://columbusdata.net/">
      <strTerminalID>string</strTerminalID>
      <blnReturnAllTables>boolean</blnReturnAllTables>
      <blnReturnTerminalSummary>boolean</blnReturnTerminalSummary>
      <blnReturnTerminalStatus>boolean</blnReturnTerminalStatus>
      <blnReturnTerminalSupportEvents>boolean</blnReturnTerminalSupportEvents>
      <blnReturnTerminalCashManagement>boolean</blnReturnTerminalCashManagement>
      <blnReturnTerminalDayTransactionsSummary>boolean</blnReturnTerminalDayTransactionsSummary>
      <blnReturnTerminalMonthToDateStatistics>boolean</blnReturnTerminalMonthToDateStatistics>
    </GetTerminalSummary>
  </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>
    <GetTerminalSummaryResponse xmlns="http://columbusdata.net/">
      <GetTerminalSummaryResult>dataset</GetTerminalSummaryResult>
    </GetTerminalSummaryResponse>
  </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 /WSTerminalData.asmx HTTP/1.1
Host: qa.cmws.columbusdata.net
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:Header>
    <clsUserCredentials xmlns="http://columbusdata.net/">
      <strIOSID>string</strIOSID>
      <strUsername>string</strUsername>
      <strLoginName>string</strLoginName>
      <strAPIKey>string</strAPIKey>
    </clsUserCredentials>
  </soap12:Header>
  <soap12:Body>
    <GetTerminalSummary xmlns="http://columbusdata.net/">
      <strTerminalID>string</strTerminalID>
      <blnReturnAllTables>boolean</blnReturnAllTables>
      <blnReturnTerminalSummary>boolean</blnReturnTerminalSummary>
      <blnReturnTerminalStatus>boolean</blnReturnTerminalStatus>
      <blnReturnTerminalSupportEvents>boolean</blnReturnTerminalSupportEvents>
      <blnReturnTerminalCashManagement>boolean</blnReturnTerminalCashManagement>
      <blnReturnTerminalDayTransactionsSummary>boolean</blnReturnTerminalDayTransactionsSummary>
      <blnReturnTerminalMonthToDateStatistics>boolean</blnReturnTerminalMonthToDateStatistics>
    </GetTerminalSummary>
  </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>
    <GetTerminalSummaryResponse xmlns="http://columbusdata.net/">
      <GetTerminalSummaryResult>dataset</GetTerminalSummaryResult>
    </GetTerminalSummaryResponse>
  </soap12:Body>
</soap12:Envelope>