Licensing Web Service

Licensing

Click here for a complete list of operations.

RetrieveLicenses

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 /LicenseServer/Services/Licensing.asmx HTTP/1.1
Host: licensing.printaudit.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.printaudit.com/LicenseServer/Services/Licensing/RetrieveLicenses"

<?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>
    <RetrieveLicenses xmlns="http://www.printaudit.com/LicenseServer/Services/Licensing">
      <VendorID>string</VendorID>
      <VendorPassword>string</VendorPassword>
      <ThirdPartyKey>string</ThirdPartyKey>
      <LicenseKey>string</LicenseKey>
    </RetrieveLicenses>
  </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>
    <RetrieveLicensesResponse xmlns="http://www.printaudit.com/LicenseServer/Services/Licensing">
      <RetrieveLicensesResult>
        <ThirdPartyLicenseInfo>
          <ThirdPartyKey>string</ThirdPartyKey>
          <CustomerName>string</CustomerName>
          <ProductName>string</ProductName>
          <IsUnlimitedDevicesOrSeats>boolean</IsUnlimitedDevicesOrSeats>
          <TotalDevicesOrSeatsWithEmbedded>int</TotalDevicesOrSeatsWithEmbedded>
          <NumberOfDevicesOrSeats>int</NumberOfDevicesOrSeats>
          <LicenseKey>string</LicenseKey>
          <HasAnalysis>boolean</HasAnalysis>
          <HasReduction>boolean</HasReduction>
          <HasRecovery>boolean</HasRecovery>
          <HasSecure>boolean</HasSecure>
          <HasDatabaseMigration>boolean</HasDatabaseMigration>
          <IsFacilitiesManagerOnly>boolean</IsFacilitiesManagerOnly>
          <RicohDeviceSeats>int</RicohDeviceSeats>
          <ECopySeats>int</ECopySeats>
          <SharpOSASeats>int</SharpOSASeats>
          <KyoceraHyPASSeats>int</KyoceraHyPASSeats>
          <LexmarkeSFSeats>int</LexmarkeSFSeats>
          <XeroxEIPSeats>int</XeroxEIPSeats>
          <HPOXPSeats>int</HPOXPSeats>
          <KMOpenAPISeats>int</KMOpenAPISeats>
          <CopyAuditTouchSeats>int</CopyAuditTouchSeats>
          <IsLocked>boolean</IsLocked>
          <HasUnlimitedMaxActivations>boolean</HasUnlimitedMaxActivations>
          <MaxActivations>int</MaxActivations>
          <NumberOfActivations>int</NumberOfActivations>
          <DateLastActivated>dateTime</DateLastActivated>
          <DateLastValidated>dateTime</DateLastValidated>
          <DaysValidFromActivation>int</DaysValidFromActivation>
          <IsValidIndefinitely>boolean</IsValidIndefinitely>
          <PurchaseDate>dateTime</PurchaseDate>
        </ThirdPartyLicenseInfo>
        <ThirdPartyLicenseInfo>
          <ThirdPartyKey>string</ThirdPartyKey>
          <CustomerName>string</CustomerName>
          <ProductName>string</ProductName>
          <IsUnlimitedDevicesOrSeats>boolean</IsUnlimitedDevicesOrSeats>
          <TotalDevicesOrSeatsWithEmbedded>int</TotalDevicesOrSeatsWithEmbedded>
          <NumberOfDevicesOrSeats>int</NumberOfDevicesOrSeats>
          <LicenseKey>string</LicenseKey>
          <HasAnalysis>boolean</HasAnalysis>
          <HasReduction>boolean</HasReduction>
          <HasRecovery>boolean</HasRecovery>
          <HasSecure>boolean</HasSecure>
          <HasDatabaseMigration>boolean</HasDatabaseMigration>
          <IsFacilitiesManagerOnly>boolean</IsFacilitiesManagerOnly>
          <RicohDeviceSeats>int</RicohDeviceSeats>
          <ECopySeats>int</ECopySeats>
          <SharpOSASeats>int</SharpOSASeats>
          <KyoceraHyPASSeats>int</KyoceraHyPASSeats>
          <LexmarkeSFSeats>int</LexmarkeSFSeats>
          <XeroxEIPSeats>int</XeroxEIPSeats>
          <HPOXPSeats>int</HPOXPSeats>
          <KMOpenAPISeats>int</KMOpenAPISeats>
          <CopyAuditTouchSeats>int</CopyAuditTouchSeats>
          <IsLocked>boolean</IsLocked>
          <HasUnlimitedMaxActivations>boolean</HasUnlimitedMaxActivations>
          <MaxActivations>int</MaxActivations>
          <NumberOfActivations>int</NumberOfActivations>
          <DateLastActivated>dateTime</DateLastActivated>
          <DateLastValidated>dateTime</DateLastValidated>
          <DaysValidFromActivation>int</DaysValidFromActivation>
          <IsValidIndefinitely>boolean</IsValidIndefinitely>
          <PurchaseDate>dateTime</PurchaseDate>
        </ThirdPartyLicenseInfo>
      </RetrieveLicensesResult>
    </RetrieveLicensesResponse>
  </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 /LicenseServer/Services/Licensing.asmx HTTP/1.1
