Read Door (Command) - Paradox API

31. Read Door (Command)

 Use to retrieve (read) door programming

 Request (Pascal STDCALL)

function ReadDoor(const PanelID: Cardinal; DoorNo: Cardinal; out XMLDoor: WideString):

HResult; stdcall;1. PanelID parameter identifies the connected control panel to retrieve information 2. DoorNo parameter identifies the door # to read programming

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List ) 2. Function parameter (XMLDoor) returns XMLData; see below:

Page 33 of 64

<?xml version="1.0"?>

<method name="DoorEnabled" readonly="True" type="Boolean">False</method>

<method name="DoorAccessEnabled" readonly="True" type="Boolean">False</method>

<method name="DoorAccessCodeOnKeypad" readonly="True" type="Boolean">False</method>

<method name="DoorAccessCardAndCode" readonly="True" type="Boolean">False</method>

<method name="DoorAccessArmRestricted" readonly="True" type="Boolean">False</method>

<method name="DoorAccessDisarmRestricted" readonly="True" type="Boolean">False</method>

<method name="DoorBurglaryAlarmOnForced" readonly="True" type="Boolean">False</method>

<method name="DoorSafeModeEnabled" readonly="False" type="Boolean">False</method>

<method name="DoorCardActivatesUnlockedSchedule" readonly="True" type="Boolean">False</method>

<method name="DoorUnlockDoorOnFireAlarm" readonly="True" type="Boolean">False</method>

<method name="DoorUnlockOnRequestForExit" readonly="True" type="Boolean">False</method>

</published>

</object>

</objects>



Parameter definition

method name Definition

(EVO only) (EVO only)

“DoorNo" Door #

“DoorLabel“ Door label (up to 16 characters)

“DoorEnabled“ Door is enabled (active) in the control panel

“DoorSerialNo“ Door serial #

“DoorAreaAssignment“ Door area(s) assignment (comma delimited, ex:“1,2”)

“DoorAccessEnabled“ Door access control is enabled

“DoorAccessOption“ Door access option:

Possible Values

"Or"

"And"

“DoorAccessCodeOnKeypad“ Door access via valid code on keypad

“DoorAccessCardAndCode“ Door access requires valid code and card

“DoorAccessArmRestricted“ Door access restricted while system is armed

“DoorAccessDisarmRestricted“ Door access restricted while system is disarmed

“DoorBurglaryAlarmOnForced“ Door generates burglary alarm on force arm

“DoorUnlockScheduleStartTimeA“ Door unlock schedule 1, start time

“DoorUnlockScheduleEndTimeA“ Door unlock schedule 1, end time

“DoorUnlockScheduleDaysA“ Door unlock schedule 1, days (comma delimited, ex:“sun, tue”)

“DoorUnlockScheduleStartTimeB“ Door unlock schedule 2, start time

“DoorUnlockScheduleEndTimeB“ Door unlock schedule 2, end time

“DoorUnlockScheduleDaysB“ Door unlock schedule 2, days (comma delimited, ex:“sun, tue”)

“DoorSafeModeEnabled“ Door safe mode is enabled

Page 34 of 64

“DoorSameModeCard1“ Door same mode card # (1) (format:“000:00000”)

“DoorSameModeCard2“ Door same mode card # (2) (format:“000:00000”)

“DoorSameModeCard3“ Door same mode card # (3) (format:“000:00000”)

“DoorCardActivatesUnlockedSchedule“ Door access via card activates unlock schedule

“DoorUnlockDoorOnFireAlarm“ Door unlocks on fire alarm

“DoorUnlockOnRequestForExit“ Door unlocks on request for exit

32.

32. Write Write Door Door (Command)(Command)

 Use to add or update (write) door programming

 Request (Pascal STDCALL)

function WriteDoor(const PanelID: Cardinal; DoorNo: Cardinal; XMLDoor: WideString): HResult;

stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information 2. DoorNo parameter identifies the door # to write programming

