licensing/ping (GET)

{server}/api/v1/licensing/ping[?licenseGuid={guid}]

Description

Used to check if the service is available (the call will succeed whether or not the licenseGuid parameter is specified). If licenseGuid is specified and matches an installed license (ScriptX.Services for Windows PC) or valid subscription identifier (ScriptX.Services for Cloud) the options enabled for the license/subscription are returned.

No authorization header is required for this API call.

Applies to:

  • ScriptX.Services for Cloud
  • ScriptX.Services for On-Premise Devices (licenseGuid parameter is ignored)
  • ScriptX.Services for Windows PC

Response model

LicenseOptions:
basicHtmlPrinting (boolean, optional)
Indicates whether the license (as specified in the optional licenseGuid parameter) is valid for basic HTML printing.
advancedPrinting (boolean, optional)
Indicates whether the license (as specified in the optional licenseGuid parameter) is valid for advanced printing options.
enhancedFormatting (boolean, optional)
Indicates whether the license (as specified in the optional licenseGuid parameter) is valid for enhanced formatting options.
printPdf (boolean, optional)
Indicates whether the license (as specified in the optional licenseGuid parameter) is valid for printing PDF documents.
printRaw (boolean, optional)
Indicates whether the license (as specified in the optional licenseGuid parameter) is valid for direct (RAW) printing.

Example usage



Request




Response 
Response headers