Host: licensing.printaudit.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>
    <RetrieveLicenses xmlns="http://www.printaudit.com/LicenseServer/Services/Licensing">
      <VendorID>string</VendorID>
      <VendorPassword>string</VendorPassword>
      <ThirdPartyKey>string</ThirdPartyKey>
      <LicenseKey>string</LicenseKey>
    </RetrieveLicenses>
  </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>
    <RetrieveLicensesResponse xmlns="http://www.printaudit.com/LicenseServer/Services/Licensing">
      <RetrieveLicensesResult>
        <ThirdPartyLicenseInfo>
          <ThirdPartyKey>string</ThirdPartyKey>
          <CustomerName>string</CustomerName>
          <ProductName>string</ProductName>
          <IsUnlimitedDevicesOrSeats>boolean</IsUnlimitedDevicesOrSeats>
          <TotalDevicesOrSeatsWithEmbedded>int</TotalDevicesOrSeatsWithEmbedded>
          <NumberOfDevicesOrSeats>int</NumberOfDevicesOrSeats>
          <LicenseKey>string</LicenseKey>
          <HasAnalysis>boolean</HasAnalysis>
          <HasReduction>boolean</HasReduction>
          <HasRecovery>boolean</HasRecovery>
          <HasSecure>boolean</HasSecure>
          <HasDatabaseMigration>boolean</HasDatabaseMigration>
          <IsFacilitiesManagerOnly>boolean</IsFacilitiesManagerOnly>
          <RicohDeviceSeats>int</RicohDeviceSeats>
          <ECopySeats>int</ECopySeats>
          <SharpOSASeats>int</SharpOSASeats>
          <KyoceraHyPASSeats>int</KyoceraHyPASSeats>
          <LexmarkeSFSeats>int</LexmarkeSFSeats>
          <XeroxEIPSeats>int</XeroxEIPSeats>
          <HPOXPSeats>int</HPOXPSeats>
          <KMOpenAPISeats>int</KMOpenAPISeats>
          <CopyAuditTouchSeats>int</CopyAuditTouchSeats>
          <IsLocked>boolean</IsLocked>
          <HasUnlimitedMaxActivations>boolean</HasUnlimitedMaxActivations>
          <MaxActivations>int</MaxActivations>
          <NumberOfActivations>int</NumberOfActivations>
          <DateLastActivated>dateTime</DateLastActivated>
          <DateLastValidated>dateTime</DateLastValidated>
          <DaysValidFromActivation>int</DaysValidFromActivation>
          <IsValidIndefinitely>boolean</IsValidIndefinitely>
          <PurchaseDate>dateTime</PurchaseDate>
        </ThirdPartyLicenseInfo>
        <ThirdPartyLicenseInfo>
          <ThirdPartyKey>string</ThirdPartyKey>
          <CustomerName>string</CustomerName>
          <ProductName>string</ProductName>
          <IsUnlimitedDevicesOrSeats>boolean</IsUnlimitedDevicesOrSeats>
          <TotalDevicesOrSeatsWithEmbedded>int</TotalDevicesOrSeatsWithEmbedded>
          <NumberOfDevicesOrSeats>int</NumberOfDevicesOrSeats>
          <LicenseKey>string</LicenseKey>
          <HasAnalysis>boolean</HasAnalysis>
          <HasReduction>boolean</HasReduction>
          <HasRecovery>boolean</HasRecovery>
          <HasSecure>boolean</HasSecure>
          <HasDatabaseMigration>boolean</HasDatabaseMigration>
          <IsFacilitiesManagerOnly>boolean</IsFacilitiesManagerOnly>
          <RicohDeviceSeats>int</RicohDeviceSeats>
          <ECopySeats>int</ECopySeats>
          <SharpOSASeats>int</SharpOSASeats>
          <KyoceraHyPASSeats>int</KyoceraHyPASSeats>
          <LexmarkeSFSeats>int</LexmarkeSFSeats>
          <XeroxEIPSeats>int</XeroxEIPSeats>
          <HPOXPSeats>int</HPOXPSeats>
          <KMOpenAPISeats>int</KMOpenAPISeats>
          <CopyAuditTouchSeats>int</CopyAuditTouchSeats>
          <IsLocked>boolean</IsLocked>
          <HasUnlimitedMaxActivations>boolean</HasUnlimitedMaxActivations>
          <MaxActivations>int</MaxActivations>
          <NumberOfActivations>int</NumberOfActivations>
          <DateLastActivated>dateTime</DateLastActivated>
          <DateLastValidated>dateTime</DateLastValidated>
          <DaysValidFromActivation>int</DaysValidFromActivation>
          <IsValidIndefinitely>boolean</IsValidIndefinitely>
          <PurchaseDate>dateTime</PurchaseDate>
        </ThirdPartyLicenseInfo>
      </RetrieveLicensesResult>
    </RetrieveLicensesResponse>
  </soap12:Body>
</soap12:Envelope>