Skip to content
NexumAPI Docs

InformationService⁠

Operations⁠

getGeneralInformation⁠

POST

Retrieves general status information about the Symitar core.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
OperatingSystemDateTimestringoptionalDate and time of the operating system
BusinessDateTimestringoptionalDate and time of the business
PreviousBusinessDatestring · dateoptionalPrevious business date
OperatingSystemHostNamestringoptionalHost name of the operating system
InstitutionNumberintegeroptionalInstitution number of of Symitar
SymNumberintegeroptionalThe Symitar number of the SymXchange instance
SymXchangeInstanceNamestringoptionalInstance name for SymXchange
SymXchangeClientNumberintegeroptionalClient number for SymXchange
InMemoModebooleanoptionalIndicates if the system is in memo mode
VersionstringoptionalVersion of Symitar
ServicePackintegeroptionalService pack number of Symitar
AlphaReleasebooleanoptionalIndicates if the Symitar release is an alpha release
BetaReleasebooleanoptionalIndicates if the Symitar release is a beta release
PreReleasebooleanoptionalIndicates if the Symitar release is a pre-release
QuestVersionstringoptionalSymitar Quest version number
SymXChangeInstanceIdintegeroptionalInstance ID for SymXchange
SymXChangeLastOnHostDateTimestringoptionalDate and time of last interaction with the host for SymXchange
ServerTimeZonestringoptionalTime zone of the server
POST/nexum/{sym}/persistent/information/getGeneralInformation
POST /nexum/627/persistent/information/getGeneralInformation HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}