COSEC PANEL200 API Guide

SECURITY SOLUTIONS

COSEC Panel200 API

User Guide
Documentation Disclaimer
Matrix Comsec reserves the right to make changes in the design or components of the product as engineering and
manufacturing may warrant. Specifications are subject to change without notice.

This is a general documentation for all variants of the product. The product may not support all the features and
facilities described in the documentation.

Information in this documentation may change from time to time. Matrix Comsec reserves the right to revise
information in this publication for any reason without prior notice. Matrix Comsec makes no warranties with respect
to this documentation and disclaims any implied warranties. While every precaution has been taken in the
preparation of this system manual, Matrix Comsec assumes no responsibility for errors or omissions. Neither is any
liability assumed for damages resulting from the use of the information contained herein.

Neither Matrix Comsec nor its affiliates shall be liable to the buyer of this product or third parties for damages,
losses, costs or expenses incurred by the buyer or third parties as a result of: accident, misuse or abuse of this
product or unauthorized modifications, repairs or alterations to this product or failure to strictly comply with Matrix
Comsec operating and maintenance instructions.

Copyright
All rights reserved. No part of this system manual may be copied or reproduced in any form or by any means
without the prior written consent of Matrix Comsec.

Version 15.0
Release date: December 27, 2024
 Contents

About the Document ..................................................................................................................................... 1

Document Conventions........................................................................................................................................ 1
Document Organization ....................................................................................................................................... 2
Who Can Use This Document.............................................................................................................................. 2
API Overview .................................................................................................................................................. 3
How It Works........................................................................................................................................................ 3
General Features ................................................................................................................................................. 4
What the User Should Know ................................................................................................................................ 4
Prerequisite .......................................................................................................................................................... 5
Authentication ...................................................................................................................................................... 5
HTTP Request-Response .................................................................................................................................... 5
Communication Flow ...................................................................................................................................................................... 6
Request Format .............................................................................................................................................................................. 6
Response Format ........................................................................................................................................................................... 7
URL Syntax..................................................................................................................................................................................... 8
Common Actions ............................................................................................................................................................................ 9
Additional Information ........................................................................................................................................ 10
Supported APIs ............................................................................................................................................ 11
Panel Door Configuration ........................................................................................................................... 13
Panel Door List................................................................................................................................................... 13
Panel Door Configuration................................................................................................................................... 14
Reader Configuration ......................................................................................................................................... 26
Commands......................................................................................................................................................... 29
Function Key Configuration................................................................................................................................ 34
To Download/Upload Multi-Language File ......................................................................................................... 35
Alarm Configuration ........................................................................................................................................... 36
Face Identification Settings ................................................................................................................................ 38
Face Mask Compulsion...................................................................................................................................... 40
Panel Configuration ..................................................................................................................................... 41
Panel Basic Configuration.................................................................................................................................. 42
Access Settings Configuration ........................................................................................................................... 45
Panel Advance Configuration............................................................................................................................. 46
Enrollment Configuration.................................................................................................................................... 47
Alarm Configuration ........................................................................................................................................... 49
Date and Time Configuration ............................................................................................................................. 50
System Timers Configuration............................................................................................................................. 53
Special Function Configuration .......................................................................................................................... 55
Multi-Language Support..................................................................................................................................... 57
To Download/Upload Multi-Language File ......................................................................................................... 58
Access Features ................................................................................................................................................ 59
User Configuration ...................................................................................................................................... 61
Setting/Retrieving User Configuration................................................................................................................ 62
Deleting a User .................................................................................................................................................. 65
Setting User Credentials .................................................................................................................................... 66
Retrieving User Credentials ............................................................................................................................... 67
Deleting User Credentials .................................................................................................................................. 71
Setting/Retrieving/Deleting User Photo.............................................................................................................. 72
Enrollment .................................................................................................................................................... 73
Enrolling a User.................................................................................................................................................. 74
Enrolling Special Cards...................................................................................................................................... 79

Table of Contents i
Events ........................................................................................................................................................... 81
Retrieving Events ............................................................................................................................................... 82
Retrieving Events in the TCP Socket ................................................................................................................. 85
Access Zone ................................................................................................................................................. 87
Sending Commands to Panel ..................................................................................................................... 89
IMEI Registration Request .......................................................................................................................... 93
Request for Security Code .......................................................................................................................... 95
To get Random Key on Code ...................................................................................................................... 97
Access Request on QR Scanning .............................................................................................................. 99
Access Policies .......................................................................................................................................... 103
Advanced Parameter for Access Route ........................................................................................................... 104
API Response Codes ................................................................................................................................. 105
Error Responses ........................................................................................................................................ 107
Appendix .................................................................................................................................................... 109
Event Configuration Reference ........................................................................................................................ 110

ii Table of Contents
 List of Tables

Table: Request - Panel Door List.................................................................................................................... 13

Table: Response - Panel Door List................................................................................................................. 13
Table: Set Panel Door Configuration Parameters .......................................................................................... 15
Table: Get Panel Door Configuration Parameters .......................................................................................... 21
Table: Response Panel Door Configuration ................................................................................................... 21
Table: Delete Panel Door Configuration Parameters ..................................................................................... 25
Table: Reader Configuration Parameters (All doors except COSEC ARC Controller) ................................... 26
Table: Reader Configuration Parameters (COSEC ARC Controller only) ...................................................... 27
Table: Normalize Door Parameters ................................................................................................................ 30
Table: To Lock the Door Parameters.............................................................................................................. 30
Table: To Unlock the Door Parameters .......................................................................................................... 30
Table: Disable Aux Input Parameters ............................................................................................................. 31
Table: Normalize Aux Input Parameters......................................................................................................... 31
Table: Disable Aux Output Parameters .......................................................................................................... 31
Table: Normalize Aux Output Parameters ...................................................................................................... 32
Table: To Disable the Door Sense Parameters .............................................................................................. 32
Table: To Normalize the Door Sense Parameters.......................................................................................... 32
Table: Reset Aux Output Latch Parameters ................................................................................................... 32
Table: Clear Biometric Credentials Parameters ............................................................................................. 33
Table: Synchronize Credentials Parameters .................................................................................................. 33
Table: Calibrate FP Sensor Parameters......................................................................................................... 33
Table: Activate Aux Relay Parameters ........................................................................................................... 33
Table: Activate Aux Relay Parameters ........................................................................................................... 34
Table: Clear Face Credentials of the Door ..................................................................................................... 34
Table: Function Key Configuration Parameters.............................................................................................. 35
Table: Download/Upload Multi-Language File - Parameters .......................................................................... 36
Table: Alarm Configuration- Parameters ........................................................................................................ 37
Table: Alarm Configuration- Parameters ........................................................................................................ 39
Table: Alarm Configuration- Parameters ........................................................................................................ 41
Table: Panel Basic Configuration Parameters................................................................................................ 44
Table: Access Settings Configuration Parameters ......................................................................................... 47
Table: Device Configuration Parameters........................................................................................................ 48
Table: Enrollment Configuration Parameters.................................................................................................. 49
Table: Alarm Configuration Parameters ......................................................................................................... 51
Table: Date and Time Configuration Parameters ........................................................................................... 52
Table: System Timers Configuration Parameters........................................................................................... 55
Table: Special Function Configuration Parameters ........................................................................................ 57
Table: Multi-Language Support Parameters................................................................................................... 59
Table: Download/Upload Multi-Language File - Parameters .......................................................................... 60
Table: Access Feature - Parameters .............................................................................................................. 61
Table: User Configuration Parameters ........................................................................................................... 64
Table: Delete User - Parameters .................................................................................................................... 67
Table: Setting User Credentials - Parameters ................................................................................................ 68
Table: Retrieving User Credentials - Parameters ........................................................................................... 69
Table: Deleting User Credentials - Parameters .............................................................................................. 73
Table: User Photo Parameters ....................................................................................................................... 74
Table: Enrolling User - Parameters ................................................................................................................ 76
Table: Enroll Special Cards - Parameters ...................................................................................................... 81
Table: Retrieving Events - Parameters........................................................................................................... 84
Table: Retrieving Events in the TCP Socket - Parameters............................................................................. 87
Table: List of Commands to Device................................................................................................................ 91
Table: clear alarm - Parameters ..................................................................................................................... 91
Table: Get Credential Count Command - Parameters.................................................................................... 92
Table: acknowledge alarm - Parameters ........................................................................................................ 92
Table: Deleting Credentials for All Users - Parameters .................................................................................. 93
Table: Reset access policy - Parameters ....................................................................................................... 93
Table: IMEI Request ....................................................................................................................................... 95
Table: IMEI Request API Response ............................................................................................................... 96
Table: Security Code Request........................................................................................................................ 97
Table:Security Code Request API Response................................................................................................. 97
Table: Access Request-qr .............................................................................................................................. 99
Table: Access Request-qr Response ............................................................................................................. 99
Table: Group:access-request-qr ................................................................................................................... 101
Table: QR Request API Response ............................................................................................................... 101
Table: Access Policies- Action= set.............................................................................................................. 105
Table: Access Policies- Action= get ............................................................................................................. 105
Table: Access Policies- Action= delete......................................................................................................... 105
Table: Advance Parameter for Access Route - Action: set........................................................................... 106
Table: Advance Parameter for Access Route- Action: get ........................................................................... 106
Table: API Response Codes ........................................................................................................................ 107
Table: Universal Time Zone Reference ........................................................................................................ 111
Table: List of Events ..................................................................................................................................... 112
Table: Size of Event Field............................................................................................................................. 115
Table: Event Structure .................................................................................................................................. 115
Table: User Events ....................................................................................................................................... 116
Table: Special Function Code Reference ..................................................................................................... 118
Table: Field 3 Detail (User Events) Reference*............................................................................................ 119
Table: Information of Bit 0 and 1* ................................................................................................................. 119
Table: Information of Bit 4 to 14* .................................................................................................................. 119
Table: Field 3 Detail (User Events) Reference*............................................................................................ 121
Table: Information of Bit 0 and Bit 1* ............................................................................................................ 121
Table: Information of Bit 4 to 11* .................................................................................................................. 121
Table: Alarm Events ..................................................................................................................................... 122
Table: System Events................................................................................................................................... 125
About the Document

Welcome to the COSEC Panel200 API User Guide. Using this document you can learn more about COSEC APIs,
browse through detailed descriptions of individual APIs and test them using sample scenarios.

Document Conventions
This API User Guide will follow a set of document conventions to make it consistent and easier for you to read.
These are as follows:

1. Text within angle brackets (e.g. “<request-type>”) denotes content in URL syntax and should be replaced
with either a value or a string. The angle brackets should be ommitted in all instances except those used to
denote “tags” within XML responses (e.g. “<name></name>”).

2. The term device used in this document, will refer only to Panel200 in standalone mode or otherwise
mentioned explicitly.

3. Any expression resembling <x~y>, indicates that the field should be repeated for index values x to index
values y. This is to avoid duplicating the same parameter for multiple index numbers.

4. Additional information about any section appears in the form of notices. The following symbols have been
used for notices to draw your attention to important items.

Important: to indicate something that requires your special attention or to remind you of
something you might need to do when you are using the system.

Caution: to indicate an action or condition that is likely to result in malfunction or damage to the
system or your property.

Warning: to indicate a hazard or an action that will cause damage to the system and or cause
bodily harm to the user.

Tip: to indicate a helpful hint giving you an alternative way to operate the system or carry out a
procedure, or use a feature more efficiently.

Matrix COSEC PANEL200 API Guide 1

Document Organization
This document has been organized into the following topics:

1. About the Document

2. API Overview
3. Supported APIs
4. Details of APIs
5. Error Responses
6. API Response Codes
7. Appendix

Topics 1 and 2 will provide a general understanding of COSEC Panel200 APIs and the basic interface
communication. Topic 3 provides a list of all supported APIs. Topics 4 provides detailed explanation of individual
APIs. The following information has been provided on each request type:

• Description of the functionality.

• Action requested.
• Generic query syntax.
• Mandatory and optional parameters (argument-value table).
• Examples (Sample Request and Sample Response).

Topic 5 provides illustrations of error messages. Topic 6 provides a list of API Response Codes and their meaning.
The Appendix will provide additional material for the user’s reference.

For a list of all tables provided in the document, refer to List of Tables. Click on the links to view the
respective tables for the required data.

Who Can Use This Document

The COSEC Devices API User Guide is meant for third-party software developers who wish to operate COSEC
Devices via another remote application. This guide will provide information to users on how to request and receive
services from COSEC Devices using a COSEC API.

2 Matrix COSEC PANEL200 API Guide

API Overview

COSEC Devices APIs provide an interface for communication with COSEC Devices via HTTP methods. These
APIs will enable specific functions to be performed on your remote devices such as setting basic and advanced
device configurations, configuring users on device, performing enrollment of credentials, monitoring events and
sending commands to device. For a complete list of COSEC Device APIs, refer to Supported APIs.

How It Works
Following is an illustration of how the COSEC system typically communicates in a client-server based architecture.

Fig. Communication through COSEC Web Server

However, here the communication with COSEC devices occurs via the COSEC Web server. On the other hand,
Devices APIs enable a client application to access and monitor a remotely installed COSEC device directly, without
installing the COSEC server/Monitor.

Fig. Communication through COSEC API

Using APIs, the third party can send a simple HTTP request to configure, control or command a device. The device
then processes and executes this request to return an appropriate response.

Matrix COSEC PANEL200 API Guide 3

General Features
All COSEC APIs -

• Are Web-based HTTP APIs.

• Use basic HTTP Request-Response for interface communication.

• Generate response in either text or XML (Extensible Markup Language) format.

• Use simple HTTP commands such as GET, SET, DELETE etc.

• Use a generic syntax for all queries.

• Support some predefined parameters and their corresponding values for each action. Each parameter will
either be mandatory or bear a system-defined default value (when no value is specified).

• Use a mandatory parameter action universally, which takes action values (such as get, set, delete etc.)
and specifies the action to be requested.

What the User Should Know

It is assumed that developers using this document have prior knowledge of:

• Basic functioning of the COSEC system

• Basic HTTP request-response communication

• XML

4 Matrix COSEC PANEL200 API Guide

Prerequisite
In order to use a Panel200 API, the user will require:

• A Panel200 (pre-installed)

• A network enabled for accessing the COSEC Device.

• The credentials for API Authentication

For information on installing a Panel200 and assigning an IP address to it, please refer to the respective
device documentation.

Authentication
The device shall request basic authentication for granting access. Default username and password for HTTP
session authentication are:

Username: admin
Password: password set on device

HTTP Request-Response
Basic HTTP communication is based on a request-response paradigm. The message structure for both request
and response has a generic format.

HTTP-message = Request | Response; HTTP/1.1 messages

Generic-message = start-line The start line

*(message-header CRLF) Zero or more header fields or ‘headers’

CRLF An empty line

[Message-body] A message-body (chunk or payload)

Start-line = Request-Line | Status-Line

Matrix COSEC PANEL200 API Guide 5

Communication Flow
The communication takes place in the following manner:

1. The client checks availability of the device.

2. If available, the client issues a request for the device.

SER VER C LIEN T

C os ec 3 rd party
D ev ic e s oftw are

R E Q U E S T: w ith s y ntax, but no authentic ation / inv alid authentic ation

R E S P O N S E: denied
R es pons e s tatus c ode ( 4x x ) along w ith s ugges tions of s upported
authentic ation m ethod

R E Q U E S T: inv alid s y ntax but v alid authentic ation

R E S P O N S E: denied
R es pons e s tatus c ode (4x x )

R E Q U E S T: w ith s y ntax and s upported pas s w ord authentic ation

R E S P O N S E: s uc c es s ful
R eques ted M es s age body along w ith res pons e s tatus c ode i .e 2x x

R E Q U E S T: the s erv er is not

c onnec ted

Fig: c om m unic ation flow

3. The device parses the request for the action to be taken.

4. In case of an error (invalid syntax, invalid authentication etc.), the request is denied and an error response
is returned. Else, the requested data is returned with the appropriate response code.

Request Format

All HTTP Requests follow a generic message format. It consists of the following components:

This line is constituted by the following three elements which must be

separated by a space:

• The method type (GET, HEAD, POST, PUT etc.)

1. Request Line • The requested URL

• The HTTP version to use

For e.g.:

GET http://192.168.1.2/device.cgi/command?action=geteventcount HTTP/1.0

6 Matrix COSEC PANEL200 API Guide

 Add information about the request using these header fields:

• A General Header (<Header-name>:<value>).

2. Header Fields
• A Request Header (<Header-name>:<value>).

• An Entity Header (<Header-name>:<value>).

3 Empty Line This is an empty line separating headers from the message body.

4 Message Body This is the chunk or payload.

Example:

GET http://matrix.com/ HTTP/1.0

Accept: text/html
If-Modified-Since: Saturday, 15-January-2000 14:37:11 GMT
User-Agent: Mozilla/4.0 (compatible; MSIE 5.0; Windows 95)

Response Format
An HTTP response is a collection of lines sent by the server to the client. A generic HTTP response format will
resemble the following:

VERSION-HTTP CODE EXPLANATION<crlf>

HEADER: Value<crlf>
.
.
.
HEADER: Value<crlf>
Empty line<crlf>
BODY OF THE RESPONSE

It consists of the following components:

This line is constituted by the following three elements which must be

separated by a space:

1. A status line • The version of the protocol used (e.g. HTTP/1.0).

• The status code (indicates the status of the request being
processed).
• The explanation of the code.

These optional lines allow additional information to be added to the

response header. This information appears in the form of a name
2. The response header fields
indicating the header type followed by a value for the header type. The
name and value are separated by a colon (:).

3. The body of the response Contains the requested data.

Matrix COSEC PANEL200 API Guide 7

Example
When the server gets a request, it will respond with a standard HTTP status code as illustrated in the following
sample response:

HTTP/1.0 200 OK
Date: Sat, 15 Jan 2000 14:37:12 GMT
Server: Microsoft-IIS/2.0
Content-Type: text/HTML
Content-Length: 1245
Last-Modified: Fri, 14 Jan 2000 08:25:13
GMT

HTTP Status Codes: Status codes are 3-digit numeric codes returned in HTTP responses that enable
recipients to understand the successful or failed status of the request issued. In general, codes in the 1xx
range indicate an informational message only, 2xx codes indicate a successful request, 3xx codes indicate
an incomplete request that requires further action, 4xx codes point at client-side errors while 5xx codes
point at server-side errors.

URL Syntax
All Panel200 APIs follow a common HTTP query syntax for the third party to generate a request. The generic URL
is stated below.

Syntax

http://<deviceIP:deviceport>/device.cgi/<request-type>?<argument>=<value>&<argument>=<value>......

Take a close look at the URL and its basic elements:

URL element Description

This is the protocol used to communicate with the client.

http://
Note: All HTTP commands are in plain text, and almost all HTTP requests
are sent using TCP port 80, though any port can be used.

This identifies the device with which communication is to be performed. It

consists of two components:
<deviceIP:deviceport>
deviceIP: Device IP address
deviceport: Device Port Number

This is a mandatory entity required to specify the CGI directory for all the
device.cgi
device-related commands.

This specifies the type of API request. For the mandatory request types,
<request-type>
please refer to the individual API descriptions.

8 Matrix COSEC PANEL200 API Guide

 URL element Description

This defines a specific action or command depending on the function to be

performed.
A mandatory argument for all COSEC API functions is action. This
<argument>
argument always takes an action as its value (For eg. action=get).
For more information on the common HTTP actions used in COSEC APIs,
please refer to section Common Actions.

<value> These are argument values that determine the output.

Example

Let us assume that the target device has the IP address 192.168.x.y and the device port number is 80. The user
wants to fetch basic configured parameters for the device. In this case, a sample request would resemble the
following:

http://192.168.x.y:80/device.cgi/device-basic-config?action=get&format=xml