3. Function parameter (XMLDoor) must contain XMLData; see below:

<?xml version="1.0"?>

<method name="DoorSafeModeEnabled" readonly="False" type="Boolean">False</method>

</published>

</object>

</objects>

 Parameters definition

method name Definition

(EVO only) (EVO only)

“DoorLabel“ Door label (up to 16 characters)

“DoorUnlockScheduleStartTimeA“ Door unlock schedule 1, start time

“DoorUnlockScheduleEndTimeA“ Door unlock schedule 1, end time

“DoorUnlockScheduleDaysA“ Door unlock schedule 1, days (comma delimited, ex: “sun, tue”)

“DoorUnlockScheduleStartTimeB“ Door unlock schedule 2, start time

“DoorUnlockScheduleEndTimeB“ Door unlock schedule 2, end time

“DoorUnlockScheduleDaysB“ Door unlock schedule 2, days (comma delimited, ex: “sun, tue”)

“DoorSafeModeEnabled“ Door safe mode is enabled

“DoorSameModeCard1“ Door same mode card # (1) (format: “000:00000”)

“DoorSameModeCard2“ Door same mode card # (2) (format: “000:00000”)

“DoorSameModeCard3“ Door same mode card # (3) (format: “000:00000”)

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List )

Page 35 of 64

33. Read All Schedules (Command) 33. Read All Schedules (Command)

 Use to retrieve (read) all schedules programming

 Request (Pascal STDCALL)

function ReadAllSchedules(const PanelID: Cardinal; out XMLSchedules: WideString): HResult;

stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List )

2. Function parameter (XMLSchedules) returns XMLData, see TPanelScheduleXML

34. Read Schedule (Command) 34. Read Schedule (Command)

 Use to retrieve (read) schedule programming

 Request (Pascal STDCALL)

function ReadSchedule(const PanelID: Cardinal; ScheduleNo: Cardinal; out XMLSchedule:

WideString): HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information 2. ScheduleNo parameter identifies the schedule # to read programming

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List ) 2. Function parameter (XMLSchedule) returns XMLData; see below:

<?xml version="1.0"?>

</published>

</object>

</objects>

 Parameter definition method name Definition EVO panels

EVO panels

"ScheduleNo" Schedule #

"ScheduleLabel" Door label (up to 16 characters)

"ScheduleBackupNo" Backup schedule #

"ScheduleStartTimeIntervalA" Schedule 1, start time

"ScheduleEndTimeIntervalA" Schedule 1, end time

"ScheduleDaysIntervalA" Schedule 1, days (comma delimited, ex:“sun, tue”)

"ScheduleStartTimeIntervalB" Schedule 2, start time

"ScheduleEndTimeIntervalB" Schedule 2, end time

"ScheduleDaysIntervalB" Schedule 2, days (comma delimited, ex:“sun, tue”)

35.

35. Write Schedule Write Schedule (Command)(Command)

Page 36 of 64

 Use to add or update (write) schedule programming

 Request (Pascal STDCALL)

function WriteSchedule(const PanelID: Cardinal; ScheduleNo: Cardinal; XMLSchedule:

WideString): HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information 2. ScheduleNo parameter identifies the schedule # to write programming 3. Function parameter (XMLSchedule) must contain XMLData; see below:

<?xml version="1.0"?>

</published>

</object>

</objects>

 Parameters definition

EVO panels EVO panels

"ScheduleLabel" Door label (up to 16 characters)

"ScheduleBackupNo" Backup schedule #

"ScheduleStartTimeIntervalA" Schedule 1, start time

"ScheduleEndTimeIntervalA" Schedule 1, end time

"ScheduleDaysIntervalA" Schedule 1, days (comma delimited, ex:“sun, tue”)

"ScheduleStartTimeIntervalB" Schedule 2, start time

"ScheduleEndTimeIntervalB" Schedule 2, end time

"ScheduleDaysIntervalB" Schedule 2, days (comma delimited, ex:“sun, tue”)

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List )

