System - Get system info

API Url

GET

http://localhost:16010/ProMarkREST/rest/System/info

Permissions: user

Query parameters

Field	Type	Description
expand`optional`	String	This is a string and will contain additional properties to be expanded in the response (Possible values will be: licenseAudit, upgradeHistory) and the expand option will be restricted to the Administrator.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
systemInfo	Object[]	Localized information.
companyName	String	Company name.
licenceAudit	Object[]	A license audit. Data includes information about users, user profiles, employees, terminals, and specific software components.
modules	Object[]	Modules list. (TRUE = the module is installed.) "enable" = TRUE if the parent module is installed.
upgradeHistory	Object	A list of dictionaries representing the upgrade history of a software system.
version	String	ProMark version.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
    "response": {
        "data": {
            "systemInfo": {
                "version": "4.62.DEVEL",
                "companyName": "ProMark Devel xx",
                "modules": {
                    "pcApprove": false,
                    "pcOffLine": true,
                    "enterpriseCentral": true,
                    "process": true,
                    "courses": true,
                    "proPortal": true,
                    "proPlanning": true,
                    "piecework": false,
                    "proBI": true,
                    "proMobileII": true,
                    "proNotify": true,
                    "kaba": true,
                    "proReportIII": true,
                    "proPortalII": true,
                    "construction": true,
                    "holidayAccounting": true,
                    "rollingSickness": false,
                    "proRoster": {
                        "enable": true,
                        "proSchedule": true,
                        "employeeShiftMgmt": true
                    },
                    "proTime": {
                        "enable": true,
                        "accountMonitor": true,
                        "bonusFigures": true
                    },
                    "proJob": {
                        "enable": true,
                        "foremann": true,
                        "jobCost": true
                    },
                    "proJect": {
                        "enable": true,
                        "distribution": true
                    },
                    "proManagement": {
                        "enable": true,
                        "proJob": true,
                        "proTime": {
                            "enable": true,
                            "rostering": true
                        }
                    },
                    "proReport": {
                        "proTime": true,
                        "proJob": true
                    }
                },
                "installedLanguages":[{
                   "code": "EN",
                   "name": "Default"
                },
                {
                   "code": "DK",
                   "name": "Dansk"
                }],
                "licenceAudit": {
                   "users": {
                      "active": 100,
                      "inactive": 10,
                      "administrators": 30,
                      "approvers": 50
                   },
                   "userProfiles": [
                       {
                          "id": "P1",
                          "description": "Restricted users",
                          "count": 30
                       },
                       {
                          "id": "P2",
                          "description": "Approval users",
                          "count": 40
                       }
                   ],
                   "employees": {
                      "active": 2500,
                      "inactive": 500
                   },
                   "terminals": {
                      "promark": 20,
                      "lan": 5,
                      "propc": 0,
                      "kabaLegacy": 0,
                      "pcmark": 0
                   },
                   "proPortalII": 100,
                   "proMobileII": 20,
                   "proPortal": 0,
                   "proAccess": {
                      "cards": 400,
                      "doors": 15
                   }
                },
                "upgradeHistory": [
                   {   
                      "version": "5.61.00",
                      "task": "ConvertHolidaySetup",
                      "time": "2023-11-22T06:00:00"
                   },
                   {
                      "version": "5.61.00",
                      "task": "ConvertBudgetApproval",
                       "time": "2023-11-22T06:00:00"
                   },
                   {
                       "version": "5.60.00",
                       "task": "ConvertCategory",
                       "time": "2023-07-03T06:30:00"
                    },
                    {
                       "version": "5.52.00",
                       "task": "AddMissingDomain",
                       "time": "2023-04-05T07:25:00"
                    }
                ]
            }
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.