Installation Check🔗︎

HTTP Verb	Path
GET	/installationCheck

Checks for a proper installation of the Textkernel REST environment.

Danger

Only use this as part of your installation process. Never call this repeatedly during normal operations.

Info

You can try this endpoint out in your Swagger page https://(your-server)/swagger/ui/index#!/InstallationCheck/InstallationCheck_Get

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

Code🔗︎

Code	Description
`Success`	Successful transaction
`AuthenticationError`	An error occurred with the credentials provided
`InstallationError`	An issue with the Document Converter or Parser installation was found

Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

EngineVersion 🔗︎ string

EngineVersion🔗︎

The version of the parsing/matching engine running under-the-hood.

ApiVersion 🔗︎ string

ApiVersion🔗︎

The version of the API.

TotalElapsedMilliseconds 🔗︎ integer

TotalElapsedMilliseconds🔗︎

How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

LicenseSerialNumber 🔗︎ string

LicenseSerialNumber🔗︎

The serial number of the Textkernel license key being used.

Version 🔗︎ string

Version🔗︎

The version of the Document Converter and Parser.

Sample JSON

{
  "Info": {
    "Code": "",
    "Message": "",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0
  },
  "Value": {
    "LicenseSerialNumber": "",
    "Version": ""
  }
}