36. Read All Access Level (Command) 36. Read All Access Level (Command)

 Use to retrieve (read) all access levels programming

 Request (Pascal STDCALL)

function ReadAllAccessLevels(const PanelID: Cardinal; out XMLAccessLevels: WideString):

HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List )

2. Function parameter (XMLAccessLevels) returns XMLData, see TPanelAccessLevelXML

37. Read Access Level (Command) 37. Read Access Level (Command)

 Use to retrieve (read) access level programming

 Request (Pascal STDCALL)

Page 37 of 64 function ReadAccessLevel(const PanelID: Cardinal; AccessLevelNo: Cardinal; out

XMLAccessLevel: WideString): HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information 2. AccessLevelNo parameter identifies the access level # to read programming

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List ) 2. Function parameter (XMLAccessLevel) returns XMLData; see below:

<?xml version="1.0"?>

</published>

</object>

</objects>

 Parameter definition method name Definition EVO panels

EVO panels

AccessLevelNo" Access Level #

“ AccessLevelLabel” Access Level label (up to 16 characters)

“ AccessLevelDoors” Access Level affected doors (comma delimited, ex:“1,2”)

38.

38. Write Access Write Access Level (Command)Level (Command)

 Use to add or update (write) access level programming

 Request (Pascal STDCALL)

function WriteAccessLevel(const PanelID: Cardinal; AccessLevelNo: Cardinal; XMLAccessLevel:

WideString): HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information 2. AccessLevelNo parameter identifies the access level # to write programming 3. Function parameter (XMLAccessLevel) must contain XMLData; see below:

<?xml version="1.0"?>

</published>

</object>

</objects>

 Parameters definition

EVO panels EVO panels

“ AccessLevelLabel” Access Level label (up to 16 characters)

“ AccessLevelDoors” Access Level affected doors (comma delimited, ex:“1,2”)

Page 38 of 64

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List )

39. Read Holidays (Command) 39. Read Holidays (Command)

 Use to retrieve (read) holidays programming

 Request (Pascal STDCALL)

function ReadHolidays(const PanelID: Cardinal; out XMLHolidays: WideString): HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List ) 2. Function parameter (XMLHolidays) returns XMLData; see below:

<?xmlversion="1.0"?>

<PanelHolidaysHolidays="01/10, 05/12"/>

</PanelInfo>

 Parameter definition

Section name Key name Definition EVO panels

EVO panels

PanelHolidays Holidays All holidays (comma delimited, format: "Day/Month" ex: "01/10, 05/12")

40.

40. Write Write Holidays Holidays (Command)(Command)

 Use to add or update (write) holidays programming

 Request (Pascal STDCALL)

function WriteHolidays(const PanelID: Cardinal; XMLHolidays: WideString): HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information 2. Function parameter (XMLHolidays) must contain XMLData; see below:

<?xmlversion="1.0"?>

<PanelHolidaysHolidays="01/10, 05/12" />

</PanelInfo>

 Parameters definition

Section name Key name Definition EVO panels

EVO panels

PanelHolidays Holidays All holidays (comma delimited, format: "Day/Month" ex: "01/10, 05/12")

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List )

41. Read All Users (Command) 41. Read All Users (Command)

 Use to retrieve (read) all users programming

 Only the system master or the master user can read user programming

 Request (Pascal STDCALL)

function ReadAllUsers(const PanelID: Cardinal; out XMLUsers: WideString): HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List )

2. Function parameter (XMLUsers) returns XMLData, see TPanelUserXML

Page 39 of 64

42. Read User (Command) 42. Read User (Command)

 Use to retrieve (read) user programming

 Only the system master or the master user can read user programming

 Request (Pascal STDCALL)

function ReadUser(const PanelID: Cardinal; UserNo: Cardinal; out XMLUser: WideString):

HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information 2. UserNo parameter identifies the user # to read programming

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List ) 2. Function parameter (XMLUser) returns XMLData; see below:

