api_auth

<back to all web services

LicenseCheck

The following routes are available for this service:
All Verbs/api/license/check
LicenseCheck Parameters:
NameParameterData TypeRequiredDescription
IsProVersionqueryboolNo
LicenseCheckResponse Parameters:
NameParameterData TypeRequiredDescription
LicensesformAvailableLicense[]No
AppsToDeactivateformAppToDeactivate[]No
AvailableLicense Parameters:
NameParameterData TypeRequiredDescription
AccountIDformlongNo
DisplayformstringNo
AppToDeactivate Parameters:
NameParameterData TypeRequiredDescription
ActivationAccountIDformlongNo
AppIDformlongNo
HardwareNameformstringNo
UserNameformstringNo
DisplayformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/license/check HTTP/1.1 
Host: 1.hyper.id 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LicenseCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <IsProVersion>false</IsProVersion>
</LicenseCheck>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LicenseCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <AppsToDeactivate>
    <AppToDeactivate>
      <ActivationAccountID>0</ActivationAccountID>
      <AppID>0</AppID>
      <HardwareName>String</HardwareName>
      <UserName>String</UserName>
    </AppToDeactivate>
  </AppsToDeactivate>
  <Licenses>
    <AvailableLicense>
      <AccountID>0</AccountID>
      <Display>String</Display>
    </AvailableLicense>
  </Licenses>
</LicenseCheckResponse>