SmartClientServices

Click here for a complete list of operations.

CheckForUpdate

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 /SCAutoUpdater/SmartClientUpdateWS.asmx HTTP/1.1
Host: www.cqgtrader.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://cqg.com/webservices/CheckForUpdate"

<?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>
    <CheckForUpdate xmlns="http://cqg.com/webservices/">
      <username>string</username>
      <password>string</password>
      <version>string</version>
      <privateLabel>int</privateLabel>
    </CheckForUpdate>
  </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>
    <CheckForUpdateResponse xmlns="http://cqg.com/webservices/">
      <CheckForUpdateResult>
        <UpdateRequired>boolean</UpdateRequired>
        <UpdateAvailable>boolean</UpdateAvailable>
        <UpdateURL>string</UpdateURL>
        <UpdateVersion>string</UpdateVersion>
        <UpdateDetails>string</UpdateDetails>
        <GatewayServer>
          <Address>string</Address>
          <Port>int</Port>
          <TargetSubsystem>string</TargetSubsystem>
          <IsCompressed>boolean</IsCompressed>
          <IsEncrypted>boolean</IsEncrypted>
        </GatewayServer>
        <AgreementRequired>boolean</AgreementRequired>
        <HelpURL>string</HelpURL>
        <Error>
          <Number>int</Number>
          <Message>string</Message>
        </Error>
        <Version>string</Version>
        <GatewayServers>
          <ServiceInfo>
            <Address>string</Address>
            <Port>int</Port>
            <TargetSubsystem>string</TargetSubsystem>
            <IsCompressed>boolean</IsCompressed>
            <IsEncrypted>boolean</IsEncrypted>
          </ServiceInfo>
          <ServiceInfo>
            <Address>string</Address>
            <Port>int</Port>
            <TargetSubsystem>string</TargetSubsystem>
            <IsCompressed>boolean</IsCompressed>
            <IsEncrypted>boolean</IsEncrypted>
          </ServiceInfo>
        </GatewayServers>
        <NewsServers>
          <string>string</string>
          <string>string</string>
        </NewsServers>
        <LoginServers>
          <string>string</string>
          <string>string</string>
        </LoginServers>
        <Location>string</Location>
        <TraderID>int</TraderID>
        <OneTimePasswordRequired>boolean</OneTimePasswordRequired>
        <DataFeedVersion>int</DataFeedVersion>
      </CheckForUpdateResult>
    </CheckForUpdateResponse>
  </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 /SCAutoUpdater/SmartClientUpdateWS.asmx HTTP/1.1
Host: www.cqgtrader.com
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>
    <CheckForUpdate xmlns="http://cqg.com/webservices/">
      <username>string</username>
      <password>string</password>
      <version>string</version>
      <privateLabel>int</privateLabel>
    </CheckForUpdate>
  </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>
    <CheckForUpdateResponse xmlns="http://cqg.com/webservices/">
      <CheckForUpdateResult>
        <UpdateRequired>boolean</UpdateRequired>
        <UpdateAvailable>boolean</UpdateAvailable>
        <UpdateURL>string</UpdateURL>
        <UpdateVersion>string</UpdateVersion>
        <UpdateDetails>string</UpdateDetails>
        <GatewayServer>
          <Address>string</Address>
          <Port>int</Port>
          <TargetSubsystem>string</TargetSubsystem>
          <IsCompressed>boolean</IsCompressed>
          <IsEncrypted>boolean</IsEncrypted>
        </GatewayServer>
        <AgreementRequired>boolean</AgreementRequired>
        <HelpURL>string</HelpURL>
        <Error>
          <Number>int</Number>
          <Message>string</Message>
        </Error>
        <Version>string</Version>
        <GatewayServers>
          <ServiceInfo>
            <Address>string</Address>
            <Port>int</Port>
            <TargetSubsystem>string</TargetSubsystem>
            <IsCompressed>boolean</IsCompressed>
            <IsEncrypted>boolean</IsEncrypted>
          </ServiceInfo>
          <ServiceInfo>
            <Address>string</Address>
            <Port>int</Port>
            <TargetSubsystem>string</TargetSubsystem>
            <IsCompressed>boolean</IsCompressed>
            <IsEncrypted>boolean</IsEncrypted>
          </ServiceInfo>
        </GatewayServers>
        <NewsServers>
          <string>string</string>
          <string>string</string>
        </NewsServers>
        <LoginServers>
          <string>string</string>
          <string>string</string>
        </LoginServers>
        <Location>string</Location>
        <TraderID>int</TraderID>
        <OneTimePasswordRequired>boolean</OneTimePasswordRequired>
        <DataFeedVersion>int</DataFeedVersion>
      </CheckForUpdateResult>
    </CheckForUpdateResponse>
  </soap12:Body>
</soap12:Envelope>