Description

This API call retrieves version and environment information about the current pixi database installation. It returns the release version, revision name, database name, system configuration flags, and master service endpoint details. The call requires no input parameters and always returns exactly one row.

Request Parameters

#

Name

Type

Required

Example

Description

No input parameters required.

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pipiGetCurrentPixiVersion/>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: Version Information

#	Name	Type	Description
1	Version	string	Current release version of the pixi database. Resolved from the local change log, falling back to the master database value.
2	RevisionName	string	Human-readable name of the current release revision.
3	InformationQualityDescription	string	Status code describing the quality of the version data. See Additional Notes for possible values.
4	Version_DbChangeLog	string	Version identifier sourced from the local database change log.
5	Version_Master	string	Version identifier sourced from the master database service.
6	DatabaseName	string	Name of the current SQL Server database.
7	IsDesktopLoginEnabled	string	Indicates whether desktop login is enabled. Returns 1 (enabled) or 0 (disabled). Defaults to 1 if not explicitly configured.
8	DefaultEntryPointUri	string	Default entry point URI of the master service for this installation. Always ends with a trailing slash.
9	ClientId	string	Client identifier assigned to this pixi installation in the master service.

Additional Notes

InformationQualityDescription status codes:
- 200 OK: Version is consistent between the local change log and the master database.
- 301 Master database cannot be accessed, information is from local DB_Change_log: Master service unreachable; version data comes from the local change log only.
- 401 Master database's entry version information is not consistent with local DB_Change_Log: Version mismatch detected between master database and local change log.