In this case, the query uses an action=get parameter which is commonly used to retrieve information from the
device-side. The URL takes another argument called format which specifies that the response returned should be
in the XML format.

• Special characters ( &, ‘, “, <, >, #, % and ;) will not be allowed in arguments or their values. Special
character “&” will be allowed as a separator between consecutive arguments and “?” will be allowed as
a separator between the request-type and an argument.

• The request line and headers must all end with <CR><LF> that is carriage return character followed by
a line feed character.

• The status line and header must all end with <CR><LF>.

• The empty line must consist of only <CR><LF> and no other white space.

Common Actions

The following actions are commonly used in COSEC APIs as values for the ‘action’ argument:

Action Use

GET To fetch required data from device.

SET To set required parameters for a given function.

This is used to get default the parameters of all/ specified

argument. If any argument is specified then default value of
GETDEFAULT
that particular argument is returned else default value of
complete group is returned.

This is used to default the parameters. If any argument is

SETDEFAULT specified then default that particular value else default
complete group

Matrix COSEC PANEL200 API Guide 9

Action Use

DELETE To delete data from device.

ENROLL To enroll an entity to a device.

Additional Information
• Generally, all the commands will be supported in the GET Method and hence the arguments and valid
values will be expected in the URL. Wherever applicable POST method will be specified explicitly. For the
POST method, the parameters must be included in the body of the HTTP request.

• To set blank values in a particular field, a blank can follow the “=”. E.g. “argument=&”

• If the format is not specified then by default, the values should be returned in text format.

• For all arguments other than ‘action’, the position in the URL may be changed.

COSEC APIs use basic authentication and can be tested on any standard Web browser. Enter the request
URL in the address field of your browser and press the ‘Enter’ key to send query to the device. Enter the
authentication credentials when prompted. The response will be displayed on your browser in the specified
format.

10 Matrix COSEC PANEL200 API Guide

Supported APIs

COSEC Devices support the following groups of APIs categorized on the basis of functions to be performed:

• Panel Configuration
• Panel Door Configuration
• User Configuration
• Enrollment
• Events
• Access Zone
• Sending Commands to Panel
• IMEI Registration Request
• Request for Security Code
• Access Request on QR Scanning
• To get Random Key on Code

Matrix COSEC PANEL200 API Guide 11

12 Matrix COSEC PANEL200 API Guide
Panel Door Configuration

This group of APIs enables users to perform the following types of Panel Door Configuration:

• Panel Door List

• Panel Door Configuration

• Reader Configuration

• Commands

• Function Key Configuration

• To Download/Upload Multi-Language File

• Alarm Configuration

• Face Identification Settings

• Face Mask Compulsion

Panel Door List

Description: To get the List of all connected Panel Doors along with door’s pdid, door-name, door-type in the
response.

Actions: get

Syntax: http://deviceIP:deviceport/device.cgi/panel-door-list?action=get

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Request - Panel Door List

Argument Valid Values Mandatory Description

Specify the format in which

format Text, xml No
response is expected

Table: Response - Panel Door List

Parameters Description

pdid Defines the Door Id

door-name Defines the Door Name

door-type Defines the Door Type

Matrix COSEC PANEL200 API Guide 13

Example

Sample Request
http://deviceIP:deviceport/device.cgi/panel-door-list?action=get&format=xml

Sample Response

HTTP Code: 200 OK

Content-Type: <type>
Content-Length: <length>
Body:
<COSEC_API>
<COSEC DOOR>
<pdid>1</pdid>
<door-name>test1-v3</door-name>

<door-type>12</door-type>
</COSEC DOOR>

<COSEC DOOR>
<pdid>2</pdid>
<door-name>test2-vega</door-name>

<door-type>9</door-type>
</COSEC DOOR>

<COSEC DOOR>
<pdid>3</pdid>
<door-name>test3-io</door-name>
<door-type>14</door-type>

</COSEC DOOR>
</COSEC_API>

Panel Door Configuration

Description: To enable, disable, define or retrieve configuration parameters related to various door features such
as Aux input, Aux Output, Door sense, Alarm etc.

Actions: get, set, delete

Syntax: http://<deviceIP:deviceport>/device.cgi/panel-door-
config?<argument>=<value>[&<argument>=<value>....]

14 Matrix COSEC PANEL200 API Guide

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Set Panel Door Configuration Parameters

Argument Valid Values Mandatory Description

1 to 255(for Panel200), 1 to
pdid Yes To define the door id
75 (for Panel/Panellite v1)

door-name Max 30 ASCII characters Yes To define the door name

1 - V1 Door
3 - V2 Door
6 - Compact Door (PATH
V1)
7 - PVR Door
9 - VEGA Door
11 - ARC DC100
door-type Yes To specify the door type
12 - V3 Door
14 - ARC IO800
16 - Path V2
17 - ARC DC200
19 - V4 DOOR
20 - ARGO
21 - ARGO FACE

0 = Inactive
active No To activate/deactivate the door
1 = Active

0 = Ethernet To define the communication type of

communication-type Yes
1 = RS-485 the door with the Panel

15 characters (0-9 digits

ip-address Yes To define the IP address
and dot (.) only)

To define the RS-485 address of the

rs-485-address 00-31 Yes door. Either IP or RS-485 address is
mandatory.

Yes
17 characters To specify the MAC address of the
mac-address Not Mandatory for
("A-F, a-f, 0 -9, : ") door.
RS485

0 = Un mute
mute-buzzer No To mute/unmute the door buzzer
1 = Mute

access-zone 1 to 99 No To define the access zone

0- Inactive
door-sense No To enable/disable the door sense.
1- Active

0- Un-supervised To enable/disable the supervised

door-sense-supervised No
1- Supervised sense of the door.

0- NO To define the sense type of the door.

door-sense-type No
1- NC

To define the output group

door-relay-unlock-
1 to 99 No number of the door for door relay
output-group-num
for unlocking the door.

To define the output group number

door-relay-lock-output-
1 to 99 No of the door for door relay for
group-num
unlocking the door

Matrix COSEC PANEL200 API Guide 15

Table: Set Panel Door Configuration Parameters

Argument Valid Values Mandatory Description

To enable the aux input of the door.

0- Inactive
aux-input No Not applicable for door type=16,20
1- Active
and 21.

To enable the aux input of the door.

Parameter applicable for IO
0- Inactive controller device type and ARC
aux-input-2 No
1- Active DC200 Single Door only. Not
applicable for door type=16,20 and
21.

To enable the aux input of the door.

Parameter applicable for IO
0- Inactive
aux-input-3 No controller device type only. Not
1- Active
applicable for door type=16,20 and
21.

To enable the aux input of the door.

Parameter applicable for IO
0- Inactive
aux-input-4 No controller device type only. Not
1- Active
applicable for door type=16,20 and
21.

To enable the aux input of the door.

Parameter applicable for IO
0- Inactive
aux-input-5 No controller device type only. Not
1- Active
applicable for door type=16,20 and
21.

To enable the aux input of the door.

Parameter applicable for IO
0- Inactive
aux-input-6 No controller device type only. Not
1- Active
applicable for door type=16,20 and
21.

To enable the aux input of the door.

Parameter applicable for IO
0- Inactive
aux-input-7 No controller device type only. Not
1- Active
applicable for door type=16,20 and
21.

To enable the aux input of the door.

Parameter applicable for IO
0- Inactive
aux-input-8 No controller device type only. Not
1- Active
applicable for door type=16,20 and
21.

To enable/disable the supervised

0- Un-supervised sense of the aux input. Not
aux-input-supervised No
1- Supervised applicable for door type=16,20 and
21.

To enable/disable the supervised

sense of the aux input.
0- Un-supervised Parameter applicable for IO
aux-input-supervised-2 No
1- Supervised controller device type only. Not
applicable for door type=16,20 and
21.

16 Matrix COSEC PANEL200 API Guide

Table: Set Panel Door Configuration Parameters

Argument Valid Values Mandatory Description

To enable/disable the supervised

sense of the aux input.
0- Un-supervised Parameter applicable for IO
aux-input-supervised-3 No
1- Supervised controller device type only. Not
applicable for door type=16,20 and
21.

To enable/disable the supervised

sense of the aux input.
0- Un-supervised Parameter applicable for IO
aux-input-supervised-4 No
1- Supervised controller device type only. Not
applicable for door type=16,20 and
21.

To enable/disable the supervised

sense of the aux input.
0- Un-supervised Parameter applicable for IO
aux-input-supervised-5 No
1- Supervised controller device type only. Not
applicable for door type=16,20 and
21.

To enable/disable the supervised

sense of the aux input.
0- Un-supervised Parameter applicable for IO
aux-input-supervised-6 No
1- Supervised controller device type only. Not
applicable for door type=16,20 and
21.

To enable/disable the supervised

sense of the aux input.
0- Un-supervised Parameter applicable for IO
aux-input-supervised-7 No
1- Supervised controller device type only. Not
applicable for door type=16,20 and
21.

To enable/disable the supervised

sense of the aux input.
0- Un-supervised Parameter applicable for IO
aux-input-supervised-8 No
1- Supervised controller device type only. Not
applicable for door type=16,20 and
21.

To define the sense type of the aux

0- NO
aux-input-sense-type No input. Not applicable for door
1- NC
type=16,20 and 21.

To define the sense type of the aux

input.
Parameter applicable for IO
0- NO
aux-input-sense-type-2 No controller device type and ARC
1- NC
DC200 Single Door only. Not
applicable for door type=16,20 and
21.

Matrix COSEC PANEL200 API Guide 17

Table: Set Panel Door Configuration Parameters

Argument Valid Values Mandatory Description

To define the sense type of the aux

input.
0- NO Parameter applicable for IO
aux-input-sense-type-3 No
1- NC controller device type only. Not
applicable for door type=16,20 and
21.

To define the sense type of the aux

input.
0- NO Parameter applicable for IO
aux-input-sense-type-4 No
1- NC controller device type only. Not
applicable for door type=16,20 and
21.

To define the sense type of the aux

input.
0- NO Parameter applicable for IO
aux-input-sense-type-5 No
1- NC controller device type only. Not
applicable for door type=16,20 and
21.

To define the sense type of the aux

input.
0- NO Parameter applicable for IO
aux-input-sense-type-6 No
1- NC controller device type only. Not
applicable for door type=16,20 and
21.

To define the sense type of the aux

input.
0- NO Parameter applicable for IO
aux-input-sense-type-7 No
1- NC controller device type only. Not
applicable for door type=16,20 and
21.

To define the sense type of the aux

input.
0- NO Parameter applicable for IO
aux-input-sense-type-8 No
1- NC controller device type only. Not
applicable for door type=16,20 and
21.

To define the debounce time. Not

debounce-time(sec) 0 to 99 No applicable for door type=16,20 and
21.

To define the debounce time.

Parameter applicable for IO
controller device type and ARC
debounce-time-2 (sec) 0 to 99 No
DC200 Single Door only. Not
applicable for door type=16,20 and
21.

18 Matrix COSEC PANEL200 API Guide

Table: Set Panel Door Configuration Parameters

Argument Valid Values Mandatory Description

To define the debounce time.

Parameter applicable for IO
debounce-time-3 (sec) 0 to 99 No controller device type only. Not
applicable for door type=16,20 and
21.

To define the debounce time.

Parameter applicable for IO
debounce-time-4 (sec) 0 to 99 No controller device type only. Not
applicable for door type=16,20 and
21.

To define the debounce time.

Parameter applicable for IO
debounce-time-5 (sec) 0 to 99 No controller device type only. Not
applicable for door type=16,20 and
21.

To define the debounce time.

Parameter applicable for IO
debounce-time-6(sec) 0 to 99 No controller device type only. Not
applicable for door type=16,20 and
21.

To define the debounce time.

Parameter applicable for IO
debounce-time-7 (sec) 0 to 99 No controller device type only. Not
applicable for door type=16,20 and
21.

To define the debounce time.

Parameter applicable for IO
debounce-time-8 (sec) 0 to 99 No controller device type only. Not
applicable for door type=16,20 and
21.

To enable/disable the aux output of

0- Inactive
aux-output No the door. Not applicable for door
1- Active
type=16,20 and 21.

To enable/disable the aux output of

0- Inactive
aux-output-2 No the door. Not applicable for door
1- Active
type=16,20 and 21.

To enable/disable the aux output of

0- Inactive
aux-output-3 No the door. Not applicable for door
1- Active
type=16,20 and 21.

To enable/disable the aux output of

0- Inactive
aux-output-4 No the door. Not applicable for door
1- Active
type=16,20 and 21.

To enable/disable the aux output of

0- Inactive
aux-output-5 No the door. Not applicable for door
1- Active
type=16,20 and 21.

Matrix COSEC PANEL200 API Guide 19

Table: Set Panel Door Configuration Parameters

Argument Valid Values Mandatory Description

To enable/disable the aux output of

0- Inactive
aux-output-6 No the door. Not applicable for door
1- Active
type=16,20 and 21.

To enable/disable the aux output of

0- Inactive
aux-output-7 No the door. Not applicable for door
1- Active
type=16,20 and 21.

To enable/disable the aux output of

0- Inactive
aux-output-8 No the door. Not applicable for door
1- Active
type=16,20 and 21.

To define the Aux output group

aux-output-group-num 1 to 99 No number of the door. Not applicable
for door type=16,20 and 21.

To define the Aux output group

aux-output-group-num-2 1 to 99 No number of the door. Not applicable
for door type=16,20 and 21.

To define the Aux output group

aux-output-group-num-3 1 to 99 No number of the door. Not applicable
for door type=16,20 and 21.

To define the Aux output group

aux-output-group-num-4 1 to 99 No number of the door. Not applicable
for door type=16,20 and 21.

To define the Aux output group

aux-output-group-num-5 1 to 99 No number of the door. Not applicable
for door type=16,20 and 21.

To define the Aux output group

aux-output-group-num-6 1 to 99 No number of the door. Not applicable
for door type=16,20 and 21.

To define the Aux output group

aux-output-group-num-7 1 to 99 No number of the door. Not applicable
for door type=16,20 and 21.

To define the Aux output group

aux-output-group-num-8 1 to 99 No number of the door. Not applicable
for door type=16,20 and 21.

1 to 65535 sec To define pulse time.

pulse-time 0.1 to 65535.0 sec for door No
type=9,16,17,20 and 21.

0- Inactive To activate and deactivate the

auto-relock No
1- Active auto relock.

auto-relock-timer 1 to 65535 sec No To define relock time.

0- NO To select whether it is NO/NC

tamper-readergrp1 No
1-NC

0-NO To select whether it is NO/NC

tamper-readergrp2 No
1-NC

20 Matrix COSEC PANEL200 API Guide

Table: Set Panel Door Configuration Parameters

Argument Valid Values Mandatory Description

To define subsequent punch

duplicate-access-time-
0-9999 No restriction time. Applicable for
interval
door type=9, 20 and 21 only.

Specifies the format in which the

format text,xml No
response is expected.

door-type=21 (ARGO FACE Door) is not applicable for Panel SDK1.

Table: Get Panel Door Configuration Parameters

Argument Valid Values Mandatory Description

pdid 1 TO 255 Yes To define the door id

Specify the format in which

format Text, xml No
response is expected

Table: Response Panel Door Configuration

Parameters Description

pdid Defines the door id

door-name Defines the door name

door-type Defines the door type

active Defines whether the door is active or not

communication-type Defines the communication type of the door with the panel

ip-address Defines the ip address of the door

rs-485-address Defines the RS-485 address of the door

Defines the MAC address of the door. Not mandatory if the communication type is
mac-address
defined as RS-485.

mute-buzzer Defines whether the door buzzer is Mute/unmute

access-zone Defines the access zone

door-sense Defines whether the door is enabled/disabled.

door-sense-supervised Defines whether the supervised sense of the door is enabled/disabled.

door-sense-type Defines the sense type of the door.

door-relay-unlock- Defines the output group number of the door for door relay for unlocking the door.
output-group-num

door-relay-lock-output- Defines the output group number of the door for door relay locking the door.
group-num

Defines whether the aux input of the door is enabled/disabled. Not applicable for door
aux-input
type=16,20 and 21.

Matrix COSEC PANEL200 API Guide 21

Parameters Description

Defines whether the aux input of the door is enabled/disabled.

aux-input-2 Parameter applicable for IO controller device type and ARC DC200 Single Door only.
Not applicable for door type=16,20 and 21.

Defines whether the aux input of the door is enabled/disabled.

aux-input-3 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the aux input of the door is enabled/disabled.

aux-input-4 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the aux input of the door is enabled/disabled.

aux-input-5 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the aux input of the door is enabled/disabled.

aux-input-6 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the aux input of the door is enabled/disabled.

aux-input-7 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the aux input of the door is enabled/disabled.

aux-input-8 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the supervised sense of the door is enabled/disabled. Not applicable
aux-input-supervised
for door type=16,20 and 21.

Defines whether the supervised sense of the door is enabled/disabled.

aux-input-supervised-2 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the supervised sense of the door is enabled/disabled.

aux-input-supervised-3 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the supervised sense of the door is enabled/disabled.

aux-input-supervised-4 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the supervised sense of the door is enabled/disabled.

aux-input-supervised-5 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the supervised sense of the door is enabled/disabled.

aux-input-supervised-6 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the supervised sense of the door is enabled/disabled.

aux-input-supervised-7 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Defines whether the supervised sense of the door is enabled/disabled.

aux-input-supervised-8 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

aux-input-sense-type defines the sense type of the aux input. Not applicable for door type=16,20 and 21.

22 Matrix COSEC PANEL200 API Guide

 Parameters Description

defines the sense type of the aux input.

aux-input-sense-type-2 Parameter applicable for IO controller device type and ARC DC200 Single Door only.
Not applicable for door type=16,20 and 21.

defines the sense type of the aux input.

aux-input-sense-type-3 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the sense type of the aux input.

aux-input-sense-type-4 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the sense type of the aux input.

aux-input-sense-type-5 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the sense type of the aux input.

aux-input-sense-type-6 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the sense type of the aux input.

aux-input-sense-type-7 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the sense type of the aux input.

aux-input-sense-type-8 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

debounce-time
defines the debounce time.Not applicable for door type=16,20 and 21.
(sec)

defines the debounce time.

debounce-time-2
Parameter applicable for IO controller device type and ARC DC200 Single Door only.
(sec)
Not applicable for door type=16,20 and 21.

defines the debounce time.

debounce-time-3
Parameter applicable for IO controller device type only. Not applicable for door
(sec)
type=16,20 and 21.

defines the debounce time.

debounce-time-4
Parameter applicable for IO controller device type only. Not applicable for door
(sec)
type=16,20 and 21.

defines the debounce time.

debounce-time-5
Parameter applicable for IO controller device type only. Not applicable for door
(sec)
type=16,20 and 21.

defines the debounce time.

debounce-time-6
Parameter applicable for IO controller device type only. Not applicable for door
(sec)
type=16,20 and 21.

defines the debounce time.

debounce-time-7
Parameter applicable for IO controller device type only. Not applicable for door
(sec)
type=16,20 and 21.

defines the debounce time.

debounce-time-8
Parameter applicable for IO controller device type only. Not applicable for door
(sec)
type=16,20 and 21.

defines whether the aux output of the door is enabled/disabled.

aux-output Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

Matrix COSEC PANEL200 API Guide 23

Parameters Description

defines whether the aux output of the door is enabled/disabled.

aux-output-2 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines whether the aux output of the door is enabled/disabled.

aux-output-3 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines whether the aux output of the door is enabled/disabled.

aux-output-4 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines whether the aux output of the door is enabled/disabled.

aux-output-5 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines whether the aux output of the door is enabled/disabled.

aux-output-6 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines whether the aux output of the door is enabled/disabled.

aux-output-7 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines whether the aux output of the door is enabled/disabled.

aux-output-8 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the aux output group number of the door. Not applicable for door type=16,20
aux-output-group-num
and 21.

defines the aux output group number of the door.

aux-output-group-num-2 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the aux output group number of the door.

aux-output-group-num-3 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the aux output group number of the door.

aux-output-group-num-4 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the aux output group number of the door.

aux-output-group-num-5 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the aux output group number of the door.

aux-output-group-num-6 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the aux output group number of the door.

aux-output-group-num-7 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

defines the aux output group number of the door.

aux-output-group-num-8 Parameter applicable for IO controller device type only. Not applicable for door
type=16,20 and 21.

pulse-time Defines pulse timer of the door.

auto-relock Defines whether auto-relock is enabled/ disabled in the door.

24 Matrix COSEC PANEL200 API Guide

 Parameters Description

auto-relock-timer Defines relock timer of the door.

tamper-readergrp1 To select whether it is NO/NC

tamper-readergrp2 To select whether it is NO/NC

duplicate-access-time-
To define the subsequent punch restriction time.
interval

Table: Delete Panel Door Configuration Parameters

Argument Valid Values Mandatory Description

Refer configuration table for To select the ID on which the

pdid Yes
valid value specified operation is to be done.

Specify the format in which

format Text, xml No
response is expected

For IO Controller, Valid Parameters are: action, pdid, door-name, door-type, active, communication-type,
ip-address, rs-485-address, mac-address, aux-input, aux-input-(2 to 8), aux-input-supervised, aux-input-
supervised-(2 to 8), aux-input-sense, aux-input-sense-(2 to 8), debounce-time, debounce-time-(2 to 8),
aux-output, aux-output-(2 to 8), aux-output-group-num, aux-output-group-num-(2 to 8), format

Matrix COSEC PANEL200 API Guide 25

Reader Configuration
Description: To set or retrieve configuration parameters for internal and external readers such as reader type,
access mode, entry-exit mode and the tag re-detection delay time.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/reader-config?action=<value>&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Reader Configuration Parameters (All doors except COSEC ARC Controller)

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

0 = None
1 = EM Prox Reader
2 = HID Prox Reader To define the internal card
internal-card-reader No
3 = MiFare Reader reader.
4 = HID iCLASS-U Reader
5 = HID iCLASS-W Reader

0 = None
internal-biometric- To define the internal biometric
1 = Finger Reader No
reader reader.
2 = Palm Vein Reader

0 = None
1 = EM Prox Reader
2 = HID Prox Reader
3 = MiFare U Reader
4 = HID iCLASS-U Reader
5 = Finger Reader
To define the external reader.
6 = HID iCLASS-W Reader
Finger Reader (type=5) is not
7 = UHF Reader
external-reader No applicable for applicable for door
8 = Combo Exit Reader
type=16,20 and 21.
9 = MiFare-W Reader
10=PIN-W Reader
11=CB - U Reader
12=CB - W Reader
13=ATOM RD300
14=ATOM RD200
15=ATOM RD100

0 = Entry To define the door mode for

internal-reader-mode No
1 = Exit internal reader.

0 = Entry To define the door mode for

external-reader-mode No
1 = Exit external reader.

0 = Inactive
exit-switch No To activate exit switch.
1 = Active

Specifies the format in which the

format text,xml No
response is expected.

To define the tag re-detection

tag-re-detect-delay 0-60 mins No
delay time.

26 Matrix COSEC PANEL200 API Guide

Table: Reader Configuration Parameters (COSEC ARC Controller only)

Argument Valid Values Mandatory Description

Yes if action is
pdid 1 to 255 desired on To select the Panel door
Panel door

To define the RS-485 Interface

Protocol in reader1 group.
rs-485-protocol- 0 = Matrix Proprietary
No
readergrp1 1 = OSDP
Note: This argument is
applicable to ARC DC 200 only.

0 = None
1 = EM Prox Reader
2 = HID Prox Reader
3 = MiFare Reader
4 = HID iCLASS-U Reader To define the RS-485 reader in
rs-485-readergrp1 No
5 = Combo Reader reader1 group.
6 = CB - U Reader
7 = ATOM RD300
8 = ATOM RD200
9 = ATOM RD100

0 = None
1 = Short-Range Reader
2 = Long-Range Reader To define the Wiegand reader in
wiegand-readergrp1 No
3 = PIN Reader reader1 group.
4 = Card+ PIN W Reader
5 = CB - W Reader

readergrp1-entry-exit- 0 = Entry To define the mode (entry/exit)

No
mode 1 = Exit for reader1 group

To define the RS-485 Interface

Protocol in reader2 group.
rs-485-protocol- 0 = Matrix Proprietary
No
readergrp2 1 = OSDP
Note: This argument is
applicable to ARC DC 200 only.

0 = None
1 = EM Prox Reader
2 = HID Prox Reader
3 = MiFare Reader
4 = HID iCLASS-U Reader To define the RS-485 reader in
rs-485-readergrp2 No
5 = Combo Reader reader2 group.
6 = CB - U Reader
7 = ATOM RD300
8 = ATOM RD200
9 = ATOM RD100

0 = None
1 = Short-Range Reader
2 = Long-Range Reader To define the Wiegand reader in
wiegand-readergrp2 No
3 = PIN Reader reader2 group.
4 = Card+ PIN W Reader
5 = CB - W Reader

readergrp2-entry-exit- 0 = Entry To define the mode (entry/exit)

No
mode 1 = Exit for reader2 group

Matrix COSEC PANEL200 API Guide 27

Table: Reader Configuration Parameters (COSEC ARC Controller only)

Argument Valid Values Mandatory Description

0 = Entry To activate exit switch

exit-switch No
1 = Exit

To define the tag re-detection

tag-re-detect-delay 0-60 mins No
delay time.

To define OSDP 3rd Party

Reader address.
osdp-add-readergrp1 00-31 No
Note: This argument is
applicable to ARC DC 200 only.

0 = 9600
To define OSDP 3rd Party
1 = 19200
Reader Baud Rate.
2 = 38400
baud-rate-readergrp1 No
3 = 57600
Note: This argument is
4 = 115200
applicable to ARC DC 200 only.
5 = 230400

To define OSDP 3rd Party

Reader address.
osdp-add-readergrp2 00-31 No
Note: This argument is
applicable to ARC DC 200 only.

0 = 9600
To define OSDP 3rd Party
1 = 19200
Reader Baud Rate.
2 = 38400
baud-rate-readergrp2 No
3 = 57600
Note: This argument is
4 = 115200
applicable to ARC DC 200 only.
5 = 230400

To enable secure channel

between 3rd Party Reader and
Control Panel for Reader Group
osdp-secure-channel- 0 = Disable
No 1.
readergrp1 1 = Enable
Note: This argument is
applicable to ARC DC 200 only.

To define encryption key for

secured communication with
encryption-key- Alphanumeric (A-F or a-f 0-9) Reader Group 1.
No
readergrp1 Maximum 32 characters
Note: This argument is
applicable to ARC DC 200 only.

To enable secure channel

between 3rd Party Reader and
Control Panel for Reader Group
osdp-secure-channel- 0 = Disable
No 2.
readergrp2 1 = Enable
Note: This argument is
applicable to ARC DC 200 only.

28 Matrix COSEC PANEL200 API Guide

Table: Reader Configuration Parameters (COSEC ARC Controller only)

Argument Valid Values Mandatory Description

To define encryption key for

secured communication with
encryption-key- Alphanumeric (A-F or a-f 0-9) Reader Group 2.
No
readergrp2 Maximum 32 characters
Note: This argument is
applicable to ARC DC 200 only.

Example

1. To configure internal card reader as an HID Prox reader and internal reader mode as entry.

Sample Request
http://<deviceIP:deviceport>/device.cgi/reader-config?action=set&pdid=1&reader1=2&door-access-mode=0

Sample Response
HTTP Code: 200 OK
Content-Type: <type>
Content-Length: <length>
Body: Response-Code=0

Matrix COSEC PANEL200 API Guide 29

Commands
Description: To send commands to Panel Door.

Syntax: http://<deviceIP:deviceport>/device.cgi/door-commands?action=<value>&<argument>=<value>….

1. To normalize the Door

Action= normalizedoor (Not applicable for door type=21 (ARGO FACE200T))

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Normalize Door Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

2. To lock the door

Action=lockdoor

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: To Lock the Door Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

3. To unlock the door

Action=unlockdoor

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: To Unlock the Door Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

4. To disable aux input of the door

Action= disableauxinput (Not applicable for door type=16,20 and 21)

30 Matrix COSEC PANEL200 API Guide

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Disable Aux Input Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

To select the port

Only applicable for IO controller,
No
port-no 1 to 8 Port 1 and Port 2 will be
applicable for ARC DC200
Single Door Dual Reader.

5. To normalize aux input of the door

Action= normalizeauxinput (Not applicable for door type=16,20 and 21)

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Normalize Aux Input Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

To select the aux port

Only applicable for IO controller,
No
port-no 1 to 8 Port 1 and Port 2 will be
applicable for ARC DC200
Single Door Dual Reader.

6. To disable aux output of the door

Action= disableauxoutput (Not applicable for door type=16,20 and 21)

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Disable Aux Output Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

No To select the aux port

port-no 1 to 8
Only applicable for IO controller

7. To normalize aux output of the door

Action= normalizeauxoutput (Not applicable for door type=16,20 and 21)

Matrix COSEC PANEL200 API Guide 31

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Normalize Aux Output Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

No To select the auxport

port-no 1 to 8
Only applicable for IO controller

8. To disable door sense

Action= disabledoorsense

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: To Disable the Door Sense Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

9. To normalize door sense

Action= normalizedoorsense

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: To Normalize the Door Sense Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

10. To reset aux output latch of the door

Action= resetauxoutputlatch (Not applicable for door type=16,20 and 21)

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Reset Aux Output Latch Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

No To select the aux port

port-no 1 to 8
Only applicable for IO controller

32 Matrix COSEC PANEL200 API Guide

11. To clear biometric credentials of the door

Action=clearbiometriccredentials

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Clear Biometric Credentials Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

12. To synchronize credentials

Action= synccredentials

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Synchronize Credentials Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

13. To calibrate FP sensor

Action= calibratefpsensor

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Calibrate FP Sensor Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on To select Panel Door
Panel door.)

