Versions Compared

Version Old Version 2 New Version 3
Changes made by

Vinodhraj DP

Vinodhraj DP

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This chapter describes how to create/retrieve/update/delete Access Groups through the FREEDOM PRIMIS API software.

access_group element:

...

This chapter describes how to create/retrieve/update/delete Controlled Areas through the FREEDOM Primis API software.

controlled_area element:

...

This chapter describes how to retrieve Activity events through the FREEDOM PRIMIS API software.

activity_event element:

...

Code Block
<activity_events>
<activity_event>
       <id>585781<<id>3042304</id>
    <hostname>localhost.localdomain<    <hostname>server</hostname>
       <event_time>2016time>2023-0207-04T1122T11:5930:2541.614938-0807:00</event_time>
       <site_id>1<id>66fc2ba1-5b58-4fe3-a67a-3d5f218db426</site_id>
       <activity_type>Card Access</activity_type>
   type/>
    <device_id>CC720F00059C<id>E45F01334F1D</device_id>
       <device_name>FBname>Dev 1<SB</device_name>
       <device_type>Freedomtype/>
Bridge 1-Rdr/R2 Supv</device_type>     <port_name>Reader 1</port_name>
    <originator_id>Edmonton_ADUser_02, Edmonton_ADUser_02:3070400000467;Group:admin group, Area:Lobby</originator_id>
    <originator_name>S-1-5-21-3760748383-892082386-3578648945-113886</originator_name>
    <result>Granted</result>
   name/>
    <originator_id>Identiv EG-2 device synchronization for name=Dev SB, id=E45F01334F1D completed with status=ok</originator_id>
    <originator_name/>
    <result/>
    <suite_id/>
       <user_id>S-1-5-21-3760748383-892082386-3578648945-113886</user_id>
    <first_name>Edmonton_ADUser_02</first_name>
    <last_name>Edmonton_ADUser_02</last_name>
    <card_number>3070400000467</card_number>
   id/>
    <first_name/>
    <last_name/>
    <card_number/>
    <snapshot_url/>
       <io_control>1</io_control>
   control/>
    <sent_to_ams>false</sent_to_ams>
       <event_code>10101<code>60004</event_code>
    <controlled_area_id>c4d9a29d-ef0f-4856-b6a5-1804a1dd8f1a</controlled_area_id>
    <controlled_area_name>Door-EG2</controlled_area_name>
</activity_event>
<activity_event>
       <id>585780<<id>3042307</id>
    <hostname>localhost.localdomain<    <hostname>server</hostname>
       <event_time>2016time>2023-0207-04T1122T11:5930:2643.487377-0807:00</event_time>
       <site_id>1</site_id>
       <activity_type>Card Access</activity_type>
   type/>
    <device_id>CC720F00059C<id>all</device_id>
       <device_name>FB 1</device_name>
   name/>
    <device_type/>
       <port_name>Reader 1</port_name>
   name/>
    <originator_id> <id>Identiv EG-2 Device Synchronization Completed</originator_id>
       <originator_name/>
      <result>Card Swipe</result>
   <result/>
    <suite_id/>
       <user_id>S-1-5-21-3760748383-892082386-3578648945-113886</user_id>
    <first_name>Edmonton_ADUser_02</first_name>
    <last_name>Edmonton_ADUser_02</last_name>
    <card_number>3070400000467</card_number>
  id/>
    <first_name/>
    <last_name/>
    <card_number/>
    <snapshot_url/>
       <io_control/>
       <sent_to_ams>false</sent_to_ams>
       <event_code>10006<code>60002</event_code>
</activity_event>
    <controlled_area_id/>
    <controlled_area_name/>
</activity_events>event>

Retrieve a range of activity events

...

Code Block
<activity_events_search>
<criteria>
 
</criteria>
<activity_events results="2">
<activity_event>
       <id>585782<<id>3041955</id>
    <hostname>localhost.localdomain<    <hostname>server</hostname>
       <event_time>2016time>2023-0207-04T1121T14:5933:2736.064413-0807:00</event_time>
       <site_id>1</site_id>
       <activity_type>Port</activity_type>
       <device_id>CC720F00059C<id>DCA632E2365A</device_id>
       <device_name>FB 1<name>-FACTORY DEFAULT-</device_name>
       <device_type>Freedomtype>Identiv Bridge 1-Rdr/R2 Supv<EG-2</device_type>
       <port_name>Relay 1<name>Port</port_name>
    <originator_id>     <originator_id>DCA632E2365A: Controller Mode (Server Online: PRM)</originator_id>
       <originator_name/>
       <result>Set</result>
       <suite_id/>
       <user_id/>
       <first_name/>
       <last_name/>
       <card_number/>
       <snapshot_url/>
       <io_control/>
       <sent_to_ams>false</sent_to_ams>
       <event_code>10301</event_code>
    <controlled_area_id>198b1cad-ab6f-4d21-a1fc-7ddde77c40c3</controlled_area_id>
    <controlled_area_name>test door</controlled_area_name>
