Get Version


This request returns the versions of the server components.
This information can be used to ensure client-server compatibility.
Authentication is not required, in order to let clients implements a version-specific login.

Version Properties

name description

apiVersionMajor

major version number of the API

apiVersionMinor

minor version number of the API

apiVersionPatch

patch version number of the API

buildNumber

API build number

serverVersionMajor

major version number of Xelion

serverVersionUpdate

update level of Xelion (may be null)

serverVersionPatch

patch level of Xelion (may be null)

serverVersionBeta

beta update level (development only, may be null)

brand

brand name for branded Xelion versions (may be null)

The Xelion server numbers matches the Xelion version string. For example: Xelion version "v6u18p4" is equal to: major = "6", update = "18" and patch = "4".

Resource

GET /server/version

Parameters

None

Payload

None

Response

Context

Authorization

Guest

Errors

HTTP code Xelion code Description

500

11000

The Xelion version information could be read. See error message for more information.

Example

Request
GET https://xelion.nl/api/v1/master/server/version
Response
{
    "apiVersionMajor": 1,
    "apiVersionMinor": 4,
    "buildNumber": "20180503.1",
    "serverVersionMajor": 6,
    "serverVersionUpdate": 22,
    "serverVersionPatch": 1
}