14. To Activate Aux Relay

Action= activateauxrelay

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Activate Aux Relay Parameters

Argument Valid Values Mandatory Description

Yes (if action is To select the ID on which the

pdid 1 to 255 desired on specified operation is to be
Panel door.) done.

Matrix COSEC PANEL200 API Guide 33

Table: Activate Aux Relay Parameters

Argument Valid Values Mandatory Description

To select the aux port

No
port-no 1 to 8 Port 2 to 8 are valid for IO
Controller only

15. To Deactivate Aux Relay

Action= deactivateauxrelay

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Activate Aux Relay Parameters

Argument Valid Values Mandatory Description

Yes (if action is To select the ID on which the

pdid 1 to 255 desired on specified operation is to be
Panel door.) done.

To select the aux port

No
port-no 1 to 8 Port 2 to 8 are valid for IO
Controller only

16. To Clear Face Credentials of the Door

Action= clearfacecredentials

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Clear Face Credentials of the Door

Argument Valid Values Mandatory Description

Yes (if action is To select the ID on which the

pdid 1 to 255 desired on specified operation is to be
Panel door.) done.

Currently, the action= clearfacecredentials is applicable for ARGO FACE Door only and is not applicable for
Panel SDK1.

34 Matrix COSEC PANEL200 API Guide

Function Key Configuration
Description: To set or retrieve configuration of Function Keys on the Panel door keypad. COSEC enables its users
to map up to 4 special functions to the arrow keys on a Door keypad. These functions can then be performed at the
door by using the keypad shortcuts. Use this API to specify which special functions are to be assigned shortcuts on
COSEC devices.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/function-key?action=<value>&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Function Key Configuration Parameters

Argument Valid Values Mandatory Description

pdid 1 to 255 Yes To define the Panel door ID

F1 0 = None
1 = Official IN
F2
2 = Official OUT
F3 3 = Short Leave IN
4 = Short Leave OUT Assigning special functions to
5 = Regular IN No respective function keys.
6 = Regular OUT
F4 7 = Post Break IN
8 = Pre - Break OUT
9 = Overtime IN
10 = Overtime OUT

Specifies the format in which the

format text,xml No
response is expected.

Example

1. To configure function key F1 as official work – IN.

Sample Request
http://<deviceIP:deviceport>/device.cgi/function-key?action=set&f1=1

Sample Response
HTTP Code: 200 OK
Content-Type: <type>
Content-Length: <length>
Body: Response-Code=0

Matrix COSEC PANEL200 API Guide 35

To Download/Upload Multi-Language File
Description: To download/upload multi-language file for custom message display on supported COSEC panel
doors for which multi-language support has been enabled.

File uploaded can be in XLS or CSV format only.

Actions: get, set, getdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/multi-language-file-door?<argument>=<value>[&<argument>=<value>]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Download/Upload Multi-Language File - Parameters

Argument Valid Values Mandatory Description

To download the multi-language file

action get Yes
for the panel door.

To download the sample multi-

action getdefault Yes
language file for the panel door

To upload a custom message file for

action set Yes
the panel door

36 Matrix COSEC PANEL200 API Guide

Alarm Configuration
Description: To set or retrieve configuration of alarm on the Panel door keypad.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/alarm?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Alarm Configuration- Parameters

Argument Valid Values Mandatory Description

1 to 255(for Panel200), 1
pdid to 75 (for Panel/Panellite Yes To define the door id
v1)

0- Inactive To enable/disable Alarm

alarm No
1- Active

0- Inactive To enable/disable the “Tamper” Alarm

tamper-alarm No
1- Active

0- Inactive To enable/disable "Duress" alarm. Not

duress-alarm No
1- Active applicable for door type=21.

0- Inactive To enable/disable “Door Held Open”

door-held-open-alarm No
1- Active alarm

0- Inactive To enable/disable “Door Abnormal”

door-abnormal-alarm No
1- Active alarm

0- Inactive To enable/disable “Door Force Open”

door-force-open-alarm No
1- Active alarm

0- Inactive
door-fault-alarm No To enable/disable “Door Fault” alarm
1- Active

0- Inactive
panic alarm No To enable/disable “Panic” alarm
1- Active

0- Inactive
deadman-alarm No To enable/disable “Deadman” alarm
1- Active

occupancy-violated 0- Inactive To enable/disable “Occupancy

No
alarm 1- Active Violated” alarm

To enable/disable “Tail Gating” alarm.

0- Inactive
tail-gating-alarm No Not applicable for door type=16, 20
1- Active
and 21.

man-trap-violation- 0- Inactive To enable/disable “Man Trap

No
alarm 1- Active Violation” alarm

0- Inactive To enable/disable “Access Denied-

anti-pass-back-alarm No
1- Active Anti Pass Back” alarm

access-denied-othr- 0- Inactive To enable/disable “ Access Denied –

No
reason-alarm 1- Active Other Reason” alarm

Matrix COSEC PANEL200 API Guide 37

Table: Alarm Configuration- Parameters

Argument Valid Values Mandatory Description

0- Inactive To enable/disable “User Unidentified”

user-unidentified-alarm No
1- Active alarm

mltpl-unauth-atmpt- 0- Inactive To enable/disable “Multiple

No
alarm 1- Active Unauthorized Attempts” alarm

door-lock-held-open- 0- Inactive To enable/disable “Door Lock Held

No
alarm 1- Active Open” alarm

door-lock-abnormal- 0- Inactive To enable/disable “Door Lock

No
alarm 1- Active Abnormal” alarm

door-lock-manual-open- 0- Inactive To enable/disable “Door Lock Manual

No
alarm 1- Active Open” alarm

To enable/ disable the “User Denied –

0- Inactive
thresh-temp-excded No Threshold Temperature Exceeded”
1- Active
alarm

0- Inactive To enable/ disable the “Access Route

access-route-alarm No
1- Active Violation” alarm

access-route-timer- 0- Inactive To enable/ disable the “Access Route

No
alarm 1- Active Timer Violation” alarm

0- Inactive
other-alarm No To enable/disable “Other” alarms
1- Active

face-mask-compulsion- 0- Inactive To enable/ disable the “Face Mask

No
alarm 1- Active Compulsion” alarm

Specifies the format in which the

format Text, XML No
response is expected

Face Mask Compulsion Alarm is not applicable for Panel SDK1.

38 Matrix COSEC PANEL200 API Guide

Face Identification Settings

Face Identification Settings are not applicable for Panel SDK1.

Description: To set or retrieve configuration of face identification settings on the Panel Door.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/fr-settings?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Alarm Configuration- Parameters

Argument Valid Values Mandatory Description

Yes (if action is

pdid 1 to 255 desired on Panel To select Panel Door.
door.)

0- Disable To enable/disable Face Recognition.

enable No
1- Enable By default, it is enabled.

To select FR mode (In case Server

mode 0- Local No
support is provided in future).

0- Tap & Go To define the Face Capturing Mode.

capturing-mode No
1- Free Scan By default, it is Free Scan.

enable-freescan- 0- Disable To enable/disable Free Scan Timeout.

No
timeout 1- Enable By default, it is disabled.

To define the Free Scan Timeout time.

freescan-timeout 5-999 sec No
By default, it is 30 sec.

To define the Identification Timeout for

identification-timeout 1-99 sec No Tap & Go Capturing Mode.
By default, it is 4 sec.

To enable/disable Conflict Checking

0- Disable with other users during Face
conflict-check No
1- Enable Enrollment.
By default, it is enabled.

Matching Threshold used to check

conflict-matching- conflict with other users during Face
1.0-99.99 No
threshold Enrollment.
By default, it is 93.

0- Disable To enable/disable Face Anti-Spoofing.

face-anti-spoofing No
1- Enable By default, it is disabled.

Minimum required value of identified

face-anti spoofing- user’s face liveness to consider him/
1.00-99.99 No
threshold her as genuine person.
By default, it is 62.

Matrix COSEC PANEL200 API Guide 39

Table: Alarm Configuration- Parameters

Argument Valid Values Mandatory Description

Defines the matching of actual user’s

face-matching-score 0.00-100.0 No face with that of user templates.
By default, it is 94.0.

This is the threshold percentage that

threshold-face- defines whether there is a face within
0-100 No
detection the detected frame.
By default, it is 60.

Specifies the format in which the

format Text, XML No
response is expected.

40 Matrix COSEC PANEL200 API Guide

Face Mask Compulsion
Description: To set or retrieve configuration of face mask compulsion on the Panel Door.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/face-mask?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Alarm Configuration- Parameters

Argument Valid Values Mandatory Description

pdid 1 to 255 Yes To select Panel Door.

0- Inactive To enable/disable Face Mask

enable No
1- Active Compulsion.

To specify the time within which the

approach-cam-timer 0.0-15.0 sec No user should approach the camera for
Face Mask Detection.

To specify time-out for Face Mask

detection-timeout 1-99 sec No
Detection.

0- Soft
restriction No To select the Restriction type.
1- Hard

To specify the threshold value below

detection-threshold-
1.00-99.99 sec No which the mask status will not be
identification
detected for identification.

To specify the threshold value below

detection-threshold-
1.00-99.99 sec No which the mask status will not be
enrollment
detected for enrollment.

Specifies the format in which the

format Text, XML No
response is expected.

Face Mask Compulsion is not applicable for Panel SDK1.

Matrix COSEC PANEL200 API Guide 41

42 Matrix COSEC PANEL200 API Guide
Panel Configuration

This group of APIs enables users to perform the following types of Panel Configuration:

• Panel Basic Configuration

• Access Settings Configuration

• Panel Advance Configuration

• Enrollment Configuration

• Alarm Configuration

• Date and Time Configuration

• System Timers Configuration

• Special Function Configuration

• Multi-Language Support