</activity_event>
<activity_event>
       <id>585784<<id>3041956</id>
    <hostname>localhost.localdomain<    <hostname>server</hostname>
       <event_time>2016time>2023-0207-04T1121T14:5933:2736.078486-0807:00</event_time>
       <site_id>1</site_id>
       <activity_type>Port</activity_type>
       <device_id>CC720F00059C<id>DCA632E2365A</device_id>
       <device_name>FB 1<name>-FACTORY DEFAULT-</device_name>
       <device_type>Freedomtype>Identiv Bridge 1EG-Rdr2</R2 Supv</device_type>
       <port_name>LED 1<name>Port</port_name>
       <originator_id> id>DCA632E2365A: Controller Mode (Server Online: PRM)</originator_id>
       <originator_name/>
       <result>Set</result>
       <suite_id/>
       <user_id/>
       <first_name/>
       <last_name/>
       <card_number/>
       <snapshot_url/>
       <io_control/>
       <sent_to_ams>false</sent_to_ams>
       <event_code>10301</event_code>
    <controlled_area_id>d04407de-5991-41b4-8437-6d6a34a736f1</controlled_area_id>
    <controlled_area_name>Test door 2</controlled_area_name>
</activity_event>
</activity_events>
</activity_events_search>

...

http://<ip address>:<api listening port>/api/activitylog/9655633045762

Result: 

Code Block
<activity_event>
       <id>965563<<id>3045762</id>
       <hostname>localhost.localdomain<<hostname>server</hostname>
       <event_time>2016time>2023-0208-15T1004T16:5519:3122.446475-0807:00</event_time>
       <site_id>1</site_id>
       <activity_type>Card Access</activity_type>
       <device_id>CC720F00059C<id>E45F0153B9B2</device_id>
       <device_name>FB 1<name>EG-2 prod key</device_name>
       <device_type>Freedomtype>Primis Bridge 1-Rdr/R2 Supv<Rdr</device_type>
       <port_name>Reader 1<2</port_name>
       <originator_id>Edmonton_ADUser_02, Edmonton_ADUser_02:3070400000467;Group:admin group, Area:Lobby<id>E45F0153B9B2: Controller Mode (Server Online: PRM);Raw:01CE01D4, BLen:26, CDef:Factory</originator_id>
       <originator_name>S-1-5-21-3760748383-892082386-3578648945-113886<name>Unknown</originator_name>
    <result>Granted<
    <result>Denied - Unknown Card</result>
       <suite_id/>
       <user_id>S-1-5-21-3760748383-892082386-3578648945-113886</user_id>
    <first_name>Edmonton_ADUser_02</first_name>
    <last_name>Edmonton_ADUser_02<id/>
    <first_name/>
    <last_name>Unknown user</last_name>
       <card_number>3070400000467<number>23100234</card_number>
       <snapshot_url/>
       <io_control>1</io_control>
   control/>
    <sent_to_ams>false</sent_to_ams>
       <event_code>10101<code>10218</event_code>
    <controlled_area_id>a825521d-caf1-4460-b617-ded8cf7621cc</controlled_area_id>
    <controlled_area_name>Door-EG</controlled_area_name>
</activity_event>

System Events

...

TERM

DEFINITION

Access Group

Access Group is the logical grouping of users which you can assign Access Right to.

Access Right

The access right assigned to an Access Group. Access Right defines the access permission to a controlled area under a time schedule.

Administrator

An individual who is responsible for the maintenance and implementation of access control rights involving tasks such as issuing, and closing user accounts; tracking users and their respective access authorizations; and managing these functions.

CA Certificate

The certificate of a Certificate Authority which issues digital certificates.

Card

The access card issued to a user. It can be a Wiegand card or a PIV card.

Certificate

The digital certificate of an entity or User.

Controlled Area

Controlled Area is an area being controlled by one or more input or output devices such as Freedom Primis Bridge readers.

Credential

The credential information of the PIV card.

Image

The digital image of a User.

IP Address

An IP address is a unique identifier for a computer or device on an Internet protocol network.
Every computer and mobile device whether it be a laptop, tablet, smart phone, printer, modem, router, server or scanner requires an IP address to connect to the Internet. IP addresses consist of four sets of numbers from 0 to 255, separated by three dots.

PIV Card

A physical identity card, smart card issued to an individual that contains stored identity credentials such as a photograph, cryptographic keys, digitized fingerprint representation to verify the identity of the cardholder by a process or individual.

Schedule

A schedule is a given period of time that is applied to Controlled Areas and Access Groups and used to schedule device activation and alarms.

Site

A geographical grouping of controlled area(s).

User

An individual whose access privilege to controlled areas are managed by PRIMIS.

Zone Group

Zone Group is a logical grouping of Controlled Areas.

...