InformationService

Get critical information about the core.

circle-info

Operations

getGeneralInformation

post

Retrieves general status information about the Symitar core.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
chevron-right
200

Successful operation.

application/json
OperatingSystemDateTimestringOptional

Date and time of the operating system

Example: 2023-04-25T08:00:00Z
BusinessDateTimestringOptional

Date and time of the business

Example: 2023-04-25T08:00:00Z
PreviousBusinessDatestring · dateOptional

Previous business date

Example: 2023-04-24
OperatingSystemHostNamestringOptional

Host name of the operating system

Example: ["object Object"]
InstitutionNumberintegerOptional

Institution number of of Symitar

Example: ["object Object"]
SymNumberintegerOptional

The Symitar number of the SymXchange instance

Example: 627
SymXchangeInstanceNamestringOptional

Instance name for SymXchange

Example: LIBUM
SymXchangeClientNumberintegerOptional

Client number for SymXchange

Example: ["object Object"]
InMemoModebooleanOptional

Indicates if the system is in memo mode

Example: ["object Object"]
VersionstringOptional

Version of Symitar

Example: 2022.01
ServicePackintegerOptional

Service pack number of Symitar

Example: ["object Object"]
AlphaReleasebooleanOptional

Indicates if the Symitar release is an alpha release

Example: ["object Object"]
BetaReleasebooleanOptional

Indicates if the Symitar release is a beta release

Example: ["object Object"]
PreReleasebooleanOptional

Indicates if the Symitar release is a pre-release

Example: ["object Object"]
QuestVersionstringOptional

Symitar Quest version number

Example: 3.2022.1.120
SymXChangeInstanceIdintegerOptional

Instance ID for SymXchange

Example: ["object Object"]
SymXChangeLastOnHostDateTimestringOptional

Date and time of last interaction with the host for SymXchange

Example: 2023-04-25T08:00:00Z
ServerTimeZonestringOptional

Time zone of the server

Example: PST8PDT
post
/getGeneralInformation
200

Successful operation.

Last updated

Was this helpful?