• To Download/Upload Multi-Language File

• Access Features

Matrix COSEC PANEL200 API Guide 43

Panel Basic Configuration
Description: To set or retrieve basic configuration parameters for a Panel such as name and maximum number of
finger templates on device.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/panel-basic-config?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Panel Basic Configuration Parameters

Argument Valid Values Mandatory Description

Alphanumeric,
name No To identify/configure the device name.
Max. 30 characters

Template-per- 0- Single Template/Finger To specify the number of finger template

No
finger 1- Dual Template/Finger to be enrolled per user.

Single Template/Finger: 0-9

where,
0 - 1 Finger
1 - 2 Fingers
2 - 3 Fingers
3 - 4 Fingers
4 - 5 Fingers
5 - 6 Fingers
6 - 7 Fingers
7 - 8 Fingers Maximum no. of finger templates that can
max-fingers No
8 - 9 Fingers be stored per user on this device.
9 - 10 Fingers

Dual Template/Finger: 0-4

where,
0 - 1 Finger
1 - 2 Fingers
2 - 3 Fingers
3 - 4 Fingers
4 - 5 Fingers

44 Matrix COSEC PANEL200 API Guide

Table: Panel Basic Configuration Parameters

Argument Valid Values Mandatory Description

0 - 1 Face
1 - 2 Faces
2 - 3 Faces
3 - 4 Faces
4 - 5 Faces
5 - 6 Faces
6 - 7 Faces
7 - 8 Faces
8 - 9 Faces
9 - 10 Faces
10 - 11 Faces
11 - 12 Faces
12 - 13 Faces
13 - 14 Faces
14 - 15 Faces Maximum no. of face templates that can
max-faces No
15 - 16 Faces be stored per user on this device.
16 - 17 Faces
17 - 18 Faces
18 - 19 Faces
19 - 20 Faces
20 - 21 Faces
21 - 22 Faces
22- 23 Faces
23 - 24 Faces
24- 25 Faces
25- 26 Faces
26- 27 Faces
27- 28 Faces
28- 29 Faces
29 - 30 Faces

0 - 1 Palm
1 - 2 Palms
2 - 3 Palms
3 - 4 Palms
Maximum no. of palm templates that can
4 - 5 Palms
max-palms No be stored per user on this device.
5 - 6 Palms
6 - 7 Palms
7 - 8 Palms
8 - 9 Palms
9 - 10 Palms

To specify the mode as Guided or Un-

palm-operation- 0 - Non-guide mode
No guided mode. Default mode is Un-guided
mode 1 - Guide mode
mode.

palm-mode- 0-Basic Template to define whether PVR will run in

No
adaptive 1-Compressed Template Adaptive mode or not

To set the panel mode as Server mode

0 - Server mode
mode No or Standalone mode. Default mode is
1 - Standalone mode
server mode.

Matrix COSEC PANEL200 API Guide 45

Table: Panel Basic Configuration Parameters

Argument Valid Values Mandatory Description

specifies the format in which the

format text, xml No
response is expected.

To get the default values for any parameter, use the action=getdefault method. To restore configuration
parameters on device to default values, use the action=setdefault method.

max-faces is not applicable for Panel SDK1.

46 Matrix COSEC PANEL200 API Guide

Access Settings Configuration
Description: To set or retrieve configuration parameters for enabling basic access control on a device for users.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi /access-setting?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Access Settings Configuration Parameters

Argument Valid Values Mandatory Description

sun (0) to sat (6)

To define the active working days. This
week-day<0~6> 0 = Inactive No parameter is repeated for each day of
1 = Active the week.

work-start-hh 00-23 No Define the work start time

work-start-mm 00-59 No Define the work start time

work-end-hh 00-23 No Define the work stop time

work-end-mm 00-59 No Define the work stop time

Specifies the format in which the

format text, xml No
response is expected

Matrix COSEC PANEL200 API Guide 47

Panel Advance Configuration
Description: To set or retrieve advance configuration parameters for a device such as application type and
Additional Security Code on device.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/panel-advanced-config?action=<value>&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Device Configuration Parameters

Argument Valid Values Mandatory Description

16 bits, 1-65535 range,

facility-code No
Should be non-zero

0- Inactive To enable/disable the additional security

asc-active No
1- Active code.

Numeric, 16 bits, To configure an Additional Security Code

asc-code No
1-65535 range (ASC). Should be non-zero.

generate-
0 - No To generate invalid user events when
invalid-user- No
1 - Yes invalid user is punched in.
events

generate-exit- 0 - No
No To generate exit switch events.
switch-events 1 - Yes

degrade- 0- Inactive
No To enable the access in degrade mode.
access 1- Active

degrade-
access-wait- 1 to 99 sec No To specify the degrade wait timer.
timer

specifies the format in which the

format text, xml No
response is expected.

48 Matrix COSEC PANEL200 API Guide

Enrollment Configuration
Description: To set or retrieve configuration parameters for enrollment of credentials on a device such as number
of credentials allowed, number of templates allowed per finger, enrollment mode etc.

Actions: get, set, getdefault, setdefault

Syntax:http://<deviceIP:deviceport>/device.cgi /enroll-options?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Enrollment Configuration Parameters

Argument Valid Values Mandatory Description

0 = Inactive To enable/disable the feature to enroll

enroll-on-device No
1 = Active through special function

To define the option to enroll the credential

using the user’s Reference No. or User ID,
for enrollment through special function.
0 = User ID
enroll-using No
1 = Reference No. Note: This parameter will not be valid for
NGT Direct Door and Vega Controller
where enrollment must be performed by
User ID.

Single Template/Finger: 0-
9

where,
0 = 1 Finger
1 = 2 Fingers
2 = 3 Fingers
3 = 4 Fingers
4 = 5 Fingers No. of fingers allowed to be enrolled in one
5 = 6 Fingers enrollment cycle.
6 = 7 Fingers
enroll-finger-count 7= 8 Fingers No Note: For the action=set method, this
8 = 9 Fingers value should not be greater than the max-
9 = 10 Fingers finger value set in Panel Device
Configuration API.
Dual Template/Finger: 0-4

where,
0 = 1 Finger
1 = 2 Fingers
2 = 3 Fingers
3 = 4 Fingers
4 = 5 Fingers

Matrix COSEC PANEL200 API Guide 49

Table: Enrollment Configuration Parameters

Argument Valid Values Mandatory Description

0 = 1 Palm
1 = 2 Palms
2 = 3 Palms
3 = 4 Palms
No. of palms allowed to be enrolled in one
4 = 5 Palms
enroll-palm-count No enrollment cycle.
5 = 6 Palms
6 = 7 Palms
7 = 8 Palms
8 = 9 Palms
9 = 10 Palms

0 = 1 Card
No. of special function cards allowed to be
1 = 2 Cards
enroll-card-count No enrolled in one enrollment cycle.
2 = 3 Cards
3 = 4 Cards

0 = Read Only Card

1 = Smart Card
2 = Biometric To define the enrollment mode for
enroll-mode No
3 = Biometric then Card enrollment through device.
4 = Face
5 = Duress Finger

Specifies the format in which the response

format text,xml No
is expected.

• If the temp-per-finger mode is changed, then the templates have to be restored to the device explicitly
by the third party software, else mismatch will occur in the module.

• If Single Template/Finger mode is selected on the device and some users are already enrolled
according to it and if abruptly the mode is changed to Dual Template/Finger then:

i. If the maximum finger count was greater than 5 fingers in Single Template/Finger mode, then after
changing the mode to the Dual Template/Finger, the finger count will set to 5.

ii. If the maximum finger count was less than 5 fingers in Single Template/Finger mode, then after
changing the mode to the Dual Template/Finger, the finger count will remain same.

• If the mode is changed back to Single Template/Finger, then finger count should not be changed. If
users want to increase the finger count they should mention it explicitly.

50 Matrix COSEC PANEL200 API Guide

Alarm Configuration
Description: To set or retrieve configuration parameters for enabling/disabling alarms and related functions on a
COSEC device such as Auto Alarm Acknowledgement.

Actions: get, set, getdefault, setdefault

Syntax:http://<deviceIP:deviceport>/device.cgi /alarm?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Alarm Configuration Parameters

Argument Valid Values Mandatory Description

To enable/disable the Duress alarm.

0 = Inactive
duress-alarm No Not applicable to door type=1,3,6,11,
1 = Active
14 and 21.

To enable/disable the Deadman alarm.

0 = Inactive
deadman-alarm No Not applicable to door type=1,3,6,11
1 = Active
and 14.

To enable/disable the panic alarm.

0 = Inactive
panic-alarm No Not applicable to door type=1,3,6,11
1 = Active
and 14.

doorcontroller-offline- 0 = Inactive
No To enable or disable the alarm.
alarm 1 = Active

doorcontroller-fault- 0 = Inactive
No To enable or disable the alarm.
alarm 1 = Active

0 = Inactive To enable or disable the auto clear

auto-clear-alarm No
1 = Active alarm.

0 = Inactive To enable or disable the auto alarm

auto-alarm-ack No
1 = Active ACK.

Specifies the format in which the

format text,xml No
response is expected.

To enable/ disable the “User Denied –

0 = Inactive
thresh-temp-excded No Threshold Temperature Exceeded”
1 = Active
alarm

To enable/ disable the “Access Route

0 = Inactive Violation” alarm.
access-route-alarm No
1 = Active Not applicable to door type=1,3,6,11
and 14.

To enable/ disable the “Access Route

access-route-timer- 0 = Inactive Timer Violation” alarm.
No
alarm 1 = Active Not applicable to door type=1,3,6,11
and 14.

Matrix COSEC PANEL200 API Guide 51

Date and Time Configuration
Description: To set or retrieve date and time configurations on a COSEC device. The user can configure the date
and time to be displayed on the device, the display format, the time update mode, the NTP server settings as well
as the Daylight Savings Time (DST) settings on the selected device.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi /date-time?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Date and Time Configuration Parameters

Argument Valid Values Mandatory Description

year 2009 to 2037 No To set year value

month 01 to 12 No To set month value

date 01 to 31 No To set date

hour 00 to 23 No To set hour

minute 00 to 59 No To set minutes

second 00 to 59 No To set seconds

Defines the time format to be

displayed on the device display.

0 = 24 hours
time-format No Note: This is applicable only for the
1 = 12 hours
time shown on the device display and
not for general date-time which will
always be in 24 hours format.

00-74 (Tool supported by

Windows), default: GMT
(+05:30) Chennai, Kolkata,
time-zone Mumbai, New Delhi. No To define the universal time zone.

Refer to Table: Universal

Time Zone Reference

0 = Auto Defines whether the update mode is

update-mode No
1 = Manual manual or through NTP Server.

Defines whether the NTP server is a

0 = Predefined
ntp-server-type No predefined server or user-defined
1 = User Defined
server address.

0 = ntp1.cs.wisc.edu
ntp-server 1 = time.windows.com No To define the NTP Address.
2 = time.nist.gov

Alphanumeric, Max. 40
user-defined-ntp No To define the user-defined NTP.
characters.

0 = Disable
dst-enable No To enable/disable DST.
1 = Enable

52 Matrix COSEC PANEL200 API Guide

Table: Date and Time Configuration Parameters

Argument Valid Values Mandatory Description

0 = January
1 = February
2 = March
3 = April
4 = May
5 = June
fwd-month
6 = July
7 = August
8 = September
9 = October
10 = November
11 = December
No Forward clock day
0 = 1st
1 = 2nd
fwd-week 2 = 3rd
3 = 4th
4 = Last

0 = Sunday
1 = Monday
2 = Tuesday
fwd-day 3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday

00 - 23 (24 hours format

fwd-time-hh No Forward clock time instance
only)

fwd-time-mm 00 - 59

0 = January
1 = February
2 = March
3 = April
4 = May
5 = June
rev-month No
6 = July
7 = August
8 = September Reverse clock day
9 = October
10 = November
11 = December

0 = 1st
1 = 2nd
rev-week 2 = 3rd No
3 = 4th
4 = Last

Matrix COSEC PANEL200 API Guide 53

Table: Date and Time Configuration Parameters

Argument Valid Values Mandatory Description

0 = Sunday
1 = Monday
2 = Tuesday
rev-day 3 = Wednesday No Reverse clock day
4 = Thursday
5 = Friday
6 = Saturday

00 - 23 (24 hours format

rev-time-hh No Reverse clock time instance
only)

rev-time-mm 00 - 59

00 - 23 (24 hours format Time by which clock should be

duration-hh
only) No forwarded or reversed.
duration-mm 00 - 59

Specifies the format in which the

format text,xml No
response is expected.

• When user sets the time locally it should be GMT time. And in GET command also the time value to
be returned will be GMT time irrespective of the time displaying on the device.

• While configuring Daylight Saving Parameters, users are responsible to define the forward and
reverse time properly.

54 Matrix COSEC PANEL200 API Guide

System Timers Configuration
Description: To set or retrieve configurations for the following system timers:

Auto Alarm Acknowledgement Timer Specifies the time period in seconds after which an unacknowledged
alarm will acknowledge itself automatically.

Inter Digit Wait Timer Specifies time period in seconds between two key inputs on the
device keypad. On the expiry of this timer, the system considers the
user input to be complete and is ready for the next input.

Multi Access Wait Timer Defines the time in seconds for which the system needs to wait for
the second credential input from a user when more than one
credential is required to grant access.

Palm Enrollment Time Out Timer Defines the time period in seconds within which a palm must be
enrolled after generating the enrollment command.

Door Abnormal Wait Timer Defines the time in seconds required for a door to be energized for a
valid credential. If the opened door does not return to its closed state
before the expiry of this timer, the door will generate a “Door
Abnormal Alarm”.

Special Function Timer Defines the time in minutes for which the Late-IN and Early-OUT special
functions will remain active after being enabled at the door controller.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi /system-timer?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: System Timers Configuration Parameters

Argument Valid Values Mandatory Description

alarm-ack-timer 10 to 65535 (sec) No To define the timer for Auto Alarm

Acknowledgement.

alarm-reissue-wait- 3 to 99 min No To specify the time for an

timer acknowledged alarm to wait before
alarming again.

door-abnormal-wait- 1 to 255 sec No To specify the time for the system to

timer wait before generating door abnormal
alarm.

degrade-wait-timer 1 to 99 sec No To specify the time before the door

switches from network fault to degrade
mode.

idwt 1-99 (sec) No To define the Inter Digit Wait Timer.

Matrix COSEC PANEL200 API Guide 55

Table: System Timers Configuration Parameters

Argument Valid Values Mandatory Description

multi-access-wait-timer 3-99 (sec) No To define the Multi Access Wait Timer.

We recommend you to set the timer

value as greater than or equal to 10
seconds to avoid access denial
issues to users.This is applicable
when the system reads the
credentials (biometric) from the
user’s Smart Cards.

palm-enroll-time-out 3-99 (sec) No To define the Palm Enrollment Time

out Timer.

sp-function-timer 1-99 (mins) No To define the Special Function Timer.

format text,xml No Specifies the format in which the

response is expected.

56 Matrix COSEC PANEL200 API Guide

Special Function Configuration
Description: COSEC enables its users to perform certain pre-defined operations directly from the COSEC device.
These are known as special functions. An RFID card can be encoded for a special function and the card-holder can
perform this function at the device just by showing this special card.

Use this API to enable, disable, define or retrieve Special Functions configuration on a device.

Actions: get, set, getdefault, setdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/special-function?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Special Function Configuration Parameters

Argument Valid Values Mandatory Description

Sp-fn-Index 1 = Offical Work - IN Yes The index number of a special function.

2 = Official Work - OUT
3 = Short Leave - IN
4 = Short Leave - OUT
5 = Regular - IN
6 = Regular - OUT
7 = Break End
8 = Break Start
9 = Over Time - IN
10 = Over Time - OUT
12 = Set Panic Alarm
13 = Enroll User
14 =Enroll Special Card
15 = Delete Credentials
16 = Late IN - Start
17 = Late IN - Stop
18 = Early OUT - Start
19 = Early OUT- Stop
20 = View User Profile
21 = Activate DND
22 = Deactivate DND
23 = Activate Dead Man
24 = Deactivate Dead Man
25 = Door Lock
26 = Door Unlock
27 = Door Normal
28 = Zone Local
29 = Zone Unlock
30 = Zone Normal
31 = Mute Door Buzzer
32 = Mute Panel Buzzer
33 = Clear Door Aux Output
34 = Clear Panel Aux Output
35 = Door Arm
36 = Door Disarm
37 = Zone Arm
38 = Zone Disarm
39 = Clear Alarm

Matrix COSEC PANEL200 API Guide 57

Table: Special Function Configuration Parameters

Argument Valid Values Mandatory Description

enable 0 = Disable No To enable/disable special functions on

1 = Enable the device.

card1 64 Bits (20 Numeric Digits No For Panel- Standalone Mode:-

approx.)

card2 64 Bits (20 Numeric Digits No

If value entered by the user contains
approx.) comma, then maximum characters to
be allowed to enter should be 21
card3 64 Bits (20 Numeric Digits No characters.
approx.)

card4 64 Bits (20 Numeric Digits No If no comma is detected in the card

approx.) value then maximum characters
supported should be 20 characters
only.
To define the special function card 3.

To define the special function card 4.

format text,xml No Specifies the format in which the

response is expected.

58 Matrix COSEC PANEL200 API Guide

Multi-Language Support
Description: To enable/disable multiple language support for custom message display on supported COSEC
devices.

Languages supported are: English, Spanish, Albanian, Thai, Vietnamese

Actions: get, set, getdefault

Syntax: http://<deviceIP:deviceport>/device.cgi/multi-language?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Multi-Language Support Parameters

Argument Valid Values Mandatory Description

0 - Inactive To enable/disable multi-language

multi-language-support No
1 - Active support.

Multi-language-input- 0 - Inactive To enable/disable multi-language

No
data 1 - Active support.

Matrix COSEC PANEL200 API Guide 59

To Download/Upload Multi-Language File
Description: To download/upload multi-language file for custom message display on supported COSEC devices
for which multi-language support has been enabled.

File uploaded can be in XLS or CSV format only.

Actions: get, set, getdefault

Syntax: http://<deviceIP:deviceport>/device.cgi /multi-language-file?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Download/Upload Multi-Language File - Parameters

Argument Valid Values Mandatory Description

To get the custom string file to be

action get Yes
downloaded.

action getdefault Yes To download the sample file.

To upload a custom string/multi

action set Yes
language file for the Panel.

To Download/Upload Multi-Language File for PANEL Doors

Description: To download/upload custom string file or download the sample file of the panel door

File uploaded can be in XLS or CSV format only.

Actions: get, set, getdefault

Syntax: http://<deviceIP:deviceport>/device.cgi /multi-language-file-

door?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Argument Valid Values Mandatory Description

To get the custom string file to be

action get Yes
downloaded.

action getdefault Yes To download the sample file.

To upload a custom string/multi

action set Yes
language file for the panel door.

60 Matrix COSEC PANEL200 API Guide

Access Features
Description: To set or retrieve configuration parameters for enabling/disabling access features

Actions: get, set,

Syntax: http://<deviceIP:deviceport>/device.cgi/access-feature?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Access Feature - Parameters

Argument Valid Values Mandatory Description

0 to 1
To enable/disable access route policy
access-route-enable No
0= Inactive on panel
1= Active

0 to 1
allow-access-not-in To enable/disable “Allow access while
No
route 0= Inactive not in Route” flag on panel
1= Active

format Text, XML No To specify the format.

Matrix COSEC PANEL200 API Guide 61

62 Matrix COSEC PANEL200 API Guide
User Configuration

This group of APIs enables users to add or delete users, set user photographs, add or fetch various configurations
related to users on or from a device as well as synchronize credentials with device. The following functions can be
called:

• Setting/Retrieving User Configuration

