InformationService

Get critical information about the core.

Symitar eDocs References: SYSTEMINFO, Memo Post Mode

Operations

getGeneralInformation

post

Retrieves general status information about the Symitar core.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

OperatingSystemDateTimestringOptional

Date and time of the operating system

BusinessDateTimestringOptional

Date and time of the business

PreviousBusinessDatestring · dateOptional

Previous business date

OperatingSystemHostNamestringOptional

Host name of the operating system

InstitutionNumberintegerOptional

Institution number of of Symitar

SymNumberintegerOptional

The Symitar number of the SymXchange instance

SymXchangeInstanceNamestringOptional

Instance name for SymXchange

SymXchangeClientNumberintegerOptional

Client number for SymXchange

InMemoModebooleanOptional

Indicates if the system is in memo mode

VersionstringOptional

Version of Symitar

ServicePackintegerOptional

Service pack number of Symitar

AlphaReleasebooleanOptional

Indicates if the Symitar release is an alpha release

BetaReleasebooleanOptional

Indicates if the Symitar release is a beta release

PreReleasebooleanOptional

Indicates if the Symitar release is a pre-release

QuestVersionstringOptional

Symitar Quest version number

SymXChangeInstanceIdintegerOptional

Instance ID for SymXchange

SymXChangeLastOnHostDateTimestringOptional

Date and time of last interaction with the host for SymXchange

ServerTimeZonestringOptional

Time zone of the server

post/getGeneralInformation

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/information/getGeneralInformation HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 157

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "OperatingSystemDateTime": "2026-06-27T17:56:24",
  "BusinessDateTime": "2010-05-08T17:56:24",
  "PreviousBusinessDate": "2010-05-07",
  "OperatingSystemHostName": "smoepivendvip.jhacorp.com",
  "InstitutionNumber": 0,
  "SymNumber": 627,
  "SymXchangeInstanceName": "LIBUM",
  "SymXchangeClientNumber": 0,
  "InMemoMode": false,
  "Version": "2025.01",
  "ServicePack": 3,
  "AlphaRelease": true,
  "BetaRelease": false,
  "PreRelease": false,
  "QuestVersion": "3.2025.1.72         ",
  "SymXChangeInstanceId": 0,
  "SymXChangeLastOnHostDateTime": "2026-06-22T10:41:08",
  "ServerTimeZone": "America/Los_Angeles",
  "Status": {
    "StatusCode": 0,
    "Message": null
  }
}