<?xml version="1.0"?>

<method name="UserUsed" readonly="False" type="Boolean">False</method>

<method name="UserCanBypass" readonly="False" type="Boolean">False</method>

<method name="UserCanStaySleepArm" readonly="False" type="Boolean">False</method>

<method name="UserCanForceArm" readonly="False" type="Boolean">False</method>

<method name="UserCanArmOnly" readonly="False" type="Boolean">False</method>

<method name="UserCanActivationPGMOnly" readonly="False" type="Boolean">False</method>

<method name="UserCanDuress" readonly="False" type="Boolean">False</method>

<method name="UserAccessControlEnabled" readonly="False" type="Boolean">False</method>

<method name="UserExtendedUnlockTime" readonly="False" type="Boolean">False</method>

<method name="UserAddScheduleTolerance" readonly="False" type="Boolean">False</method>

<method name="UserCodeFollowsSchedule" readonly="False" type="Boolean">False</method>

<method name="UserCardDisarmOnAccess" readonly="False" type="Boolean">False</method>

<method name="UserCardAndPINDisarm" readonly="False" type="Boolean">False</method>

<method name="UserCodeLength" readonly="False" type="UnicodeString">4 Digits</method>

</published>

</object>

</objects>

 Parameter definition method name Definition (MG/SP/EVO panels)

(MG/SP/EVO panels)

"UserNo" User #

"UserName" User label (up to 16 characters)

"UserUsed" User is used (has a valid user code in the system)

"UserCode" User code

"UserCard" User card #

"UserRemoteSerialNo" User remote serial #

Page 40 of 64

"UserPartitionAccess" User area access (comma delimited, ex:“1,2”)

"UserCanBypass" User can bypass is enabled

"UserCanStaySleepArm" User can stay / sleep arm is enabled

"UserCanForceArm" User can force arm is enabled

"UserCanArmOnly" User can arm only (no disarm) is enabled

"UserCanActivationPGMOnly

User can activate PGM only (no deactivate) is enabled

"UserCanDuress" User can duress is enabled (EVO panel only)

(EVO panel only)

"UserType" User type:

Possible Values

"Regular "

"Master "

"Full Master "

"UserAccessControlEnabled" User access control is enabled

"UserAccessLevelNo" User access level assignment (see Access Level command)

"UserAccessScheduleNo" User access schedule assignment (see Schedule command)

"UserExtendedUnlockTime" User extended unlock period is enabled

"UserAddScheduleTolerance" User extended schedule tolerance is enabled

"UserCodeFollowsSchedule" User code follows schedule

"UserArmWithCard" User can arm with card

"UserCardDisarmOnAccess" User can disarm system on card access

"UserCardAndPINDisarm" User must enter a valid card and PIN to disarm the system

"UserCodeLength" User code length:

Possible Values

"4 Digits"

"6 Digits"

"Flexible"

43. Write Multiple Users (Command) 43. Write Multiple Users (Command)



Use to add or update (write) multiple users programming

 Only the system master or the master user can write user programming

 Request (Pascal STDCALL)

function WriteMultipleUsers(const PanelID: Cardinal; XMLUsers: WideString): HResult; stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information 2. Function parameter (XMLUsers) must contain XMLData, see TPanelUserXML

 Answer

1. Function call returns HResult (see 2.2.2 Result Code List )

44.

44. Write User Write User (Command)(Command)

 Use to add or update (write) user programming

 Only the system master or the master user can write user programming

 You must read all users to detect user availability (see“UserUsed” property)

 Request (Pascal STDCALL)

function WriteUser(const PanelID: Cardinal; UserNo: Cardinal; XMLUser: WideString): HResult;

stdcall;

1. PanelID parameter identifies the connected control panel to retrieve information 2. UserNo parameter identifies the user # to write programming

3. Function parameter (XMLUser) must contain XMLData; see below:

<?xml version="1.0"?>

Page 41 of 64