• Deleting a User
• Setting User Credentials
• Retrieving User Credentials
• Deleting User Credentials
• Setting/Retrieving/Deleting User Photo

Matrix COSEC PANEL200 API Guide 63

Setting/Retrieving User Configuration
Description: To set basic user configuration parameters on a device using the action=set parameter and retrieve
configuration details using action=get.

Actions: get, set

Syntax: http://<deviceIP:deviceport>/device.cgi/users?<argument>=<value>[&<argu-
ment>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: User Configuration Parameters

Argument Valid Values Mandatory Description

To set or retrieve the

alphanumeric user ID for the
selected user.

user-id Maximum 15 characters Yes

Note: If a set request is sent
against an existing user ID, then
configuration for this user will be
updated with the new values.

Direct Door V2= 1 - 2,000

Path V1 Controller = 1 - 2,000
Wireless Door = 1 - 25,000
PVR = 1 - 25,000
NGT = 1 - 10,000 To identify the index number for
user-index Vega Controller = 1 - 25,000 No the selected user ID (only get
Path V2 Door = 1 - 25,000 parameter)
ARC DC200 = 1-25,000
Door V4 = 1- 25,000
ARGO = 1- 25,000
ARGO FACE= 1- 25,000

Yes (Not
To select the numeric user ID on
mandatory
ref-user-id Maximum 8 digits which the specified operation is
for the get
to be done.
action)

name Alphanumeric. Max. 15 characters No To define the user name

0 = Inactive
user-active No to activate or deactivate a user.
1 = Active

To define a user as VIP.

0 = Inactive
vip No Note: A VIP user is a user with
1 = Active
the special privilege to access a
particular door.

0 = Inactive To enable/disable the user

validity-enable No
1 = Active validity.

64 Matrix COSEC PANEL200 API Guide

Table: User Configuration Parameters

Argument Valid Values Mandatory Description

validity-date-dd 1-31 No
To define the end date for user
validity-date-mm 1-12 No
validity.
validity-date-yyyy 2000-2037 No

To set the user PIN or get the

event from user PIN.
user-pin 1 to 15 Digits No
Note: The user-pin can be set to
a blank value.

0 = Inactive To enable/disable the bypass

by-pass-finger No
1 = Active finger option.

0 = Inactive To enable/disable the bypass

by-pass-palm No
1 = Active palm option.

64 Bits (8 bytes) (max value - For Panel- Standalone Mode:-

card1 No
18446744073709551615)
If value entered by the user
contains comma, then maximum
characters to be allowed to enter
should be 21 characters.
64 Bits (8 bytes) (max value -
card2 No
18446744073709551615) If no comma is detected in the
card value then maximum
characters supported should be
20 characters only.

To set the user group number.

Note: A user can be assigned to

any user group ranging from 1 to
user-group 0-999 No 999. User group number can be
set/update via “Set” action. To
remove a user from an assigned
user group, user group should be
set to 0.

0 = Inactive To enable/disable restrict user

restrict-access No
1 = Active option.

To define the route id assigned to

route-id 1 to 255 No
the user.

0 = Inactive To enable/disable face

enable-fr No
1 = Active recognition for a user.

Specifies the format in which the

format text, xml No
response is expected.

Matrix COSEC PANEL200 API Guide 65

 • For set requests only one user’s complete data should be sent at a time. Attempting to set data for
multiple users at a time will return an error response. For more examples of error responses, see
Error Responses.

• To create a new user on device, both user-id and ref-user-id are mandatory parameters to be
provided, and these should be unique for each user.

• If a user is already configured in the system and admin wants to update the user with new
information/data, only Alphanumeric User ID is sufficient but if the reference user ID is also
mentioned then it would be verified whether this belongs to the same user or not.

• Whenever an event is generated related to a user, the required user ID field upon calling the event
will always show user’s reference user ID. Whereas if “Get” action is sent to call user configuration
then it will show alphanumeric user ID.

• enable-fr is not applicable for Panel SDK1.

Example

1. To get user names for user-id = 1

Sample Request

http://deviceIP:deviceport/device.cgi/users?action=get&user-id=1&format=xml

Sample Response
HTTP Code: 200 OK
Content-Type: <xml>
Content-Length: <length>
Body:
<COSEC_API>
<user-id>1</user-id>
<user-index>0</user-index>
<ref-user-id></ref-user-id>
<name></name>
<user-active>0</user-active>
<vip>0</vip>
<validity-enable>0</validity-enable>
<validity-date-dd>1</validity-date-dd>
<validity-date-mm>1</validity-date-mm>
<validity-date-yyyy>2009</validity-date-yyyy>
<user-pin></user-pin>
<by-pass-finger>0</by-pass-finger>
<card1>0</card1>
<card2>0</card2>
</COSEC_API>

66 Matrix COSEC PANEL200 API Guide

Deleting a User
Description: To delete a user from a device. Deleting a user will result in deletion of the credentials of that user
along with all the other configurations set on the device.

Actions: delete

Syntax: http://<deviceIP:deviceport>/device.cgi/users?action=delete&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Delete User - Parameters

Argument Valid Values Mandatory Description

user-id Maximum 15 characters Yes To specify the alphanumeric user ID

for the user to be deleted.

format text,xml No Specifies the format in which the

response is expected.

Matrix COSEC PANEL200 API Guide 67

Setting User Credentials
Description: To set a user’s biometric or card credentials on a device.

Actions: set

Syntax: http://<deviceIP:deviceport>/device.cgi/credential?action=set&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Setting User Credentials - Parameters

Argument Valid Values Mandatory Description

1 = Finger
2 = Card
To define the user credentials
type 3 = Palm Yes
type.
4 = Palm template with guide mode
5 = Face Image

To select the user-id for which the

user-id Alphanumeric (Max 15 characters) Yes
credential is to be fetched.

64 Bits (8 bytes) (max value - For Panel- Standalone Mode:-

card1 No
18446744073709551615)
If value entered by the user
contains comma, then maximum
characters to be allowed to enter
should be 21 characters.
64 Bits (8 bytes) (max value -
card2 No
18446744073709551615) If no comma is detected in the
card value then maximum
characters supported should be
20 characters only.

Specifies the format in which the

format text,xml No
response is expected.

This is the data of respective

credential type, which is to be
data - No
stored at given index number for
the respective user id.

At a time only finger or palm or face can be get/set. All cannot be set at the same time. Also, multiple face
images cannot be set at a time.

For type=5, file size should be less than 200 KB and supported file format= jpg only.

Type=5 (Face Images) is not applicable for Panel SDK1.

68 Matrix COSEC PANEL200 API Guide

Retrieving User Credentials
Description: To retrieve a user’s credential information from a device.

Actions: get

Syntax: http://<deviceIP:deviceport>/device.cgi/credential?action=get&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Retrieving User Credentials - Parameters

Argument Valid Values Mandatory Description

1 = Finger
2 = Card
To define the user credentials
type 3 = Palm Yes
type.
4 = Palm template with guide mode
5 = Face Image

To select the user-id for which the

user-id Alphanumeric (Max. 15 characters) Yes
credential is to be fetched.

64 Bits (8 bytes) (max value - For Panel- Standalone Mode:-

card1
18446744073709551615)
If value entered by the user
contains comma, then maximum
characters to be allowed to enter
should be 21 characters.
64 Bits (8 bytes) (max value -
card2
18446744073709551615) If no comma is detected in the
card value then maximum
characters supported should be
20 characters only.

Matrix COSEC PANEL200 API Guide 69

Table: Retrieving User Credentials - Parameters

Argument Valid Values Mandatory Description

1 = 1 Finger
2 = 2 Finger
3 = 3 Finger
4 = 4 Finger
5 = 5 Finger
finger-index No
6 = 6 Finger
7 = 7 Finger
8 = 8 Finger
9 = 9 Finger Identifies the finger template/
10 = 10 Finger palm template is to be set or
retrieved from the device. The
1 = 1 Palm template will be set and retrieved
2 = 2 Palm from the data portion of the
3 = 3 Palm request and response.
4 = 4 Palm
5 = 5 Palm
palm-index 6 = 6 Palm No
7 = 7 Palm
8 = 8 Palm
9 = 9 Palm
10 = 10 Palm
11 = 11 Palm (Compressed)

70 Matrix COSEC PANEL200 API Guide

Table: Retrieving User Credentials - Parameters

Argument Valid Values Mandatory Description

1 = 1 Face
2 = 2 Face
3 = 3 Face
4 = 4 Face
5 = 5 Face
6 = 6 Face
7 = 7 Face
8 = 8 Face
9 = 9 Face
10 = 10 Face
11 = 11 Face
12 = 12 Face
13 = 13 Face
Identifies the face template to be
14 = 14 Face
set or retrieved from the device.
15 = 15 Face
face-index No The template will be set and
16 = 16 Face retrieved from the data portion of
17 = 17 Face
the request and response.
18 = 18 Face
19 = 19 Face
20 = 20 Face
21 = 21 Face
22 = 22 Face
23 = 23 Face
24 = 24 Face
25 = 25 Face
26 = 26 Face
27 = 27 Face
28 = 28 Face
29 = 29 Face
30 = 30 Face

Specifies the format in which the

format text,xml No
response is expected.

This is the data of respective

credential type, which is to be
data - No
stored at given index number for
the respective user id.

Matrix COSEC PANEL200 API Guide 71

 • Credential parameters to be applied will depend on the credential type selected.

• At a time only finger or palm or face can be get/set.

• The Face Image uploaded should be less than 200 KB and in jpg format only.

• The set command is basically similar to adding and duplication of finger template will not be verified
by the device. It is expected to be handled by the 3rd party software.

• The method used in this case should be POST method as it consists of raw/ hex data in the data
portion of the request and the response.

• Finger/palm/Face index fields are not mentioned as mandatory fields because if user selects
credential type card then there is no need to specify the finger or palm index or Face index, similarly
if credential type is finger then palm index in not a mandatory field and vice versa.

• For type=5 (Face Image), only enrolled face image count will be displayed in response.

• Type=5 (Face Image) and face-index are not applicable for Panel SDK1.

72 Matrix COSEC PANEL200 API Guide

Deleting User Credentials
Description: To delete selected credentials of a user from a device.

Actions: delete

Syntax: http://<deviceIP:deviceport>/device.cgi/credential?action=delete&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Deleting User Credentials - Parameters

Argument Valid Values Mandatory Description

user-id Alphanumeric (Max. 15 characters) Yes To delete the credential of a

particular user.

type 0 = All Yes Defines the credential type to be

1 = Finger deleted.
2 = Card Note: For the selected type, all
3 = Palm credentials will be deleted.
4 = Palm template with guide mode
5 = Face Image

format text,xml No Specifies the format in which the

response is expected.

For delete if type is All then card, biometric credentials and face images should be deleted.

Type=5 (Face Images) is not applicable for Panel SDK1.

Example
1. To delete finger templates of user id 1.

Sample Request

http://deviceIP:deviceport/device.cgi/credential?action=delete&user-id=1&type=1

Sample Response

HTTP Code: 200 OK

Content-Type: <type>
Content-Length: <length>
Body: Response-Code=0

Matrix COSEC PANEL200 API Guide 73

Setting/Retrieving/Deleting User Photo
Description: To set/upload the user photo on the Panel using the action=set parameter, retrieve the user photo
using action=get and delete the user photo using action=delete

Actions: get, set, delete

Syntax: http://<deviceIP:deviceport>/device.cgi/photo?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: User Photo Parameters

Argument Valid Values Mandatory Description

To set or retrieve the

alphanumeric user ID for the
selected user.

user-id Maximum 15 characters Yes

Note: If a set request is sent
against an existing user ID, then
configuration for this user will be
updated with the new values.

0 = jpeg Yes (No for

1 = jpg Get and To define the format of
photo-format
2 = png Delete photograph.
3 = bmp action)

Specifies the format in which the

format text, xml No
response is expected.

74 Matrix COSEC PANEL200 API Guide

Enrollment

The Enrollment APIs can be used to generate an enrollment request for a device. Once the enrollment request is
successfully sent on the device, the device will initiate the enrollment process and request credentials to be
provided physically, as per the credential type and sequence specified.

Perform the enrollment function on a remote door controller using these enrollment APIs:

• Enrolling a User
• Enrolling Special Cards

Matrix COSEC PANEL200 API Guide 75

Enrolling a User
Description: To command a device to initiate enrollment for a user based on parameters specified.

Actions: enroll

Syntax: http://<deviceIP:deviceport>/device.cgi/enrolluser?action=enroll&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Enrolling User - Parameters

Argument Valid Values Mandatory Description

pdid 1 to 255 Yes To select the panel door

type 0 = Read Only Card Yes Defines the credential to be

1 = Smart Card enrolled.
2 = Biometric
3 = Biometric Then Card If OSDP Reader is connected and
4 = Mobile Device configured with ARC DC200, then
7 = Face type =0 (Read Only Card) will be
8 = Duress Finger applicable.

user-id Maximum 15 characters Yes Defines the alphanumeric User ID

of the user whose credential is to
be enrolled.

enroll-using 0 = Reader Group1 No To specify on which reader the

1 = Reader Group2 enrollment is to be done. It is only
applicable for ARC controllers.

finger-count Single Template/Finger: 0-9 Yes To specify the number of fingers to

be enrolled.
where,
0 = 1 Finger
1 = 2 Fingers
2 = 3 Fingers
3 = 4 Fingers
4 = 5 Fingers
5 = 6 Fingers
6 = 7 Fingers
7= 8 Fingers
8 = 9 Fingers
9 = 10 Fingers

Dual Template/Finger: 0-4

where,
0 = 1 Finger
1 = 2 Fingers
2 = 3 Fingers
3 = 4 Fingers
4 = 5 Fingers

76 Matrix COSEC PANEL200 API Guide

Table: Enrolling User - Parameters

Argument Valid Values Mandatory Description

card-count 0 = 1 Card Yes To specify the number of cards to

1 = 2 Cards be enrolled.
2 = 3 Cards
3 = 4 Cards

palm-count 0 = 1 Palm Yes To specify the number of palms to

1 = 2 Palms be enrolled.
2 = 3 Palms
3 = 4 Palms
4 = 5 Palms
5 = 6 Palms
6 = 7 Palms
7 = 8 Palms
8 = 9 Palms
9 = 10 Palms

face-count 0 = 1 Face No To specify the number of faces to

1 = 2 Faces be enrolled.
2 = 3 Faces
3 = 4 Faces
4 = 5 Faces
5 = 6 Faces
6 = 7 Faces
7 = 8 Faces
8 = 9 Faces
9 = 10 Faces
10 = 11 Faces
11 = 12 Faces
12 = 13 Faces
13 = 14 Faces
14 = 15 Faces
15 = 16 Faces
16 = 17 Faces
17 = 18 Faces
18 = 19 Faces
19 = 20 Faces
20 = 21 Faces
21 = 22 Faces
22 = 23 Faces
23 = 24 Faces
24 = 25 Faces
25 = 26 Faces
26 = 27 Faces
27 = 28 Faces
28 = 29 Faces
29 = 30 Faces

w-asc 0 = Inactive No To enable/disable the Additional

1 = Active Security Code (ASC) to be written
on the Smart Card.

w-fc 0 = Inactive No To enable/disable the Facility Code

1 = Active (FC) to be written on the Smart
Card.

Matrix COSEC PANEL200 API Guide 77

Table: Enrolling User - Parameters

Argument Valid Values Mandatory Description

w-ref-user-id 0 = Inactive No To enable/disable the User ID to be

1 = Active written on the Smart Card.

w-name 0 = Inactive No To enable/disable the User Name to

1 = Active be written on the Smart Card.

w-designation 0 = Inactive No To enable/disable the designation

1 = Active to be written on the Smart Card.

w-branch 0 = Inactive No To enable/disable the branch name

1 = Active to be written on the Smart Card.

w-department 0 = Inactive No To enable/disable the department

1 = Active name to be written on the Smart
Card.

w-bg 0 = Inactive No To enable/disable the blood group

1 = Active to be written on the Smart Card.

w-contact 0 = Inactive No To enable/disable Emergency

1 = Active Contact information to be written on
the Smart Card.

w-medical-history 0 = Inactive No To enable/disable the medical

1 = Active history to be written on the Smart
Card.

w-fp-template 0 = No Templates No To enable/disable the finger

1 = 1 Finger Template templates to be written on the
2 = 2 Finger Templates Smart Card.

w-palm-template 0 = No No To enable/disable the Palm

1 = Yes templates to be written on the
Smart Card.

name Alphanumeric, 15 Chars, ASCII No Defines the values for the

Code respective fields to be written on the
designation
Smart Card.
branch

department

78 Matrix COSEC PANEL200 API Guide

Table: Enrolling User - Parameters

Argument Valid Values Mandatory Description

bg Maximum 4 characters. Valid No Defines the values for the

Values: respective fields to be written on the
A+ Smart Card.
A-
B+ Note: ‘bg’ stands for blood group of
B- the user.
AB+
AB-
O+
O-
A1-
A1+
A1B-
A1B+
A2-
A2+
A2B-
A2B+
B1+

contact Alphanumeric, 15 Chars, ASCII No

Code

medical-history Alphanumeric, 15 Chars, ASCII No

Code

format text,xml No Specifies the format in which the

response is expected.

• This is only to send enrollment command, if the credential is to be retrieved then it has to be
retrieved explicitly using the get and set credential command.

• By default, if count is not specified for enroll command then consider it as one and perform the
enroll operation.

• This enrollment has no links to the parameter configured on the device for “enroll through special
function”.

• face-count and type=7 is not applicable for Panel SDK1.

Example

1. To start enrollment of two fingers for user id 45.

Sample Request

http://deviceIP:deviceport/device.cgi/enrolluser?action=enroll&pdid=1&user-id=45&type=2&finger-count=2

Matrix COSEC PANEL200 API Guide 79

Sample Response
HTTP Code: 200 OK
Content-Type: <type>
Content-Length: <length>
Body: Response-Code=0

80 Matrix COSEC PANEL200 API Guide

Enrolling Special Cards
Description: A Special Card is an RFID card which can be encoded for a special function. This API enables the
user to perform enrollment of special cards on the selected device based on specified parameters such as special
function ID and number of cards to be enrolled as special cards.

Actions: enroll

Syntax: http://<deviceIP:deviceport>/device.cgi/enrollspcard?action=enroll&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Enroll Special Cards - Parameters

Argument Valid Values Mandatory Description

pdid 1 to 255 Yes To select the panel door

sp-fn-id All configured Special Functions Yes Defines the special function
(special function ID) identification number.

type 0- Read Only Card Yes Defines the credential type to be

1- Smart Card enrolled

If OSDP Reader is connected and

configured with ARC DC200, then
type =0 (Read Only Card) will be
applicable.

enroll-using 0 = Reader Group1 No To specify on which reader the

1 = Reder Group2 enrollment is to be done. It is only
applicable for ARC controllers.

card-count 0 = 1 Card No To specify the number of cards to be

1 = 2 Cards enrolled.
2 = 3 Cards
3 = 4 Cards

format text,xml No Specifies the format in which the

response is expected.

Matrix COSEC PANEL200 API Guide 81

82 Matrix COSEC PANEL200 API Guide
Events

Any action that occurs or is performed using a live COSEC device is referred on the COSEC system as an Event. A
client application can directly request event logs to be fetched from a specific device or be fed with live events data
via the device listening port. The functions available in this API group are as follows:

• Retrieving Events
• Retrieving Events in the TCP Socket

Matrix COSEC PANEL200 API Guide 83

Retrieving Events
Description: To request all or specified events from a device.

Actions: getevent

Syntax: http://<deviceIP:deviceport>/device.cgi/events?action=getevent&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Retrieving Events - Parameters

Argument Valid Values Mandatory Description

roll-over-count 0 to 65535 Yes This identifies the first event that is to

