Submit

Used to create or update records.

Type: Submit

Copy 
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=<SubType>

SubTypes

The subtype for Submit is the record's table name (see Table Names).

Request Parameters

The parameters for Submit are detailed under each record in the Programming section.

To update a record an ID parameter must be supplied (e.g. UserId, AreaId). For example, to edit the area with ID of 17:

Copy 
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_AREAS_TBL&AreaId=17&Name=Reception&EntryTimeSeconds=15

To create a new record the ID parameter is still supplied but its value is empty. For example, to add a new area:

Copy 
http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_AREAS_TBL&AreaId=&Name=Area 1&EntryTimeSeconds=30&AlternateEntryTime=60&ExitTimeSeconds=45&Alarm1TimeMinutes=4&SmartZoneTimer=20&SmartZoneCount=0&ChildArea=2147483647&RearmAreaTimeMinutes=15&MaximumBypassZoneCount=0&MaxUserCount=0&BellPGMOutput=112&BellPulseOnTime=0&BellPulseOffTime=0&ExitDelayPGMOutput=2147483647&ExitDelayPulseOnTime=0&ExitDelayPulseOffTime=0&EntryDelayPGMOutput=2147483647&EntryDelayPulseOnTime=0&EntryDelayPulseOffTime=0&DisarmedPGMOutput=2147483647&DisarmedPulseOnTime=0&DisarmedPulseOffTime=0&ArmedPGMOutput=2147483647&ArmedPulseOnTime=0&ArmedPulseOffTime=0&ReadyPGMOutput=2147483647&ReadyPGMOutputGroup=2147483647&BypassedZonesPGMOutput=2147483647&BypassedZonesPulseOnTime=0&BypassedZonesPulseOffTime=0&TamperAlarmPGMOutput=2147483647&TamperAlarmPulseOnTime=0&TamperAlarmPulseOffTime=0&AlarmMemoryPGMOutput=2147483647&AlarmMemoryPulseOnTime=0&AlarmMemoryPulseOffTime=0&UserCountReachedPGMOutput=2147483647&UserCountReachedPulseOnTime=0&UserCountReachedPulseOffTime=0&ClientCode=65535&ReportingId=2&ZoneRestoreOnBellCutOff=false&ReArmEnabled=false&ArmChildArea=false&ArmChildIfAllOtherAreasAreArmed=false&DisarmChildArea=false&DisarmChildIfAllOtherAreasAreaDisarmed=false&UseUnattendedBruteForceArming=false&AreaEnabledInLoiterMode=false&ReportArming=true&ReportDisarming=true&Report24HRAreaDisarming=true&ReportUserBypass=true&EnableUserCounting=false&ArmOnUserCountAt0=false&ReportEntryAlarmImmediately=false&ClearUserCountWhenArmed=true&EnableStayArming=true&EnableForceArming=true&EnableInstantArming=true&DoNotArmIfTroubleCondition=false&VaultControlArea=false&DualCodeVaultControl=false&PreventArmingOnCountNotZero=false&AlwaysVerifyAreaSchedule=false&UserRearmInStayMode=false&DisarmAreaWhenScheduleStarts=false&ArmAreaWhenScheduleStarts=false&EnableSmartInput=false&AreaCanBeReset=false&RecentClosingTime=0&LoiterTimerInMinutesDefault=0&LoiterResetArea=2147483647&InterlockAreaGroup=2147483647&VaultDisarmDelaySeconds=0&VaultDualCodeDelaySeconds=0&ArmDisarmSchedule=2147483647&DeferAutomaticArming=false&AlwaysForceArmUsingCardReader=false&DisableExitPGMonStayArming=false&ClearAlarmMemoryafterArming=false&EnableLateArmReport=false&EnableEarlyDisarmReport=false&DisableReArmOnSchedule=false&AreaDeferArmingStartedPGMOutput=2147483647&DeferArmingStartedPulseOnTime=0&DeferArmingStartedPulseOffTime=0&DeferWarningKeypadGroup=2147483647&DeferWarningTimeMinutes=60&FailToArmPGM=2147483647&BellSquawkOnArmingStart=false&BellSquawkOnArmingComplete=false&BellSquawkOnlyWhenUnattended=false&BellSquawkOnDisarm=false&BellSquawkOnSuccessfulReport=false&NormalDisarmSchedule=2147483647&NormalArmSchedule=2147483647&LockAreaGroupOnArming=2147483647&BellPGMOutputGroup=2147483647&ExitDelayPGMOutputGroup=2147483647&EntryDelayPGMOutputGroup=2147483647&DisarmedPGMOutputGroup=2147483647&ArmedPGMOutputGroup=2147483647&BypassedZonesPGMOutputGroup=2147483647&TamperAlarmPGMOutputGroup=2147483647&AlarmMemoryPGMOutputGroup=2147483647&UserCountReachedPGMOutputGroup=2147483647&AreaDeferArmingStartedPGMOutputGroup=2147483647&FailToArmPGMGroup=2147483647&Commands=&ServiceId0=1

You do not need to define every parameter when adding a record. Any parameters which are not defined will use the default values as shown in the parameter table for each record type.

The ID parameter must be supplied before any other parameters or the data will not be updated. Other parameters can be entered in any order

String Length

The Protege WX API puts limits on the length of strings that can be submitted. The limits are:

  • Most fields can have a maximum of 50 characters.

  • User name fields (First Name, Last Name and Display Name) can have a maximum of 32 characters. This is to save memory on sites with large numbers of users.

  • The Wiegand or TLV Format field in credential types has no limit.

  • The Commands field has no limit for any record type.

Any submission that includes strings longer than these limits will be rejected, with the response: 'Command Failed (18) Submitted record name is too long'.

Success Response

Copy 
OK

For records that have a Reporting ID, if the record saved successfully but the Reporting ID was changed by the controller, the following response will be returned.

Copy 
OK. Reporting ID changed from 0 to <new Reporting ID>.

Errors

Copy 
Command Failed (1) The specified table type was not found.

Corrective action: Check that the command is correctly formatted and contains a valid table type.
Copy 
Command Failed (2) The specified record Id was not found.

Corrective action: Check that the command is correctly formatted and contains the Id of a record that is known to be in the database. 
                   If creating a new record the record Id parameter should be submitted without a number included and an Id will be automatically assigned.
Copy 
Command Failed (4) Submitting this record would exceed the licence limits.

Corrective action: None, the licensed number of records has been reached.
                   If there are unused records then deleting them first will allow new records to be added but not more that the license allows.
Copy 
Command Failed (10) Could not load database file.

Corrective action: For application software build 359 or earlier this indicates an internal fault, contact ICT Support. Later firmware will not return this error.
Copy 
Command Failed (11) Record processed, but unable to save database.

Corrective action: This indicates an internal fault. Contact ICT Support.
Copy 
Command Failed (12) Record saved, but main app did not respond.

Corrective action: This indicates an internal fault. Contact ICT Support.
Copy 
Command Failed (18) Submitted record name is too long.

Corrective action: Resubmit the record with a name containing 50 characters or less (32 characters or less for users).