Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.

Installation Check

GET /v9/installationCheck

Checks for a proper installation of the Sovren REST environment.

Warning

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

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

    Infoobject
    Information explaining the outcome of the transaction.
    Info.Codestring
    A response code elaborating on the HTTP status code.
    The following is a list of codes that can be returned by the service:

    Success – Successful transaction

    MissingParameter - A required parameter wasn't provided

    InvalidParameter - A parameter was incorrectly specified

    AuthenticationError - An error occurred with the credentials provided

    InstallationError - An issue with the Document Converter or Parser installation was found
    Info.Messagestring
    This message further describes the code providing additional detail.
    Valueobject
    Contains response data for the transaction.
    Value.LicenseSerialNumberstring
    The serial number of the Sovren license key being used.
    Value.Versionstring
    The version of the Document Converter and Parser.

    Sample Response

    { ... 
    { ... 
    "Code" :  "","Message" :  ""
    },
    { ... 
    "LicenseSerialNumber" :  "","Version" :  ""
    }
    }