be sent to the 3rd party from a set of
seq-number Yes
events sent in this response. If the
1 to 5,00,000 “no-of-events” field value is 1, then
this will be the only event sent to the
server.

no-of-events 1 to 5 (for Direct Door V2 and Path No Specifies the number of events to be
Controller) fetched.
1 to 100 (for all other Direct Doors)

format text,xml No Specifies the format in which the

response is expected.

• For different kind of events, different fields are required, to understand the functionality of an event,
which are denoted as Detail fields.

• The Detail field in the response depends on the type of device. For further information, refer to relevant
tables in the Event Configuration Reference (Appendix).

• For Panel200 will Firmware Version V1R66 and later, the Panel Door ID will also be sent in the
response for HTTP Events.

Example

Sample Request
http://panelip:port/device.cgi/events?action=getevent&roll-over-count=0&seq-number=10&format=xml

84 Matrix COSEC PANEL200 API Guide

 Sample Response

-<Events>
<roll-over-count>0</roll-over-count>
<seq-No>10</seq-No>

<pd-id>1</pd-id>
<date>30/05/2024</date>

<time>10:55:33</time>
<event-id>101</event-id>
<detail-1>1</detail-1>
<detail-2>0</detail-2>

<detail-3>10</detail-3>
<detail-4>0</detail-4>

<detail-5/>
<Events>
-<Events>

<roll-over-count>0</roll-over-count>
<seq-No>11</seq-No>

<pd-id>1</pd-id>
<date>30/05/2024</date>
<time>10:59:60</time>
<event-id>101</event-id>

<detail-1>1</detail-1>
<detail-2>0</detail-2>
<detail-3>20</detail-3>
<detail-4>0</detail-4>

<detail-5/>
<Events>
-<Events>
<roll-over-count>0</roll-over-count>

<seq-No>12</seq-No>
<pd-id>1</pd-id>
<date>30/05/2024</date>

<time>10:59:12</time>
<event-id>101</event-id>

<detail-1>1</detail-1>
<detail-2>0</detail-2>

<detail-3>40</detail-3>
<detail-4>0</detail-4>
<detail-5/>
<Events>

</COSEC_API>

Matrix COSEC PANEL200 API Guide 85

In the above example:

• pd-id: It represents the Door ID.

• detail-1: It represents the Reference ID of the user.

• detail-3: It represents the credential used and the Access Mode of the Reader (Entry/Exit).

• Event with seq-No=10 and detail-3=10 denotes that PIN credential is used.

• Event with seq-No=11 and detail-3=20 denotes that Card credential is used.

• Event with seq-No=12 and detail-3=40 denotes that Finger credential is used.

The detail-3 value will be as per the credential used. For details, refer to Table: Field 3 Detail (User Events)
Reference* and Table: Information of Bit 4 to 14*.

86 Matrix COSEC PANEL200 API Guide

Retrieving Events in the TCP Socket
Description: To receive all or specific events through the TCP listening port of the device.

Actions: getevent

Syntax: http://<deviceIP:deviceport>/device.cgi/tcp-events?action=getevent&<argument>=<value>….

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Retrieving Events in the TCP Socket - Parameters

Argument Valid Values Mandatory Description

trigger 1 = Start No To start/ stop the process.

0 = Stop

keep-live-events 0 = inactive No To specify whether the events

1 = active should be sent continuously or till the
Maximum limit.

ipaddress 0 to 15 char ASCII 0-9,'.' Yes Defines the IP Address on which the
events are to be sent.

port 1024 – 65535 Yes Defines the listening port on which

the events are to be sent.

roll-over-count 0 to 65535 Yes It is used to specify the exact

sequence number of an event stored
at any port.

seq-number Yes It is used to specify the sequence

number of any event. The maximum
1 to 5,00,000
value for this can be from 1 to the
event log capacity of that device.

response-time 3 - 15 seconds No To specify the response time to wait

for a confirmation of established
network.

interface 0 = Ethernet No Specifies the interface.

1 = Wi-Fi
2 = Mobile Broadband Note: If no interface is defined,
Ethernet will be tried by default.

format text,xml No Specifies the format in which the

response is expected.

Due to memory constraints, this API is not supported on Door V2.

Matrix COSEC PANEL200 API Guide 87

Example
1. To request to send the events continuously on the TCP port from event seq 1 and roll over count 0
on IP address 192.168.102.42 and tcp listening port 80.

Sample Request

http://deviceIP:deviceport/device.cgi/tcp-events?action=getevent&ipaddress=192.168.102.42&port=80&roll-over-
count=0&seq-number=1

Sample Response

HTTP Code: 200 OK

Content-Type: <type>
Content-Length: <length>
Body: Response-Code=0

• The default TCP protocol acknowledgement should be used to send the next event. If in case any
event is missed in between, then it is the responsibility of the 3rd party to re-request for that event.
This shouldn’t be done via TCP port but missed events can be re-requested through HTTP API.

• If during the event transferring if reboot occurs then the prior command (to send events) will no
longer be valid and client must re-request events. In such a case, the events which have already
been sent, will be overwritten by the same.

• The user ID against which an event is stored must be the Reference ID for a user. This being
numeric (max. 8 digits), will enable efficient utilization of storage space on devices, especially those
having high event logging capacity (upto 5,00,000 events).

88 Matrix COSEC PANEL200 API Guide

Access Zone

Access Zones are areas with well defined boundaries, which are defined to effectively implement an Access
Security System with Access Policies. A site can have multiple Access Zones, each Zone having multiple door
controllers. User needs to define the Access Zones before defining the door controllers and assigning the Access
Zones.

Syntax: http://<deviceIP:deviceport>/device.cgi/access-zone?<argument>=<value>[&<argument>=<value>….]

For Action= Get

Argument Valid Values Mandatory Description

zone-id 1 to 99 Yes To specify the zone-id whose details

are to be fetched.

format text,xml No Specifies the format in which the

response is expected.

Response contains following parameters and their values:

Argument Description

zone-name Defines the zone name

access-level Defines the access level

degrade-mode Defines if degrade mode functionality is enabled or not

degrade-mode-type Defines the level of degrade mode access ie. Basic or Advance

access-control-on-exit Defines if basic access policies are to be checked on exit or not

internal-access-mode Defines access mode of internal reader or reader group 1 reader

external-access-mode Defines access mode of external reader or reader group 2

For Action= Set

Argument Valid Values Mandatory Description

zone-id 1 to 99 Yes To specify the zone-id whose details

are to be fetched.

zone-name 15 char, ASCII No To specify the zone name.

access-level 1 to 15 No To specify the access level of the

zone.

degrade-mode 0 - Inactive No To enable degrade mode

1 - Active functionality.

degrade-mode-type 0 - Basic No To define the type of degrade mode:

1 - Advance Basic or Advance. By default basic
will be set.

access-control-on- 0 = Inactive No To specify whether to check basic

exit 1 = Active access policies on exit or not

Matrix COSEC PANEL200 API Guide 89

 Argument Valid Values Mandatory Description

internal-access- 0 = Card No To define access mode of internal

mode 1 = Biometric reader or reader group 1 reader
2 = Card + PIN
3 = Biometric + PIN Biometric and BLE credentials are
4 = Biometric + Card not supported in OSDP Readers.
5 = Biometric +Card + PIN
6 = Any One
11 = Biometric + Group
12 = Biometric Then Card
14 = None
19 = BLE
20 = Card Then Biometric
15 = Face
16 = Card + Face
17 = PIN + Face
18 = Biometric + Face

external-access- 0 = Card No To define access mode of external

mode 1 = Biometric reader or reader group 2
2 = Card + PIN
4 = Biometric + Card Biometric and BLE credentials are
6 = Any One not supported in OSDP Readers.
12 = Biometric Then Card
14 = None
19 = BLE
3 = Biometric + PIN
5 = Biometric + Card + PIN
20 = Card Then Biometric

For Action= delete

Argument Valid Values Mandatory Description

zone-id 1 to 99 Yes To specify the zone-id whose details

are to be fetched.

90 Matrix COSEC PANEL200 API Guide

Sending Commands to Panel

It is possible to send CGI commands to a panel in order to perform certain functions.

The generic URL for these commands:

http://<deviceIP:deviceport>/device.cgi/command?action=<value>&<argument>=<value>….

Table: List of Commands to Device

S.No. Command to Device Action Description

To command the device to clear an alarm.

1 Clear Alarm clearalarm For parameters, refer Table: clear alarm -
Parameters below.

To get the count of already enrolled

templates and credentials for a user on the
selected device.
Get Credential Count for Enrolled
2 getcount
Credentials
For parameters, refer Table: Get
Credential Count Command - Parameters
below.

To command the device to acknowledge

an alarm without clearing it.
3 Acknowledge Alarm acknowledgealarm
For parameters, refer Table: acknowledge
alarm - Parameters below.

To obtain the total number of users added

4 Get User Count on Device getusercount
on a device.

Get Current Event Sequence To get the current event sequence number
5 geteventcount
Number and roll over count in a device.

To set all the configurations on the device

6 Default the System Configuration systemdefault
to default status.

To delete all biometric credentials of users

from device.
7 Delete Credentials for All Users deletecredential
For parameters, refer Table: Deleting
Credentials for All Users - Parameters
below.

8 Reset IO Link reset-io-link To reset the active latch type of IO link

For action =clearalarm

For valid values of this action, refer to the following argument-value table.

Table: clear alarm - Parameters

Argument Valid Values Mandatory Description

pdid 1 to 255,0 Yes To select the panel door or panel.

0= to perform the action on panel,

1-255= to perform the action on the
desired panel door

Matrix COSEC PANEL200 API Guide 91

Table: clear alarm - Parameters

Argument Valid Values Mandatory Description

format Text, xml No Specifies the format in which the

response is expected

For action=getcount

For valid values of this action, refer to the following argument-value table.

Table: Get Credential Count Command - Parameters

Argument Valid Values Mandatory Description

user-id 1 to max. User ID in the door Yes Defines the numeric ID of the user
(2 bytes) whose data is to be fetched.

card-count Actual enrolled card count will be No To get the number of cards enrolled.
fetched.

finger-count Actual enrolled finger count will be No To get the count pass the
fetched. parameter as argument

palm-count Actual enrolled palm count will be No To get the count pass the
fetched. parameter as argument

face-count Actual enrolled face count will be No To get the count pass the
fetched. parameter as argument

format text,xml No To specify the format in which the

response is expected.

• If no parameter is requested then all the count values will be returned by default (of supported
credential types e.g. for PVR door, only card and palm template count will be returned).

• Palm template count and finger template counts depend on the device type i.e. Palm template
count is only applicable for PVR doors and FP template counts are applicable for other devices. The
specified credential should be applicable for the device on which the command is sent.

• face-count is not applicable for Panel SDK1.

For action=acknowledgealarm

For valid values of this action, refer to the following argument-value table.

Table: acknowledge alarm - Parameters

Argument Valid Values Mandatory Description

pdid 1 to 255,0 Yes To select the panel door or panel.

0= to perform the action on panel,

1-255= to perform the action on the
desired panel door

92 Matrix COSEC PANEL200 API Guide

For action=deletecredential

For valid values of this action, refer to the following argument-value table.

Table: Deleting Credentials for All Users - Parameters

Argument Valid Values Mandatory Description

type 0 = All Yes To specify the type of credential to

1 = Finger be deleted.
2 = Palm
3= Face

Type=3 (Face) is not applicable for Panel SDK1.

For action= resetaccesspolicy

Syntax= http://<deviceIP:deviceport>/device.cgi/command?action=resetaccesspolicy

For valid values of this action, refer to the following argument-value table.

Table: Reset access policy - Parameters

Argument Valid Values Mandatory Description

user-id 15 Character ASCII Yes To select the user for which access
route access policy needs reset

access-route 0= unchecked Yes To enable/disable access route

1= checked access policy which is to be Reset

Example
Following are some sample cases for your reference:

1. To get the current rollover count and sequence number of events in the device.

Sample Request
http://<deviceIP:deviceport>/device.cgi/command?action=geteventcount&format=xml

Sample Response
HTTP Code: 200 OK
Content-Type: <xml>
Body:
<COSEC_API>
<Roll-over-count>1</roll-over-count>
<seq-number>1</seq-number>
</COSEC_API >

Matrix COSEC PANEL200 API Guide 93

94 Matrix COSEC PANEL200 API Guide
IMEI Registration Request

To register the IMEI number of the user on COSEC Standalone Panel200, the IMEI Registration request is sent
from the COSEC APTA.

Description: To send IMEI Registration Request from COSEC APTA installed in mobile device.

This API will be applicable with Third Party Software.

Actions: set

Syntax: http://<deviceIP:deviceport>/device.cgi/imei-register?<argument>=<value>[&<argument>=<value>…...]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: IMEI Request

Argument Valid Values Mandatory Description

15 characters The user ID on which the specified

ABCDEFGHIJKLMNOPQ operation is to be done.The user id &
RSTUVWXYZabcdefghijkl password appended in the API for access
user-id Yes
mnopqrstuvwxyz of the Url will be:
1234567890 and white User id: admin
space allowed Password: password set on device

40 characters
ABCDEFGHIJKLMNOPQ
RSTUVWXYZabcdefghijkl The imei through which the panel will
imei Yes
mnopqrstuvwxyz authenticate the user's mobile device.
1234567890 allowed

Upto 8 digits Random number generated by Panel for

device-id No
auto sign-in feature

format xml - -

Matrix COSEC PANEL200 API Guide 95

Table: IMEI Request API Response

Response Response Code Rights

User identified & IMEI received matches with IMEI

1
stored against the identified user in the panel
1,2
User identified & registered the received IMEI
against the identified user. This is case will be *value 1 or 2 will sent
created when: depend upon the rights
assigned against the
1.no IMEI was present against the user and Auto user in the panel
register flag=1 database.

2.IMEI was already present against the user and 1 1= authorized to gain
auto register flag=1. (here the new IMEI received will access through API
be replaced with old IMEI)
2=not authorized to gain
3. The Device ID stored in IMEI field against the user access through API
matches with the Device ID received in Request API
(here the Device ID will be replaced by IMEI umber
once it matches)

When the received IMEI is stored against any other

2
user. API should fail

If this request is received but the IMEI wait timer [1

3
minute timer] is not active for the user. 0

When Panel Door is offline 4

* Whenever code
When the received user id does not exists in panel =2,3,4,5 mobile device
5 should ignore rights
database. API should fail
parameter.
When access through mobile feature is not enabled
6
API should fail.

When the Device ID/IMEI both received 7

*Note:
when code =1 ; it indicates the IMEI registration is successful
when code =2,3,4,5,6,7; it indicates the IMEI registration is not successful

96 Matrix COSEC PANEL200 API Guide

Request for Security Code

To establish secured connection with the Panel200 through COSEC APTA after registering IMEI number of the
user.

Description: To get the security code for the user.

This API will be applicable with Third Party Software.

Actions: get

Syntax: http://<deviceIP:deviceport>/device.cgi/security-code?<argument>=<value>[&<argument>=<value>…]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Security Code Request

Argument Valid Values Mandatory Description

15 characters The user ID on which the specified

ABCDEFGHIJKLMNOPQ operation is to be done.The user id &
RSTUVWXYZabcdefghijkl password appended in the API for access
user-id Yes
mnopqrstuvwxyz of the Url will be:
1234567890 and white User id: admin
space allowed Password: password set on device

format xml - -

The response should have following parameters:

Argument Valid Values Description

2 bytes(2 char)
ABCDEFGHIJKLMNOPQ
security-code RSTUVWXYZabcdefghijkl As per configured in the panel
mnopqrstuvwxyz
1234567890

Table:Security Code Request API Response

Response Response Code Reason

When received user id doesn't exist in the

13 user id not exists
panel

When mobile access feature is not enabled in Feature not enabled in

24
the panel config

When the door is offline 30 Door Offline

Matrix COSEC PANEL200 API Guide 97

98 Matrix COSEC PANEL200 API Guide
To get Random Key on Code

Description: To get a random key for particular user for secured access.

Actions: get

Syntax: http://<deviceIP:deviceport>/device.cgi /random-key?<argument>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Access Request-qr

Argument Valid Values Mandatory Description

15 characters
ABCDEFGHIJKLMNOPQ
The user ID (alphanumeric user ID) on
RSTUVWXYZabcdefghijkl
user-id Yes which the specified operation is to be
mnopqrstuvwxyz
done.
1234567890 and white
space allowed

The door ID on which the specified

pdid Numeric (1-255) Yes
operation is to be done.

format xml - -

Table: Access Request-qr Response

Field Valid Values

random-key random number upto 8 digit

Note:
• Whenever the received user id doesn't exist in the panel, response code13(user id not exists) will be sent.
• Whenever the access through API is not enabled in the panel, response code24 (Feature not enabled in
config) will be sent.
• Whenever the feature mobile access is not enabled for the received user id in the panel, response 24
(Feature not enabled in config) will be sent
• Whenever the door is offline, response code30 (Door Offline) will be sent.

Matrix COSEC PANEL200 API Guide 99

100 Matrix COSEC PANEL200 API Guide
Access Request on QR Scanning

To access COSEC device without biometric credentials is a new feature. You can access COSEC Panel doors
using COSEC APTA by QR scanning.

Description: To access a device from COSEC APTA installed in mobile device.

This API will be applicable with COSEC Server and Third Party Software also.

Actions: set

Syntax: http://<deviceIP:deviceport>/device.cgi/access-request-qr?<argu-
ment>=<value>[&<argument>=<value>….]

Parameters: All arguments for this query and their corresponding valid values are listed below:

Table: Group:access-request-qr

Argument Valid Values Mandatory Description

Encrypted random A security Key encrypted by mobile is sent

security-key Yes
number to authenticate the API.

40 characters
ABCDEFGHIJKLMNOP
The imei through which the panel will
imei QRSTUVWXYZabcdefg Yes
authenticate the user’s mobile device.
hijklmnopqrstuvwxyz
1234567890 allowed

15 characters The user ID on which the specified

ABCDEFGHIJKLMNOPQ operation is to be done.The user id &
RSTUVWXYZabcdefghijkl password appended in the API for access
user-id Yes
mnopqrstuvwxyz of the Url will be:
1234567890 and white User id: admin
space allowed Password: password set on device

To define the mode of the request

mode 0,1 Yes 0=ENTRY
1=EXIT

pdid 1 to 255 Yes To specify the panel door id

format xml - -

Table: QR Request API Response

Response Response Code Reason Applicable Doors

User verified-Access Allowed or When

1 0 All doors
visitor is allowed

APB-soft(when exit was not done by

1 0 All doors
user)

Matrix COSEC PANEL200 API Guide 101

Table: QR Request API Response

Response Response Code Reason Applicable Doors

APB-soft(when entry was not done by

1 0 All doors
user)

User Allowed-Mode =Entry(When

1 0 Linux based direct doors
Schedule door mode is Active)

APB-soft(when exit was not done by

1 0 Linux based direct doors
user)

User Allowed-Mode =Exit (When

1 0 Linux based direct doors
Schedule door mode is Active)

APB-soft(when entry was not done by

1 0 Linux based direct doors
user)

User Access Denied 2 0 All doors

2-person rule violated/ Invalid input for

2 1 All doors
2-person rule

Access deniedAPB(HARD) denied

2 2 All doors
because exit was not made by user

Access deniedAPB(HARD) denied

2 3 All doors
because entry was not made by user

User blocked 2 4 All doors

When no door is present in the panel

2 5 Panel doors
against the pdid received in the API

When restrict access flag is enabled

2 6 Panel doors
to the user on the device.

Door Locked 2 7 All doors

Access Denied-First-in user rule

2 8 All doors
violation

Occupancy rule violation-when

2 9 All doors
maximum occupancy rule is violated

Occupancy rule violation- when

