System
Used to check license limits, perform online (automatic) licensing and firmware update, retrieve the controller time, check database migration status and install HTTPS certificates.
Type: System
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=System&SubType=<SubType>SubTypes
-
LicenceLimits
-
OnlineLicenceUpdate
-
ServerTimeX
-
CheckMigration
-
HTTPSValidate, HTTPSCert, HTTPSPassForCert (see Update HTTPS Certificate)
LicenceLimits
Request a list of license items and their limits.
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=System&SubType=LicenceLimitsSuccess Response
Successful response contains the ampersand separated list of records.
WXNumDoors=32&WXNumUsers=10000&WXNumAccessLevels=4294967295&WXNumCredentialTypes=4294967295&WXNumDoorTypes=4294967295&WXNumSchedules=4294967295&WXNumZones=512&WXNumZoneTypes=4294967295&WXNumTroubleZones=512&WXNumAreas=32&WXNumPgms=512&WXNumPhoneNumbers=4294967295&WXNumServices=16&WXNumFloors=0&WXNumElevators=0&WXNumAreaGroups=4294967295&WXNumDoorGroups=4294967295&WXNumElevatorGroups=0&WXNumFloorGroups=0&WXNumKeypadGroups=4294967295&WXNumMenuGroups=4294967295&WXNumPgmGroups=4294967295&WXNumKeypads=32&WXNumAnalogExpanders=32&WXNumZoneExpanders=32&WXNumPgmExpanders=32&WXNumReaderExpanders=32&WXNumHolidayGroups=4294967295&WXNumProgFunctions=0&WXNumAutomations=0&WXNumDataValues=248&WXNumReaderUnits=128&WXNumEventReports=4294967295&WXNumCameras=2&WXNumServiceCID=16&WXNumServiceSerialPrinter=0&WXNumServiceSIA=0&WXNumServiceAutomation=0&WXNumServiceModBus=0&WXNumServiceCBus=0&WXNumServiceIntercom=0&WXNumServiceReportIp=16&WXNumServiceLinkMe=0&WXNumServiceVizIp=0&WXNumServiceBacNet=0&WXNumServiceHLIElevator=0&WXNumServiceAperio=0&WXNumRdr485ICT=16&WXNumRdr485OSDP=0&WXNumRdr485SALLIS=0&WXNumRdr485APERIO=0&WXNumRdr485ALLEGION=0&WXNumRdr485CREDENTIAL=0&WXNumProgFnLogic=0&WXNumProgFnAreaControl=0&WXNumProgFnDoorControl=0&WXNumProgFnRippleControl=0&WXNumProgFnVirtualDoor=0&WXNumProgFnValueCompare=0&WXNumProgFnZoneControl=0&WXNumProgFnElevatorControl=0&WXNumProgFnRegisterCounter=0&WXNumProgFnFloorTemping=0&WXNumProgFnRTHP=0&WXNumProgFnSequentialCompare=0&WXNumProgFnAverage=0&WXNumFirmwareUpdate=0&WXpert=0&WXNumRegistration=0See License Items for a full list of response parameters.
OnlineLicenceUpdate
Perform online (automatic) licensing.
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=System&SubType=OnlineLicenceUpdate&SiteName=Test Site&SiteContact=John Smith&SiteEmail=jsmith@domain.com&InstallerContact=John Smith&InstallerEmail=jsmith@domain.com&DisplaySiteName=true&WebVersion=02.3.213&ServerName=ict.co&ServerPort=80&OutboundPort=12345Request Parameters
|
Parameter |
Example |
Description |
|---|---|---|
|
SiteName |
Test Site |
Name of the site where the system is installed |
|
SiteContact |
John Smith |
Name of the site contact |
|
SiteEmail |
jsmith@domain.com |
Email address of the site contact |
|
InstallerContact |
John Smith |
Name of the installer contact |
|
InstallerEmail |
jsmith@domain.com |
Email address of the installer contact |
|
DisplaySiteName |
Boolean true or false |
Whether to display site name in the UI or not |
|
WebVersion |
02.3.213 |
Protege WX firmware version number |
|
ServerName |
ict.co |
The DNS name of the license server |
|
ServerPort |
80 |
The port to connect to the license server on |
|
OutboundPort |
12345 |
The outbound port to connect to the license server |
Errors
Request Failed (12) The Installers name or other details were not foundRequest Failed (13) The main app returned but not with a recognisable Ack.Request Failed (14) No response from the main app.Request Failed (23) Could not connect to the server.Request Failed (24) Request sent but no response from the Server.Request Failed (25) Invalid response from the server.ServerTimeX
Request the current controller system time.
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=System&SubType=ServerTimeXSuccess Response
ts=1136286165The response parameters are:
|
Parameter |
Example |
Description |
|---|---|---|
|
ts |
1136286165 |
The controller system time in seconds since 1 Jan 1970 |
CheckMigration
Checks if the database has just been migrated from V3 to V4.
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=System&SubType=CheckMigration*uploaded_file*Success response:
No migration.The db has just been migrated from V3 to V4.Errors
Request Failed (10) SubType not recognised.Request Failed (11) SubType not found.Request Failed (12) The Installers name or other details were not foundRequest Failed (13) The main app returned but not with a recognisable Ack.Request Failed (14) No response from the main app.Request Failed (15) The licence file will not allow firmware updates.Request Failed (16) The main app returned but with a Nack.Request Failed (17) The DLL could not reload the firmware file.Request Failed (18) The firmware file CRC failed.Request Failed (19) The firmware file was downloaded OK but the main app did not accept the restart command.Request Failed (20) The DLL could not reload the licence file.Request Failed (21) The licence file CRC failed.Request Failed (22) The licence file serial number failed.Request Failed (23) Could not connect to the server.Request Failed (24) Request sent but no response from the Server.Request Failed (25) Invalid response from the server.Request Failed (128) Request SubType not recognised.Request Failed (129) Request Type not recognised.