getWsdlVersion()

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access deactivation for version 1.5 began in Q1 2022 and will enter its concluding phases in October 2022. Access to version 1.6 will be deactivated in Q4 2024. Visit our SOAP API lifecycle FAQ article to learn more.

This API call is an informational Web Service that returns the current version of the WSDL, based on the API user name. The value returned will be in the standard software versions format of X>Y>Z.

WSDL versions

The Web Services API uses a three decimal numbering system to indicate its most current version. The API is currently in version 1.7. The second place number increases by 1 when a significant update occurs that will likely impact most existing integrations.

The third place number increases whenever a change is made to the Web Services WSDL. These changes will not impact existing integrations.

It is possible that, at some point, the WSDL used for integration development will differ from the WSDL available in different Autotask zones, for example, when an Autotask release is rolled out over several weeks. In addition, when working with international customers, there is always a delay between an Autotask English language release and the same release in the localized zones. Developers can use this call to confirm which WSDL is being accessed by the logged in user.

Sample GetWsdlVersion() SOAP XML

            <?xml version="1.0" encoding="utf-8"?>
<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:Header>
    <AutotaskIntegrations xmlns="http://autotask.net/ATWS/v1_6/">
      <PartnerID>
      </PartnerID>
      <IntegrationCode>[insert your own tracking identifier]</IntegrationCode>
    </AutotaskIntegrations>
  </soap:Header>
  <soap:Body>
    <GetWsdlVersion xmlns="http://autotask.net/ATWS/v1_6/">
      <UserName>apiuserjohna@qanext.com</UserName>
    </GetWsdlVersion>
  </soap:Body>
</soap:Envelope>