occupancy control for zone has been 2 10 Panel doors
violated

When minimum occupancy required

rule is violated and exit has been 2 11 Direct doors
denied to the user.

User validity expired 2 13 All doors

System error-Access denied

Generate this when user is allowed
2 14 All doors
but an error occurred while writing the
events in the flash.

Denied-visitor escort rule violation(2nd

person not identified)/ Visitor escort
2 15 Panel doors
violation cases/ Waiting for visitor
escort state

when requested user id is not

2 16 All doors
assigned or not found on device

102 Matrix COSEC PANEL200 API Guide

Table: QR Request API Response

Response Response Code Reason Applicable Doors

Entry Restricted cases 2 17 All doors

When the User is not active from the

2 18 All doors
server

1) If the "Access through API" has not

been set & API from Mobile has been
received
2 19 All doors
2) If API access mode is API +
biometric and biometric reader is not
configured with API's mode i.e entry/
exit

1) When the security key received

from the api don't match with the API
Security key stored in the device.

2) Whenever access request

through API feature is not enabled
for the received User.
2 20 All doors
3) When the user is not in the route
assigned to the door

4) Whenever the IMEI received in

the API doesn’t match with the IMEI
stored against the identified user.

Waiting for second user -when 2-

person is active and first person has 3 1 All doors
been verified

Waiting for second user -Occupancy Panel doors & Linux based
3 0
1st user identified direct doors

If device is serving a command like

enrollment, firmware upgrade or
4 0 All doors
deletion of credentials and API is
received

When the access mode=

API+Biometric & user has identified
5 0 All doors
and devices waits for Biometric
credentials

When passed pdid, i.e. panel door is

6 0 Panel Doors
offline

Approach to Device for Face Mask

9 23 Panel Doors
Detection

Enable Face Recognition on Device

10 24 Panel Doors
for Mask Detection

In above table:

All doors include:

• All direct doors and all panel doors

Matrix COSEC PANEL200 API Guide 103

Linux based direct doors include:
• NGT, Vega, Wireless/V3, PVR, Path, V2, V4, ARC DC 200, ARGO, FMX

Direct doors include:

• NGT, Vega, Arc, Wireless/V3, PVR, Path V2, V4, ARC DC 200, ARGO, FMX

Panel doors include:

• Vega, Arc, Wireless/V3, PVR, V1, V2, Path V2, V4, ARC DC 200, ARGO

104 Matrix COSEC PANEL200 API Guide

Access Policies

Action: set, get, delete

Syntax: http:// <deviceIP:deviceport>/device.cgi/access-route?<argument>=<value>[&<argument>=<value>….]

Table: Access Policies- Action= set

Arguments Valid Values Mandatory Description

route-id 1 to 255 Yes To set or retrieve alphanumeric route ID.

0= Inactive To enable or disable Access Route Policy.

active No
1= active By default it is disabled/deactivated

route name 15 Char ASCII Code Yes To define the access route name

0= soft To set or retrieve the restriction for un-

restriction No
1= hard sequenced route. By default it is ‘Soft’

0= unsequenced To enable or disable sequencing in access

sequenced No
1= sequenced route. By default it is disabled

0= Inactive To reset access route at lowest level. By

reset-lowest-level No
1= active default it is disabled

To Enable/Disable checking on last Exit

0= Inactive
check-last-exit-level No Level.by default it is disabled. This is
1= active
applicable only when route is sequenced

To set or retrieve the last exit level

0= soft
last-exit-level-restrct No restriction. By default it is ‘Soft’. This is
1= hard
applicable only when route is sequenced

To define the door id and level as an array

door-info Id (1-255),level(1-32) Yes
of max. 255 doors

format Text, XML No To specify the format.

For action = get

For valid values of this action, refer to the following argument-value table.

Table: Access Policies- Action= get

Argument Valid Values Mandatory Description

route-id 1 to 255 Yes To define the Access Route ID

format Text, XML No To specify the format.

For action= delete

For valid values of this action, refer to the following argument-value table.

Table: Access Policies- Action= delete

Argument Valid Values Mandatory Description

To select the route ID on which the

route-id 1 to 255 Yes
specified operation is to be done.

Specifies the format in which the

format Text, XML No
response is expected

Matrix COSEC PANEL200 API Guide 105

Advanced Parameter for Access Route
Advances parameter for access route will be applicable only when the route is sequenced.

Action: set, get

Syntax: http:// <deviceIP:deviceport>/device.cgi/ad-access-route?<argument>=<value>[&<argument>=<value>….]

For valid values of this action, refer to the following argument-value table.

Table: Advance Parameter for Access Route - Action: set

Argument Valid Values Mandatory Description

route-id 1 to 255 Yes To set or retrieve alphanumeric route

ID.

door-id 1 to 255(for Panel200), Yes

To define the door id of the device
1 to 75 ( for Panel/Panellite v1)

entry-enable 0= inactive No To enable/disable sequenced

1= active access route at entry. By default it is
disabled

entry-route-timer 1-65535 seconds No To set or retrieve entry route timer.

By default it is 600 seconds

entry-level-restrct 0= soft No To set or retrieve the entry level

1= hard restriction. By default it is ‘Soft’

entry-perform-action 0= on user punch No To set or retrieve the Perform Action

1= on timer elapse on Entry. By default it is “On User
Punch”

exit-enable 0= inactive No To enable/disable sequenced

1= active access route at exit. By default it is
disabled

exit-route-timer 1-65535 seconds No To set or retrieve exit route timer. By

default it is 600 seconds

exit-level-restrct 0= soft No To set or retrieve the exit level

1= hard restriction. By default it is ‘Soft’

exit-perform-action 0= on user punch No To set or retrieve the Perform Action

1= on timer elapse on Exit. By default it is “On User
Punch”

format Text, XML No To specify the format

Action: get

For valid values of this action, refer to the following argument-value table.

Table: Advance Parameter for Access Route- Action: get

Argument Valid Values Mandatory Description

route-id 1 to 255 Yes To define the Access Route ID.

format Text, XML No To specify the format

106 Matrix COSEC PANEL200 API Guide

API Response Codes

These numerical codes will be returned with an API response. These response codes shall indicate the result of a
particular request made by the client. For e.g. the response code ‘0’ will indicate that the requested action was
performed successfully. Refer to the given table for a list of response codes and their meanings.

Table: API Response Codes

Response Code Description Test Condition

0 Successful -

Failed - Invalid Login

1 On every Authentication/Verification while logging In
Credentials

Date and time – manual

2 If unable to set the RTC for date and time API
set failed

In User API, if validity-date or date of birth is set wrong.

3 Invalid Date/Time If the starting time and end time of a shift is configured as
same.

Maximum users are

4 On every set command for user API
already configured.

Card 1 and card 2 are

7 On every set command for user API and set credential API
identical

On every set command for user API and set credential API,
8 Card ID exists
Set Special Function API

Finger print template/

9 Palm template/ Face Set credential API
Image already exists

Event sequence number and roll over count not found, image
10 No Record Found not found, file not found.
No panel doors are added in panel

Template size/ format If the expected template size is not as per the required size,
11
mismatch format or any checksum error etc. in Set credential API

In Set credential API, if the max FP template is set in the

12 FP Memory full
module.

In enroll user command if user id is not available in the device

and in User Configuration API, to update a user if provided
User id/reference id not
13 reference user ID doesn’t belong to that user verified with
found
alphanumeric user ID.
Also, to be used for get security code API

In enroll user command, if max no. of credentials is already

14 Credential limit reached
enrolled.

The enroll request is for smart card and the device has
proximity reader or if enroll request has palm template but door
Reader mismatch/
15 has finger reader and similar cases.
Reader not configured
If OSDP Reader is connected with ARC DC200 and if
enrollment type is other than Reader Only Card (type=0).

All cases of enrollment when the device is unable to process a

16 Device Busy
request as it is in a different menu state

Matrix COSEC PANEL200 API Guide 107

Table: API Response Codes

Response Code Description Test Condition

Internal error like configuration, firmware or event or calibration

17 Internal process error
failure occur

18 PIN already exists Set User API: PIN is already assigned to another user

In enroll user smart card, write FP is enabled, but FP is not

Biometric credential not
19 enrolled, Get FP/Palm template command is sent but template
found
is not present.

In case memory card is not connected, and a command

20 Memory Card Not Found
related to getting an image (user photo) is sent.

When an already existing User ID is entered against a user

21 Reference User ID exists
having unique User ID.

For enrolling user, if writing FP template on smart card is

enabled, but no fingerprint is enrolled.
22 Wrong Selection
When palm/finger/card count exceeds the maximum number of
available places.

Palm template mode In Set Credentials API, when palm template with particular
23
mismatch mode does not match with the selected mode.

Feature not enabled in In configuration, if a particular parameter is not enabled and is

24
the configuration required for the process.

Message already exists

In Device Display API, if message is configured for same date
25 for same user for same
and same user that is already configured.
date

26 Error in Import Data Import API if any of the import rules are violated

Maximum doors are

27 On every set command for Panel door API
already configured

Whenever the IP/RS 485 address/MAC address conflicts with

an existing panel door
28 Panel door already exists
This will be also applicable whenever the user tries to change
the door type of an already existing door.

Whenever the value set for any parameter is not as per its field
type defined.
Whenever IP/MAC entered is not valid.
29 Invalid value
Whenever username/door name is set as blank.
Whenever the Pdid received in the API doesnot exists in the
panel.

30 Door Offline When Panel door is offline

Whenever user's Photo is not present in the panel and Get

31 Photo not uploaded
User Photo has been fired

108 Matrix COSEC PANEL200 API Guide

Error Responses

These are some possible error response types obtained from incorrect API requests.

• Argument is mentioned in request but valid value is not assigned.

Sample Response

HTTP code: <code>

Content-type: <type>
Body:
Request failed: Incomplete command “<argument>=”

• Invalid value is assigned to argument in request.

Sample Response

HTTP code: <code>

Content-type: <type>
Body:
Request failed: Invalid command “<argument>=<invalid value>”

• Syntax of request is incorrect or any unexpected arguments are received.

Sample Response

HTTP code: <code>

Content-type: <type>
Body:
Request failed: Invalid syntax “<entire request>”

• Mandatory fields are not mentioned in request.

Sample Response

HTTP code: <code>

Content-type: <type>
Body:
Request failed: Incomplete command “<entire request>”

Matrix COSEC PANEL200 API Guide 109

 • Syntax of request is valid but no data found.

Sample Response

HTTP code: <code>

Content-type: <type>
Body:
Request failed: No record found “<argument>=<value>”

110 Matrix COSEC PANEL200 API Guide

Appendix

Table: Universal Time Zone Reference

Index=0 Text="(GMT-12:00) International Date Line West"

Index=1 Text="(GMT-11:00) Midway Island, Samoa"
Index=2 Text="(GMT-10:00) Hawaii"
Index=3 Text="(GMT-09:00) Alaska"
Index=4 Text="(GMT-08:00) Pacific Time (Us & Canada); Tijuana"
Index=5 Text="(GMT-07:00) Arizona"
Index=6 Text="(GMT-07:00) Chihuahua, La Paz, Mazatlan"
Index=7 Text="(GMT-07:00) Mountain Time (Us & Canada)"
Index=8 Text="(GMT-06:00) Central America"
Index=9 Text="(GMT-06:00) Central Time (Us & Canada)"
Index=10 Text="(GMT-06:00) Guadalajara, Mexico City, Monterrey"
Index=11 Text="(GMT-06:00) Saskatchewan"
Index=12 Text="(GMT-05:00) Bogota, Lima, Quito"
Index=13 Text="(GMT-05:00) Eastern Time (Us & Canada)"
Index=14 Text="(GMT-05:00) Indiana (East)"
Index=15 Text="(GMT-04:00) Atlantic Time (Canada)"
Index=16 Text="(GMT-04:00) Caracas, La Paz"
Index=17 Text="(GMT-04:00) Santiago"
Index=18 Text="(GMT-03:30) Newfoundland"
Index=19 Text="(GMT-03:00) Brasilia"
Index=20 Text="(GMT-03:00) Buenos-Aires, Georgetown"
Index=21 Text="(GMT-03:00) Greenland"
Index=22 Text="(GMT-02:00) Mid-Atlantic"
Index=23 Text="(GMT-01:00) Azores"
Index=24 Text="(GMT-01:00) Cape Verde Is"
Index=25 Text="(GMT) CASABLANCA, MONROVIA"
Index=26 Text="(GMT) Dublin, Edinburgh, Lisbon, London"
Index=27 Text="(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna"
Index=28 Text="(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague"
Index=29 Text="(GMT+01:00) Brussels, Copenhagen, Madrid, Paris"
Index=30 Text="(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb"
Index=31 Text="(GMT+01:00) West Central Africa"
Index=32 Text="(GMT+02:00) Athens, Beirut, Istanbul, Minsk"
Index=33 Text="(GMT+02:00) Bucharest"
Index=34 Text="(GMT+02:00) Cairo"
Index=35 Text="(GMT+02:00) Harare, Pretoria"
Index=36 Text="(GMT+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius"
Index=37 Text="(GMT+02:00) Jerusalem"
Index=38 Text="(GMT+03:00) Baghdad"
Index=39 Text="(GMT+03:00) Kuwait, Riyadh"
Index=40 Text="(GMT+03:00) Moscow, St Petersburg, Volgograd"
Index=41 Text="(GMT+03:00) Nairobi"
Index=42 Text="(GMT+03:30) Tehran"
Index=43 Text="(GMT+04:00) Abu Dhabi, Muscat"
Index=44 Text="(GMT+04:00) Baku, Tbilisi, Yerevan"
Index=45 Text="(GMT+04:30) Kabul"
Index=46 Text="(GMT+05:00) Ekaterinburg"
Index=47 Text="(GMT+05:00) Islamabad, Karachi, Tashkent"
Index=48 Text="(GMT+05:30) Chennai, Kolkata, New Delhi, Mumbai"
Index=49 Text="(GMT+05:45) Kathmandu"
Index=50 Text="(GMT+06:00) Almay, Novosibirsk"
Index=51 Text="(GMT+06:00) Astana, Dhaka"
Index=52 Text="(GMT+06:00) Sri Jayewardenepura"
Index=53 Text="(GMT+06:30) Rangoon"
Index=54 Text="(GMT+07:00) Bangkok, Hanoi, Jakarta"
Index=55 Text="(GMT+07:00) Krasnoyarsk"
Index=56 Text="(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi"
Index=57 Text="(GMT+08:00) Irkutsk, Ulaanbataar"
Index=58 Text="(GMT+08:00) Kuala Lumpur, Singapore"
Index=59 Text="(GMT+08:00) Perth"
Index=60 Text="(GMT+08:00) Taipei"

Matrix COSEC Panel200 API Guide 111

Table: Universal Time Zone Reference

Index=61 Text="(GMT+09:00) Osaka, Sapporo, Tokyo"

Index=62 Text="(GMT+09:00) Seoul"
Index=63 Text="(GMT+09:00) Yakutsk"
Index=64 Text="(GMT+09:30) Adelaide"
Index=65 Text="(GMT+09:30) Darwin"
Index=66 Text="(GMT+10:00) Brisbane"
Index=67 Text="(GMT+10:00) Canberra, Sydney, Melbourne,"
Index=68 Text="(GMT+10:00) Guam, Port Moresby"
Index=69 Text="(GMT+10:00) Hobart"
Index=70 Text="(GMT+10:00) Vladivostok"
Index=71 Text="(GMT+11:00) Magadan, Solomon Is, New Caledonia"
Index=72 Text="(GMT+12:00) Auckland, Wellington"
Index=73 Text="(GMT+12:00) Fiji, Kamchatka, Marshall Is"
Index=74 Text="(GMT+13:00) Nuku'alofa"

Event Configuration Reference

Table: List of Events

Event ID Event Description

101 User Allowed

102 User Allowed – with Duress

103 User Allowed – Anti-Pass Back-soft

104 User Allowed - Dead-man Zone

105 User Allowed – Door Not open

106 User Allowed – Smart Secure Access

107 User Allowed – Smart card based route access - soft

108 User Allowed – Panel route access - soft

109 User Allowed – two person rule - primary user

110 User Allowed – two person rule - secondary user

112 User Allowed - Multi-Level Access

113 User Allowed - Access Route Timer Violation - Soft

115 User Allowed - Face Mask Not Detected-Soft

151 User Denied – User Invalid

152 User Denied – Occupancy Control

153 User Denied – 2-Person Rule

154 User Denied – Time Out

156 User Denied – Anti-Pass Back

157 User Denied – Disabled User

158 User Denied – Blocked User

159 User Denied – First IN User

160 User Denied – DND Enabled

161 User denied – Control zone

112 Matrix COSEC PANEL200 API Guide

 Event ID Event Description

162 User Denied – Door Lock

163 User Denied – Invalid Access Group

164 User Denied – Validity date expired

165 User Denied – Invalid Route Access

166 User Denied – Invalid Shift Access

167 User Denied – Invalid Access Cluster

172 User Denied - FP sensor busy

173 User Denied - Unauthorized User

174 User Denied – Door Interlock

175 User Denied – FR Disabled

176 User Denied – Access Route Timer Violation

178 User Denied - Face Mask Not Detected

201 Door Status changed

202 Dead-man timer changed

203 DND status changed

204 Aux input status changed

205 Aux output status changed

206 Door sense input status

207 Door Controller Communication status

208 Door Open/ Close

209 Lock relay status changed

301 Dead-man timer expired Alarm– User IN

302 Duress detection

303 Panic Alarm

304 FP Memory Full – Alarm

305 Door Held open too long

306 Door Abnormal

307 Door force open

308 Door Controller Offline

309 Door Controller -Fault

310 Tamper Alarm

311 Master Controller Mains fail Alarm

312 Master Controller Battery fail

313 Master Alarm – MC Alarm input

314 RTC

315 Event Buffer Full

317 Intercom - panic

Matrix COSEC Panel200 API Guide 113

 Event ID Event Description

318 Occupancy Violated Alarm

319 Tail- Gating Alarm

320 Man Trap Timer Violated Alarm

321 Access Denied Alarm

322 Multiple Unauthorized Access Alarm

323 Custom Alarm 1

324 Custom Alarm 2

325 Custom Alarm 3

326 User Unidentified

327 Anti-Pass Back Violated Alarm

328 Access Route Violated Alarm

329 Raise Alarm

330 Lock Open Too Long

331 Lock Abnormal

332 Manual Lock Override

351 Alarm acknowledged

352 Alarm cleared

353 Alarm Re-issued

333 Access Route Timer Violated Alarm

335 Face Mask Not Detected

401 User Block/Restore

402 Login to ACS

403 Message transaction confirmation to ACMS

405 Enrolment

406 Master Alarm sense input status

407 Master Aux Output status

408 Input Output Group Link status

409 Credentials Deleted

410 Time Triggered Function

411 Time Stamping Function

413 Camera Event for time stamp

451 Configuration Change

452 Roll over of events

453 Master Controller Power ON

454 Configuration Defaulted

455 Soft Override

456 Backup and Update

114 Matrix COSEC PANEL200 API Guide

 Event ID Event Description

457 Default System

458 Sensor Calibration

459 User Denied – invalid card

460 User PIN Change

461 Enrollment Authorized/ Unauthorized

462 User Access Policy Reset

465 Face Image and Face Template Available

467 Unidentified Face Capture

468 Unidentified Face Image Available

470 Event Photo Available

471 Device Storage Alert

*The Events listed above is a consolidated list considering all the Doors. The events displayed will depend on the
Door Type and features supported.

Table: Size of Event Field

Door Field 1 Field 2 Field 3 Field 4 Field 5 Event Log Capacity

Panel200 4 bytes 2 bytes 2 bytes 4 bytes 4 bytes 5,00,000 events

Table: Event Structure

Reply Event

