licensing (GET)
{server}/api/v1/licensing
Description
Returns descriptive detail about the license in use (obtained from the authorization header).
Applies to:
- ScriptX.Services for Cloud
- ScriptX.Services for On-Premise Devices (Authorisation header is ignored)
- ScriptX.Services for Windows PC
Response model
License:
- guid (string, optional)
- Confirms the license identifier GUID as sent (encoded) in the request Authorisation header.
- company (string, optional)
- Name of the company or organisation to whom this license is assigned.
- companyHomePage (string, optional)
- URL of company or organisation website home page.
- from (string, optional)
- Start date of license in ISO date-time format eg. 2017-02-23T00:00:00+00:00.
- to (string, optional)
- End date of license in ISO date-time format eg. 2017-02-23T00:00:00.
- options (LicenseOptions, optional)
- Options for this license as defined by the LicenseOptions class.
- domains (Array[string], optional)
- Domains for which this license is valid. Only requests from licensed domains will be processed by the ScriptX.Services server.
LicenseOptions:
- basicHtmlPrinting (boolean, optional)
- Indicates whether the license (as specified in the request Authorisation header) is valid for basic HTML printing.
- advancedPrinting (boolean, optional)
- Indicates whether the license (as specified in the request Authorisation header) is valid for advanced printing options.
- enhancedFormatting (boolean, optional)
- Indicates whether the license (as specified in the request Authorisation header) is valid for enhanced formatting options.
- printPdf (boolean, optional)
- Indicates whether the license (as specified in the request Authorisation header) is valid for printing PDF documents.
- printRaw (boolean, optional)
- Indicates whether the license (as specified in the request Authorisation header) is valid for direct (RAW) printing.