RPL_EVT TYPE MID ROLL_OVER_COUNT EVT_SEQ_NUM SOURCE_ID DATE TIME EVT_ID

Reply Event

FIELD1 FIELD2 FIELD3 FIELD4 FIELD5

The above structure will be used to send events to COSEC Server.

Send Event

SND_EVT EVT_SEQ_NUM SOURCE_ID DATE TIME EVT_ID FIELD1 FIELD2 FIELD3

Send Event

FIELD4 FIELD5 MAC ADDRESS

This structure will be used to send events to CCC Server or when TCP Events API is fired.

Matrix COSEC Panel200 API Guide 115

Table: User Events

Event Details Device

(Field
(Field 1) 4)
(Field 2) (Field 3)
and
Event
ID Special
(Field Panel200/Panel/Panel-Lite/Standalone Panellite
Reference 5)
Code Entry/Exit
ID

User Allowed Events

Special
Detail
Xxxx Function
code
(Referenc
101 (Reference
e ID=0 for 
ID=0 for (Reference
REX input)
REX input) ID=0 for
REX input)

Special
102 Xxxx Function
code
Detail 
Special
103 Xxxx Function Detail 
code

Special
104 Xxxx Function Detail 
code

Special
105 Xxxx Function Detail 
code

Special (Refe
rence
106 Xxxx Function Detail
ID=0

code
for
REX
Special input)
107 Xxxx Function Detail 
code

Special
108 Xxxx Function Detail 
code

Special
109 Xxxx Function Detail 
code

Special
110 Xxxx Function Detail 
code

First four last two

111
bytes of
extension
bytes of
extension
Detail 
number number

0 = Door
unlock
112 Xxxx
1 = Door
Detail 
lock

User Denied Events

116 Matrix COSEC PANEL200 API Guide

 Event Details Device

(Field
(Field 1) 4)
(Field 2) (Field 3)
and
Event
ID Special
(Field Panel200/Panel/Panel-Lite/Standalone Panellite
Reference 5)
Code Entry/Exit
ID

Special
Function
151 Xxxx
code
Detail 

152 Xxxx Detail 

153 Xxxx Detail 

154 Xxxx Detail 

155 Xxxx Detail 

156 Xxxx Detail 

157 Xxxx Detail 

158 Xxxx Detail 

159 Xxxx Detail 

160 Xxxx Detail 

161 Xxxx Detail 

162 Xxxx Detail 

163 Xxxx Detail 

164 Xxxx Detail 

0=Door Not
in Sequence

1=Door Not
in Route

2=Door Not
in Sequence
for Smart
card based
165 Xxxx Route Detail
3=Door Not
in Smart
card based 
Route

4=Credentia
l Invalid for
Smart card
based
Route
Access

Matrix COSEC Panel200 API Guide 117

 Event Details Device

(Field
(Field 1) 4)
(Field 2) (Field 3)
and
Event
ID Special
(Field Panel200/Panel/Panel-Lite/Standalone Panellite
Reference 5)
Code Entry/Exit
ID

0=Outside
working
hours 
1=Holiday

166 Xxxx Detail

2=Week off

3=Field
Break 
4=Rest Day

167 Xxxx Detail 

First four last two
171
bytes of
extension
bytes of
extension
Detail 
number number

172 Xxxx Detail 

Table: Special Function Code Reference

Applicable for Allowed Applicable for Denied

S.No. Special Function Name Special Function Code
Events Events

1
Official Work-IN Marking in
1 

T&A

2
Official Work-OUT Marking
2 

in T&A

3
Short Leave-IN Marking in
3 

T&A

4
Short Leave-OUT Marking
4 

in T&A

5 Clock - IN Marking in T&A 5 



6
Clock - OUT Marking in
6 

T&A

7
Post Lunch-IN Marking in
7 

T&A

8
Pre Lunch -OUT Marking
8 

in T&A

9
Over time – IN Marking in
9 

T&A

10
Over time – OUT Marking
10 

in T&A

118 Matrix COSEC PANEL200 API Guide

 Applicable for Allowed Applicable for Denied
S.No. Special Function Name Special Function Code
Events Events

11
Late –IN Allowed Marking
11 

in T&A

12
Early - OUT Allowed
12 

Marking in T&A

Access in Degrade Mode

13 99  
Marking

14 Smart Identification 98  

15 e-Canteen 97  

Table: Field 3 Detail (User Events) Reference*

Bit 15 Bit 14 Bit 13 Bit 12 Bit 11 Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

Card Card Time Entry/

RFU QR BLE Face API Group Palm Finger Card PIN RFU
2 1 Stamp Exit

* Applicable for Firmware Version: COSEC_PANEL200_V01R71.02 and later.

Table: Information of Bit 0 and 1*

Credential Bit 1 Bit 0 Value

Entry 0 0 0 

Exit 0 1 1 

* Applicable for Firmware Version: COSEC_PANEL200_V01R71.02 and later.

Table: Information of Bit 4 to 14*

Credential Bit 14 Bit 13 Bit 12 Bit 11 Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Value

PIN 0 0 0 0 0 0 0 0 0 0 1 1

Card 1 0 0 1 0 0 0 0 0 0 1 0 258

Card 1 + PIN 0 0 1 0 0 0 0 0 0 1 1 259

Finger 0 0 0 0 0 0 0 0 1 0 0 4

Finger + PIN 0 0 0 0 0 0 0 0 1 0 1 5

Finger + Card 1 0 0 1 0 0 0 0 0 1 1 0 262

Finger + Card 1 +
0 0 1 0 0 0 0 0 1 1 1 263
PIN

Palm 0 0 0 0 0 0 0 1 0 0 0 8

PIN + Palm 0 0 0 0 0 0 0 1 0 0 1 9

Card 1 + Palm 0 0 1 0 0 0 0 1 0 1 0 266

PIN + Card 1 +
0 0 1 0 0 0 0 1 0 1 1 267
Palm

Group + Palm 0 0 0 0 0 0 1 1 0 0 0 24

Matrix COSEC Panel200 API Guide 119

Credential Bit 14 Bit 13 Bit 12 Bit 11 Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Value

API 0 0 0 0 0 1 0 0 0 0 0 32

API + Finger 0 0 0 0 0 1 0 0 1 0 0 36

API + Palm 0 0 0 0 0 1 0 1 0 0 0 40

API + Face 0 0 0 0 1 1 0 0 0 0 0 96

API + PIN 0 0 0 0 0 1 0 0 0 0 1 33

Group + Finger 0 0 0 0 0 0 1 0 1 0 0 20

API + Card 1 0 0 1 0 0 1 0 0 0 1 0 290

Face 0 0 0 0 1 0 0 0 0 0 0 64

PIN + Face 0 0 0 0 1 0 0 0 0 0 1 65

Card 1 + Face 0 0 1 0 1 0 0 0 0 1 0 322

Finger + Face 0 0 0 0 1 0 0 0 1 0 0 68

Palm + Face 0 0 0 0 1 0 0 1 0 0 0 72

BLE 1 0 0 1 1 0 0 0 0 0 0 0 384

BLE 2 0 1 0 1 0 0 0 0 0 0 0 640

BLE 1 + Card 1 0 0 1 1 0 0 0 0 0 1 0 386

BLE 2 + Card 1 0 1 1 1 0 0 0 0 0 1 0 898

BLE 1 + Finger 0 0 1 1 0 0 0 0 1 0 0 388

BLE 2 + Finger 0 1 0 1 0 0 0 0 1 0 0 644

BLE 1 + Palm 0 0 1 1 0 0 0 1 0 0 0 392

BLE 2 + Palm 0 1 0 1 0 0 0 1 0 0 0 648

BLE 1 + Face 0 0 1 1 1 0 0 0 0 0 0 448

BLE 2 + Face 0 1 0 1 1 0 0 0 0 0 0 704

BLE 1 + PIN 0 0 1 1 0 0 0 0 0 0 1 385

BLE 2 + PIN 0 1 0 1 0 0 0 0 0 0 1 641

Card 2 0 1 0 0 0 0 0 0 0 1 0 514

Card 2 + PIN 0 1 0 0 0 0 0 0 0 1 1 515

Finger + Card 2 0 1 0 0 0 0 0 0 1 1 0 518

Finger + Card 2 +
0 1 0 0 0 0 0 0 1 1 1 519
PIN

Card 2 + Palm 0 1 0 0 0 0 0 1 0 1 0 522

PIN + Card 2 +
0 1 0 0 0 0 0 1 0 1 1 523
Palm

API + Card 2 0 1 0 0 0 1 0 0 0 1 0 546

Card 2 + Face 0 1 0 0 1 0 0 0 0 1 0 578

BLE 1 + Card 2 0 1 1 1 0 0 0 0 0 1 0 898

BEL 2 + Card 2 0 1 0 1 0 0 0 0 0 1 0 642

QR 1** 1 0 1 0 0 0 0 0 0 0 0 1280

QR 1 + PIN 1 0 1 0 0 0 0 0 0 0 1 1281

120 Matrix COSEC PANEL200 API Guide

 Credential Bit 14 Bit 13 Bit 12 Bit 11 Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Value

API + QR 1 1 0 1 0 0 1 0 0 0 0 0 1312

QR 1 + Face 1 0 1 0 1 0 0 0 0 0 0 1344

BLE 1 + QR 1 1 0 1 1 0 0 0 0 0 0 0 1408

BLE 2 + QR 1 1 1 1 1 0 0 0 0 0 0 0 1920

QR 2 1 1 0 0 0 0 0 0 0 0 0 1536

QR 2 + PIN 1 1 0 0 0 0 0 0 0 0 1 1537

API + QR 2 1 1 0 0 0 1 0 0 0 0 0 1568

QR 2 + Face 1 1 0 0 1 0 0 0 0 0 0 1600

BLE 1 + QR 2 1 1 1 1 0 0 0 0 0 0 0 1920

BLE 2 + QR 2 1 1 0 1 0 0 0 0 0 0 0 1664

* Applicable for Firmware Version : COSEC_PANEL200_V01R71.02 and later.

** QR is applicable to Panel200-Server Mode only.

Table: Field 3 Detail (User Events) Reference*

Bit 15 Bit 14 Bit 13 Bit 12 Bit 11 Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0

Entry/
RFU BLE Face API Group Palm Finger Card PIN RFU RFU
Exit

* Applicable for Firmware Version: Earlier than COSEC_PANEL200_V01R71.02.

Table: Information of Bit 0 and Bit 1*

Credential Bit 1 Bit 0 Value

Entry 0 0 0 

Exit 0 1 1 

* Applicable for Firmware Version : Earlier than COSEC_PANEL200_V01R71.02.

Table: Information of Bit 4 to 11*

Credential Bit 11 Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Value

PIN 0 0 0 0 0 0 0 1 1

Card 0 0 0 0 0 0 1 0 2

Card + PIN 0 0 0 0 0 0 1 1 3

Finger 0 0 0 0 0 1 0 0 4

Finger + PIN 0 0 0 0 0 1 0 1 5

Finger + Card 0 0 0 0 0 1 1 0 6

Finger + Card
0 0 0 0 0 1 1 1 7
+ PIN

Palm 0 0 0 0 1 0 0 0 8

PIN + Palm 0 0 0 0 1 0 0 1 9

Card + Palm 0 0 0 0 1 0 1 0 10

Matrix COSEC Panel200 API Guide 121

 Credential Bit 11 Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Value

PIN + Card +
0 0 0 0 1 0 1 1 11
Palm

Group + Palm 0 0 0 1 1 0 0 0 24

API 0 0 1 0 0 0 0 0 32

API + Finger 0 0 1 0 0 1 0 0 36

API + Palm 0 0 1 0 1 0 0 0 40

API + PIN 0 0 1 0 0 0 0 1 33

Group + Finger 0 0 0 1 0 1 0 0 20

Face 0 1 0 0 0 0 0 0 64

Card + Face 0 1 0 0 0 0 1 0 66

PIN + Face 0 1 0 0 0 0 0 1 65

Finger + Face 0 1 0 0 0 1 0 0 68

Palm + Face 0 1 0 0 1 0 0 0 72

BLE 1 0 0 0 0 0 0 0 128

BLE + Finger 1 0 0 0 0 1 0 0 132

BLE + Palm 1 0 0 0 1 0 0 0 136

BLE + Face 1 1 0 0 0 0 0 0 192

BLE + PIN 1 0 0 0 0 0 0 1 129

BLE + Card 1 0 0 0 0 0 1 0 130

* Applicable for Firmware Version: Earlier than COSEC_PANEL200_V01R71.02.

Table: Alarm Events

Event Details Applicable Devices

Pane
(Field
l200/
4) Direct Path Wirele Vega
Event NGT PVR Door ARGO ARC Pane
(Field 1) (Field 2) (Field 3) and Door Contro ss Contr ARGO
ID Door Door FMX FACE DC200 l/
(Field V2 ller Door oller
Pane
5)
l Lite

Alarm
301
Reference
ID Xxxx
1 = Critical
Seque-
nce           
Number

302
Reference
ID Xxxx
1 = Critical
Same as
above           

122 Matrix COSEC PANEL200 API Guide

 Event Details Applicable Devices

Pane
(Field
l200/
4) Direct Path Wirele Vega
Event NGT PVR Door ARGO ARC Pane
(Field 1) (Field 2) (Field 3) and Door Contro ss Contr ARGO
ID Door Door FMX FACE DC200 l/
(Field V2 ller Door oller
Pane
5)
l Lite

303
Reference
ID Xxxx
1 = Critical
Same as
above           

304
1= Internal
2= External
3 = Minor
Same as
above
          

305 3 = Minor
Same as
above           

Same as
306 2 = Major
above           

307 1 = Critical
Same as
above           

308 2 = Major
Same as
above           

Same as
309 2 = Major
above           

Same as
310 1 = Critical
above
          

311 2 = Major
Same as
above           

312 1 = Critical
Same as
above           

313 1 = Critical
Same as
above           

1= Power
ON/OFF
Detected
(time not in
sync)
2 = Major
314 2= low 1 = Critical
Same as
above           
battery
detected

3= RTC
Not
Detected

315
2 = Major
1 = Critical
Same as
above           
First four Last two
317
bytes of
Extension
bytes of
extension
Same as
above           
number number

318
Reference
ID Xxxx
2 = Major
Same as
above           

319
Reference
ID Xxxx
2 = Major
Same as
above           

320
Reference
ID Xxxx
2 = Major
Same as
above           

321
Reference
ID Xxxx
2 = Major
Same as
above           

322
Reference
ID Xxxx
2 = Major
Same as
above           

323 2 = Major
Same as
above           

324 2 = Major
Same as
above           

325 2 = Major
Same as
above           

326 2 = Major
Same as
above           

Matrix COSEC Panel200 API Guide 123

 Event Details Applicable Devices

Pane
(Field
l200/
4) Direct Path Wirele Vega
Event NGT PVR Door ARGO ARC Pane
(Field 1) (Field 2) (Field 3) and Door Contro ss Contr ARGO
ID Door Door FMX FACE DC200 l/
(Field V2 ller Door oller
Pane
5)
l Lite

327
Reference
ID Xxxx
2 = Major
Same as
above           

328
Reference
ID Xxxx
2 = Major
Same as
above           

329
Reference
ID Xxxx
2 = Major
Same as
above           

4=
SysInterlo
ck
5=
User_Jeev Same as
351
es above           
6=
User_AC
MS
9 = Auto

4=
SysInterlo
ck
5=
User_Jeev
Same as
352 es
above
          
6=
User_AC
MS
7= Special
Function

353
Same as
above           

124 Matrix COSEC PANEL200 API Guide

Table: System Events

Event Details Applicable Devices

Panel200
/Panel/
(Field 4) Direct Path Vega Panel IO
Event Wireles NGT PVR Door
(Field 1) (Field 2) (Field 3) and Door Controlle Control Lite/ Control
ID s Door Door Door FMX
(Field 5) V2 r ler Standalo ler
ne Panel
lite

0= Unused
(Restore User)

1= Blocked
401
User ID:
xxxx
2=Unauthorize         
d access 0= Restored

4=Invalid PIN

5= SA

402 6= SE
1=Success
0=Fail         
7= Operator

Transact 1=Success
403 ion ID: 0=Fail         
Xxxx

Guard
404
Tour no.
Xxxx +
1=Success
0=Fail         
cycle no.

0= FP-1/Palm-1

1= Card1/FP-2/
8 = User Card Palm-2

9 = User 2= Card-2/ F-3/

Finger Palm-3

10 = Special 3 = Card-3/FP-
Cards 4/Palm-

405 ID: Xxxx

14 = Palm 4 = Card-4/FP-
5/Palm-5         
16 = Palm
template with 5= FP-6/Palm-6
guide mode
6= FP-7/Palm-7
17 = User
Finger- 7= FP-8/Palm-8
Suprema ISO
format 8= FP-9/Palm-9

9= FP-10/Palm-
10

Matrix COSEC Panel200 API Guide 125

 Event Details Applicable Devices

Panel200
/Panel/
(Field 4) Direct Path Vega Panel IO
Event Wireles NGT PVR Door
(Field 1) (Field 2) (Field 3) and Door Controlle Control Lite/ Control
ID s Door Door Door FMX
(Field 5) V2 r ler Standalo ler
ne Panel
lite

1=Normal

2=Fault (Open)
406         
3= Fault(Short)

4= Activated

407
1=Normal
4=Activated         
11 = Pulse
12 = Interlock
13 = Latch
I/O Link 15 = Toggle 1=Normal
408
ID (only with 4=Activated         
activated
event)

8 = User Cards
5= Web Jeeves
9 = User
409 ID: Xxxx Fingers
6= ACMS
7= Special         
14 = Palm
Function

Time
1=Normal/
Triggere
Deactivated
410 d         
Function
4=Activated
Id

Time
1=Normal/
Stampin
411 g
Deactivated
        
Function
4=Activated
ID

Guard
412
tour no.
+cycle
Door Controller
sequence no.
1=Success
0=Fail         
no.

event
413
sequenc
e
roll over count
1=Success
0=Fail         
number

Configur
451
-ation
Table ID
Index start Index end         
xxx

Roll over
452 number         
00 to 99

453         
Configur
454
-ation
Table ID
Index start Index end         
xxx

126 Matrix COSEC PANEL200 API Guide

 Event Details Applicable Devices

Panel200
/Panel/
(Field 4) Direct Path Vega Panel IO
Event Wireles NGT PVR Door
(Field 1) (Field 2) (Field 3) and Door Controlle Control Lite/ Control
ID s Door Door Door FMX
(Field 5) V2 r ler Standalo ler
ne Panel
lite

Time
Period =
xxx
1= 2-person
(configur
Rule
ed
2= Access
value)
Policies
3= Alarms
(this field
4= Anti-pass
455
is used
only with
back
1= Overridden
0= Resumed         
5= First In User
Overridd
6= Mantrap
en
7= Occupancy
events)
control
8= Visitor
Resume
Escort Rule
events
will have
blank

1=Backu 1=Configuratio 0 = Fail

456
p
2=Updat
n
2=Event
1 = Success
2 = CRC Check         
e 3=Firmware Fail

6 = from ACMS
457 8 = from         
Hardware

0 = Internal
0 = Fail
Finger Reader
458
1 = Success
2 = Not         
1 = External
Supported
Finger Reader

459 Card ID Card ID Card ID         

Referen
460 ce ID:         
xxxx

Referen
461 ce ID:
0 = Authorized
1 = Rejected
System User
Index 1 to 10         
xxxx

Matrix COSEC Panel200 API Guide 127

SECURITY SOLUTIONS

MATRIX COMSEC PVT. LTD.

Head Office:
394-GIDC, Makarpura, Vadodara - 390010, India.
Ph.:+91 265 2630555, +918511173344
E-mail: Tech.Support@MatrixComSec.com

Website: www.matrixcomsec.com