{"info":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","description":"

Overview

Suprema BioStar 2 API is a JSON-based API. All requests are made to endpoints beginning with https://server_ip|domain_name[:port]/api

The API can be used to perform almost any operation. Following are a few examples of what can be done with Suprema BioStar 2 API:

Manage User data
Manage Access Group data
Manage Doors data
Assign an Access Group to one or multiple User
Assign a User with one or multiple Access Group
Manage Devices
And many more...

All requests must be secure (https).

General Information

To call the API, BioStar 2 is mainly using HTTP Methods GET, POST, PUT, and DELETE.

GET is used to retrieve data from the server at the specified resource. For example, if you want to retrieve the User data with /users endpoint, then by making a GET request to the endpoint should result with the list of all available users.
POST request is used to send data to the server to create or update a resource. The data sent to the server is stored on the body of the HTTP request.
PUT is similar to POST in that it creates or updates a resource. The difference between them is that when calling the same PUT requests multiple times it will have the same result. While calling a POST request repeatedly will create the same resource multiple times.
DELETE is used to delete resources at the specified endpoint.

There are four parameter location that’s being used on Suprema BioStar 2 API:

PATH parameter is located on the URL, usually on the end of an endpoint. For example in /items/{ItemID}, the PATH parameter is ItemID.
BODY. An array of string values will be located on the BODY of the HTTP request. The request body needs to be in JSON format.
QUERY. Similar to the PATH parameter, QUERY parameter is also located on the URL, the difference is QUERY parameter will be located after a question mark. Example: /items?id=###, the QUERY parameter is id.
HEADER. Custom headers that are expected as part of the request.

Path templating refers to the usage of template expressions, delimited by curly braces ({}), to mark a section of a URL path as replaceable using path parameters. Example: https://127.0.0.1:4433/api/some_api/{id}
Above example shows that the required value will be placed on {id}

For AUTHORIZATION details please check POST Login documentation.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18574376","collectionId":"7dba1759-9dd3-4185-8d65-8e3c91373f22","publishedId":"UVsLQ69e","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-08-18T06:40:11.000Z"},"item":[{"name":"Revision Notes","item":[],"id":"bc0b9d95-ee10-496c-8c00-2a164daa924d","description":"

v2.9.12 Revisions

2026-03-11

Added Delete All Event Logs in Device

2025-09-09

Added Fetch Event Image
\n
Added Clear APB (All and Specific Users)
\n
Updated Create QR/Barcode
\n

v2.9.9 Revisons

These APIs have been added/revised, with changes effective from BioStar 2 v2.9.9. See the Changes section on each API for details.

2025-09-12

⚠️ API URL Trailing Slash No Longer Supported ⚠️

As of version 2.9.9, API endpoints will no longer accept trailing slashes (/) at the end of URLs.

🚫 Invalid:

GET {ip}/api/endpoint/

POST {ip}/api/endpoint/?param=123

✅ Valid:

GET {ip}/api/endpoint

POST {ip}/api/endpoint?param=123

This update affects all endpoint calls with a trailing slash at the end of the path. Please review your integrations and remove any trailing slashes to ensure continued functionality.

\n
This change improves consistency and aligns with stricter URL parsing behavior introduced in recent platform updates.
\n

Affected endpoints in this collection:

List All Access Group v2 POST /api/v2/access_groups/search/

Check Card Availibility GET /api/v2/cards/registered?card_id=123

2025-06-10

Updated User: Update
\n
Updated View a User's Details
\n
Updated View AD Server Setting
\n
Updated Check Active Directory Connection
\n
Updated Synchronize
\n
Added View AD User Mapping List
\n
Added View AD Column List
\n
Added View AD User Group Filter List
\n
Added Check EntraID SSO Login Setting
\n

v2.9.8 Revisons

These APIs have been added/revised, with changes effective from BioStar 2 v2.9.8. See the Changes section on each API for details.

2024-12-09

Added Create/Update User Private Message
\n
Added Delete User Private Message
\n
Added Fetch User Private Message
\n
Updated Create Custom Field(s)
\n
Updated Update Custom Field(s)
\n
Added Create New User with File Upload
\n
Updated User: Fill Custom Field
\n
Added Download File from File Upload Custom Field
\n
Updated Advanced Search
\n
Added Export User Data as CSV (File Upload Example)
\n
Added Batch Edit with Advanced Search
\n
Updated Send User Data to Device
\n
Added Delete User(s) From Device (Advanced Search)
\n
Added Delete User(s) with Advanced Search
\n
Added Export User(s) as SVG with Advanced Search
\n
Added Export User(s) as PDF with Advanced Search
\n
Updated Data File Export
\n
Updated Send Visual Face by Email
\n
Added Count Deleted CSN Mobile
\n
Added Delete CSN Mobile from Database
\n
Added View Deleted CSN Mobile
\n

2024-11-28

Added Bulk Add New User

2024-11-28

Added API example for Add Slave Device

v2.9.7 Revisons

These APIs have been revised, with changes effective from BioStar 2 v2.9.7. See the Changes section on each API for details.

2024-07-23

Updated Update an AG

2024-06-05

Added square bracket on /api/users body
\n
Added note on operators description for /api/events/search
\n
Added note on GET /api/users
\n

2024-05-20

Added Export User Data from a Device to BioStar 2
\n
Added View User Statistics in a Device
\n

v2.9.6 Revisons

These APIs have been revised, with changes effective from BioStar 2 v2.9.6. See the Changes section on each API for details.

2024-09-27

Updated User Credential: Visual Face

2024-05-02

Added User: Bulk Update

2024-03-20

Added Update Device Homescreen

2024-03-19

Added View Firmwares Information
\n
View Event Types: Add description for Query Parameter is_break_glass
\n

2024-03-18

Added Audit Category
\n
Added Audit Search
\n
Added Audit Search User
\n
Added Audit Search Operator Level
\n
Added Audit Search IP List
\n
Added Audit Search Target List
\n
Added Audit CSV Export
\n

2024-03-14

Added Advanced Search
\n
Added Clear Timed APB
\n
Added Create Multiple Trigger Actions
\n
Added Update Multiple Trigger Actions
\n
Added Delete Multiple Trigger Actions
\n
Added View Multiple Trigger Actions
\n
Added Quick Action Category
\n
Added Trigger Quick Action by ID
\n
Added View Trigger Action with Quick Action Enabled
\n
Added View All Quick Action
\n
Added View All Quick Action by Permission ID
\n
Added View Quick Action by ID
\n
Added Save/Update/Delete Quick Action
\n

2024-01-04

Added Create Mobile Access Card in Airfob Portal

2024-01-02

Added Mobile Access Category
\n
Added Delete Mobile Access Card in Airfob Portal: Card ID
\n
Added Delete Mobile Access Card in Airfob Portal: User ID
\n
Added Delete Mobile Access Card in Airfob Portal: ALL on User ID
\n

2023-08-31

Added Update Firmware
\n
Added Run in Postman button on the bottom of General Information section
\n

2023-08-04

Added List All Added Device(s) status response details
\n
Added List All Added Device(s) with Criteria status response details
\n

2023-08-03

Added Backup feature APIs

2023-06-01

Added View a Card Detail

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"87b6e8b8-8166-4e37-b22e-d87062c3a422","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"70243f93-976e-4466-94cf-e0cc876df413","type":"text/javascript","exec":[""]}}],"_postman_id":"bc0b9d95-ee10-496c-8c00-2a164daa924d"},{"name":"Authorization","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"34b8a49c-73e2-49ae-b347-a879c8fce2d5","exec":["//put response's bs-session-id value to collection variable bsid\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","if(pm.response.to.have.status(200)) {\r"," let params = pm.response.headers.get('bs-session-id');\r"," pm.collectionVariables.set(\"bsid\", params);\r","}"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"packages":{},"type":"text/javascript"}}],"id":"0b54ae8b-6744-44dd-8556-8001ae3139ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"login_id\": \"admin\",\r\n \"password\": \"your-password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/login","description":"

In order to use Suprema BioStar 2 API, you will need a Session ID which will be available after you’re logged in.

To log in, make a form encoded server side POST request as shown on example below.

POST /api/login

Host: server_ip|domain_name[:port]

{“User”: {“login_id”: “user_login_id_here”, “password”: “password_here”}}

The parameters are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
login_id	String	Y	Your login ID
password	String	Y	Your password

If successful, you will receive back the following response:

Status: 200 OK\nbs-session-id: c52127fea7f645149083d04d89ad68e5\nContent-Type: application/json;charset=UTF-8\n{\n  \"User\": {\n    \"user_id\": \"1\",\n    \"name\": \"Administrator\",\n    \"gender\": \"1\",\n    \"email\": \"admin111@gmail.com\",\n    \"birthday\": \"1977-10-08T04:00:00.00Z\",\n    \"photo_exists\": \"false\",\n    \"pin_exists\": \"false\",\n    \"login_id\": \"admin\",\n    \"password_exists\": \"true\",\n    \"updated_count\": \"15\",\n    \"last_modified\": \"946\",\n    \"idx_last_modified\": \"263\",\n    \"start_datetime\": \"2001-01-01T00:00:00.00Z\",\n    \"expiry_datetime\": \"2030-12-31T23:59:00.00Z\",\n    \"security_level\": \"0\",\n    \"display_duration\": \"20\",\n    \"display_count\": \"3\",\n    \"permission\": {\n      \"id\": \"1\",\n      \"name\": \"Administrator\",\n      \"description\": \"this is a permission for Administrator\",\n      \"filter\": {\n        \"UserGroup\": [\n          \"1\"\n        ],\n        \"DeviceGroup\": [\n          \"1\"\n        ],\n        \"DoorGroup\": [\n          \"1\"\n        ],\n        \"ElevatorGroup\": [\n          \"1\"\n        ],\n        \"ZoneType\": [\n          \"-1\"\n        ],\n        \"AccessGroup\": [\n          \"0\"\n        ],\n        \"GraphicMapGroup\": [\n          \"1\"\n        ]\n      },\n      \"module\": {\n        \"Dashboard\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"User\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"Device\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"Door\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"Elevator\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"Zone\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"AccessControl\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"Monitoring\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"TA\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"Setting\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"Video\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        },\n        \"Visitor\": {\n          \"read\": \"true\",\n          \"write\": \"true\"\n        }\n      },\n      \"device\": {\n        \"id\": \"939257394\"\n      },\n      \"user\": {\n        \"id\": \"33\"\n      }\n    },\n    \"inherited\": \"false\",\n    \"user_group_id\": {\n      \"id\": \"1\",\n      \"name\": \"All Users\"\n    },\n    \"disabled\": \"false\",\n    \"expired\": \"false\",\n    \"department\": \"department 12\",\n    \"user_title\": \"title\",\n    \"idx_user_id\": \"1001\",\n    \"idx_user_id_num\": \"1001\",\n    \"idx_name\": \"2001\",\n    \"idx_phone\": \"1001\",\n    \"idx_email\": \"5001\",\n    \"fingerprint_template_count\": \"0\",\n    \"face_count\": \"0\",\n    \"card_count\": \"0\",\n    \"access_groups\": [\n      {\n        \"id\": \"1\",\n        \"name\": \"Meeting Room 1 AG\"\n      },\n      {\n        \"id\": \"2\",\n        \"name\": \"Meeting Room 2 AG\"\n      },\n      {\n        \"id\": \"22\",\n        \"name\": \"Building Access\"\n      }\n    ],\n    \"user_custom_fields\": [\n      {\n        \"user_id\": {\n          \"user_id\": \"1\",\n          \"name\": \"Administrator\"\n        },\n        \"custom_field\": {\n          \"id\": \"1\",\n          \"name\": \"Test\",\n          \"type\": \"0\",\n          \"order\": \"1\"\n        }\n      },\n      {\n        \"user_id\": {\n          \"user_id\": \"1\",\n          \"name\": \"Administrator\"\n        },\n        \"custom_field\": {\n          \"id\": \"2\",\n          \"name\": \"33\",\n          \"type\": \"0\",\n          \"order\": \"2\"\n        }\n      }\n    ],\n    \"need_to_update_pw\": \"false\"\n  },\n  \"Response\": {\n    \"code\": \"0\",\n    \"link\": \"https://support.supremainc.com/en/support/home\",\n    \"message\": \"Success\"\n  }\n}\n\n

There will be a key called bs-session-id, which is a consecutive strings of hex digits located on the header of the response:
bs-session-id: 643f64efb7114485a2fd89de17ca13fb

This value will be used as authorization of the APIs that will be called. To apply this value, put it on the header of the API that will be called with key name bs-session-id.

Response Properties:

Parameter	Type	Description
user_id	Number / Alphanumeric	Unique identifier for the user.
name	String	User's full name.
gender	Character	(Deprecated) Previously indicated gender: N = Not set, M = Male, W = Female. No longer used in the user module.
birthday	ISO Date	User’s date of birth in ISO format.
photo	Base64 String	User’s profile picture in Base64 format.
photo_exists	Boolean	Indicates whether the user has a profile picture (`true` = has a photo, `false` = no photo).
pin	Base64 String	User’s encrypted PIN code.
pin_exists	Boolean	Indicates whether the user has set a PIN (`true` = PIN set, `false` = no PIN).
login_id	String	User’s login identifier.
password_exists	Boolean	Indicates whether the user has set a password (`true` = password set, `false` = no password).
updated_count	Number	Number of times the user’s data has been updated.
last_modified	Number	Timestamp of the last data modification.
idx_last_modified	Number	Internal tracking number for the last modification when personal data is encrypted.
start_datetime	ISO Date	Date and time when the user’s access period started.
expiry_datetime	ISO Date	Date and time when the user’s access will expire.
security_level	Number	User’s security clearance level.
display_duration	Boolean	Indicates whether the screen display period is enabled.
display_count	Boolean	Indicates whether screen display count is enabled.
permission	Object	Defines the user’s operator-level permissions.
inherited	Boolean	Indicates whether the user inherits properties from a user group (`true` = inherits, `false` = does not inherit).
user_group_id	Object	The user group to which the user belongs.
disabled	Boolean	Indicates whether the user’s account is disabled (`true` = disabled, `false` = active).
expired	Boolean	Indicates whether the user’s account has expired (`true` = expired, `false` = active).
idx_user_id	Number	Internal tracking number for the user ID in decrypted memory.
idx_user_id_num	Number	Internal tracking number for user ID when alphanumeric mode is activated in decrypted memory.
idx_name	Number	Internal tracking number for the user’s name in decrypted memory.
idx_phone	Number	Internal tracking number for the user’s phone number in decrypted memory.
idx_email	Number	Internal tracking number for the user’s email address in decrypted memory.
fingerprint_login	Boolean	Indicates whether the user can log in using a fingerprint.
fingerprint_template_count	Number	Number of registered fingerprints for the user.
face_count	Number	Number of registered facial recognition templates for the user.
visual_face_count	Number	Number of registered visual facial recognition templates.
card_count	Number	Number of assigned access cards for the user.
qr_count	Number	Number of assigned QR code credentials.
mobile_count	Number	Number of assigned mobile access cards.
need_to_update_pw	Boolean	Indicates whether the user is required to update their password (true = password update required).
version.dbBiostarVersion	String	Installed version of the BioStar 2 database.
version.biostarVersion	String	Installed build number of the CGI server.
isMatchVersion	Boolean	Indicates whether `dbBiostarVersion` and `biostarVersion` have the same prefix (`true` = versions match). Example: `2.9.8.30` and `2.9.8.42` would return `true`.
notiPopupOpen	Boolean	The inverse of `isMatchVersion`. (`true` = versions do not match).

","urlObject":{"path":["api","login"],"host":["https://127.0.0.1"],"query":[],"variable":[]}},"response":[{"id":"fb0ee427-4411-498b-8bc6-4e90136346e3","name":"Login Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"login_id\": \"admin\",\r\n \"password\": \"your-password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"bs-session-id","value":"435564a0e0d2443fa2d8f86d5bb40622"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"24631"},{"key":"Date","value":"Tue, 21 Jan 2025 01:53:26 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"User\": {\n \"user_id\": \"1\",\n \"name\": \"Administrator\",\n \"gender\": \"1\",\n \"birthday\": \"1977-10-08T04:00:00.00Z\",\n \"photo\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr/wAARCACgAJYDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDQNowXyyMg9u38s0+NEThwAfvcnqa9A+KngPwD4M8Rf2R4M+J+neKbM2yP/aNjYz2wWQj5oykyqeCDgjIIIPBJUcm9tp4PLgHOcAj5q/OqWOTlb+v+CfYzwztcpRupbcgOf9odquwHgqGA3dDzUeLJRkXCrjg4+vpUbXVrG2VucYyOWHHr26V6FOs2ckqKNS3uQRuVcZHT+X+fer1pdIT5hzktg8df8/hWC2q2iPzKCB6d/wDPNSwa9boPlcnngZrqjJM55U9DqI7iMYcLkDknbmpobhcADjBOMnJHt+tc1Brrn5vMBU9B6e5qZNfG4+ZMDjv3I/KteUwcGdStx12rkY4C9jUsF+uAmMZzn0+tcyniSGP5mfg/dGeBz2zUyeJLSdA4I2+mRz3696LPoQ4s6cXasmyQHJPUHipIrzZ1kVSPRug/z2rmW1y1mBi8xWK/xY46/jT7aeW4Zdinp1Iq02jNwZ1cN5Gy5jnHOOo+lWxqCMoUT47uT1/+tXN2dleXMmxImAH8/wD6/wDhW7p3h13XZcY3cZGK2hJszdkW7cCYDMwxnOM/eHpVyGBCxIlIPfac9f8AP86S08Lyyn5ZwAOmfyrYsfCaj5nuHJK/Lge3+fzrVXZFynZ2MbAR/N6qB/n2/wD1Vk/GSzSx8IWmJGXzb4DHqAjc/Tn9RXrXjfwZ8KPBEFnd+E/iimuQ+Szahcz6S9hHbMMYGZSd2fmOcAAL1OcDyH9pjxj4PtfBFjqtv4hhuLS38y6uZLZvM2RBcbtqAkgfNzjsfQ1hjHH6nJrsbYXXExR5irBG5BzjuuaK5/wd8Q/DnjzTn1Xw3PLLDHM8XmTW7RklWKnhsHqCPw4or5Rxaep9ImraHxp4x8L/ABj/AGQvj9J+zP8AEL4gT61F/ZaajoWvJcTJLc27M+BMHkbDKUdOCfujnnj0PwF448e65rVl4d0G61DU7y9nS2sbCBWnluZWYKkaIMl2YkAKASSQBXBft1/s+fHz4E/H+6/aC+NvjSDxJZ+JWFlp/iS1hW3yY41CpPDGFSE7FGMAqSCc5PPC+FfiNrjXSzWlvdQSRFHhuEO3nOQVIOQQR/KvpMurKvhIyupO29up42YUpUcS0rpH2lp/jfxL4N1qTwr8QfC82mana7BcafrGnNBPGGRXXfHIoZcqysMjkEEZBFd5pvxQ0WeNWfQNNbp1tIz/ADFfFWs/G34meM/EE/ivxp4j1TWNUuSoudS1W/e4nl2qEXdJIxZsKqqMngKAOBVaf47+MdKicwxTyhD92NwenXoeD0r1qVaKgueKv1ttc8ycJuWkmfbmt/EjQjCdum6ajHp/okfT8q898V/EyOOQm1SFAOuyIL/LrXy5oH7Xvi/RvEen63ffD241eGxvYp5NM1CJzbXao4YwyiORWMbAbWCspwTgg80njX9pzUvGfiy81zTfg+/h22uZQ0WlaUZ3trYYAwhuJpZCCQWOXIyxxgYUVOom7coQjJK7ke7Xvxb1FHIS4YEnAxJx/nNaqaz8YLD4fx/FaTwVq48LzX/2KLxDJp8v2Jrjk+SJyNm/5W+XOflb0OPnCx+IOp37+WbOZGK7jG7LkD1xnIro1+I3xHbwk/gSLxHqi6DJei8k0VdRcWjXIXYJjFnZ5m35d2M44ziuSpWcWuW3/AOqMbrU9IvfjXrjA7LsA/7J6fzrndZ+KOrXsTrPrlwQwJwtwRkenBrg5ptWkB+THH94cVWlt9Wf78IPH9/oKynidDSFJ3Od1P4n/Ef9lv4k6V8bPhL4g1q5sjqEaaz4cu9duJbe+JY7UKOWJBJI4PBAwOx/XH4PeJvEfjT4ZaH4s8W+GJNE1HUdOhuL7SpVANpIyglOp6H3r8jfiFFqVp4RvNRlv0077Kn2iC+Vdxt5IyHRgB3DKK/SH/gnpfftUa78AbXxT+1h4mi1HWNXmW50yP7NDHLb2ZRdnmGLCuW+8OAQDg5PNVh5qrF2M8VBxsz6DsmXcFKkjPHHBFbOn2Qu3DCBCAOvfHr/AJ9awYWjDjO0sOR6V1nhWTGXwcbRznGa9CKbR571NAWem+HtHu/EOsl4bKxtnuLqRYmdkjRSzHaoJPGeACa8M8TftDeG/j/8Ntc0r4ZePJbfzCx0660/Q7pLmMhmVVIIaKUuxUKRKBuALBcFV+j5bBNY0i40prh4xNEyiRJHXaSOPuspPXpnnFfMUf7CfxD8C+OdZ8TT/EfwNPaawfLsl1jQ2tJ3gD+dJulgJLuCAG+Xy2VAXBOCtSjU0sRJpHiV9+x58bviz4gk0b4ufGLVr3w5oekQXN5FLrAt7ezQswD3KrI0UakAt5iqNwz8oNWfhw8lnd6z4X0vxrput6DpUqQaJPpMSCEwZkw4w7s4ZAjbnO7nGTjJof8ABTnx34++F1ovwM8DPruvaj4ltNIfVLazijtp9SeHzYEhttkpE658svGgcB3yqfMFXD/ZW8F/8K++H17oF78Ptb8O3serzC9tNfJW4lYcBmjaKMxuoGxh8wLIWBAO0eXmsHDCysu1/v2OvLmpY1L1/I9FtbPTNIt/s+m6fFbxk5CQoFX8hRQ7hznnHsMYor5Zq7Ppz1b9rzwD8J/HH7OviTw78VPBuueItBaKOXUdO8O/NdhY5FcTKvmJv8tlDlc5IXADHAr8dPhbIttrep+Dbe7mv7OwJksdSnzvkiLEKGQltjYwSu5tp4BOMn9uZtWf5kS4dCQV3xnBTI6j35z+Ffj78ZPh5Zfs6/tla78GvD/xDXxdaalEb+9vprQpdWt1IWkeOVl3B25yTx98ZC1tkUJ0G4t7lZq41aV7al23hTbtZSCB0o8D/Cnxx4q8USaJ8PtCu9Z1fU793sNN0/T5bmWVmQDYI4wWfp0HPNfUf/BNb9hG0/bG8calqnjDUXtfDPhsxfb1h4e7lcsUi3Z+RTtO4jnkY65H6zfBX4CL8JvCjeEvgv4F0bQ7KK9intTaRRB4pItxWUOYizPuwCzliw3A8Ngfc4XLK1amqr0i9j4rFZlRoVHSWskfhD4u+D/7V3wgl+wfEr4VX3huTyhJ5XiHwndWjeWSyhgJgCAWVgD0yD6VhGX4neUDCdGbHUm3cE/k9f0SeNvhZ8WPFulOmsaiLzUJo3LajdywsULEBVC+SVCLguFC4DEgqwOa8D+NP/BKr4bfGnwHqi6j8L9OtPGWoQEWvjzR75rf7HcrsZXmt4lWGYPsKMrR52udrq2GGtXLayV4NN/11FSzSi2lNM/EWw8JeILrx1P4y8SmzVpLFLcxWoONysTu5+tX7nxp8P8ATZntrvxnpcMiOVeOXUI1ZT6EFuPpXbfFP4beNfgx8SNd+EvxAs/s+raBqMlpdgK4SRlPyyxl1VmjddroxUbkdWxzXnH/AASk+GP7F/jf/gov8QvBX7Ztt4QudO1TT7iPwnF4xeJLU6srJKsTSTgRRF4hJtaR1V22xrukdVrxYUnWrOFSXK0etVrRo0VOKuixdfE34ZxBmb4h6JgfezqsX6/NVK6+Mfwstsib4jaEnAwX1SEZ/Nq+zv8AgqJ8Ff8AgmV+xlfv+zrq/wCxLoXhPxJrPgK41rwr8QrbwlY3luurQXLGDTpYpbUqUmMJjkfaxRbmHcqK5mi848T/ALP/AOyv+2D/AMEhfH37Zfwr/Yi+H/hLU9F8I6wNVlsdLmhNhqdiiO9xpznGYHjw4UlvKZjDvkaN2O6y2FTESoKTclq9Dk/tVRipcuj8z5M+If7Rngn4d+J/Cer6t4SbxTo8moR6hJbW2oLFb3qRPuWMyhHBXeFJ4wQuO9fsv8Ndci8WfD3RPFFrpcNnHqWl29yltazCVIFkjDBFdQAQAcZAA4r8cPgd8C7b4vfsNaY0d95F3DYb9PLShE8yN2c722sQMdgO4r9Lv+CU37RfxJ/ao+Bwn8b/AA9tNNh8Ow22n2ut2er28qag6RhW3QRtut3ACnaV24YYNGDpRi3TR0Y27gps+kdL0R7iNXKgnHftzVT4m/EXxB8H/D9zqmi/C3WfEtwLdXs7fS7V5jcyliPJAQHYe5d8KM8kDmu10LSlhby5yM56gZ79K66y0+WfSzZWOoG0lcENN5aszKRggbgdp564OMdK9mNC6PIlVsfLvjL9vn43eENe0PTtC/Yb1uK3u4ydYvPHfiay0C3jIiB8uCWSR/NlLNgR4DHHHJGZfhJ+0L/wUN1P4g3+seIv2a9M8NeG7W+gj1XQ9e8d2Vzc6er24y8c10Y90TOV+UhME48wgiuB/aq/4JMftPftW/F211Dxr+1ZPb+GIiv9n2i2DXVwirsMvMbRIm45GSMBQOASRX0T+zZ/wS3sfh/pmgXeqa/JHqnhC++0+HJba+k2AOiLIk+Rhg3l9ECoVbaQeSHGhVcrdO+n+RyzrtvQ4v4O+BPhd47/AG+Z/iLHqnxG1LX/AA3ZLca5PNoMb6dBPLvRYYljjAgiVBu3I0m/g7iNzG1/wUj+y/8AC/rO1sfLYJ4dt2fYMZZnlJLe/wBea+tPCmg6d4k8d2EX9iwaJ4ouNDuf+Eyg08sMqQscJO7Hmxh1cwysOiPtAywr4s/artr+X446lot38Rn8VSaPbW+n/wBpNbwR7dkYzF+4jjRtpJBIGc5BJINcmc0fZ4Dl7tHbk03LG3fRP9Dx8wynouPX0orbm0VWkwOSByAMUV8eqUlofXKpF9SfVP2sfhr4e8d6P8O7i9vr/U9alxbppunSzpGoXJZ2RSOhHyjLfMOMHNfCX7cHgjxL8Gf20dV+KHxJjjurHx1arJoWqWkLgQBAkZgcEDDhVQnvyPevqDQP2O9Q+BeiH4rWs2keOPJ8S3Gn6ZJBaW9vd6QMsVjkZ5GDeWIyvmxYJ/iDHmt79oD4CX/x3+Es3g34l+CNTa3ijS7sb6OEma0ftLEX24yCRkkBgeeOnqRwNXC1mkjz6eL+sUb1Gl5djK/4I2/t9/BL9mD4ia/4O+O9pM/hbxhDA8GqQiYf2fewFthcIwJhdXYMwDlWROApdh+u/hT4ofCfxtBFrnwO12G90uKNVmuLLUVuoXdlEilXVmByrqfvYwRwOc/hl8Rv+Caet6Z8UdGtPh18VdMufh6lta3fmeKtRtLPU9MnKETW3neaItu4EhyvCuMgkEtu/HL9pL4ef8EsPgRqviT4I+KNcuPEuoa0sWl6j4S+JaX9pFfGEOkt7FbStZyouwKUe3/eqpTKn5l+lwGIr4dqnVT5dert/kz53HYSlilzUmuZ+Wv37o/d228caY2pr4Yk8RW0Or/ZvtEFi1yonaLON+zO7bnjOK5z4jfHOP4OfD/UfG3xU1zR9F0qxj8+/vbm/bbwGIVV2ku5OwBRlmLYAJwD+Ev7Lv8AwVn/AG/f2lNDg8fSftT6kfEehEpMlx4e0i1t/skwJkKyJFsYAIAqursMFiVxXG/tu/FD9pHXvEHhbU7740p4otNSvJbSTS/EfjOfWL3TJljEssylYobeOKRNu1Fy42jdkFTSxOc4ahKUIpOS7tfpf7tx4fIsXUhGbbUXo7J/r08zvv2wPjTbftOftHeMPjhpGlfZItdvVbT7ec7T5UMMcEJkxu2syRIzYyAWOMgc/O3/AATM/Z+/Zk/aK/4KSeLfhJ+29a2uiaP8QfCV5pPh1LrxFJZXNh4iMlr9lktrkL5P2jZHOYfODQys6xFJTKkb+YeOf2o/i5pnxS8PeG/D2nWVvpsmmwPegRgNc5JdpH3s21tvUJhflGADknif2hL6fXPjjcSx27p9oS1wHPySHygfMAxgfe2nr9zrwAPnHiatKp9YaTUtWns77+h62MpwhQ9jB25dD3T/AIKm+I/jh8Dp7H/gl7+0L8R5vGWqfs/+Jb6Dwp42iuObnw9qljplxaWJgePfG0CRxspeeRYRcPApeK3iNfpfeeIPidqv/BGv4lfBy+/Z1+HHwo0PwX+zjqE+vfD/AMK/EV7vxDorXGmXF3Eb3TriylNh9uAkuQs11LchbgtIzzCSvwr+IX7QXxn/AGifHGrfHj4w+NU1rxQqaTper67rV5bHVL429mLW0cx5824K29kqyXSqxZlRp5DJMhkqz/G/xh8LvBWuab4J8caho+o+JdGl0jVRpl60ZvNOuPluLaUKRvhkRdrKRgkLxkDHdQxlXCY/SDcZ2W6uo/d0Vtb7I8OVBVIxj1Tufc3/AATw0iFf2RT4ktzFa6cJJJUjILtEQpUl5CfnOyOPoFHy8AV6N/wb2/tU+BNZ+PfxE+BKC/hXxXqbX3hsLvkgkeEHzC3ynYzJhgxbGABgEc/KHwF/aO+InwK/ZL0/wK/hJfs2pRyNbhFNxNK7MSCVQhUj2Hq7Lj1NfdX/AAbqfAe1Pirxv+1Tr3guCH90mm6BdtAAXeQl51R9+PlURhjtYHONwIIrqwtJKqku/wCB7GJqL6u77W/E/UrTfDexBJKxG5uoBBxmt6wh03TYPtEglYLwBFEXYd/uqCSa4XWfG15NvFxqSW0KtxGpxz68HPpXJeNvi8nw28OXvxAufiLpmlaRo9hNc6td6los160aqNwZBHPHgAA5XaxJIxjv9FTjGx89Jyse8+Dfi58HLvxbF8PH8f6VbeJJIPOi8M6jdLa6iYzyH+zS7ZdpH8WzHevyK/4LZ/8ABYHwZ+0xrk37FnwE8eT2Hhzw/wCIAfE/i3SNZvrW31SRPMiksnRIFNxAhyzbGdHwpXJGK5D/AIKEf8FgvgD8fvgRe6P4Q/ZntPG72mo/Zh4q8W6Da6bbwylCQ8NvDNJfM4BBH7yFSfvq4G0/ll4h1zUL7ToobTUrpRdYka1FyZBz7HJUnHTGR+leJmmNco+yoS3+0vy2t80y8PTqKXO9Leh+z/7D3/BbD4WfsU/DHw98LvF48Uat4cuLC6s9G8Q29qZorDdNGzLF5s7SSrHmYAOELFI8fKxYet/Ef9oT4K/Fj4pax4w+Cmty6h4XvPIbSL1rKSIzoIE3SFZFVgWk3k5AyWJr8MvCHxk8LeGPDV/Yavo80d3cRxRmKPZ5E8iBh5hhZNqMATggg5/MfZ37L/7dHwLg1DQ/g5e3er2uoXEcFtHfXFrEto85UAJuSRmGW+XlQM/nXg4/HYudBUkrxTvtrpp3/rue1lypyxkqs9G1byPup/FdhOMLaS4B42gE0Vz+m2Ut6Rb26sfk39cccDvRXkRnVkr2PonCnF2Phrwr/wAFx/24NMeW08N6N4Sh+0zBrhrm0uG8wkBQWaOZGOBx17960f2qf+CmX7Yd/wCGNGl8W+MIg+oWSGzi0aS4SNZSxHlgPMxwMBuuTu696+JdN1S7tZIpLdd2HAk29RzXsHwcsvFn7VXx20HwfpqG4tPDdvttgsRYLcMcljgEnbjOMdIvevqMRWhTwkm1rokeLhKEq2LSvotWfUXwb8X+Ofj34WvPAuueO7vxdfmFbTXbTW9YvUjdjGGdFO7btVCMjA4OAT0rzb4hftdv8M/gt8Sv2dPhdpXhuytbuzGj3EDafAE1cljC/wA0675kiO8knALR7uTg07/glX4r1y0+FPjnxdbGOTXbk6lLp80mdi3rxJ5bdDgBmzzxgda+X7LTRrt54i1+aFriWwZfsqsThUGSRjZJ/CpH3WI7DOCPBlia0Hbmd4vv6f16H0Cw9F3fKrNdl/Wn5n1F+wZ4++A37Pfxt+FEviP4paFHomm2d5eeJA04VLe8/drCrvyGJRTjbnBZ8/eGfPvi98Vvhp4z0/WX+JUt74o1LVfHOr6uG8P+KoreKLzPL8vcWEm+PBKouR8qY9qzvgv4XsvHPxD0v4da74j/ALLsdU1ttNa8ZIWFqjiNhIFdIlIQNnDyqDyGkI4X1zT/ANkKSPxZrXgee7h1i5s7aefS722urdrieKORInMsEdziBwyyMAvmblwyblYbc6M67muRJtt9nd2d9PQdWNBwam7Ky7qyuuv/AAT5x+JXibw9ovxM0jx14HnjnvtJ+w3NnqCLC7RSx4ZlyTg7WB4PoK5v4u6tqvjj4i2/ifRNStoJrlgkNvEmLdFGWKkJvKHJdxj5QCQAq4C/Q3ij4LQeBPEmt6Hr2lQgaQbnLuyO7+SCWyiSkDA2/dZj1+90Ph3xIvLGfwvquu6dNFBJbQNcwxxMVVWVSoUdTjD4weoHJzzUzxdek6dCcetv01PHzOnhE/aRk+aWvkeXeLPBOreD/DUXjm38UacIL+MW2p6Xp5ukuYo5nMwMw2RpL5cgTjzWy6RDBVSa0vFf7Kv9jeZe2Hx78IahHKiXFir22rW1xd28qCWGbZNYqF3xsjjLchhgkEE+7fBb4XeIvi14T/4V38LfgldeKbl5YrDXdY8u4a3VrtzHEHeN1S23ljGGkYKBFwc7mrmfhR8HPiB8LviRffsyfGlLnQdQhtTqPhqS5tlK6nbtNsb7O4YCRdwmOUZ1DRTqxXynK+rRzDEzwcp06abj5NJr1fVddTko0cO5RTbd+1tH21NQfEjTbX9nm08C6Dr32e/nMaajZyXKYDKqxsysWHyMFyOjeqiv0v8A2Mv21f8Agm/+xn+zzpPhvwZ8ftSv7m8tftWpWWq310729y+S8a2yBoYcEkfuxlsZLNxXw9qPw1stAe0htlDxRtIsglJV5EQbfmIZtx3Dnbt65BIGTsL4SsDMTD4D0vYLhgEM10W+WPcVyz9E6jPJP3mYVwQznF4abapxvp3PdqZThcTTinOX4H1v8TP+Cz3wF1Oyv7jwr48e4migd7Kwg0e7zcyAHYhZogoycckgc9RX5w/Er9qn9u74zX9/rOt/EfUwL9pAth/ad7FEsTE4iWKECILg49++TXq/irwSU8PySaV4GtEmMMaiSGzYsh3DgiZgMt949+49KfLeaXpoP2zRrMLhpPPks12lCeTguB82OcgZAHTFZ1OIMdWVmo9e/T5oqlkeBp7OX4f5HyZH8KfGGnyPc60tnbs6Hb9sS4AVvfEJzWf49+B3xZ8PfDq4+LU3hSG88Nx3UFvPrulXQuYdPnl8zyYJxE5+yvJ5UxRZ0RpBGxUMAce46l4n3ak2o2s21ZddinAihBQK8Yz8sd2ABjkfKwzzsk/1lcn8YNTvbSw8Z+E9Oe3jttT8NwNcwRptR5Fms7jIA6YYMR6Z4wDWmX5vWrYuMKsVZ9e39fiLGZNhIYeU6d+Zd9bngOi6xrWq6pZ2MMMTyyzpEmV+8WIA4Bx1NftTD+zV8LviH4R0ix8deDrO6ewWCeyuBEBLbum1htcfMvI5GcEdq/Hz9nrwPqmu/HHwjpJtkaOTxPYJOwuEwga4Qc5P6d6/d3SbJbeCOGTkKuBz04r0M2UIOEYabnj5dTVpOSPQP2bvA8PjHxzc6T9nLpDo7yKCucYliX29aK9F/YU0RZfF+vajsLNDpsUYwOcPJn/2mKK6sswkJYRSkt7mWPxEo4lpPsfzv+Pv2a/2ofgh8VtY+GMXwx17Xv7I1CSGDVNO0Se5ttQgJzHPHJGrAq6FWA3Eru2kAggdZ8Ll/az+CXhe8vfhl8EPH2leJbiR3fUk8IXTKqMuCPmTk7dwxz1PuK/W3w/+wv4sWOKbxh8T9LtWkw0i6fA0+Fzwd0rQ7s47Z4wea3L79mvwP4Kt1ll1C/1K5ZXTyIb2LfgDPmGMouExtbBcfKQc9BXJic1yWo0nO9n0T/4COjC4TNqKbUbJ92v+Cz8yP+Cbfhj4s6r8K9Z8K+ANRt7DVBrOy8k1CyWTyYsxibCOCBJsDbdwIBxxXl37OOhS+LPHN14bS3EzXWqRReUF4clZBj/VyEdccI59jX6y/Dj9lz4UfAS9vrr4P+BYNGvdVuvN1K7vby8ncs4xM2w3AUE5yAmADxjoRZ0/9mX9mnw3KzeAPgZ4Rt70SLJFBaaQsV7IABkhmYNv4YrlsHODjlq8SeKw8nzJO7ld+mll+DPbvVSs9lFL563/AEPyp8PrJ4W+IMkjyzKllrvmRO8e3OyDqGLMOeMMUwCfuZ+Y/TfwTi+LPgn4neJPipomi6peWuv6bqyaTPbBZ0t/3gMqMXtGRwVcEbI7dixyGjOK+09F8B3Wk6hHPpHh/T7QxSeevh+TSkEscIlCCfIBwNrbi5HDLgB8k11Gq+FtRm1NpFTEk9wIWjhsxKANgbdGk8aFQFJJKbjkEfwms4YiNCpzx3W3kE26sORrTqfKGt/Bzx78TfGer+K9T0TVLeXVn1a4llhtdP2Ykto5AEH2eJXBIbG3ZuZSItj5Y/L37RP7C2paz4v1A/DW40K00y7DefaahrRjuJgxDNuggg8q32ybwqxuVMYTAHIP6I+LvFmn+HNau/Dd1a28swuwy+XaI22YjhlBGEk5IbGDnjOTXmurJ4M17V7KDTfBsM17fSM0duu0NOPmDsD8u3a64YHIAyxOFyeXE5vPEVkoR6+ut1t1B5XSnQXtfl0sbX/BOP4VW/wl/Zmg8JPpMcd1b+JdPuNanth4fuYpZmuNk0inU2jkjT7Mluh2gqzwu1wwikCj50/4Kqfswal4s+Hei/tO/DZok8QfDHT5rw3dyvh2KO8ghv5ZJIX+yyjz3jjAnSJt7FBOqRtE6Mv2r8Lvhj4j8BRRT65/YWhWUsVndDSZpop5kW4jLxuy2yTRRuu9VZGZG3SkLvKSbdrw5qngyPTbqGSHXpraeymaKOPS4pJYpDvHkrukDOBIxIMrZG456DPuLO61OhCKhe2mrt/wP1PNWXUk5JS0+8/PH4X2uoftL/CSz+NXw/0lpdPukvftFvFPYSPY3SujNbSLHEj+Z83yqUVpAQ0SBOK7W2/Z4+KHnyQnw+0bfb5Y45StkwZPs3mAhwuwIefnGI9w2j95WD8L5rL/AIJpft3SfssDwje/8Kg+MF3bah4GbWb2+f8AsnVxH5LW8bmEJJ5k5jhZSsjrC9g8kxKPv/R7QLi68L3TaZ8XPhr4o062iXzY/wCzdPWW5AXDD5J2tFZMjactnb0PauPGuFOsnGLcZWaeu3Z6WTvpuduGrVJ07NpSWj2/zPzi1f4Pa3JZRy60NPsi6acfPmvLKHyvPjPMjErsCkfNv4TjzACQx5Dxr4GudF8K3euf2zpjRrp5nMdvqVuzt+/8rZsSTzC+cttALhfnxtwa/TjS/i7od/4SiTx34W1iDV2gANnqFha3MO/IDmOWGZ9yliuQ6jZvBAAA3dN4u8B+Fr65l8PXukaDeBmSJra6s/OS+THzAgRLJMvzK29F2rsZSRgivMjWw9S6itbPrrr5Wud/PWptOW39db2PxS+H/hvVPG9/e2+nwqhtLBb5jcTvCRGkBZgPtOwMccbFO8k9A3ynhbHwDrXxe/aKsfh5olq9xd+I9Phsba1jXOZWjjUEcc/d/Sv21tP2ZPgz4W1S91PwP4B0LQ57+3ew1S/0Oxjs2vYJsD7PuXazIQVj2eY28EAg4Irivh9+xV+yL8F/jJpnx3034dWej+MNAu1bQr1dUuZE80lk5szcFXQBjuYxx4zxhl3VvgsRhMPXhKd/P002+5k4idWrRkordaeuu58e/Bz/AIIdfFv4E+K7L41ajdanNDpWowXeoW11axpH5Syh9wIbIIIB79DxzX2LpYBUBcgDGMV7x8Qf2ofGPjT4ean8Lde8Dabpk2qQmFtbiimgikXfjKW58xwPl67juyDgZArw/S/Cuux3LW+nr9uETKJTDEytEGICFwRxu9ATzkDJBr6bOM2ybF14PDS0S637+Z83leCzKhRl9YWt+lj6T/YR0l1tfEeqYwHe3iDjuQHJ7f7QorX/AGL9d8N+Efhxqa+LtYtNPuZNbdWhvLpImG2NBjDEd80V7GAdJYSNpL7zy8ZGq8TL3X9x5LrWjJDaalefaUub6WxFzLG0rRqCAGWQl2ViGK7WOc84JAo0Lx14E160i0HxV4n/AOEhvWEtzHpVjpDSNJ+5P3ZLiGQhQHG5kUPsJHU5rLm1TWWF/wDbrYyHUI5JLi6mtmt4okCnEMqwhtwCuQBIQec+tQeMR40niPiLwdcjRJ4CC9zaxpc3U5bK/u2kKx/MNgzLtPXLKFyfyb2eyP0DmMTRvBOoT/EHUNR1jxJdCwtLMIfDGnQ2plscMXSOUW0WW+VopFERHJ25cdd2RLPToxHfvo1pcXhK3sxijRXjBbKZw7N/DkFmPP8ACeBFPe+I9U8H28ni/wCI7ldMvkubibXtDgvHuZkaO4Rolhds7WDY2sXRlG0jaDWV8QodCF1YeIPD+tGCTUEuLpYrXQGF3M5j+SSNwmYZBvI3SYB8wBuNytrzWsjJrdnSXPg+Xw5Z3M9x9sFlLcxpbjRo1iDRsQAzKu4yD5vmZjwATtVQWOfpsWk60k9gbuyuF0ZgLK6MBSRZGbMgDRDMbbNq4XazhiCD96sktrWl2T+KPEOlX+kaPbxK6rcXk8TxzFhkmFGxK7SBAA5P8JQZZt2JY6J431PRJdV+EaM4nnZNV/ta7nTy5WQfOqhZstyv8JXBPJwVqXXe2oKnDm6I8S+Pfi7UtO+MWqHQLyKSxiNvIFd5WkhZIV3qRMN6sHVuGGcYGMACuS+Ef7TmpfCjxL/wky6dJdzm0SEpCQpWP7T5pVZCrG3kEixTLKoYgw7CrxyuteqfET9krXPENtE3iXX59D1W7t3R71JVmt0cA7BtaCEsoIJCqiHBOc5DDzqD/gnd8YNG0OP/AITr43aPBqNxJny9N0CV4kTcQmA0wYAgcswVQRjJ5Nb4eth4vmejXk/0uZVqeIasndPzPqLw746Xxp4F03WfDOso1trVpbyJlt9ijRmN38ydVVyS0ZRlMC/vHfIUgBodH1zT7+Q/8Ih5WpMrJBLb2sU729ncIqszvLOg2F32udxAB5CR421lfBLw9cfDD4Q+EP2bfiT4m8F/2/bXN1/whVjqSPpFxrNobxrq4uF3zXP2yeJrxsRQIHVY4i4jVzNXy3+3Z8ctU+Amp/2fo2rG3tJBOk9na6bbtE6zSs7+akp+cM6OSyhgCG3MpkUN6MKDm1Kmrp/L+vuMY+97s9GfTH7Y/wCxPd/th/DyO98d+LPBVrrfhq2ebQU1/wAQWE01nNFC6JCkollubWCWIIoVUCo8cMpT92rjrvhb8T/icvwh0tfE9hpHiHVLV47fXL3wX4stNSsmuo0OHLloWR9kmWXYu1pCqqyYY/lCP2kLfx1rEPiO98P2NvOYAstxe+DEllmBYYBaO3fcMEdGwVU8sSQeNs/jv8TPh18eG8U+CNaf+xtaElnOj6Wl1YWskuxJGWB45Fj3fu1yse4piNQVASvco4DEVcJytWa1V3f1WiW5w1p0KVZS5r9HZW+Z+3PiP4g/Bz+zP+EQnS3fVblY7izmhumErQSxMkhCCNlOy58rY0bhmjaTzNodFHT+C9H8MeFtFOmQ+HZ7xyDc29rqNwkLPMAjJ5ruZJnw6RspJLZMh+RJWI/Nz9ljx5+2b8YtSsfD2i+EbyWOz0lNLsbqWIWU8topX93I4EZkYxoYg8yyDa2dyP8AvD+ovjvxL4f+IXhex0nxXYaDqmo2mhI+v2umanA1sJsrL5CGV0KlEaOcmZgNlzbhSNpZuLF4eOHw/tpJcy0Wnn3699S6U5Tq+zTdn5mG8Xh62v5bDRvDd5K0hVLhr24jka8kighEkzsGZIvNZflUgOEZRt+QuLVz4m0DUfh2NN1TRV0q6mijbS8y2nmPkt+6jjmgWWM52fLsTBBJZcE1y3hfwutz4muNb0bxTP4XWOA/8S3wtqNhcqqtP5UBmghgkUNMIywJ80gEpuQqFPe6pp9vc2L+G9e8P6BqcqpGdQbUwJ9kLvuXzVS2VSBtYJnbnYpycbj89NKdRya3d/TyPRi3GKSOVSwj0uS10rU7lodWk0w3Exlu42uVj3EBZtoJ8oMSS8XygrjIz82Rpuk67q9hrEerXl55lsADplhEsr3zMiNEqLdgKXboHDbd5KsQY3296+m+Fr3VYfE2r+JNJXUJbhbW1vksIIWzvbbApdRLyH2gbzuBBH3/AJs6w8A64vjKPxHceNNR1aK3heW20VNMjtQd3I3S24EgKnBG5SR0AJODFNU+e5U3Pksi18Or1bjSw2qaLf6PfJEitP430JVnnj5wPMgm8mTBHADbkBOR82SV3VjaXcA+wmGbTbrmVTGkmo5ibDENuUmJt7MOOG2nk4+Ur2I1FbQ4HTdzxa/1qTSdG1q5urOzupY1b7ZYDc6+YLZSLT/WyNvIIPywgMHyI8tzwOjT6ncrf61481zWtLfTbDTry/tNQZ7eGzMls0jRNI91IYVjiSQTM8gG+Rv3p3YN/wAFyfELVtG0+X49+AtF8Ey6n+58OaXq3j4azeNeNIsaqY3ghjcbWV8Qzu5BVAAxwtv4seDPC3jixm0rx9p+nSx6Nqcjxa94q8HPFYWrqzRFkutTMkSxvJsjBiDOxdNqld7L5ypO7v8Agdk6jtdL9Cn4P1LwP8ZdavtZ+EvjPwnOmjNGqT+D9TivFgSQguLuO3uNh8wRSpGWDMimQxspG43vDVj4T8f6u9zq17Lremaa72D/AGa3to7fRZwi+bBKxdplkBCKyb2CNy4UBWGp8HfhjrWjRDUvC0/h67s50DD/AIRews2trvYGwJJ4IoAn31ZNhb7xyoGVbotK0vw9p2gS+AdP1GfTLgRNqmq3/i+eW88o+bGWaFbm7cxFZZI2idnZYiijac5ESpNvt2ClWbj7y1IrPwVHfeGbc6L4Z0vVtGu/9K0yxhsle3liOXheNt0kBL8MHJAO8NwTVPw38PjpHjPWvEB8da7eR2srafYaVqVpI0dhIIioZF2LNKhxnzJJQjb2KuAV27AfxLL4Y0u2+LcE+tXGpxSObm3uNINlbmRn8hQ84iaSbySh3Im0neQoB2iRPEnjLw6W1XSofBOkaTJqFvZvPfarcsbm5kljit4llnjiCSlpEVYsHc8qhWLEij2Cihur7ysW9Msl8XXV3b6TpOmxajp1hbySzRalb3K208jymS3KKFmDDyhu8xEBLAKSVbD/AA34di18TavbIYb+MS2yhQJZflwNrOg3bQVDEI5BbcT82a4LUtb/AGefDVxLdeKdctX1NNfOkWEqWmqafLZXUrbSBNEzFYX89EjmUxwMCcSMCWGx8Q/jn8Mo9Kt7XxBeJeaddXNvMl9pqubaUxXMZBEiTA5ikUSbyVG6MbdzgRtnKMU1bQ0U5dT4Z/4Ls/DLUviF+yna/E3SNDgm1TwB42klvzokE1tb2Oj36tbym4SYL5txLcC3ZwgzG00kJWTy3nf8rdS/a9/aN8SaFp/hv4hfFXUvEtppVyZrRPEE5vJFB3FozNKDNsO5srvxyMYIBH7rft6W/gD4lfslfEXwNpHgDUNVv9c8PSw2lqb+WK4uLmCZZYHDl/Nk8qeNZRHnbJtKnIfn+efxHp8+nanNbTIFZHIwOh96+uyKtRr4Z0/5X89f+Dc8jHQqUqiqPr/X+R1U/wAbr83099p3hbSLMzSsxjt4pSq5wMDfISQAoAyTjnHU5jsvjh4m0+7F3p1nZwOImjQxo/y7nV2YZbqSinPtkYNcOznOKEJLd6+iVNJHlus29j334c/tdftI3HinStQ0v4sanpd9pczNpGraVItpfaeZIRBKsF1CFmhSRMCRFkCSYy6sea/d79kLRda+A37IvgrwV8P/AId65e+I2htlv4NfSe2W3eeXzJpHdoSIIkMkj+WV8wc7laQuW/Bz9h34QRfF345eFvBd1Bevb6jrEMV4+nRB54rYupmdNwIysas2SCo25PAr+hXwL8az4g1ibStV0k6ZqUoaeWF9ZglM4zz5aiV3BAA5MajCnHpXz+cxU4RivU9PCzszf8K2PiPVdZ1Xw34j8T3F1q1jaquoXdtpt5bIUmXdHHbm9aZXQgEtJDOdsiYwjKRVGzudU069Ol/EcxaHqGq6hcWunLb2wvbW+QRhYpFkiRPLBDjKSLGxcyKrPhJKyvFdp4r1KO/8IeNL+61PQPEKvbQ21h4eu532lgRE8lhseMBQUzIyq4YDcfnWo9a0rQmGhahfeF9fvLC50+bSm0fU7PUdUvDqlzNDLZtNfQrdMltERepNcJLJDEJYzll2AfNzoWZ6EZo9Ci0LXLT4cS6NZXdxa3UFxFLdWsFmJhIluCFiiSZYw7GItGrOWCmR+WyTWFoFt8Rn1uS8uNThtNMhtoip1jwrO6RujqY1itob0Rl0ZUbcQGHyldwDbcyw8S6ol/p7/F2XTNPtWsGGmaTotnq2sSrLFIVWeS/MMaxNsDo0T2/mBicytgrW22paRJp8AvPG2qMYVH2q50ix1OJ52zlmSELuAye8pPXkmsbNMq90bNt4I8E/FGK5vPiDB4auL2W+aaCS01K6trqKBQI0iPm/vY0BDEoNiM537NxLErR0PxV4IfQ/7S+IfxD0+0jklSGyvdZkWwmk8uNVKlbuGOTJG1iSXDMz42ABaK7YylbR2MORPdHJWNpbDXry41zxPqt3HLCjK8E7wRM20rsCiXcrjAYlFjBJGSzZriNJ8EfEvwTc2uhaX8Z9Q8X6Te6laya6nj9I5biOOGNEZLOSzW2SJ3jjJYSJKpkAkADNK0kHhXwp4b8O6e2g6Z498ZXn+nW073Os+Ir64mMkDiUIsksm0o2NsgUYkUlXDAcQfFbQTZi9+IHh2eSz1K9isrfxDdwv+8n022N00cSFifLaOS7lkDRbHJOd+UVTxqq07J/gdnsIqN7fix2qX/hi7Oi/F34P+CPtD39klxpPiGK3zarE7dWfKy7ypClNy43bSCNyMzxH4g+N/jmCysdRt/D+ntZ6nDdi7jdYxcRI3mNauZorkRoxXD7Qp5CqcDDZ2meJdf0iS3vpdTu9St7K0lXzojDJfQI6cbJJVbfkhGw5+You4kAq17xZ4M+FjaIt7491q9lgmQhGv9Qmgu5gY2fykKgTtMAsjokZV8qAFyDUVJyvu7mcYJ6q1h3xF+InifWvCGr2viLQDoNjZW0v9qa7oeqaXLaw2kVukvmu968KCM7poWEsJVSrNujCpJXBeGvG3i+wsdC8VyW/xP1LQmihfShPd+FLGy1GGSNTEnzXEYnjljwQ28Hbgr13Dr/Cuq6bpkUWneENBv8AVp7N4pD/AGpJaQtN5gVZL5YxsEUhET4AjQZYKFjX7lD4k+I38E6XFa/E74o6NZWeoXSlb3xDqdvZi+kjVSQkMyhIyCqHEZG0nfkNknmlWt7lrs6I0uZcydkN13xB4c/aj8MJY3/w1vtOl0y7mntIvEt7NZz20ihfLliOnzMsyEs3Anj+6W2kYNZtz4d8fI9x4he20rSdTuSH1XUlv5btAu1i0sKyqrcK6piVzGv2dQqBTmustvAPxFuFgsXk1O0aK+N0u10RZQsgEsTnB+RgiqZWyVVwytzWrpHhvWtVuzrF9eRWfh5LZ4UtprOV7w3SujI26NpFERjdw29FKsq4ZxuCcFT29TSnsdcVTj8Z4R480abxH4K1WG9Fprn2eDdr2na9ZxxwPbZfzEYE+ShG1/nO5DjncNpHwn8ff+CWWq/F34k3Unwo0KPwndMjXWraZqOopc2VozhRFFEIYxJBvwZBGxKqMhQqhQf1S8VeFPB99faHc2+geJ7zV7W3aKa98PaxdrpunXV5H5KC6hUqLuHziqLLJY3CW+HmkSFVkdMnTdD/AGSf2avBlr8OvAvirQdM07QtUls7Tw7b+LLkXllLNcIhiBt2luJsXLTM3mKzRiY5ZEiYHswdbGYL36LtJ/P/AID8tOr7a41YUa+lTb7vz1/H89PxyvP+CI37aEEC3FjZeHNT3lfKjsdUnTzAWVSwaa3VMLuBPPTpkkAs8Gf8EV/2xNe1PTW1TS9G0m0vr9YCb+7l89R8zOVh8tXkKokj7RgkRtjoSP2hf4fjwdPdr4/8VazEt7qkkkNz4mlkkhtIriPZ9jguYldAsbCQmZvJlIdQzOoIE+r/AAN8JWHha606b4fXfirXYtYt7jS7DwrqOnJf6TNatKYdRiN/NDHG0cpIILNuEiqY2R5BXt0uIsxslKUXfyt+Z588twnM2otWPmP9ib/gldYfsj6gnjyLxrcapr85MFnqjWaWawwsHE8cVtMGYMyfKSzsWjVmXYGYH7M+Hfgrw5aX15qcWmTXGq2MOySXUJQkuGG7cAH8vYdpVWClgyyAtjIHiPws+IL/AAi+LHxYsv2mv2pLDxGvjDx1Ba+BfCvhaefVpdBiX7Sttp8lvaW5+x3UiIqeXj99LbNtaWQvu988Par4jh1rT9V8QfD/AMS6ba27SRQHVtSs5L0glN8n2a0EqPZ7WG/M32jzEXbarhZBGIzDEVNJyv8AgvO3oEKFK90jL+Gnw7m+B1lfeL9W8VeML7+07thb+H/EHiuXVoraVpHCrDPMpm+eOOM7XaQRrA+0KzzNLufDOSXwBA+nW2k3MNjqOsPIkTajPMsLXNymyOITswijjDHbFEFQ4wqIcBjwl8QPA3xa1RfDdm0505BPM8mlu1pCA77E+5ebi+6N3ClMkDzMoWw/JfFL9oDx74D8ReFNC1f9m/WLiDxT430ewsNVtfEkFslgrTljcH7O7TrHtQO0RTynjkeOWUhvKfhWJlVfK3qzd0eRXR3vxrk+INl8GvE99b32ieEL+z0ctpGv6jM19b2srZTLI8St5nQRjZKCzrlJOYnz/gBb/ELW9J0fxnP4wtvEuk3+hqk7y3KSosoknBkieDSbUb9sC+Ysih1kYxhYgmZ7mmfG39n/AFS2u/ht45+I2hSiG3MWq2FrrhmJKW6DDbUhRR5gUeSF2SLvymGdB4x8V/21fB3hTVb7Q/AEt3cXFlbwjT9NstZnhghtMvGkjxMSgj/csqhI2VtrgMwUmrpU68qKnBXu/n0/AzlOEK3Iz3PTPGNn8T9Pk8dfALWfDPjrTvtjWc50zxTbi1spURHZFeG1l3uQ6MwdyVBTbgMwor4i1H9oz9oTXvGGq+OvAutWGmaleLbW/iQiCSzkmmjRjFHcuE/eSwxsEVAzKkbgAkMDRXYsHXa0X3tk+2prd/cjnp/25PjX4Y8KXel2/hjS/EHiSzsPtMkE0ymQ7mBLiGAxZCITtVSCdqjc7HJ1tO/4KKW99eadpE/hdL2x1i0kXT/EyO3lSaiEkbDWbPv8lVRm2mYvlShCbQ1eL3HhoWXiDT/iJofhjUtMvfNdNQgtNLa4F7FIrZWRLfJ3AhSJCSAUGQcjEniDw14U0jRU0zUR/Y0F9rEV+iXU5i8yWKeO4Kqs3AVmRdyrgfMx4Ylq7pZVCG8GvvMIY2U/hkn9x7TqH7avwyg8Jx6Hd/EK1082epmK8vNC8MOsAkDOptdkwuUXAySoZWBjGMLlTc0X9t/4Wa54o0+HxN4qstXt4IQlvrE2kvFO/m3KRSRBUeIMSSspZVXZHCQElYnHhVr4P0t9eu9d0TxFqltLqFvGl5HHcQSRyqjOVYGZHZRukPyqdozwoOcxXeo+HNL1aB/Et1LLpum2xe6v9UhiiVZicptcqkZ2oXUlOP3mCSwOeZ5XT5rqTf3f5FyxcuWzSt/XmfYvgz9rr4LrcagkviVUs2vIxo08GnxqZYTDbuzAs8kk37zz13OsRG0qsZVVmk8r8B+P/wBll/EGvfETx/8AHS68U6ne3Kx3njDUBbwtPaxIUiiKokUFtsEhTMaKspJlwfMCr52/wv0C+tguqmG6USmUfuQFOfVQcZxnoACSSAOlch4d8AWuhyTXFn8OlN5O0kdxdaGloghjYhRCXm8p5BtA4KY57gjOayqV3y1LfI0eMp8q5oX+Z9Y+CPH/AMHNA8W6Q/w/+O2rtYCwD2+mNrE97B9l8kAeVCbsxRbfMh58ogKxAHzB07C5/ae+E9z4c1TVdL+Lst1bvcS2zafDDEJoZLZdj2kDqy/NuhlyrsHEjON6LgD5S0XwFNJPd30/hOLddIJRA94JguWLGJiQ2xhldpDuDgktyK2dZ8FatPZ2cul6MbvUY5Y3NnHqMlrtCxn5FEXExLkAIxEZ5JYEcpZXO1nU/D/gl/XaVtIfj/wD6T8U/Gr4XeM/hhH4DT4q2tta3cMa3N4ly8kyxgLKsbCJWJ38LIGYFkkckksa5TV/GnwA1C2n8AeKvircMZbCCU2GiWjuyQSF2RySgdd4RlIC/wDLNlG1lYj5z8Kv4S8R6fF4lv7DWZTrwSeO7sZDqNoFECRbo5Ld5UhjKoqhFYK2GYAnea6TTfh/4a8TRm7ukk8mKNg76laSwySBcjZtkVXVc98AYzjsaFk8Ypp1GR/aPNJWgfTPiL9un4ZeOvAa6l8PvEki6dMCqPDby20sjpLj9zNFIHhICH7yOGyoKhWIbzjw1+294T8KNf8Agv4n/DrW7u21mWTztU8Qaymr29xGkCrvkjk8rBZ2VCiqWKomTkfu+HsfDeox3dhpUJhudOgW4acXGsTeZajkRRxxOkgkAI2HLKeARyuxqmra74Smk1PTrfV3+12Dql3HIfIjUOgYorum1gcfMyknI2k5UKNKeT0NE23/AF5Ic8dUs7JG14s+L/inVvit4V+LOh2dpolp4O0q/j0q1sPDNvBeSi4kTdbyGWF2hijtVa3EcSQzYaVhcAvgL44+PfxZ+IGma/8A8J3cQt4efTbmdrYancwx2xwGn3tHMjywoSWWO4DIvmEKUjUxD58X9o34fW9+R4m134bmwgtgY7nSvHEt7crs3O37oWoWVpHVQdoVlVmwGYqBdT9qT4F+LPAlj4b8TE6vPLcJPfaZoi3gsfOJxhhMluJV4DlHQr0+8RmuhZTDRcrdjmeNl3sei6B4/wDFuu+CNMu9E+INvpVr80mnLoMCxQPayTH7QqCIRjlGYIQUCMzHDEFGzfEOm/EfxTrjeI/HWqw+K7OdryO80fX7918lUunls5Y7Zo5hcTSjy97STRLtVHEfzGJcrR/H+o+Kry68Q3fgaHzIomstKMmrmSSeEsWM0rCBXjYfKdod1Ad8Enr5RoH7cGsfDT4j3WpfFjwbb6poOjE2niTwPZxSW97p8QEZ/ta2mE2b0KRKWiPl7ImRvnUSTx9tDKo0mkoJf15amFTHOad23/Xme4azo99odzqOn6TpNkwubaSYa9qTqlrFM0ilvMiUhpECzSbUXaW+zOrPH5iS13Oi/An4o6rqVxouj+B9cgtIbjz7+y1+zitrW5E+6Ndz3MQby4lj5W3G8KN0iyPIN/ofwl+M/wAGNe8A6d8TfgFpum6npclh5MWraTHunSFdu9J2cGbPyIXEvzFsFjnBPzd8fP2+vif8TPH+r/Cr4S32s6bpcV4lpP4ksRbwCGURlpF86XcUiPzZmwpTYGVipzXp/UMPQhzVJfd/wTgeLrVp8sF959T/AA1/Z78AeHbEzfEDxbLaXo8xLaHwkkUaQI0rs+XmhO/zAIXYBEw6sCZPlaivg3wr8IT8YNRu/iH40hsvEDTyPb3WswXiTS+fGEAi3Xkk2UA3HKnr1JorBY3BQ91UvxNHhcVLX2h//9k=\",\n \"photo_exists\": \"true\",\n \"pin\": \"PxundUqtIoZjZagX+3VnaEwacJSxHH+89uYiJRm92vE=\",\n \"pin_exists\": \"true\",\n \"login_id\": \"admin\",\n \"password_exists\": \"true\",\n \"updated_count\": \"5\",\n \"last_modified\": \"26\",\n \"idx_last_modified\": \"33\",\n \"start_datetime\": \"2001-01-01T00:00:00.00Z\",\n \"expiry_datetime\": \"2037-12-31T23:59:00.00Z\",\n \"security_level\": \"0\",\n \"display_duration\": \"20\",\n \"display_count\": \"3\",\n \"permission\": {\n \"id\": \"1\",\n \"name\": \"Administrator\",\n \"description\": \"this is a permission for Administrator\",\n \"filter\": {\n \"UserGroup\": [\n \"1\"\n ],\n \"DeviceGroup\": [\n \"1\"\n ],\n \"DoorGroup\": [\n \"1\"\n ],\n \"ElevatorGroup\": [\n \"1\"\n ],\n \"ZoneType\": [\n \"-1\"\n ],\n \"AccessGroup\": [\n \"0\"\n ],\n \"GraphicMapGroup\": [\n \"1\"\n ]\n },\n \"module\": {\n \"Dashboard\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"User\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"Device\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"Door\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"Elevator\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"Zone\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"AccessControl\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"Monitoring\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"TA\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"Setting\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"Video\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"Visitor\": {\n \"read\": \"true\",\n \"write\": \"true\"\n },\n \"Report\": {\n \"read\": \"true\",\n \"write\": \"true\"\n }\n }\n },\n \"inherited\": \"false\",\n \"user_group_id\": {\n \"id\": \"1\",\n \"name\": \"All Users\"\n },\n \"disabled\": \"false\",\n \"expired\": \"false\",\n \"idx_user_id\": \"1001\",\n \"idx_user_id_num\": \"1000\",\n \"idx_name\": \"2001\",\n \"idx_phone\": \"1000\",\n \"idx_email\": \"1000\",\n \"fingerprint_login\": \"false\",\n \"fingerprint_template_count\": \"0\",\n \"face_count\": \"0\",\n \"visual_face_count\": \"0\",\n \"card_count\": \"0\",\n \"qr_count\": \"0\",\n \"mobile_count\": \"0\",\n \"need_to_update_pw\": \"false\"\n },\n \"version\": {\n \"dbBiostarVersion\": \"2.9.8.1\",\n \"biostarVersion\": \"2.9.8.14\",\n \"isMatchVersion\": \"true\",\n \"notiPopupOpen\": \"false\"\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"},{"id":"3dc17ec9-64bc-4378-b058-9688cfc9f0ae","name":"Login Failed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"login_id\": \"admin1\",\r\n \"password\": \"your-password\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"400 Bad Request"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"150"},{"key":"Date","value":"Tue, 21 Jan 2025 02:05:37 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {\n \"code\": \"101\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Failed to login for invalid username or password\"\n }\n}"}],"_postman_id":"0b54ae8b-6744-44dd-8556-8001ae3139ff"},{"name":"Logout","event":[{"listen":"test","script":{"id":"e56506e5-0e22-484d-a3fe-0b88dfe8e59c","exec":[""],"type":"text/javascript"}}],"id":"f344b4ff-e2c2-4a2b-8c4e-8bb2aef3b448","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"bs-session-id","value":"---","description":"

BioStar 2's session id. Generated on successful login.

\n"}],"url":"https://127.0.0.1/api/logout","description":"

This API is used to Logout from the current session.

There are no body parameter on this endpoint.

It is required to have bs-session-id key on the header, the value generated on successful login.

Known errors:

Putting \"/\" at the end of the endpoint

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"86d0578d-a523-4c21-ae01-2657d863a372","id":"86d0578d-a523-4c21-ae01-2657d863a372","name":"Authorization","type":"folder"}},"urlObject":{"path":["api","logout"],"host":["https://127.0.0.1"],"query":[],"variable":[]}},"response":[{"id":"5a7db81d-8e1e-451b-89ea-e1aaf7595f4e","name":"Logout","originalRequest":{"method":"POST","header":[{"key":"bs-session-id","value":"---","description":"BioStar 2's session id. Generated on successful login."}],"url":"https://127.0.0.1/api/logout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"107"},{"key":"Date","value":"Tue, 21 Jan 2025 07:59:20 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"}],"_postman_id":"f344b4ff-e2c2-4a2b-8c4e-8bb2aef3b448"}],"id":"86d0578d-a523-4c21-ae01-2657d863a372","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"bc844921-29b4-4fff-b5de-34e0ba5096c9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eba90acb-e462-47ea-8b20-c6481207fa09","type":"text/javascript","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"]}}],"_postman_id":"86d0578d-a523-4c21-ae01-2657d863a372","description":""},{"name":"Access Group","item":[{"name":"Create New Access Group","id":"00237534-7069-48b0-a23d-5a645ed214c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"AccessGroup\": {\r\n \"name\": \"ac_grp2\",\r\n \"description\": \"\",\r\n \"users\": [\r\n {\r\n \"user_id\": 1\r\n }\r\n ],\r\n \"user_groups\": [\r\n {\r\n \"id\": 1\r\n }\r\n ],\r\n \"access_levels\": [\r\n {\r\n \"id\": 2\r\n }\r\n ],\r\n \"floor_levels\": [\r\n {\r\n \"id\": \"32769\",\r\n \"name\": \"floor_test\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/access_groups","description":"

This request is used to make a new Access Group (AG)

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	The name of the AG. Must be unique
description	String	N	AG's description
users	Number	N	List of user(s) id of the AG
user_group	Number	N	List of user group(s) id of the AG
access_levels	Number	N	List of access level(s) id of the AG
floor_levels	Number	N	List of floor level(s) id of the AG

If BioStar 2 does not have license for Elevator module, skip the floor_levels parameter or put it like this: \"floor_levels\": \"\"

For numeric value (such as id's), the value can be put on a quote or not.

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
AccessGroup	Object	AccessGroup object
AccessGroup.id	Number	ID of the Access Group which was created
AccessGroup.name	String	Name of the Access Group which was created
DeviceResponse	Object	DeviceResponse object
DeviceResponse.rows	Array	List of device responses
DeviceResponse.id	Number	ID of the device which updated it's AG.
DeviceResponse.code	Number	Response code from the device. 0=Success
DeviceResponse.result	Boolean	Summary of device response. True when all devices successfully updated (code=0), False when even one is failed (code != 0).

Known errors:

Putting \"/\" at the end of the endpoint
\n
name is a required and unique parameter
\n

This API is used to view all available Access Groups.

By default the result will be sorted ascending by id.

This API is used to see all Access Groups. It provides more concise response rather than the previous (GET /api/access_groups) and parameters to filter the response.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
limit	Number	Y	To limit result by n record(s), 0 to show all
order_by	String	Y	To order result(s) by name or id (false is for ascending and true for descending)

Known errors:

Empty body
\n
Input other than number on limit parameter
\n
Input without key:value pair (name:val or id:val) on order_by parameter
\n

Changes:

v2.9.9:
\n
- Trailing slashes (/) at the end of this endpoint are no longer supported.
\n

To view an Access Group with id {id} or :id
{id} or :id are markers for replacing with the required value.

Known errors:

Using id which doesn't exist
\n
Using value other than number
\n
Putting \"/\" at the end of the endpoint
\n

ID of the Access Group which will be viewed

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"5faac57e-d261-4b4a-9c17-5f0a28912648","name":"View One AG","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://127.0.0.1/api/access_groups/:id","host":["https://127.0.0.1"],"path":["api","access_groups",":id"],"variable":[{"key":"id","value":"1","description":"ID of the Access Group which will be viewed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"584"},{"key":"Date","value":"Mon, 17 Feb 2025 07:44:02 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"AccessGroup\": {\n \"id\": \"1\",\n \"name\": \"Adminstrative\",\n \"description\": \"\",\n \"users\": [\n {\n \"name\": \"RB\",\n \"user_id\": \"2\"\n },\n {\n \"name\": \"AM\",\n \"user_id\": \"3\"\n },\n {\n \"name\": \"JJ\",\n \"user_id\": \"61000\"\n }\n ],\n \"user_count\": \"3\",\n \"user_groups\": [\n {\n \"id\": \"1005\",\n \"name\": \"Administrative\",\n \"description\": \"\",\n \"parent_id\": {\n \"id\": \"1\",\n \"name\": \"All Users\"\n },\n \"depth\": \"1\",\n \"inherited\": \"true\",\n \"face_count\": \"0\",\n \"user_count\": \"0\"\n }\n ],\n \"access_levels\": [\n {\n \"id\": \"1\",\n \"name\": \"Administrative Employee\",\n \"description\": \"Access level for Administrative Employee\"\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"},{"id":"10e611d1-9307-4ee5-959e-b468204a5911","name":"View One AG (With Floor Levels)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://127.0.0.1/api/access_groups/:id","host":["https://127.0.0.1"],"path":["api","access_groups",":id"],"variable":[{"key":"id","value":"12","description":"ID of the Access Group which will be viewed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"515"},{"key":"Date","value":"Mon, 17 Feb 2025 07:43:12 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"AccessGroup\": {\n \"id\": \"12\",\n \"name\": \"Test1\",\n \"description\": \"\",\n \"user_count\": \"0\",\n \"user_groups\": [\n {\n \"id\": \"1005\",\n \"name\": \"Administrative\",\n \"description\": \"\",\n \"parent_id\": {\n \"id\": \"1\",\n \"name\": \"All Users\"\n },\n \"depth\": \"1\",\n \"inherited\": \"true\",\n \"face_count\": \"0\",\n \"user_count\": \"0\"\n }\n ],\n \"access_levels\": [\n {\n \"id\": \"3\",\n \"name\": \"All Access\",\n \"description\": \"Access level for All Access\"\n }\n ],\n \"floor_levels\": [\n {\n \"id\": \"32769\",\n \"name\": \"FL1\",\n \"description\": \"\"\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"}],"_postman_id":"c95e24ad-9922-4588-8803-69d7ee8c9ca9"},{"name":"View List of Users from an Access Group","event":[{"listen":"test","script":{"id":"7014b138-eb2c-4736-83de-32f01b1c0abb","exec":[""],"type":"text/javascript"}}],"id":"c030fcbc-9ba4-4f24-9564-416dfaadc367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/access_groups/:id/users","description":"

To view user information only from AG with id {id}

Known errors:

Using id which doesn't exist will return success but show no record
Using value other than number
Putting \"/\" at the end of the endpoint

ID of the Access Group which will be viewed

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"11985764-99b9-455c-af72-818aa2a6e277","name":"View List of Users from an Access Group","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://127.0.0.1/api/access_groups/:id/users","host":["https://127.0.0.1"],"path":["api","access_groups",":id","users"],"variable":[{"key":"id","value":"1","description":"ID of the Access Group which will be viewed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"235"},{"key":"Date","value":"Mon, 17 Feb 2025 07:47:24 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"UserCollection\": {\n \"total\": \"3\",\n \"rows\": [\n {\n \"user_id\": \"2\",\n \"name\": \"RB\"\n },\n {\n \"user_id\": \"3\",\n \"name\": \"AM\"\n },\n {\n \"user_id\": \"61000\",\n \"name\": \"JJ\"\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"}],"_postman_id":"c030fcbc-9ba4-4f24-9564-416dfaadc367"},{"name":"Update an Access Group","id":"c52a526c-ae24-4306-83da-c9a39067c148","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"AccessGroup\": {\r\n \"name\": \"Meeting Room Name\",\r\n \"description\": \"MR Description\",\r\n \"access_levels\": [\r\n {\r\n \"id\": 1\r\n }\r\n ],\r\n \"user_groups\": [\r\n {\r\n \"id\": 1\r\n }\r\n ],\r\n \"users\": [\r\n {\r\n \"user_id\": 17\r\n },\r\n {\r\n \"user_id\": 9932\r\n },\r\n {\r\n \"user_id\": 2\r\n }\r\n ],\r\n \"new_users\": [\r\n {\r\n \"user_id\": 1\r\n }\r\n ],\r\n \"delete_users\": [\r\n {\r\n \"user_id\": 17\r\n },\r\n {\r\n \"user_id\": 9932\r\n },\r\n {\r\n \"user_id\": 2\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/access_groups/:id","description":"

This endpoint is used to replace Access Group with id {id}/:id values with the one specified by parameters below:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	The name of the AG. Must be unique
description	String	N	AG's description
user_group	Array	N	List of user group(s) id of the AG. To add or delete User Groups, put new ones in this field or remove what you want to delete from the field.
access_levels	Array	N	List of access level(s) id of the AG
floor_levels	Array	N	List of floor level(s) id of the AG
new_users	Array	N	List of user(s) id which will be added to the AG
delete_users	Array	N	List of user(s) id which will be deleted from the AG

Notes:

To add/delete multiple, repeat the braces (see users example)
\n
When you add/update data, it will remove any previous data and add the one that you input
Ex: If parameter description have value, and on update this parameter value is left empty, then the previous value will be removed.
\n
To skip a record from updating, either skip the parameter or fill the current data on the update field.
\n
When updating an AG, parameter user_group need to be filled if existing User Group want to be retained. If this parameter is left empty, the existing User Group(s) in the AG that should be still there will not be there.
\n

Known Errors:

Repeating the same value on parameter with multiple options

ID of the Access Group which will be updated

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"45dadc1a-95d5-4c94-855b-6d61b5fdc263","name":"Update an AG","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"AccessGroup\": {\r\n \"name\": \"Meeting Room Name\",\r\n \"description\": \"MR Description\",\r\n \"access_levels\": [\r\n {\r\n \"id\": 1\r\n }\r\n ],\r\n \"user_groups\": [\r\n {\r\n \"id\": 1\r\n }\r\n ],\r\n \"users\": [\r\n {\r\n \"user_id\": 17\r\n },\r\n {\r\n \"user_id\": 9932\r\n },\r\n {\r\n \"user_id\": 2\r\n }\r\n ],\r\n \"new_users\": [\r\n {\r\n \"user_id\": 1\r\n }\r\n ],\r\n \"delete_users\": [\r\n {\r\n \"user_id\": 17\r\n },\r\n {\r\n \"user_id\": 9932\r\n },\r\n {\r\n \"user_id\": 2\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://127.0.0.1/api/access_groups/:id","host":["https://127.0.0.1"],"path":["api","access_groups",":id"],"variable":[{"key":"id","value":"1","description":"ID of the Access Group which will be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"Set-Cookie","value":"JSESSIONID=2FFEDBAE36C395555DECAFA23AA6205D; Path=/; Secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"107"},{"key":"Date","value":"Tue, 04 Feb 2025 08:02:39 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"}],"_postman_id":"c52a526c-ae24-4306-83da-c9a39067c148"},{"name":"Delete an Access Group","id":"8eaed861-0c92-4247-b84f-0981068a2737","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/access_groups?id=","description":"

To delete Access Group as specified by QUERY parameter id (?id=)
id is a required value.

To get an Access Group's id, you can use GET /api/access_groups to view all available Access Groups, alternatively you can also use POST /api/v2/access_groups/search for the same result.

Known errors:

Using id which doesn't exist
\n
Using value other than number
\n

ID of the AG which will be deleted

\n","type":"text/plain"},"key":"id","value":""}],"variable":[]}},"response":[{"id":"650a9674-3191-4444-87f5-1fcd370f9347","name":"Delete an Access Group","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://127.0.0.1/api/access_groups?id=2","host":["https://127.0.0.1"],"path":["api","access_groups"],"query":[{"key":"id","value":"2","description":"ID of the AG which will be deleted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"107"},{"key":"Date","value":"Mon, 17 Feb 2025 07:24:47 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"}],"_postman_id":"8eaed861-0c92-4247-b84f-0981068a2737"}],"id":"9ead7190-6d0d-48e4-8ff4-cbac6497813c","description":"

This section contains all API related to Access Group (AG)

\n","event":[{"listen":"prerequest","script":{"id":"e9490b97-2d27-4f1a-a5a0-690ca5348598","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1353b428-f624-4b08-bec2-ec16e95bacbe","type":"text/javascript","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"]}}],"_postman_id":"9ead7190-6d0d-48e4-8ff4-cbac6497813c","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Access Level","item":[{"name":"Create New AL","event":[{"listen":"test","script":{"id":"135c0428-8658-4846-8ab2-c75154276ea8","exec":[""],"type":"text/javascript"}}],"id":"190638db-f2bf-4999-8989-936c92d1466a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"AccessLevel\": {\r\n \"name\": \"Access Level Name\",\r\n \"description\": \"Access Level Description\",\r\n \"access_level_items\": [\r\n {\r\n \"doors\": [\r\n {\r\n \"id\": 75\r\n },\r\n {\r\n \"id\": 80\r\n }\r\n ],\r\n \"schedule_id\": {\r\n \"id\": \"1\"\r\n }\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/access_levels","description":"

This request is used to make a new Access Level (AL)

The parameters are as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	The name of the AL. Must be unique
description	String	N	AL's description
access_level_items	Array	N	This array is linked to two instance, schedule_id and doors, each with key:value parameter pair of id:id_num. doors is also an array, so you can put multiple value here.

Known errors:

Putting \"/\" at the end of the endpoint
name is a required and unique parameter
Duplicate id on doors instance

This request is used to view all Access Level (AL)

The parameter type is QUERY.

Known errors

Duplicate id on doors instance

\n","type":"text/plain"},"key":"filterObject","value":""},{"description":{"content":"

Limit response record(s) by the amount specified on this parameter. 0 for show all.

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Shift response record(s) by the amount specified on this parameter. default value = 0

\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"SelectAllYN","value":"true"},{"description":{"content":"

Order the response record(s)

\n","type":"text/plain"},"key":"order_by","value":"id:false"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"total","value":""}],"variable":[]}},"response":[],"_postman_id":"266882a7-3db2-4b3b-a1b0-e865ec0ef516"},{"name":"Update an AL","event":[{"listen":"test","script":{"id":"6cd63a5e-25c4-417d-bb91-8f2ec96ffa6e","exec":[""],"type":"text/javascript"}}],"id":"d4b71728-fd23-48ba-b841-fa08ec11ab4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"AccessLevel\": {\r\n \"name\": \"Test Update\",\r\n \"description\": \"Update\",\r\n \"access_level_items\": [\r\n {\r\n \"id\": \"126\",\r\n \"doors\": [\r\n {\r\n \"id\": \"75\"\r\n },\r\n {\r\n \"id\": \"80\"\r\n }\r\n ],\r\n \"schedule_id\": {\r\n \"id\": \"1\"\r\n }\r\n },\r\n {\r\n \"id\": \"128\",\r\n \"doors\": [\r\n {\r\n \"id\": \"75\"\r\n },\r\n {\r\n \"id\": 79\r\n }\r\n ],\r\n \"schedule_id\": {\r\n \"id\": \"2\"\r\n }\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/access_levels/:id","description":"

This request is used to update an Access Level (AL)

Known errors:

Putting \"/\" at the end of the endpoint
name is a required and unique parameter
Duplicate id on doors instance

ID of the AL that will be updated

\n","type":"text/plain"},"type":"any","value":"41","key":"id"}]}},"response":[],"_postman_id":"d4b71728-fd23-48ba-b841-fa08ec11ab4a"},{"name":"Delete an AL","event":[{"listen":"test","script":{"id":"cc0cdac1-2b4a-4bd4-bb97-de75499a4a01","exec":[""],"type":"text/javascript"}}],"id":"f5253114-e5d2-4444-ad7e-619244e4330b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/access_levels/:id","description":"

This request is used to delete an existing Access Level (AL)

Known errors:

Putting \"/\" at the end of the endpoint
Value other than number on PATH variable
Non-existent record id on PATH variable will return success but no action.

ID of the AL that will be deleted

\n","type":"text/plain"},"type":"any","value":"12","key":"id"}]}},"response":[],"_postman_id":"f5253114-e5d2-4444-ad7e-619244e4330b"}],"id":"03857e96-dea5-4bb5-9980-684b6059a51d","description":"

This section contains all API related to Access Level (AL)

\n","event":[{"listen":"prerequest","script":{"id":"3d748b24-e3c6-4eb6-8834-6f8bf602cb52","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0aeac151-4b53-42e3-8e39-830266ff976f","type":"text/javascript","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"]}}],"_postman_id":"03857e96-dea5-4bb5-9980-684b6059a51d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Backup","item":[{"name":"View Backup Configuration","id":"87892b2c-8316-44f9-8082-29c5790d3ba4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/v2/setting/getBackupDbConfig","description":"

This API is used to view BioStar 2 Backup configuration.

This API is used to check if there's any running backup process.

Message response will be True if there's any, and False if there's no running backup process.

This API is used to modify BioStar 2 backup configuration.

BODY Parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
use	String	Y	Toggle true to use Shceduled Backup
cycle	String	Y	Number of backup files to keep (1 to 100)
path	String	Y	Folder path, make sure that the folder exist
minute	String	Y	Minute value for Scheduled Backup (0 to 59)
hour	String	Y	Hour value for Scheduled Backup (0 to 23)
days	String	Y	Date value for Scheduled Backup
month	String	Y	Month value for Scheduled Backup. Leave it as * since currently it only support Daily and Weekly.
weeks	String	Y	Day value for Scheduled Backup. Used when it's configured as Weekly Backup. (mon tue wed thu fri sat sun, default value is ?)
userId	String	Y	UserId of the user who modify the configuration

This API is used to run Backup process.

It is required to have BODY parameters when running this API. Use GET /api/v2/setting/getBackupDbConfig for BODY payload.

It is possible to use a custom wiegand format.

To create a custom format, you can edit the provided formats which is between id number 5 to 14.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	N	ID of the wiegand format.
name	String	N	Name of the wiegand format.
description	String	N	Description of the wiegand format.
use_facility_code	Boolean	N	Toggle to use facility code.
length	Number	N	Total bits of the card.
id_fields		N	Encoded input of the ID bits. Facility code will also be placed here. Use comma as separator.
parity_fields		N	Encoded input of the parity bits.
parity_types	Number	N	1=Odd, 2=Even
parity_positions	Number	N	Position of the parity bits. Put it on the same sequence as parity_types.

ID of the wiegand format which will be updated.

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"9a031221-3cf6-42b0-b2c5-14d80d10df4e"},{"name":"Delete Smart Card Layout","id":"3c07b8b0-0c55-4e1a-ac58-f7f6e0ad0dfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/cards/layouts?id","description":"

This API is used to delete smart card layout from BioStar 2.

This API is used to view all available card types.

This API is used to check whether a card already posted on the system or not.

If card already posted, then it will show the card's detail on the response.

Changes:

v2.9.9:
\n
- Trailing slashes (/) at the end of this endpoint are no longer supported.
\n

ID of the card which will be checked.

\n","type":"text/plain"},"key":"card_id","value":"123"}],"variable":[]}},"response":[],"_postman_id":"22453195-0290-48e8-92fa-56038f30056e"},{"name":"List All Cards","id":"b66ba897-8142-4d2f-86d8-7e856ec8b17b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/cards?limit=50&offset=0&card_type=wiegand","description":"

This API is used to view all cards recorded on BioStar 2 database.

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Filter the response by card type.

\n","type":"text/plain"},"key":"card_type","value":"wiegand"}],"variable":[]}},"response":[],"_postman_id":"b66ba897-8142-4d2f-86d8-7e856ec8b17b"},{"name":"View a Card Detail","id":"fb4e3da5-6353-48cf-b63d-1ef8a72ca144","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/cards?query=1169166509350528","description":"

This API is used to find a card by card ID and find out who owns the card.

ID of the card which will be viewed

\n","type":"text/plain"},"key":"query","value":"1169166509350528"}],"variable":[]}},"response":[],"_postman_id":"fb4e3da5-6353-48cf-b63d-1ef8a72ca144"},{"name":"List Unassigned Cards","id":"c0a0421d-696a-4eda-8355-d88445048d51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/cards/unassigned?card_type=csn&limit&offset&wiegand_format_id=4","description":"

This API is used to view all unassigned cards recorded on BioStar 2 database.

Limit the response to show only the specified type of card. Use plus (+) sign as separator to filter by multiple types.

\n","type":"text/plain"},"key":"card_type","value":"csn"},{"description":{"content":"

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":null},{"description":{"content":"

Limit the response to show only the specified wiegand format. Remove this parameter to show all.

\n","type":"text/plain"},"key":"wiegand_format_id","value":"4"}],"variable":[]}},"response":[],"_postman_id":"c0a0421d-696a-4eda-8355-d88445048d51"},{"name":"List Assigned Cards","id":"f8512e96-1313-4a7c-992e-1c77ca181737","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/cards/assigned?card_type=wiegand&offset=0&wiegand_format_id=","description":"

This API is used to view all assigned cards recorded on BioStar 2 database.

Limit the response to show only the specified type of card. Use plus (+) sign as separator to filter by multiple types.

\n","type":"text/plain"},"key":"card_type","value":"wiegand"},{"disabled":true,"description":{"content":"

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Limit the response to show only the specified wiegand format. Remove this parameter to show all.

\n","type":"text/plain"},"key":"wiegand_format_id","value":""}],"variable":[]}},"response":[],"_postman_id":"f8512e96-1313-4a7c-992e-1c77ca181737"},{"name":"List Blacklisted Cards","id":"849f7f6a-5045-4743-b7c4-f485f646a946","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/cards/blacklist?limit=1000&offset=0","description":"

This API is used to view all blacklisted cards recorded on BioStar 2 database.

Limit the response to show only the specified type of card. Use plus (+) sign as separator to filter by multiple types.

\n","type":"text/plain"},"key":"card_type","value":"wiegand"},{"description":{"content":"

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":"1000"},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"

Limit the response to show only the specified wiegand format. Remove this parameter to show all.

\n","type":"text/plain"},"key":"wiegand_format_id","value":""}],"variable":[]}},"response":[],"_postman_id":"849f7f6a-5045-4743-b7c4-f485f646a946"},{"name":"Delete Blacklisted Card","id":"f9ab7749-f593-4d6f-ab1e-f97be405a89e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/cards/blacklist?id=50","description":"

This API is used to remove a blacklisted card from the list.

ID of the blacklisted card which will be removed from the list.

\n","type":"text/plain"},"key":"id","value":"50"}],"variable":[]}},"response":[],"_postman_id":"f9ab7749-f593-4d6f-ab1e-f97be405a89e"},{"name":"Blacklist Card","id":"d3bd37f2-cb32-4f09-9e98-db06228abc85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Blacklist\": {\r\n \"card_id\": {\r\n \"id\": \"49\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/cards/blacklist","description":"

This API is used to add a card to blacklist.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the card which will be added to the blacklist.

This API is used to view all available wiegand format.

This API is used to view a wiegand format detail.

This API is used to view all available smart card layouts.

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[],"_postman_id":"0f612045-4c2f-40d3-b6cc-1508e48fac13"},{"name":"View a Smart Card Layout Details","id":"59ff11c7-c32c-49bb-947e-733242b3e4eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/cards/layouts/:id","description":"

This API is used to view a smart card layout details.

ID of the card layout which will be viewed.

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"59ff11c7-c32c-49bb-947e-733242b3e4eb"},{"name":"Create Smart Card Layout","id":"64173396-9fbf-4b4d-a0f8-c89119365795","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"CardLayout\": {\r\n \"name\": \"smart_test\",\r\n \"use_second_key\": \"false\",\r\n \"number_of_template\": 2,\r\n \"template_size\": 300,\r\n \"mifare_primary_key\": \"\",\r\n \"mifare_start_block_index\": \"4\",\r\n \"mifare_second_key\": \"\",\r\n \"iclass_primary_key\": \"\",\r\n \"iclass_second_key\": \"\",\r\n \"iclass_start_block_index\": \"13\",\r\n \"desfire_primary_key\": \"\",\r\n \"desfire_second_key\": \"\",\r\n \"desfire_app_id\": 1,\r\n \"desfire_file_id\": 1,\r\n \"desfire_encryption_type\": 0,\r\n \"desfire_advanced_mode\": 0,\r\n \"des_adv_app_master_key_index\": \"0\",\r\n \"des_adv_file_read_access_key_index\": \"1\",\r\n \"des_adv_file_write_access_key_index\": \"2\",\r\n \"seos_primary_key\": \"\",\r\n \"seos_second_key\": \"\",\r\n \"seos_adf\": \"2A8570811E1000070000020000\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/cards/layouts","description":"

This API is used to create smart card layout.

Fill the corresponding parameter with the card's specification.

If the card uses default configuration, then simply fill the name and run the API.

This API is used to add a card to BioStar 2.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
card_type:id	Number	Y	Type card id of the card. See \"View All Card Types\" for all type of cards. 0: CSN card 1: Wiegand Card 2: Secure Credential Card (Smart card) 3: Access on Card (Smart card) 4: Mobile CSN Card 5: Wiegand Mobile 6: QR/Barcode 7: BioStar 2 QR
card_type:type	Number	Y	Type allocation of the card type. View the list using /api/cards/types to determine the correct value.
card_id	Number	Y	Input value shown/read when scanning the card.

NOTE:

This API will return error if the card_id is already exist on the database. Use \"Check Card Availability\" API to validate.
\n
As per BioStar 2 version 2.9.4, this API will return an error when generating CSN Card with invalid card id.
Error Code: ACB_ERROR_CODE.415
Cases of invalid card id:
\n
- CSN with card id staring with 0
  \n
- CSN with card id using letters
  \n
- More than 32 characters
  \n
\n

This API is used to add a card to BioStar 2.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
card_type:id	Number	Y	Type card id of the card. See \"View All Card Types\" for all type of cards. 0: CSN card 1: Wiegand Card 2: Secure Credential Card (Smart card) 3: Access on Card (Smart card) 4: Mobile CSN Card 5: Wiegand Mobile 6: QR/Barcode 7: BioStar 2 QR
card_type:type	Number	Y	Type allocation of the card type. View the list using /api/cards/types to determine the correct value.
card_id	Number	Y	Input value recorded on the card.
display_card_id	Number	N	Input value shown/read when scanning the card.
isUserPhoto	Boolean	Y	Toggle true if the credential will be using the user photo (photo must exist)
isDepartment	Boolean	Y	Toggle true if the credential will be using the user department (department field must be filled)
isTitle	Boolean	Y	Toggle true if the credential will be using the user title (title field must be filled).
start_datetime	Date	Y	Start datetime for the credential availability.
expiry_datetime	Date	Y	End datetime for the credential availability.

NOTE:

This API will return error if the card_id is already exist on the database. Use \"Check Card Availability\" API to validate.

For this example, there's no conversion required since the card id already have 35 bit value.

19044429267 > Decimal
100 0110 1111 0010 0010 1110 1101 1101 0011 > Binary (35 Bits)

Just make sure to use format id which doesn't use facility code.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
card_type:id	Number	Y	Type card id of the card. See \"View All Card Types\" for all type of cards. 0: CSN card 1: Wiegand Card 2: Secure Credential Card (Smart card) 3: Access on Card (Smart card) 4: Mobile CSN Card 5: Wiegand Mobile 6: QR/Barcode 7: BioStar 2 QR
card_type:type	Number	Y	Type allocation of the card type. View the list using /api/cards/types to determine the correct value.
card_id	Number	Y	Input value shown/read when scanning the card.
wiegand_format_id:id	Number	Y	If card_type is wiegand, then fill this parameter: 0: 26 bit format 1: HID 37 bit-H10302 2: HID 37 bit-H10304 3: HID Corporate 1000 (35 bit) 4: HID Corporate 1000 (48 bit) 5~14: Custom formats.

NOTE:

This API will return error if the card_id is already exist on the database. Use \"Check Card Availability\" API to validate.

To input card that is using facility code, there's conversion that needs to be done first.

The process is:

Get the Facility Code and Card ID
Convert it to Binary
Combine the binary value of the Facility Code and Card ID
Convert it to Decimal
Use the converted value on card_id parameter
Don't forget to select the corresponding wiegand_format_id

Conversion when The Card is Using Facility Code

\n
E: Even
O: Odd
C: Facility Code
D: ID
\n

26 bit SIA Standard-H10301
Position: 0-25

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	E	CCCCCCCC	DDDDDDDDDDDDDDDD	O
Position	0	1-8	9-24	25

E&O : Not included on the calculation
Bit : 8 bits + 16 bits
Byte: 1 byte + 2 bytes
Hexa: FF + FFFF

Example:
Facility Code + Card ID
20 + 10000 > Decimal
14 + 2710 > Hex
14 2710 > Combined Hex (CH)
1320720 > Converted CH to Decimal. Use this as input

HID 37 bit-H10304
Position: 0-36

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	E	CCCCCCCCCCCCCCCC	DDDDDDDDDDDDDDDDDDD	O
Position	0	1-16	17-35	36

E&O : Not included on the calculation
Bit : 16 bits + 19 bits

Example:
Facility Code + Card ID
43962 + 123456 > Decimal
1010 1011 1011 1010 + 001 1110 0010 0100 0000 > Binary (16 + 19 bits)
1010 1011 1011 1010 0011 1100 0100 1000 000 > Combined Binary (CB)
23048872512 > Converted CB to Decimal. Use this as input

HID Corporate 1000
Position 0-34

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	O	E	CCCCCCCCCCCCCCCC	DDDDDDDDDDDDDDDDDDD	O
Position	0	1	2-13	14-33	34

E&O : Not included on the calculation
Bit : 12 bits + 20 bits

Example:
Facility Code + Card ID
2543 + 1005255 > Decimal
1001 1110 1111 + 1111 0101 0110 1100 0111 > Binary (12 + 20 bits)
1001 1110 1111 1111 0101 0110 1100 0111 > Combined Binary (CB)
2667534023 > Converted CB to Decimal. Use this as input

HID Corporate 1000 (48bit)
Position 0-47

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	O	E	CCCCCCCCCCCCCCCCCCCCCC	DDDDDDDDDDDDDDDDDDDDDDD	O
Position	0	1	2-23	24-46	47

E&O : Not included on the calculation
Bit : 22 bits + 23 bits

Example:
Facility Code + Card ID
2813689 + 4336695
10 1010 1110 1110 1111 1001 + 100 0010 0010 1100 0011 0111 > Binary
1010 1011 1011 1011 1110 0110 0001 0001 0110 0001 1011 1 > Combined Binary (CB)
23602938391607 > Converted CB to Decimal. Use this as input

This API is used to create a secure credential card.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
user_id	Number	Y	User ID of the user which will be using this card and which the biometric will be linked to.
fingerprint_templates:finger_index	Number	N	Fingerprint template of the user.
visual_face_templates	Number	N	Visual face template of the user.
card_id	Number	Y	Card ID which will be displayed and used as record's key.
card_type_id:id	Number	Y	Type of the card which will be created.

Device ID with the corresponding layout set which will be used to write the card.

\n","type":"text/plain"},"type":"any","value":null,"key":"dev_id"}]}},"response":[],"_postman_id":"61ec6074-738d-4e26-a31e-7917e1f9788a"},{"name":"Create Card (Access on Card)","id":"de0dca6c-1975-4215-bff3-bf0e038f63e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SmartCard\": {\r\n \"user_id\": {\r\n \"user_id\": \"8\",\r\n \"fingerprint_templates\": [\r\n {\r\n \"finger_index\": \"0\"\r\n }\r\n ],\r\n \"visual_face_templates\": []\r\n },\r\n \"card_id\": {\r\n \"card_id\": \"8\",\r\n \"card_type_id\": {\r\n \"id\": \"3\"\r\n },\r\n \"use_alphanumeric_user_id\": \"false\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/devices/:dev_id/write_card","description":"

This example shows how to create Access on Card.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
user_id	Number	Y	User ID of the user which will be using this card and which the biometric will be linked to.
fingerprint_templates:finger_index	Number	N	Fingerprint template of the user.
visual_face_templates	Number	N	Visual face template of the user.
card_id	Number	Y	Card ID which will be displayed and recorded on the system. Use the same number as user_id.
card_type_id:id	Number	Y	Type of the card which will be created.
use_alphanumeric_user_id	Boolean	Y	Toggle true if user_id uses alphanumeric setting.

Device ID with the corresponding layout set which will be used to write the card.

\n","type":"text/plain"},"type":"any","value":null,"key":"dev_id"}]}},"response":[],"_postman_id":"de0dca6c-1975-4215-bff3-bf0e038f63e8"},{"name":"Create QR/Barcode","id":"af8d17a7-2b03-4c85-a86c-5115dd9090ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"CardCollection\": {\r\n \"rows\": [\r\n {\r\n \"card_id\": \"1000002\",\r\n \"card_type\": {\r\n \"id\": \"6\",\r\n \"type\" : \"6\"\r\n }\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/cards","description":"

This API is used to add a QR/Barcode to BioStar 2.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
card_type:id	Number	Y	Type card id of the card. See \"View All Card Types\" for all type of cards. 0: CSN card 1: Wiegand Card 2: Secure Credential Card (Smart card) 3: Access on Card (Smart card) 4: Mobile CSN Card 5: Wiegand Mobile 6: QR/Barcode 7: BioStar 2 QR
card_type:type	Number	Y	Type allocation of the card type. View the list using /api/cards/types to determine the correct value.
card_id	Number	Y	Input value shown/read when scanning the card.

NOTES:

This API will return error if the card_id is already exist on the database. Use \"Check Card Availability\" API to validate.
\n
When using card_type with ID 6 (QR), the card_id value must not exceed 32 characters.
\n

This API is used to create BioStar 2 QR.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
card_type:id	Integer	Y	Type card id of the card. See \"View All Card Types\" for all type of cards. 0: CSN card 1: Wiegand Card 2: Secure Credential Card (Smart card) 3: Access on Card (Smart card) 4: Mobile CSN Card 5: Wiegand Mobile 6: QR/Barcode 7: BioStar 2 QR
card_type:type	String	Y	Type allocation of the card type. View the list using /api/cards/types to determine the correct value.
card_id	Integer	Y	Input value shown/read when scanning the card.
user_id	String	Y	ID of the user which the QR will be assigned to.

NOTES:

This API will return error if the card_id is already exist on the database. Use \"Check Card Availability\" API to validate.

This example shows how to create Mobile Card.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
user_id	Number	Y	User ID of the user which will be using this card and which the biometric will be linked to.
fingerprint_templates:finger_index	Number	N	Fingerprint template of the user.
card_id	Number	Y	Card ID which will be displayed and recorded on the system. Use the same number as user_id.
card_type_id:id	Number	Y	Type of the card which will be created.
card_layout_id:id	Number	Y	Layout ID for Mobile Credential which have been created.
options:is_a_mobile_credential	Boolean	Y	Toggle true if the card is Mobile Credential.

This API is used to remove the written smart card data from a Smart Card.

Device ID with the corresponding layout set which will be used to write the card.

\n","type":"text/plain"},"type":"any","value":null,"key":"dev_id"}]}},"response":[],"_postman_id":"032b3449-4800-4493-917a-9f7003f4e801"},{"name":"Send BioStar 2 QR by Email","id":"a61842b7-a76e-4057-a45f-2bd5236b45e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"1\",\r\n \"language\": \"en\",\r\n \"card_collection\": [\r\n {\r\n \"id\": \"10072\",\r\n \"card_id\": \"3045804110617690774352189081668890\",\r\n \"display_card_id\": \"165113371684849\",\r\n \"card_type\": {\r\n \"id\": \"7\",\r\n \"name\": \"SCQr\",\r\n \"type\": \"7\"\r\n }\r\n }\r\n ],\r\n \"total\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/send_email_qr","description":"

This API is used to send BioStar 2 QR by email.

Before using this API, make sure that:

SMTP is set
User email field is filled

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the user which the QR code applied to and the email will be sent to.
language	String	Y	ko=Korean, en=English
card_collection:id	Number	Y	ID of the QR which will be sent to the user email.
card_collection:card_id	Number	Y	ID of the card as recorded on BioStar 2 database.
card_collection:display_card_id	Number	Y	ID which will be shown when scanning/reading the card.
card_type:id	Number	Y	ID for the card type.
card_type:name	String	Y	Name of the card type.
card_type:type	Number	Y	Type code of the card type.
total	Number	Y	Total of the card.

This API is used to send Visual Face mobile enrollment link.

Body Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	String	Y	User ID
language	String	Y	Language which will be used. ko : Korean en : English ja : Japanese
adv_criteria	Object	Y	See Batch Edit with Advanced Search for adv_criteria details.

Changes:

v2.9.8:
\n
- Added adv_critera in Body Parameter
\n

This API is used to list all User Groups.

This API is used to list User Group(s) which specified on the Body parameter.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
user_group_id_list	Array	N	Specify User Group ids which will be viewed. Use comma (,) as separator.

This API is used to create a new User Group.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
parent_id:id	Number	Y	Parent ID of the new User Group.
depth	Number	N	Depth of the User Group based on the parent.
name	String	Y	Name of the User Group.

User groups may be created in up to 8 levels.
Up to 48 characters may be entered for a user group name.

This API is used to update a User Group.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
UserGroup:name	String	Y	Specify new name of the User Group.

Id of the User Group which will be updated.

\n","type":"text/plain"},"type":"any","value":"21436","key":"id"}]}},"response":[],"_postman_id":"84438b8f-00c5-40bb-aa1d-b8face754823"},{"name":"Delete UG","id":"ccaf91e8-2a31-4a12-a639-acbbe66b47ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/user_groups?id=21436","description":"

This API is used to delete a User Group.

Id of the User Group which will be deleted.

\n","type":"text/plain"},"key":"id","value":"21436"}],"variable":[]}},"response":[],"_postman_id":"ccaf91e8-2a31-4a12-a639-acbbe66b47ef"}],"id":"68728792-a42e-4da3-b19d-5b27686df22d","event":[{"listen":"prerequest","script":{"id":"61cbfe2c-68cf-4e3e-b5c9-cebaed2dfd9d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3bbf1fdc-7fbf-422e-b336-54f96c72fda9","type":"text/javascript","exec":[""]}}],"_postman_id":"68728792-a42e-4da3-b19d-5b27686df22d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"User","item":[{"name":"Find Next Available UserID","event":[{"listen":"test","script":{"id":"9e003e5c-2428-408a-82b3-ab3f5d8e98da","exec":["const jsonData = pm.response.json();\r","pm.collectionVariables.set(\"nuid\", jsonData.User.user_id);"],"type":"text/javascript"}}],"id":"5d8320c0-a817-4ce9-948c-c3781e4e34c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/users/next_user_id","description":"

This API returns the next available user ID based on the currently assigned user IDs. If user IDs are numeric, the response will be the next sequential number. If alphanumeric user IDs are enabled, the API will only consider numeric user IDs and return the next available numeric value.

If the currently used user IDs are 1, 2, 3, the API response will be 4.
\n
If user ID type is configured to alphanumeric, but existing IDs are 1, 2, 3, x4, 4x, the response will still be 4 (since \"x4\" and \"4x\" are ignored).
\n

Notes:

The API automatically filters out non-numeric user IDs when alphanumeric mode is enabled.
\n
This does not create a new user ID, only suggests the next available one.
\n

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
User.user_id	String	The next available user ID.

This API is used to create a new user.

BODY parameters:

Parameters	Type	Required	Description
user_id	String	Y	ID of the User. Unique. When User ID Type in Setting > Server is set to Number, a number between 1 and 4294967295 can be entered. When Alphanumeric is set, a combination of alphabetic characters and numbers can be entered. Do not use spaces when entering ID. Numbers or Alphanumeric characters can be set for user_id. For more details, refer to Setting Section of this documentation.
name	String	N	Name of the user. Up to 48 characters.
user_group_id	Number	Y	ID of the User Group that the user will be under. Refer to User Group Section of this documentation for listing available User Groups.
disabled	Boolean	N	Toggle User active or not; false for active, true for non-active.
start_datetime	Date/Time	Y	Start active period for the User. The earliest allowable value is 2001-01-01 00:00.
expiry_datetime	Date/Time	Y	End active period for the User. Value can not exceed 2037-12-31 23:59.
email	String	N	Email address of the User.
department	String	N	Department of the User. Up to 64 characters.
user_title	String	N	Title of the User.
photo	Base64	N	Photo of the User.
phone	String	N	Phone number of the User.
permission	Number	N	Operator Level of the User. Use View User by Account Level (GET /api/permissions) to view the list of available Operator Level and its ID). None: The user has no operator privilege. To use this Operator Level, remove permission parameter from the API Request. Administrator: The user can use all menus. User Operator: The user can only use the USER and PREFERENCE menus. Monitoring Operator: The user can use the MONITORING and PREFERENCE menus and only view the DASHBOARD, USER, DEVICE, DOOR, ZONE and ACCESS CONTROL menus. Video Operator: The user can only use the VIDEO menu. T&A Operator: The user can only use the TIME ATTENDANCE menu and only view the USER menu. User: The user can only view own information and T&A records.
access_groups	Number	N	ID of the Access Group that the User will have access. Refer to Access Group Section of this documentation for listing available Access Groups. Can enter more than 1 Access Group.
login_id	String	N	Required when permission parameter is not removed.
password	String	N	Required when permission parameter is not removed.
user_ip	String	N	Limit the access of the User so he/she can only login from the registered IP Address. The user IP can be entered in the format xxx.xxx.xxx.xxx. Each octet can only be entered in numbers between 0 and 255. Users whose user IP is not registered can log in from any IP.
pin	Number	N	PIN of the user. Maximum 32 digit.

When Setting > Server is set to Number, you can make use of endpoint /api/users/next_user_id to automatically get the next user_id. Refer to GET Find Next Available UserID for the detail of this endpoint.

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
total	String	Total of created user
user_id	String	Created user's ID
name	String	Created user's name

Known errors:

name is more than 48 characters
\n
Using single quote on name
\n
Duplicate user_id, email, or login_id
\n
Empty user_id, user_group_id, start_datetime, expiry_datetime
\n
Using user_group_id:id which doesn't exist
\n
Putting \"/\" at the end of the endpoint
\n
Password with 3 or more subsequent letter or number
\n

This API can be used starting from BioStar 2 version 2.9.8.

It is used to create multiple users at once.

Things to be noted when using this API:

Parameters which can be used is the same as when creating a user (see Create New User)
\n
user_id should be unique.
\n
To add a user credential using this API, you must create the credential and include the credential ID in the body.
\n
Because syncing users to their devices takes time, it is recommended to add less than 30 users at a time.
\n

This API can be used starting from BioStar 2 version 2.9.8.

This example is to show how to create a new user with File Upload.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
custom_field.id	Number	*Y	ID of the Custom Field which will be inserted.
item	String	*Y	Filename
size	Number	*Y	Filesize
document	String	*Y	File in Base64 format
mimetype	String	*Y	Mimetype document of a file extension for example, TXT = text/plain, JSON = application/json

Notes:

*Y: Required if a file needs to be uploaded to the File Upload Custom Field.
\n
custom_field.id can be inferred by using List Available Custom Field(s)
\n
File need to be converted to Base64 format to upload.
\n

Response Example:

{\n    \"UserCollection\": {\n        \"total\": \"1\",\n        \"rows\": [\n            {\n                \"user_id\": \"401\",\n                \"name\": \"Ba - sing\"\n            }\n        ]\n    },\n    \"Response\": {\n        \"code\": \"0\",\n        \"link\": \"https://support.supremainc.com/en/support/home\",\n        \"message\": \"Success\"\n    }\n}\n\n

This API is used to update a user.

BODY Parameters:

Parameters	Type	Required	Description
user_id	String	Y	ID of the User. Unique. When User ID Type in Setting > Server is set to Number, a number between 1 and 4294967295 can be entered. When Alphanumeric is set, a combination of alphabetic characters and numbers can be entered. Do not use spaces when entering ID. Numbers or Alphanumeric characters can be set for user_id. For more details, refer to Setting Section of this documentation.
name	String	N	Name of the user. Up to 48 characters.
user_group_id	Number	Y	ID of the User Group that the user will be under. Refer to User Group Section of this documentation for listing available User Groups.
disabled	Boolean	N	Toggle User active or not; false for active, true for non-active.
start_datetime	Date/Time	Y	Start active period for the User.
expiry_datetime	Date/Time	Y	End active period for the User.
email	String	N	Email address of the User.
department	String	N	Department of the User. Up to 64 characters.
user_title	String	N	Title of the User.
photo	Base64	N	Photo of the User.
phone	String	N	Phone number of the User.
permission	Number	N	Operator Level of the User. Use View User by Account Level (GET /api/permissions) to view the list of available Operator Level and its ID). None: The user has no operator privilege. To use this Operator Level, remove permission parameter from the API Request. Administrator: The user can use all menus. User Operator: The user can only use the USER and PREFERENCE menus. Monitoring Operator: The user can use the MONITORING and PREFERENCE menus and only view the DASHBOARD, USER, DEVICE, DOOR, ZONE and ACCESS CONTROL menus. Video Operator: The user can only use the VIDEO menu. T&A Operator: The user can only use the TIME ATTENDANCE menu and only view the USER menu. User: The user can only view own information and T&A records.
access_groups	Number	N	ID of the Access Group that the User will have access. Refer to Access Group Section of this documentation for listing available Access Groups. Can enter more than 1 Access Group.
login_id	String	N	Required when permission parameter is not removed.
password	String	N	Required when permission parameter is not removed.
user_ip	String	N	Limit the access of the User so he/she can only login from the registered IP Address. The user IP can be entered in the format xxx.xxx.xxx.xxx. Each octet can only be entered in numbers between 0 and 255. Users whose user IP is not registered can log in from any IP.
pin	Number	N	PIN of the user. Maximum 32 digit.
isExludeSyncADUser	Number	N	1: User will be excluded from AD or EntraID sync.

When Setting > Server is set to Number, you can make use of endpoint /api/users/next_user_id to automatically get the next user_id. Refer to GET Find Next Available UserID for the detail of this endpoint.

Known errors:

name is more than 48 characters
\n
Using single quote on name
\n
Duplicate user_id, email, or login_id
\n
Empty user_id, user_group_id, start_datetime, expiry_datetime
\n
Using user_group_id:id which doesn't exist
\n
Putting \"/\" at the end of the endpoint
\n
Password with 3 or more subsequent letter or number
\n
Start and expiry date difference is more than 30 years
\n

Changes:

v2.9.9:
\n
- Added 'isExludeSyncADUser' parameter
\n

This API is used for updating user information in bulk.

This API can be used from BioStar 2 version 2.9.6 onwards.

The difference of this API and /api/users?id=1+2+3 is that this API can update different data of many users at the same time.

Warning: The maximum number of users that can be modified in a single API call is 100.

BODY Parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
user_id	String	Y	User ID of the user. This will be used as the update target.

All user information parameters in /api/users are included.

Response Example:

{\n    \"UserCollection\": {\n        \"rows\": [\n            {\n                \"user_id\": \"3\",\n                \"ret_code\": \"0\"\n            },\n            {\n                \"user_id\": \"2\",\n                \"ret_code\": \"224\"\n            },\n            {\n                \"user_id\": \"1\",\n                \"ret_code\": \"0\"\n            }\n        ]\n    },\n    \"Response\": {\n        \"code\": \"1\",\n        \"link\": \"https://support.supremainc.com/en/support/home\",\n        \"message\": \"Request is successful, but partially\"\n    }\n}\n\n

Response Code:

ret_code presents BioStar 2 response code for modifying each user. The meaning on each code is explained on [BioStar 2 Install Path]\\nginx\\html\\resources\\messages_en.

For example ret_code 224, find the number in the properties file: ACB_ERROR_CODE.224 = Cannot use the same previous PW.

\"Response.code\" could be 0, 1, 8.

0 : Overall success.
\n
1 : Partial success
\n
8 : Overall failed.
\n

HTTP Response Code:

200 OK : Overall success, partial success or overall failed.
\n
500 Internal Server Error: An unexpected error occurred on the server.
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}},"urlObject":{"path":["api","users","bulk"],"host":["https://127.0.0.1"],"query":[],"variable":[]}},"response":[{"id":"f1c0b5f3-a3c3-4b7e-bb28-39c243b0f5a8","name":"User: Bulk Update (Success update 100 users)","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"UserCollection\": {\r\n \"rows\": [\r\n {\r\n \"user_id\": \"50\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"51\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"52\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"53\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"54\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"55\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"56\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"57\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"58\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"59\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"60\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"61\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"62\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"63\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"64\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"65\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"66\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"67\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"68\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"69\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"70\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"71\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"72\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"73\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"74\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"75\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"76\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"77\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"78\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"79\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"80\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"81\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"82\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"83\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"84\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"85\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"86\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"87\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"88\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"89\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"90\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"91\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"92\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"93\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"94\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"95\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"96\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"97\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"98\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"99\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"100\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"101\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"102\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"103\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"104\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"105\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"106\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"107\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"108\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"109\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"110\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"111\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"112\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"113\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"114\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"115\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"116\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"117\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"118\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"119\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"120\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"121\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"122\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"123\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"124\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"125\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"126\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"127\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"128\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"129\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"130\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"131\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"132\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"133\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"134\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"135\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"136\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"137\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"138\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"139\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"140\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"141\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"142\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"143\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"144\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"145\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"146\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"147\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"148\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"149\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"3385"},{"key":"Date","value":"Tue, 25 Feb 2025 03:50:05 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"UserCollection\": {\n \"rows\": [\n {\n \"user_id\": \"50\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"51\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"52\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"53\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"54\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"55\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"56\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"57\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"58\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"59\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"60\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"61\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"62\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"63\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"64\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"65\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"66\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"67\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"68\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"69\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"70\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"71\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"72\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"73\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"74\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"75\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"76\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"77\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"78\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"79\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"80\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"81\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"82\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"83\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"84\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"85\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"86\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"87\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"88\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"89\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"90\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"91\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"92\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"93\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"94\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"95\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"96\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"97\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"98\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"99\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"100\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"101\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"102\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"103\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"104\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"105\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"106\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"107\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"108\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"109\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"110\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"111\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"112\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"113\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"114\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"115\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"116\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"117\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"118\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"119\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"120\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"121\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"122\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"123\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"124\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"125\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"126\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"127\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"128\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"129\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"130\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"131\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"132\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"133\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"134\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"135\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"136\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"137\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"138\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"139\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"140\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"141\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"142\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"143\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"144\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"145\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"146\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"147\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"148\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"149\",\n \"ret_code\": \"0\"\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"},{"id":"53f5165d-e2b9-4aa2-88f5-1cf467c274ec","name":"User: Bulk Update (Error when user is more than 100)","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"UserCollection\": {\r\n \"rows\": [\r\n {\r\n \"user_id\": \"50\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"51\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"52\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"53\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"54\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"55\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"56\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"57\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"58\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"59\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"60\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"61\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"62\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"63\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"64\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"65\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"66\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"67\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"68\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"69\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"70\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"71\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"72\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"73\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"74\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"75\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"76\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"77\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"78\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"79\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"80\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"81\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"82\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"83\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"84\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"85\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"86\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"87\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"88\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"89\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"90\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"91\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"92\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"93\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"94\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"95\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"96\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"97\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"98\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"99\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"100\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"101\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"102\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"103\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"104\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"105\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"106\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"107\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"108\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"109\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"110\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"111\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"112\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"113\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"114\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"115\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"116\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"117\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"118\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"119\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"120\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"121\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"122\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"123\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"124\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"125\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"126\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"127\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"128\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"129\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"130\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"131\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"132\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"133\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"134\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"135\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"136\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"137\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"138\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"139\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"140\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"141\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"142\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"143\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"144\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"145\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"146\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"147\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"148\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"149\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"150\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n },\r\n {\r\n \"user_id\": \"151\",\r\n \"user_group_id\": {\r\n \"id\": \"11027\"\r\n }\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"400 Bad Request"},{"key":"Set-Cookie","value":"JSESSIONID=F61AB7ED1956FEFEDEE65A820BF075EC; Path=/; Secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"128"},{"key":"Date","value":"Tue, 25 Feb 2025 03:41:02 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {\n \"code\": \"700\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Failed to parse json data.\"\n }\n}"}],"_postman_id":"aef3856a-2591-4e76-bb66-1560cc5d0ac7"},{"name":"User: Fill Custom Field","event":[{"listen":"prerequest","script":{"id":"8d98be47-f88b-41c7-b763-b73c0f51e4a0","exec":[""],"type":"text/javascript"}}],"id":"18dad3f6-6d63-408e-9717-5d655f53d810","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"user_custom_fields\": [\r\n {\r\n \"item\": \"Combo option 1\",\r\n \"custom_field\": {\r\n \"id\": \"1\"\r\n }\r\n },\r\n {\r\n \"item\": \"Text input here\",\r\n \"custom_field\": {\r\n \"id\": \"2\"\r\n }\r\n },\r\n {\r\n \"item\": \"134669\",\r\n \"custom_field\": {\r\n \"id\": \"3\"\r\n }\r\n },\r\n {\r\n \"custom_field\": {\r\n \"id\": \"5\"\r\n },\r\n \"item\": \"ACCOUNTS.TXT\",\r\n \"size\": 5768,\r\n \"document\": \"U1c1IGlzIHRoZSBiZXN0IGRldmVsb3Blcg==\",\r\n \"mimetype\": \"text/plain\"\r\n } \r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/:id","description":"

Use GET /api/setting/custom_fields (here) to view available Custom Fields.

There are 4 types of Custom Fields: Text Input, Number Input, Combo Box and File Upload. Text Input and Combo Box will accept any value, and Number Input will only receive number.

Body Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
item	String	N	Content of the Custom Field
custom_field:id	Number	Y	ID of the Custom Field (This does NOT represent the Custom Field's type)
item	String	*Y	Filename
size	Number	*Y	Filesize
document	String	*Y	File in Base64 format
mimetype	String	*Y	Mimetype document of a file extension for example, TXT = text/plain, JSON = application/json

Notes:

If an API request using the PUT method does not include a Custom Field in the Body, its value will be removed.
\n
To delete a file from a File Upload Custom Field, trigger the API using PUT and omit the respective File Upload Custom Field's ID from the request body. Do note this will also remove the file from the system permanently.
\n

Response Example:

{\n    \"Response\": {\n        \"code\": \"0\",\n        \"link\": \"https://support.supremainc.com/en/support/home\",\n        \"message\": \"Success\"\n    }\n}\n\n

Changes:

v2.9.8:
\n
- Added Custom Field File Upload
\n

ID of the user which will be updated

\n","type":"text/plain"},"type":"any","value":"3","key":"id"}]}},"response":[{"id":"86d94ce8-50b8-43aa-a9d6-2e36a280debf","name":"User: Fill Custom Field (Text Input Box)","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"user_custom_fields\": [\r\n {\r\n \"item\": \"Your input here\",\r\n \"custom_field\": {\r\n \"id\": \"2\"\r\n }\r\n } \r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://127.0.0.1/api/users/:id","host":["https://127.0.0.1"],"path":["api","users",":id"],"variable":[{"key":"id","value":"4","description":"ID of the user which will be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"107"},{"key":"Date","value":"Mon, 17 Feb 2025 06:25:24 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"},{"id":"92d97455-6b0c-4172-9e28-8013671bc8b1","name":"User: Fill Custom Field (Number Input)","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"user_custom_fields\": [\r\n {\r\n \"item\": \"123456\",\r\n \"custom_field\": {\r\n \"id\": \"3\"\r\n }\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://127.0.0.1/api/users/:id","host":["https://127.0.0.1"],"path":["api","users",":id"],"variable":[{"key":"id","value":"4","description":"ID of the user which will be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"107"},{"key":"Date","value":"Mon, 17 Feb 2025 06:32:38 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"},{"id":"0d8c42dc-0e7b-43c4-932a-0c0414507d78","name":"User: Fill Custom Field (Combo Box)","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"user_custom_fields\": [\r\n {\r\n \"item\": \"Option 2\",\r\n \"custom_field\": {\r\n \"id\": \"4\"\r\n }\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://127.0.0.1/api/users/:id","host":["https://127.0.0.1"],"path":["api","users",":id"],"variable":[{"key":"id","value":"4","description":"ID of the user which will be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"107"},{"key":"Date","value":"Mon, 17 Feb 2025 06:36:37 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"},{"id":"1c4cf88f-a429-4fd3-b7bf-2046975bc59a","name":"User: Fill Custom Field (File Upload)","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"user_custom_fields\": [\r\n {\r\n \"custom_field\": {\r\n \"id\": \"5\"\r\n },\r\n \"item\": \"ACCOUNTS.TXT\",\r\n \"size\": 5768,\r\n \"document\": \"U1c1IGlzIHRoZSBiZXN0IGRldmVsb3Blcg==\",\r\n \"mimetype\": \"text/plain\"\r\n } \r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://127.0.0.1/api/users/:id","host":["https://127.0.0.1"],"path":["api","users",":id"],"variable":[{"key":"id","value":"4","description":"ID of the user which will be updated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Status","value":"200 OK"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Content-Length","value":"107"},{"key":"Date","value":"Mon, 17 Feb 2025 06:39:38 GMT"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}"}],"_postman_id":"18dad3f6-6d63-408e-9717-5d655f53d810"},{"name":"User Credential: Misc (Include Device Default Authentication Mode)","event":[{"listen":"prerequest","script":{"id":"70b51861-f9d6-46b0-b97b-34b1b9e74d47","exec":[""],"type":"text/javascript"}}],"id":"e650d38e-5a14-4a65-a6d2-39e61405ab70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"pin\": \"\",\r\n \"security_level\": 0,\r\n \"private_operation_modes\": [\r\n {\r\n \"operation_method\": 2,\r\n \"operation_mode\": 0,\r\n \"exclude\": false\r\n },\r\n {\r\n \"operation_method\": 2,\r\n \"operation_mode\": 1,\r\n \"exclude\": false\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/:id","description":"

On this example you can see how to use stated parameters to adjust misc. credential values.

Parameters on this example:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
pin	Number	N	PIN of the User
security_level	Number	N	To set the security level of the credential. The higher the security level is set, the false rejection rate (FRR) gets higher, but the false acceptance rate (FAR) gets lower. Acceptable value: 0 to 5
private_operation_modes
:operation_method	Number		The first credential of an Authentication Mode (0: ID, 1: Card, 2: Fingerprint/Biometric (Standard), 3: Face)
:operation_mode	Number		Authentication Mode combination (see below for reference, \"-1\" = do not use)
:exclude	Boolean		If Include Device Default Authentication Mode option is on, so when you want to also follow the Auth Modes that the devices have, “private_operation_modes” will have same number of elements that you actually configured. But if Exclude Device Default Authentication Mode is on, you need to add four or more elements because all the values of “operation_method” should be included to override device’s Auth Modes.

Authentication Mode Combination Table:

Value	Code	Description	Type
0	BS2_AUTH_MODE_BIOMETRIC_ONLY	Biometric only	Standard
1	BS2_AUTH_MODE_BIOMETRIC_PIN	Biometric + PIN	Standard
2	BS2_AUTH_MODE_CARD_ONLY	Card only	Standard
3	BS2_AUTH_MODE_CARD_BIOMETRIC	Card + Biometric	Standard
4	BS2_AUTH_MODE_CARD_PIN	Card + PIN	Standard
5	BS2_AUTH_MODE_CARD_BIOMETRIC_OR_PIN	Card + Biometric or PIN	Standard
6	BS2_AUTH_MODE_CARD_BIOMETRIC_PIN	Card + Biometric + PIN	Standard
7	BS2_AUTH_MODE_ID_BIOMETRIC	ID + Biometric	Standard
8	BS2_AUTH_MODE_ID_PIN	ID + PIN	Standard
9	BS2_AUTH_MODE_ID_BIOMETRIC_OR_PIN	ID + Biometric or PIN	Standard
10	BS2_AUTH_MODE_ID_BIOMETRIC_PIN	ID + Biometric + PIN	Standard
11	BS2_EXT_AUTH_MODE_FACE_ONLY	Face	Extended
12	BS2_EXT_AUTH_MODE_FACE_FINGERPRINT	Face + Fingerprint	Extended
13	BS2_EXT_AUTH_MODE_FACE_PIN	Face + PIN	Extended
14	BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_OR_PIN	Face + Fingerprint/PIN	Extended
15	BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_PIN	Face + Fingerprint + PIN	Extended
16	BS2_EXT_AUTH_MODE_FINGERPRINT_ONLY	Fingerprint	Extended
17	BS2_EXT_AUTH_MODE_FINGERPRINT_FACE	Fingerprint + Face	Extended
18	BS2_EXT_AUTH_MODE_FINGERPRINT_PIN	Fingerprint + PIN	Extended
19	BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_OR_PIN	Fingerprint + Face/PIN	Extended
20	BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_PIN	Fingerprint + Face + PIN	Extended
21	BS2_EXT_AUTH_MODE_CARD_ONLY	Card	Extended
22	BS2_EXT_AUTH_MODE_CARD_FACE	Cardn + Face	Extended
23	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT	Card + Fingerprint	Extended
24	BS2_EXT_AUTH_MODE_CARD_PIN	Card + PIN	Extended
25	BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT	Card + Face/Fingerprint	Extended
26	BS2_EXT_AUTH_MODE_CARD_FACE_OR_PIN	Card + Face/PIN	Extended
27	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_OR_PIN	Card + Fingerprint/PIN	Extended
28	BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_OR_PIN	Card + Face/Fingerprint/PIN	Extended
29	BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT	Card + Face + Fingerprint	Extended
30	BS2_EXT_AUTH_MODE_CARD_FACE_PIN	Card + Face + PIN	Extended
31	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE	Card + Fingerprint + Face	Extended
32	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_PIN	Card + Fingerprint + PIN	Extended
33	BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_PIN	Card + Face/Fingerprint + PIN	Extended
34	BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT_OR_PIN	Card + Face + Fingerprint/PIN	Extended
35	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE_OR_PIN	Card + Fingerprint + Face/PIN	Extended
36	BS2_EXT_AUTH_MODE_ID_FACE	ID + Face	Extended
37	BS2_EXT_AUTH_MODE_ID_FINGERPRINT	ID + Fingerprint	Extended
38	BS2_EXT_AUTH_MODE_ID_PIN	ID + PIN	Extended
39	BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT	ID + Face/Fingerprint	Extended
40	BS2_EXT_AUTH_MODE_ID_FACE_OR_PIN	ID + Face/PIN	Extended
41	BS2_EXT_AUTH_MODE_ID_FINGERPRINT_OR_PIN	ID + Fingerprint/PIN	Extended
42	BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT_OR_PIN	ID + Face/Fingerprint/PIN	Extended
43	BS2_EXT_AUTH_MODE_ID_FACE_FINGERPRINT	ID + Face + Fingerprint	Extended
44	BS2_EXT_AUTH_MODE_ID_FACE_PIN	ID + Face + PIN	Extended
45	BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE	ID + Fingerprint + Face	Extended
46	BS2_EXT_AUTH_MODE_ID_FINGERPRINT_PIN	ID + Fingerprint + PIN	Extended
47	BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT_PIN	ID + Face/Fingerprint + PIN	Extended
48	BS2_EXT_AUTH_MODE_ID_FACE_FINGERPRINT_OR_PIN	ID + Face + Fingerprint/PIN	Extended
49	BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE_OR_PIN	ID + Fingerprint + Face/PIN	Extended

As stated on previous example (User Credential: Misc (Include Device Default Authentication Mode)), when you want to use Exclude Device Default Authentication Mode then you need to state all values of the Authentication Method.

On this example, the Authentication Mode that's being used is Biometric (operation_method: 2) only (operation_mode: 0) and the other Authentication Method: ID (0), Card (1), and Face (3) are set as do not use (operation_mode: -1) and hidden (exclude: true)

To use Extended Auth Mode simply use code that starts from 11 (refer to Authentication Mode Combination Table on User Credential: Misc (Include Device Default Authentication Mode)), do note that this mode only supported by FaceStation F2.

This example shows how to assign a card to a User, which is applicable to CSN, Wiegand, Smart, Mobile, and QR/Barcode.

First the card must be enrolled to the database by using POST /api/cards.

After enrolled, use GET /api/cards to view all Cards or GET /api/cards/unassigned to view all Cards which are unassigned.

Select a card from the response and apply it on the body as shown on the example to assign it to the selected user.

This example shows how to update fingerprint data on a User.

The BODY parameters as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
fingerprint_templates
:finger_mask	Boolean	N	Set to True to mark the fingerprint as a duress fingerprint. When threatened by someone to open the door, the user can authenticate using this fingerprint to send an alarm signal to BioStar 2.
:template0	Raw	Y	First scan template of the fingerprint
:template1	Raw	Y	Second scan template of the fingerprint
:isNew	Boolean	N

Use POST /api/devices/:dev_id/scan_fingerprint to enroll fingerprint
Use POST /api/server_matching/identify_finger to check whether the fingerprint already recorded or not.

Raw data for template0 and template1 available after enrolling a fingerprint.
\n
Fingerprint(s) used for regular access should not be registered as duress fingerprint.
\n
If the fingerprint authentication rate is low, delete the existing fingerprint information and add a new fingerprint.
\n
Use an adequate security level. If 1:1 Security Level is too high, the fingerprint authentication rate may be too low or the false rejection rate (FRR) may be too high.
\n
For best fingerprint scanning quality, make sure to cover the entire surface of the fingerprint sensor with the finger.
\n

This example shows how to add a Face Credential on a User.

You can add the user's faces if the device supports face authentication.

When registering a face, maintain a distance of 40cm to 80cm between the device and the face.
Be careful not to change the facial expression. (smiling face, drawn face, wink, etc.)
If you do not follow the instructions on the screen, the face registration may take longer or may fail.
Be careful not to cover the eyes or eyebrows.
Do not wear hats, masks, sunglasses or eyeglasses.
Be careful not to display two faces on the screen. Register one person at a time.
It is recommended for a user wearing glasses to register both faces with and without glasses.

Parameters on this example:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
faces	Array	Y	Main container of the credential
:raw_image	Raw	Y	Raw image of the face scan
:templates	Array	Y	Container of the face templates
::template	Raw	Y	Face template of the User

To get data for parameter raw_image and template, use GET /api/devices/:device_id/credentials/face

Use POST /api/v2/devices/search to list all device which can support the selected credentials. See API documentation for details on the usage of the API.

When updating a User, it is required to put the credential data as acquired from GET /api/users/:id
This is done so the data won't be lost after update.

To delete a Face, skip the parameters on using this API.

You can use raw_image value as value on photo parameter of a User.

Visual Face is a credential that captures the user's face with a visual camera. It is different from face information captured with an infrared camera and is only available on devices that support Visual Face.

There are two ways to input a Visual Face: by scanning through a enrollment device, or by uploading an image.

Up to 2 visual faces can be added.
Use GET /api/devices/:device_id/credentials/face to scan Visual Face using an enrollment device.

You can enroll a visual face using FaceStation F2.
Use POST /api/v2/devices/search to list compatible devices.

To upload image as a Visual Face: image file size is up to 10MB and supported file formats are JPG, JPEG and PNG.
Use PUT /api/users/check/upload_picture to check whether the image is suitable for use or not.
BODY example on using Upload Picture:

{\n\"User\": {\n \"credentials\": {\n  \"visualFaces\": [{\n   \"template_ex_picture\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/ Truncated\"\n  }]\n }}\n}\n\n

Parameters on this example:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
visualFaces	Array	Y	Main container of Visual Face credential
:template_ex_normalized_image	Base64	Y	Cropped image ready for visual face extraction.
:templates	Array	Y	Container of the templates
::credential_bin_type	Number	Y	UNKNOWN = -1 FACE_TEMPLATE = 0 FACE_TEMPLATE_IMAGE = 1 FACE_RAW_IMAGE = 2 FACE_TEMPLATE_EX_VER_2 = 5 (For FaceStation F2) FACE_TEMPLATE_EX_VER_3 = 9 (For BioStation 3 and W3) FACE_TEMPLATE_EX_NORMALIZED = 7 FACE_TEMPLATE_EX_PICTURE = 8
::template_ex	Raw	Y	Visual Face template data which includes FaceStation F2 and the new BioStation 3.
:template_ex_picture	Base64	Y	Parameter for Upload Picture raw data

Changes:

v2.9.6:
\n
- templateEx changed to template_ex
  \n
- templateExIr removed since it's not used anymore
  \n
- Added credential_bin_type: FACE_TEMPLATE_EX_VER2 and FACE_TEMPLATE_EX_VER_3
  \n
\n

This API is used to check whether the image that will be uploaded on Visual Face credential is according to specification or not.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
template_ex_picture	Base64	Y	Image that will be checked

Supported image file size is up to 10MB.
Supported image file formats are JPG, JPEG and PNG.

This API is used to delete user(s) from BioStar 2 database.

Known errors:

Empty parameter id
Using id which doesn't exist

ID of the User which will be deleted. To delete multiple Users, use plus (+) sign as separator of each User ID. Ex: 1001+1002+1003+1004\nUse GET /api/users to list available users

\n","type":"text/plain"},"key":"id","value":"101"}],"variable":[]}},"response":[],"_postman_id":"df2f5868-efb3-4eeb-9eef-2aa07c01797f"},{"name":"Delete User(s) with Advanced Search","event":[{"listen":"prerequest","script":{"id":"27bffb83-4043-49fa-ab21-001635f145b8","exec":["//batch delete\r","/*\r","var currentCount = pm.collectionVariables.get('nLoop');\r","if (currentCount > 203){\r"," currentCount = parseInt(currentCount)-1;\r"," pm.collectionVariables.set('nLoop', currentCount);\r"," }*/\r","\r","/* batch delete subsequent users\r","var text =\"\";\r","var i = 9001;\r","for (; i <= 9973; i++) {\r"," text += i + \"+\";\r","}\r","text = text.slice(0, -1); \r","pm.collectionVariables.set('nLoop',text);\r","*/\r","\r","pm.iterationData.get(\"iterIDVal\")"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"014f0771-1909-4b0e-9a34-e26854e306a8","exec":[""],"type":"text/javascript","packages":{}}}],"id":"5709adb8-cc2a-4c60-b1f0-c4387fcc0e8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"adv_criteria\": {\r\n \"limit\": 50,\r\n \"order_by\": \"user_id:false\",\r\n \"user_group_ids\": [\r\n 1121\r\n ],\r\n \"user_id\": \"11\",\r\n \"user_email\": \"abc@gmail.com\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/advance_search/delete?adv=mode1","description":"

This API is used to delete user(s) which is collected from Advanced Search query.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
adv_criteria	Object	Y	See Batch Edit with Advanced Search for adv_criteria details.

Response Example:

{\n  \"Response\" : {\n    \"code\" : \"0\",\n    \"link\" : \"https://support.supremainc.com/en/support/home\",\n    \"message\" : \"Success\"\n  }\n}\n\n

Use this to enable Advanced Search query result.

\n","type":"text/plain"},"key":"adv","value":"mode1"}],"variable":[]}},"response":[],"_postman_id":"5709adb8-cc2a-4c60-b1f0-c4387fcc0e8c"},{"name":"Send User Data to Device","event":[{"listen":"prerequest","script":{"id":"ddd345d0-77d9-450c-891c-2e1f5209e810","exec":[""],"type":"text/javascript"}}],"id":"8c455d14-9445-4930-ac33-aca9fd8a6cb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DeviceCollection\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"543720368\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/export?overwrite=true&id=15&adv=mode1","description":"

This API is used to send user data to a device.

For example when you want to send user John data after credential update to FaceStation F2.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the device

Response Example:

{\n  \"DeviceResponse\" : {\n    \"rows\" : [ {\n      \"id\" : \"50362288\",\n      \"code\" : \"0\"\n    } ],\n    \"result\" : \"true\"\n  },\n  \"Response\" : {\n    \"code\" : \"0\",\n    \"link\" : \"https://support.supremainc.com/en/support/home\",\n    \"message\" : \"Success\"\n  }\n}\n\n

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
DeviceResponse	Object	Response from device
DeviceResponse.rows	Array	List of device ID
DeviceResponse.result	Boolean	Indicate success or fail
Response	Object	Indicate success or fail

Changes:

v2.9.8:
\n
- Added adv=mode1 on Query Parameter to enabled advanced search compatibility. This parameter is optional. When not used, it will use the previous capability.
  \n
- Request Body with Advanced Search example (see Batch Edit with Advanced Search for adv_criteria details) :
  \n
\n

{\n  \"DeviceCollection\" : {\n    \"rows\" : [ {\n      \"id\" : \"50362288\"\n    } ]\n  },\n  \"adv_criteria\" : {\n    \"limit\" : 50,\n    \"order_by\" : \"user_id:false\",\n    \"user_group_ids\" : [ 1014 ],\n    \"user_id\" : \"8\",\n    \"user_email\" : \"support@supremainc.com\"\n  }\n}\n\n

Toggle to overwrite the data on the device. True to overwrite (default value)

\n","type":"text/plain"},"key":"overwrite","value":"true"},{"description":{"content":"

ID of the User that will be sent to the Device. To send multiple users, use plus (+) sign as separator of each User ID. Ex: 1001+1002+1003+1004

\n","type":"text/plain"},"key":"id","value":"15"},{"description":{"content":"

Use this to enable Advanced Search query result.

\n","type":"text/plain"},"key":"adv","value":"mode1"}],"variable":[]}},"response":[],"_postman_id":"8c455d14-9445-4930-ac33-aca9fd8a6cb6"},{"name":"Delete User(s) From Device (Advanced Search)","event":[{"listen":"prerequest","script":{"id":"27bffb83-4043-49fa-ab21-001635f145b8","exec":["//batch delete\r","/*\r","var currentCount = pm.collectionVariables.get('nLoop');\r","if (currentCount > 203){\r"," currentCount = parseInt(currentCount)-1;\r"," pm.collectionVariables.set('nLoop', currentCount);\r"," }*/\r","\r","/* batch delete subsequent users\r","var text =\"\";\r","var i = 9001;\r","for (; i <= 9973; i++) {\r"," text += i + \"+\";\r","}\r","text = text.slice(0, -1); \r","pm.collectionVariables.set('nLoop',text);\r","*/\r","\r","pm.iterationData.get(\"iterIDVal\")"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"014f0771-1909-4b0e-9a34-e26854e306a8","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f0944e10-2418-4e94-8ca0-f99f32d9f12b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DeviceCollection\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"40000701\"\r\n }\r\n ]\r\n },\r\n \"adv_criteria\": {\r\n \"limit\": 50,\r\n \"order_by\": \"user_id:false\",\r\n \"user_name\": \"a\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/remove?adv=mode1","description":"

This example shows how to delete users in device(s) in concurrence with Advanced Search query result.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
DeviceCollection	Object	Y	Device collection.
DeviceCollection.rows	Array	Y	Device ID(s) which user data will be deleted.
adv_criteria	Object	Y	See Batch Edit with Advanced Search for adv_criteria details.

Response Example:

{\n  \"DeviceResponse\" : {\n    \"rows\" : [ {\n      \"id\" : \"50362313\",\n      \"code\" : \"0\"\n    } ],\n    \"result\" : \"true\"\n  },\n  \"Response\" : {\n    \"code\" : \"0\",\n    \"link\" : \"https://support.supremainc.com/en/support/home\",\n    \"message\" : \"Success\"\n  }\n}\n\n

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
DeviceResponse	Object	Response from device
DeviceResponse.rows	Array	List of device ID
DeviceResponse.result	Boolean	Indicate success or fail
Response	Object	Indicate success or fail

Use this to enable Advanced Search query result.

\n","type":"text/plain"},"key":"adv","value":"mode1"}],"variable":[]}},"response":[],"_postman_id":"f0944e10-2418-4e94-8ca0-f99f32d9f12b"},{"name":"List Idle Users","event":[{"listen":"prerequest","script":{"id":"988182ba-efeb-4d3f-881f-ca57d8a9947c","exec":[""],"type":"text/javascript"}}],"id":"6f4e8ac2-d67a-4264-a3d8-bc90375a0e51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"offset\": 0,\r\n \"limit\": 0,\r\n \"conditions\": [\r\n {\r\n \"column\": \"user_group_id.id\",\r\n \"operator\": 2,\r\n \"values\": [\r\n 2\r\n ]\r\n }\r\n ],\r\n \"orders\": [\r\n {\r\n \"column\": \"user_id\",\r\n \"descending\": false\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/absence?search_month=1&last_modified=0","description":"

Show user(s) which do not have any activity on the last n month(s).

n = search_month parameter

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
offset	Number	Y	Default: 0. Shift the response record(s) according to the specified value
limit	Number	Y	Default: 0. Limit the response record(s) shown by the specified value.
conditions:column	String		Column/field which the condition will be based on.
conditions:operator	Number		0 = EQUAL 1 = NOT_EQUAL 2 = CONTAINS 3 = BETWEEN (values[0], values[1])
conditions:values	Number		Value of the condition according to the operator and column.
orders:column	String	N	Column/field which the order will be based on.
orders:descending	Boolean	N	Toggle false to set the response's order as ascending.

Error Codes:

400: Invalid query parameters
\n
405: Method not allowed (only POST supported)
\n
500: Internal server/database error
\n

Number of months to look back. Users with no activity within this range are returned. Optional (default = 0)

\n","type":"text/plain"},"key":"search_month","value":"1"},{"description":{"content":"

UNIX timestamp. Only returns users modified after this time. (Unused if 0)

\n","type":"text/plain"},"key":"last_modified","value":"0"}],"variable":[]}},"response":[],"_postman_id":"6f4e8ac2-d67a-4264-a3d8-bc90375a0e51"},{"name":"List Idle Users - Multiple ID","event":[{"listen":"prerequest","script":{"id":"988182ba-efeb-4d3f-881f-ca57d8a9947c","exec":[""],"type":"text/javascript"}}],"id":"c234cd32-88b0-4684-9cd5-b9f110711872","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"offset\": 0,\r\n \"limit\": 0,\r\n \"conditions\": [\r\n {\r\n \"column\": \"user_id\",\r\n \"operator\": 2,\r\n \"values\": [\r\n 1,2,4\r\n ]\r\n }\r\n ],\r\n \"orders\": [\r\n {\r\n \"column\": \"user_id\",\r\n \"descending\": false\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/absence","description":"

This example shows a workaround using this API to get multiple users data by adjusting the parameters.

The advantage of this workaround is that the API response can be adjusted to only show only the required users directly.

Query parameter search_month value is set to 0 or removed
Body parameter conditions:column value set to user_id, :operator value to 2 (contains), and :value can specify multiple user id which uses comma as separator.

For BODY Parameter details refer to POST List Idle Users.

Filter user(s) which idle for the last n month(s).

\n","type":"text/plain"},"key":"search_month","value":"9"}],"variable":[]}},"response":[],"_postman_id":"c234cd32-88b0-4684-9cd5-b9f110711872"},{"name":"Delete Idle Users","event":[{"listen":"prerequest","script":{"id":"988182ba-efeb-4d3f-881f-ca57d8a9947c","exec":[""],"type":"text/javascript"}}],"id":"939c108c-59ec-41a9-ad05-cc04608e71b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"offset\": 0,\r\n \"limit\": 0,\r\n \"conditions\": [\r\n {\r\n \"column\": \"user_group_id.id\",\r\n \"operator\": 2,\r\n \"values\": [\r\n 2\r\n ]\r\n }\r\n ],\r\n \"orders\": [\r\n {\r\n \"column\": \"user_id\",\r\n \"descending\": false\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/absence/delete?search_month=1&id=10 11","description":"

This API is used to delete idle users.

For BODY parameter refer to POST List Idle Users.

Filter user(s) which idle for the last n month(s).

\n","type":"text/plain"},"key":"search_month","value":"1"},{"description":{"content":"

ID of the idle users which will be deleted. Use space as separator to delete multiple users.

\n","type":"text/plain"},"key":"id","value":"10 11"}],"variable":[]}},"response":[],"_postman_id":"939c108c-59ec-41a9-ad05-cc04608e71b8"},{"name":"Advanced Search","id":"90801371-c02f-41b7-9b1d-0e2a8ae18fb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"limit\": 50,\r\n \"order_by\": \"user_id:false\",\r\n \"user_group_ids\": [\r\n 1004\r\n ],\r\n \"user_id\": \"45\",\r\n \"user_name\": \"Riz\",\r\n \"user_email\": \"@gmail.com\",\r\n \"user_department\": \"oddBit\",\r\n \"user_title\": \"Mister\",\r\n \"user_card\": \"12\",\r\n \"user_operator_level_id\": \"255\",\r\n \"user_access_group_ids\": \"1\",\r\n \"user_custom_field_1\": \"custom field 1\",\r\n \"user_custom_field_2\": \"123\",\r\n \"user_custom_field_3\": \"test1\",\r\n \"user_custom_field_4\": \"custom field 4\",\r\n \"user_custom_field_5\": \"456\",\r\n \"user_custom_field_6\": \"test4\",\r\n \"user_custom_field_7\": \"custom field 7\",\r\n \"user_custom_field_8\": \"789\",\r\n \"user_custom_field_9\": \"test5\",\r\n \"user_custom_field_10\": \"custom field 10\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/users/advance_search","description":"

This API is used to fetch user information via advanced search. It is accessible in BioStar 2 version 2.9.5 and later.

BODY Parameters:

Parameter	Type	Required	Description
limit	Number	N	The maximum number of users to return. Default is 50.
offset	String	N	The number of users to skip before starting to return results. Default is 0.
user_id	String	N	The User ID to search, supports like search
user_group_id	String	N	Group ID for search user. Also gets the child user group
user_group_ids	String	N	Array of Group IDs for advanced search parameter
user_name	String	N	User name for Advance Search parameter, supports like search both encrypted and unencrypted
user_email	String	N	User email, supports like search both encrypted and unencrypted
user_phone	String	N	User Phone for Advance Search parameter, supports like search both encrypted and unencrypted
user_department	String	N	User Department for Advance Search parameter, supports like search on unencrypted and exact search on encrypted
user_access_group_ids	String	N	User access group id for advance search parameter, supports multiple value with format String with Delimiter , i.e 1,2,3
user_title	String	N	User title for advance search parameter, supports like search on unencrypted and exact search on encrypted
user_card	String	N	User card ID
user_status	Boolean	N	User status for advance search parameter
user_operator_level_id	String	Y	User operator level id for Advance Search parameter
user_custom_field_1	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
user_custom_field_2	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
user_custom_field_3	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
user_custom_field_4	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
user_custom_field_5	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
user_custom_field_6	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
user_custom_field_7	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
user_custom_field_8	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
user_custom_field_9	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
user_custom_field_10	String	N	Custom fields for advance search parameter support like search on unencrypted and exact search on encrypted
order_by	String	N	Order, will accept with format properties:false, for example if we want to order by name, it will be user_name:false. false = ASCENDING and true = DESCENDING

Response Example:

{\n  \"UserCollection\" : {\n    \"total\" : 1,\n    \"rows\" : [ {\n      \"user_id\" : \"45\",\n      \"name\" : \"Suprema\",\n      \"email\" : \"one@suprema.com\",\n      \"department\" : \"Your Dept\",\n      \"user_title\" : \"Your Title\",\n      \"phone\" : \"085697068105\",\n      \"user_group_id\" : {\n        \"id\" : 1004,\n        \"name\" : \"user group1\"\n      },\n      \"operator_level\" : \"User\",\n      \"fingerprint_template_count\" : 0,\n      \"face_count\" : 0,\n      \"visual_face_count\" : 0,\n      \"mobile_count\" : 0,\n      \"qr_count\" : 0,\n      \"card_count\" : 1,\n      \"start_datetime\" : \"2001-01-01T00:00:00\",\n      \"expiry_datetime\" : \"2037-12-31T23:59:00\",\n      \"last_modified\" : 5,\n      \"updated_count\" : 0,\n      \"login_id\" : \"Abrar\",\n      \"disabled\" : false,\n      \"have_pin\" : true,\n      \"access_groups\" : [ {\n        \"id\" : 1,\n        \"name\" : \"access group 3\",\n        \"users\" : [ ],\n        \"user_groups\" : [ ],\n        \"access_levels\" : [ ],\n        \"floor_levels\" : [ ]\n      } ],\n      \"user_custom_fields\" : [ {\n        \"custom_field\" : {\n          \"id\" : 1,\n          \"name\" : \"CF1\",\n          \"type\" : 0,\n          \"order\" : 1\n        },\n        \"item\" : \"custom field 1\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      }, {\n        \"custom_field\" : {\n          \"id\" : 2,\n          \"name\" : \"CF2\",\n          \"type\" : 1,\n          \"order\" : 2\n        },\n        \"item\" : \"123\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      }, {\n        \"custom_field\" : {\n          \"id\" : 3,\n          \"name\" : \"CF3\",\n          \"type\" : 2,\n          \"order\" : 3\n        },\n        \"item\" : \"test1\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      }, {\n        \"custom_field\" : {\n          \"id\" : 4,\n          \"name\" : \"CF4\",\n          \"type\" : 0,\n          \"order\" : 4\n        },\n        \"item\" : \"custom field 4\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      }, {\n        \"custom_field\" : {\n          \"id\" : 5,\n          \"name\" : \"CF5\",\n          \"type\" : 1,\n          \"order\" : 5\n        },\n        \"item\" : \"456\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      }, {\n        \"custom_field\" : {\n          \"id\" : 6,\n          \"name\" : \"CF6\",\n          \"type\" : 2,\n          \"order\" : 6\n        },\n        \"item\" : \"test4\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      }, {\n        \"custom_field\" : {\n          \"id\" : 7,\n          \"name\" : \"CF7\",\n          \"type\" : 0,\n          \"order\" : 7\n        },\n        \"item\" : \"custom field 7\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      }, {\n        \"custom_field\" : {\n          \"id\" : 8,\n          \"name\" : \"CF8\",\n          \"type\" : 1,\n          \"order\" : 8\n        },\n        \"item\" : \"789\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      }, {\n        \"custom_field\" : {\n          \"id\" : 9,\n          \"name\" : \"CF9\",\n          \"type\" : 2,\n          \"order\" : 9\n        },\n        \"item\" : \"test5\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      }, {\n        \"custom_field\" : {\n          \"id\" : 10,\n          \"name\" : \"File Upload\",\n          \"type\" : 3,\n          \"order\" : 10\n        },\n        \"item\" : \"1\",\n        \"user_id\" : {\n          \"user_id\" : \"45\",\n          \"name\" : \"Suprema\"\n        }\n      } ]\n    } ]\n  },\n  \"Response\" : {\n    \"code\" : \"0\"\n  }\n}\n\n

Response Properties:

- UserCollection : The user collection.\n    - total : total number of users\n    - rows : list of users\n        - user_id : user ID\n        - name : user name\n        - email : user email\n        - department : user department\n        - user_title : user title\n        - phone : user phone number\n        - user_group_id : user group data\n        - operator_level : operator level/permission\n        - fingerprint_template_count : count of fingerprint template\n        - face_count : face count\n        - visual_face_count : count of visual face\n        - mobile_count : count of mobile credentials\n        - qr_count : count of QR credentials\n        - card_count: count of card\n        - start_datetime : start datetime of user\n        - expiry_datetime : expiry datetime of user\n        - last_modified : last modified\n        - updated_count : updated count of user\n        - login_id : user’s login ID\n        - disabled : is user enabled or disabled\n        - have_pin : does user have pin\n        - access_groups : list of access groups\n        - user_custom_fields : user’s custom fields\n- Response : The response\n    - code : success/fail code\n\n

Errors:

This API uses the following error codes:

400 Bad Request: The request was malformed or missing required parameters.
\n
401 Unauthorized: The API key provided was invalid or missing.
\n
404 Not Found: The requested resource was not found.
\n
500 Internal Server Error: An unexpected error occurred on the server.
\n

Changes:

v2.9.8:
\n
- Updated Response Example to display File Upload Custom Field.
  \n
- Modified response value for user_custom_fields parameter. Added key \"item\" with value 0 or 1 for custom field type File Upload. 0 = user does not have a file and 1 = user have a file.
  \n
- To search user who does not have a document, search custom_field order with the value \"No\" (\"user_custom_field_#\": \"No\"). Then the API will specify user who does not have a document by specific custom field.
  Conversely, fill value with \"Yes\" to find user who have a document by specific custom field.
  \n
- In previous version, user_operator_level_id is not mandatory, for version 2.9.8 this is mandatory. user_operator_level_id value now can be -1 (None) or 0 (All) or an ID to differentiate user without Operator Level.
  \n
\n

This example is applicable starting from BioStar 2 version 2.9.8.

By adding adv=mode1 on Query Parameter, Batch Edit feature can works with Advanced Search result.

The API works by query users based on adv_criteria object, then apply new value based on input in User object.

BODY Parameters:

Parameter	Type	Required	Description
User	Object	Y	User data to change, existing payload
adv_criteria	Object	Y	Advanced Search criteria, this is required for searching user data that want to be changed
adv_criteria.limit	Number	Y	Advanced Search search result limit
adv_criteria.order_by	String	Y	Advanced Search search result order
adv_criteria.user_group_id	Number	N	User Group ID to search, this is specifically for when clicking leftmost user group and do Advanced Search
adv_criteria.user_group_ids	Array	N	List of User Group IDs to search, this field value is from Advanced Search's search form
adv_criteria.user_id	String	N	User ID to search
adv_criteria.user_email	String	N	Email to search
adv_criteria.user_access_group_ids	String	N	List of access groups to search (format : 17,18)
adv_criteria.user_operator_level_id	Number	Y	Operator Level ID to search. Value : 0 = user with all operator level, -1 = user with no operator level, else ID of operator level
adv_criteria.user_department	String	N	Department of user to search
adv_criteria.user_title	String	N	Title of user to search
adv_criteria.user_card	String	N	User card ID to search
adv_criteria.user_custom_field_1 until adv_criteria.user_custom_field_10	String	N	User custom fields to search
adv_criteria.user_status	String	N	User status to search. false = Active, true = Inactive

Response Example:

{\n    \"FailedUserCollection\": {\n        \"total\": \"0\",\n        \"rows\": \"\"\n    },\n    \"Response\": {\n        \"code\": \"0\",\n        \"link\": \"https:\\/\\/support.supremainc.com\\/en\\/support\\/home\",\n        \"message\": \"Success\"\n    }\n}\n\n

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
FailedUserCollection	Object	List of failed user to edit
Response	Object	Response from backend
Response.code	String	Indicate that the request is failed or not (0 is success, other is failed)
Response.link	String	Suprema link
Response.message	String	Success or failed message from backend

Use this to enable Advanced Search query result.

\n","type":"text/plain"},"key":"adv","value":"mode1"}],"variable":[]}},"response":[],"_postman_id":"8cda0518-0211-4fe9-8054-62255181b033"},{"name":"List All User v2","event":[{"listen":"prerequest","script":{"id":"57c937b1-88de-48a5-b21c-42ba5bb3bb4d","exec":[""],"type":"text/javascript"}}],"id":"dfebfb50-d685-416d-9630-d84a33acd86c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"limit\": 0,\r\n \"search_text\": null,\r\n \"user_group_id\": \"1\",\r\n \"order_by\": \"user_id:false\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/users/search","description":"

This API is used to list all users recorded on Bio Star 2 database.

The BODY Parameters are as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
limit	Number	Y	Limit response record(s) by the value specified on this parameter
search_text	String	N	Search record(s) with the text specified on this parameter. Default value: null
user_group_id	Number	N	Filter response record(s) according to user_group_id specified on this parameter
order_by	String	N	Order the response record(s) by the User parameter such as user_id or name. False for ascending, True for descending.

Known errors:

At least one parameter must exist
Using unavailable user_group_id will show empty response

This API is used to list users which is recorded on BioStar 2 database.

Known errors:

Putting \"/\" at the end of the endpoint
Using group_id which doesn't exist will return success but no records

Note: This API is deprecated in BioStar 2 v2.8.12, please use /api/v2/users/search instead.

Filter response record(s) according to the group_id specified on this parameter. Use GET /api/user_groups to list all User Groups. Default value: 1 to show all.

\n","type":"text/plain"},"key":"group_id","value":"1"},{"description":{"content":"

Limit response record(s) by the amount specified on this parameter. 0 for show all.

\n","type":"text/plain"},"key":"limit","value":"0"},{"description":{"content":"

Shift response record(s) by the amount specified on this parameter. default value = 0. Ex: If you have 10 records, put value 5 on limit, and when you put value 5 on offset, you will get record 6 to 10 on the result.

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Order the response record(s) by the User parameter such as user_id or name. False for ascending, True for descending.

\n","type":"text/plain"},"key":"order_by","value":"user_id:false"},{"description":{"content":"

Show response record(s) with User last_modified value which is equal or greater than this parameter value.

\n","type":"text/plain"},"key":"last_modified","value":"0"}],"variable":[]}},"response":[],"_postman_id":"97152ab7-85d1-40fa-9d3d-f53bfb41ae06"},{"name":"View a User's Details","event":[{"listen":"prerequest","script":{"id":"f86d116b-9ce9-4218-b671-8ec99228fbae","exec":["if (pm.iterationData.get(\"iterIDVal\") === undefined) {\r"," pm.collectionVariables.set(\"iterIDVal\", 2);\r","} else {\r"," val = pm.iterationData.get(\"iterIDVal\");\r"," pm.collectionVariables.set(\"iterIDVal\", val);\r","}"],"type":"text/javascript"}}],"id":"f8b59a1c-9103-4161-9ca1-246be74cb130","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/users/:id","description":"

This API is used to view a user's details which is recorded on BioStar 2 database.

Known errors:

Putting \"/\" at the end of the endpoint
\n
Using User ID which doesn't exist
\n

Changes:

v2.9.9:
\n
- Added 'isExludeSyncADUser' parameter on the response. If this parameter value is 1, the AD or EntraID sync will exclude the user from synchronization.
\n

ID of the User

\n","type":"text/plain"},"type":"any","value":"101","key":"id"}]}},"response":[],"_postman_id":"f8b59a1c-9103-4161-9ca1-246be74cb130"},{"name":"List All Operator Level","id":"343f705d-8385-47a4-86e0-b76014b4583a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/permissions","description":"

This API is used to view all operator level as recorded on BioStar 2 database.

This API is used to list user fields which can be processed as CSV.

This API is used to get the content of exported .csv file.
File content will be shown on the response of the API.

Usage:
After POST /api/users/csv_export, get the URI from the response and use it as PATH parameter as shown on the example.

This API is used to upload a file to BioStar 2 Server.

Usage of this API is to upload a .csv or .tgz file to BioStar 2 Server Installation path, which after the file can be further processed for importing User Data to the database through POST /api/users/csv_import or POST /api/users/data_import.

Uploaded file will be located on: {{BioStar 2 Installation Path}}\\nginx\\html\\download

Do note that if there's any file with the same name, it will be overwritten.

This API is used to export User Data as .csv file.

This feature is useful when you create users in bulk or when you transfer users to another 3rd party systems.

The location of the exported file is on: {{BioStar 2 Installation Folder}}\\nginx\\html\\download

There is no input required on the BODY parameter. But it is required to put Query parameter to run the API correctly.

Result will be sorted by ID.

ID of the Users to export. Use * to export all users. To select multiple users use plus sign (+) or space ( ) as separator, ex: 1001+1002+1009.

\n","type":"text/plain"},"key":"id","value":"1+2+3"}],"variable":[]}},"response":[],"_postman_id":"9b0b5ac9-0eed-4abc-bc83-c7c314d6075f"},{"name":"Export User Data as CSV (File Upload Example)","id":"2e6b5b22-d28a-4873-af5d-06a9cfb9311c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"offset\": 0,\r\n \"group_by\": 1,\r\n \"columns\": [\r\n \"user_id\",\r\n \"name\",\r\n \"email\",\r\n \"user_group_id\",\r\n \"access_groups\",\r\n \"start_datetime\",\r\n \"expiry_datetime\",\r\n \"operator_level\",\r\n \"fingerprint_template_count\",\r\n \"face_count\",\r\n \"visual_face_count\",\r\n \"card_count\",\r\n \"have_pin\",\r\n \"qr_count\",\r\n \"mobile_count\",\r\n \"disabled\"\r\n ],\r\n \"headers\": [\r\n \"ID\",\r\n \"Name\",\r\n \"Email\",\r\n \"Group\",\r\n \"Access Group\",\r\n \"Start datetime\",\r\n \"End datetime\",\r\n \"Operator Level\",\r\n \"Fingerprint\",\r\n \"Face\",\r\n \"Visual Face\",\r\n \"Card\",\r\n \"PIN\",\r\n \"QR/Barcode\",\r\n \"Mobile Access Card\",\r\n \"Status\"\r\n ]\r\n },\r\n \"adv_criteria\": {\r\n \"user_group_ids\": [],\r\n \"user_group_id\": \"1\",\r\n \"user_operator_level_id\": \"0\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/csv_export?id=1+2+3&adv=mode1","description":"

This example shows how to use this API to show File Upload Custom Field information on CSV Export.

BODY Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
Query	Object	Y	Data criteria to search
Query.offset	Number	Y	Data offset
Query.group_by	Number	Y	Group by what column
Query.columns	String	Y	Object to retrieve data
Query.headers	String	Y	Column name to show in CSV/PDF
adv_criteria	Object	Y	See `Batch Edit with Advanced Search` for details

Response Example:

{\n  \"File\" : {\n    \"uri\" : \"User_20241030_7f554f6983034c8eb1b42076f68e488b.csv\"\n  },\n  \"Response\" : {\n    \"code\" : \"0\",\n    \"link\" : \"https://support.supremainc.com/en/support/home\",\n    \"message\" : \"Success\"\n  }\n}\n\n

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
File	Object	File object
File.uri	String	Exported file name
Response	Object	Response object
Response.code	Number	Indicate success or fail
Response.link	String	Suprema link
Response.message	String	Success / error message

ID of the Users to export. Use * to export all users. To select multiple users use plus sign (+) or space ( ) as separator, ex: 1001+1002+1009.

\n","type":"text/plain"},"key":"id","value":"1+2+3"},{"description":{"content":"

Use this to enable Advanced Search query result.

\n","type":"text/plain"},"key":"adv","value":"mode1"}],"variable":[]}},"response":[],"_postman_id":"2e6b5b22-d28a-4873-af5d-06a9cfb9311c"},{"name":"Import User Data from CSV","id":"46f5c3a4-1a9b-43d4-b9ca-d9dda9249146","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"File\": {\r\n \"uri\": \"User_Test.csv\",\r\n \"fileName\": \"User_Test.csv\"\r\n },\r\n \"CsvOption\": {\r\n \"start_line\": 2,\r\n \"import_option\": 1\r\n },\r\n\"Query\": {\r\n \"headers\": [\r\n \"user_id\",\r\n \"name\",\r\n \"department\",\r\n \"user_title\",\r\n \"phone\",\r\n \"email\",\r\n \"user_group\",\r\n \"start_datetime\",\r\n \"expiry_datetime\",\r\n \"csn\",\r\n \"\",\r\n \"\",\r\n \"\",\r\n \"qr\",\r\n \"26 bit SIA Standard-H10301\",\r\n \"HID 37 bit-H10302\",\r\n \"\",\r\n \"\",\r\n \"\",\r\n \"Purpose\",\r\n \"License Plate Number\",\r\n \"Hello\",\r\n \"Hair Color\",\r\n \"Hair Color 2\",\r\n \"\",\r\n \"\",\r\n \"\"\r\n ],\r\n \"columns\": [\r\n \"user_id\",\r\n \"name\",\r\n \"department\",\r\n \"user_title\",\r\n \"phone\",\r\n \"email\",\r\n \"user_group\",\r\n \"start_datetime\",\r\n \"expiry_datetime\",\r\n \"csn\",\r\n \"mobile_start_datetime\",\r\n \"mobile_expiry_datetime\",\r\n \"csn_mobile\",\r\n \"qr\",\r\n \"26 bit SIA Standard-H10301\",\r\n \"HID 37 bit-H10302\",\r\n \"HID 37 bit-H10304\",\r\n \"HID Corporate 1000\",\r\n \"HID Corporate 1000 48bit\",\r\n \"Purpose\",\r\n \"License Plate Number\",\r\n \"Hello\",\r\n \"Hair Color\",\r\n \"Hair Color 2\",\r\n \"face_image_file1\",\r\n \"face_image_file2\",\r\n \"pin\"\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/csv_import","description":"

This API is used to import User Data from a .csv file to the BioStar 2 database.

To run this API successfully, it is imperative to run POST /api/attachments first to upload the .csv file to the server install path.

After .csv file got uploaded to the server, put the filename value from the above API to the uri and fileName parameter on this API.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
File:uri	String	Y	Path of the .csv file
File:fileName	String	Y	File Name of the .csv file
CsvOption		Y	Container for available importing options
:start_line	Number	Y	Specify row number to start data import
:import_option	Number	Y	Options when same ID exist in BioStar 2: 1=Preserve Data, 2=Overwrite Data
Query:headers	Array	Y	List of fields on .csv file. Number of fields should match with system. Use GET /api/users/csv_option to see system fields. Use GET /download/:csv_filename to see the content of the intended .csv file.
Query:columns	Array	Y	List of fields on the BioStar 2. Use GET /api/users/csv_option to get this list.

Fields listed on Query parameter are also used for field mapping between .csv file and BioStar 2 database.

For example field user_id on Query:headers (.csv) will be matched with the first field of Query:columns (BioStar 2). To change this mapping, adjust the sequence on Query:headers as desired (eg. exchange field department with user_id so the value of department will be used on user_id on BioStar 2).

To skip a field from mapping, put empty string (\"\") on the intended field.

If there's no issue on the import process, the API will shows \"Success\" response.
If there's issue (duplicate email, etc.), the response will show that the \"Request is successful but partially\" and will include a filename which contain records that caused the errors which can be downloaded by using GET /download/:csv_filename

If the CSV file to import contains data for custom user fields and the fields do not exist on the server, then the data for the fields will be ignored during the import process.

To enter user information in a language other than English or Korean, save the CSV file in UTF-8 format.

You can store the data file on external storage (USB) and import to BioStar 2 or device. Up to 500,000 users can be moved from server to device or from device to device.

The exported data file from devices using older firmware version cannot be imported into BioStar 2. Make sure always use the latest version of firmware.
\n
If you use BioStar 2.8.10 or later, data exported from the previous version of BioStar 2 cannot be imported.
\n
If you use BioStar 2.8.10 or later, it is impossible to read data from a device that are using older firmware version. Upgrade the device’s firmware to a compatible version. Compatible devices and firmware versions are as follows:
\n
- BioStation 2 FW 1.9.0 or later > device_type: 8
  \n
- BioStation A2 FW 1.8.0 or later > device_type: 9
  \n
- FaceStation 2 FW 1.4.0 or later > device_type: 10
  \n
- FaceStation F2 FW 1.0.0 or later > device_type: 29
  \n
- X-Station 2 FW 1.0.0 or later > device_type: 32
  \n
\n
If the fingerprint template format is different, the data file cannot be imported. For example, the data file exported from a device which uses the Suprema fingerprint template format cannot be imported into a device which uses the ISO fingerprint template format.
\n
When importing user data with visual faces enrolled from FaceStation F2, the existing data will be retained if there are already visual face data enrolled on BioStar 2 via Upload Image or a mobile device.
\n

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
device_type	Number	Y	Device type which the exported data will be applied to
group_id	Number	Y	Group ID of the device. Default value=1
adv_criteria	Object	Y	See Batch Edit with Advanced Search for adv_criteria details.

The exported data file includes the profile photo, user ID, name, period, access group, PIN, auth. mode, credentials (face, fingerprint, card, mobile access card, visual face, BioStar 2 QR, QR/Barcode), 1:1 security level.
\n
You can export visual face data directly registered from the device only. It is not possible to export the data registered with the other methods, such as image file upload, CSV import, and mobile devices.
\n
Be sure that the device is selected correctly. Otherwise, the device cannot recognize the data file.
\n

Response Example:

{\n  \"File\" : {\n    \"uri\" : \"BioStar2_20241030_093821.tgz\"\n  },\n  \"Response\" : {\n    \"code\" : \"0\",\n    \"link\" : \"https://support.supremainc.com/en/support/home\",\n    \"message\" : \"Success\"\n  }\n}\n\n

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
File	Object	File object
File.uri	String	Exported file name
Response	Object	Response object
Response.code	Number	Indicates success or failure
Response.link	String	Suprema link
Response.message	String	Success or error message

Changes:

v2.9.8:
\n
- Added adv Query Parameter for enabling Advanced Search query capability.
  \n
- Added adv_criteria on Body Parameter as example on how to use Advanced Search query.
  \n
\n

ID of the user which will be exported. Use space as separator between IDs when exporting multiple user.

\n","type":"text/plain"},"key":"id","value":"14"},{"description":{"content":"

Use this to enable Advanced Search query result.

\n","type":"text/plain"},"key":"adv","value":"mode1"}],"variable":[]}},"response":[],"_postman_id":"c08594f5-85e3-4fbf-9d41-3ba38bfb924b"},{"name":"Data File Import","id":"9d871d7c-7b34-4e93-8831-ddc27f0966fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"file\": {\r\n \"originalName\": \"BioStar2_20220124_173247.tgz\",\r\n \"name\": \"BioStar2_20220124_173247.tgz\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/data_import","description":"

You can store the data file on external storage (USB) and import to BioStar 2 or device. Up to 500,000 users can be moved from server to device or from device to device.

The exported data file from devices using older firmware version cannot be imported into BioStar 2. Make sure always use the latest version of firmware.
If you use BioStar 2.8.10 or later, data exported from the previous version of BioStar 2 cannot be imported.
If you use BioStar 2.8.10 or later, it is impossible to read data from a device that are using older firmware version. Upgrade the device’s firmware to a compatible version. Compatible devices and firmware versions are as follows:
- BioStation 2 FW 1.9.0 or later > device_type: 8
- BioStation A2 FW 1.8.0 or later > device_type: 9
- FaceStation 2 FW 1.4.0 or later > device_type: 10
- FaceStation F2 FW 1.0.0 or later > device_type: 29
- X-Station 2 FW 1.0.0 or later > device_type: 32
\n
If the fingerprint template format is different, the data file cannot be imported. For example, the data file exported from a device which uses the Suprema fingerprint template format cannot be imported into a device which uses the ISO fingerprint template format.
When importing user data with visual faces enrolled from FaceStation F2, the existing data will be retained if there are already visual face data enrolled on BioStar 2 via Upload Image or a mobile device.

Select the desired file (*.tgz) and then click Open.
A success message will appear on the screen when import successfully.

Use POST /api/attachments to upload the file (.tgz) to the BioStar 2 server.
Use the resulting filename on the response as value on the BODY parameter.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
file:originalName	String	Y	Original filename of the file
file:name	String	Y	Current filename of the file

This API is used to export user data as SVG which was collected using Advanced Search query.

BODY Parameter:

Parameter	Type	Required	Description
View	Object	Yes	Parent object
Query	Object	Yes	User data criteria to query (not used; only mandatory fields are supplied)
display_fields	Array	Yes	List of columns to show in SVG/PDF file
display_fields.name	String	Yes	Object name to retrieve data
display_fields.display_name	String	Yes	Column name to show in SVG/PDF file
display_fields.display_type	String	Yes	Display as this data type
display_fields.width	String	Yes	Column width in SVG/PDF file
display_fields.enum	Array	No	Enum list
View.name	String	Yes	Report name
View.show_title_every_page	Boolean	Yes	Indicates if the report will show title on every page
View.group_by_page_break	Boolean	Yes	Indicates if the report will group by page break
View.footer_report_date	Boolean	Yes	Indicates whether to show the date in the report footer
View.footer_comment	String	Yes	Footer comment
View.footer_display_page_number	Boolean	Yes	Indicates if the report will show page numbers
View.content_type	String	Yes	Report file type (e.g., SVG or PDF)
View.page_size	String	Yes	Report page size (e.g., A4 or Letter)
View.page_portrait	Boolean	Yes	Report page orientation (true = portrait, false = landscape)
View.adv_criteria	Object	Yes	See Batch Edit with Advanced Search for adv_criteria details.

Response Example:

{\n  \"FileCollection\" : {\n    \"total\" : \"4\",\n    \"rows\" : [ {\n      \"uri\" : \"/report/list_20241030093818_2566_p1.svg\",\n      \"type\" : \"image/svg+xml\"\n    }, {\n      \"uri\" : \"/report/list_20241030093818_2566_p2.svg\",\n      \"type\" : \"image/svg+xml\"\n    }, {\n      \"uri\" : \"/report/list_20241030093818_2566_p3.svg\",\n      \"type\" : \"image/svg+xml\"\n    }, {\n      \"uri\" : \"/report/list_20241030093818_2566_p4.svg\",\n      \"type\" : \"image/svg+xml\"\n    } ]\n  },\n  \"Response\" : {\n    \"code\" : \"0\",\n    \"link\" : \"https://support.supremainc.com/en/support/home\",\n    \"message\" : \"Success\"\n  }\n}\n\n

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
FileCollection	Object	File collection
FileCollection.total	Number	Total number of files
FileCollection.rows	Array	List of files
FileCollection.rows.uri	String	File location
FileCollection.rows.type	String	File MIME type
Response	Object	Response object
Response.code	Number	Indicates success or failure
Response.link	String	Suprema link
Response.message	String	Success or error message

Use this to enable Advanced Search query result.

\n","type":"text/plain"},"key":"adv","value":"mode1"}],"variable":[]}},"response":[],"_postman_id":"7d79606e-3e54-4edd-9028-9c7b53006192"},{"name":"Export User(s) as PDF with Advanced Search","id":"620fcc32-869e-4237-bc74-1ae164cf10e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"View\": {\r\n \"Query\": {\r\n \"collection_name\": \"UserCollection\",\r\n \"object\": \"query\",\r\n \"orders\": [\r\n {\r\n \"column\": \"user_id\",\r\n \"descending\": \"false\"\r\n }\r\n ]\r\n },\r\n \"display_fields\": [\r\n {\r\n \"name\": \"user_id\",\r\n \"display_name\": \"ID\",\r\n \"display_type\": \"string\",\r\n \"width\": 5\r\n },\r\n {\r\n \"name\": \"name\",\r\n \"display_name\": \"Name\",\r\n \"display_type\": \"string\",\r\n \"width\": 9\r\n },\r\n {\r\n \"name\": \"email\",\r\n \"display_name\": \"Email\",\r\n \"display_type\": \"string\",\r\n \"width\": 12\r\n },\r\n {\r\n \"name\": \"user_group_id.name\",\r\n \"display_name\": \"Group\",\r\n \"display_type\": \"string\",\r\n \"width\": 9\r\n },\r\n {\r\n \"name\": \"access_groups\",\r\n \"display_name\": \"Access Group\",\r\n \"display_type\": \"objects\",\r\n \"width\": 9\r\n },\r\n {\r\n \"name\": \"start_datetime\",\r\n \"display_name\": \"Start datetime\",\r\n \"display_type\": \"string\",\r\n \"width\": 7\r\n },\r\n {\r\n \"name\": \"expiry_datetime\",\r\n \"display_name\": \"End datetime\",\r\n \"display_type\": \"string\",\r\n \"width\": 7\r\n },\r\n {\r\n \"name\": \"operator_level\",\r\n \"display_name\": \"Operator Level\",\r\n \"display_type\": \"string\",\r\n \"width\": 9\r\n },\r\n {\r\n \"name\": \"fingerprint_template_count\",\r\n \"display_name\": \"Fingerprint\",\r\n \"display_type\": \"string\",\r\n \"width\": 4\r\n },\r\n {\r\n \"name\": \"face_count\",\r\n \"display_name\": \"Face\",\r\n \"display_type\": \"string\",\r\n \"width\": 4\r\n },\r\n {\r\n \"name\": \"visual_face_count\",\r\n \"display_name\": \"Visual Face\",\r\n \"display_type\": \"string\",\r\n \"width\": 4\r\n },\r\n {\r\n \"name\": \"card_count\",\r\n \"display_name\": \"Card\",\r\n \"display_type\": \"string\",\r\n \"width\": 4\r\n },\r\n {\r\n \"name\": \"have_pin\",\r\n \"display_name\": \"PIN\",\r\n \"display_type\": \"string\",\r\n \"width\": 4\r\n },\r\n {\r\n \"name\": \"qr_count\",\r\n \"display_name\": \"QR/Barcode\",\r\n \"display_type\": \"string\",\r\n \"width\": 4\r\n },\r\n {\r\n \"name\": \"mobile_count\",\r\n \"display_name\": \"Mobile Access Card\",\r\n \"display_type\": \"string\",\r\n \"width\": 4\r\n },\r\n {\r\n \"name\": \"disabled\",\r\n \"display_name\": \"Status\",\r\n \"display_type\": \"enum\",\r\n \"width\": 2,\r\n \"enum\": [\r\n \"false=\",\r\n \"true=Inactive\"\r\n ]\r\n }\r\n ],\r\n \"name\": \"All Users\",\r\n \"show_title_every_page\": false,\r\n \"group_by_page_break\": \"false\",\r\n \"footer_report_date\": true,\r\n \"footer_comment\": \"Created by Administrator\",\r\n \"footer_display_page_number\": \"true\",\r\n \"content_type\": \"PDF\",\r\n \"page_size\": \"A4\",\r\n \"page_portrait\": \"false\"\r\n },\r\n \"adv_criteria\": {\r\n \"user_group_ids\": [],\r\n \"user_group_id\": \"1\",\r\n \"user_operator_level_id\": \"0\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/users/report?use_centigrade=true&adv=mode1","description":"

This API is used to export user data as SVG which was collected using Advanced Search query.

BODY Parameter:

Parameter	Type	Required	Description
View	Object	Yes	Parent object
Query	Object	Yes	User data criteria to query (not used; only mandatory fields are supplied)
display_fields	Array	Yes	List of columns to show in SVG/PDF file
display_fields.name	String	Yes	Object name to retrieve data
display_fields.display_name	String	Yes	Column name to show in SVG/PDF file
display_fields.display_type	String	Yes	Display as this data type
display_fields.width	String	Yes	Column width in SVG/PDF file
display_fields.enum	Array	No	Enum list
View.name	String	Yes	Report name
View.show_title_every_page	Boolean	Yes	Indicates if the report will show title on every page
View.group_by_page_break	Boolean	Yes	Indicates if the report will group by page break
View.footer_report_date	Boolean	Yes	Indicates whether to show the date in the report footer
View.footer_comment	String	Yes	Footer comment
View.footer_display_page_number	Boolean	Yes	Indicates if the report will show page numbers
View.content_type	String	Yes	Report file type (e.g., SVG or PDF)
View.page_size	String	Yes	Report page size (e.g., A4 or Letter)
View.page_portrait	Boolean	Yes	Report page orientation (true = portrait, false = landscape)
View.adv_criteria	Object	Yes	See Batch Edit with Advanced Search for adv_criteria details.

Response Example:

{\n  \"FileCollection\" : {\n    \"total\" : \"1\",\n    \"rows\" : [ {\n      \"uri\" : \"/report/list_20241030093819_7596.pdf\",\n      \"type\" : \"image/svg+xml\"\n    } ]\n  },\n  \"Response\" : {\n    \"code\" : \"0\",\n    \"link\" : \"https://support.supremainc.com/en/support/home\",\n    \"message\" : \"Success\"\n  }\n}\n\n

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
FileCollection	Object	File collection
FileCollection.total	Number	Total number of files
FileCollection.rows	Array	List of files
FileCollection.rows.uri	String	File location
FileCollection.rows.type	String	File MIME type
Response	Object	Response object
Response.code	Number	Indicates success or failure
Response.link	String	Suprema link
Response.message	String	Success or error message

Use this to enable Advanced Search query result.

\n","type":"text/plain"},"key":"adv","value":"mode1"}],"variable":[]}},"response":[],"_postman_id":"620fcc32-869e-4237-bc74-1ae164cf10e5"},{"name":"View User by Account Level","id":"ecd47cd9-f046-4280-a71f-8bb6e72582ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/permissions","description":"

This API is used to view all user permission grouped by user account level.

1: Administrator
2: User Operator
3: Monitoring Operator
4-252: Custom Account Level
253: Video
254: TA
255: User
100000: Visitor

This API is used to download User Data File from BioStar 2 Server.

Use the filename which resulted from POST /api/users/data_export

Put the filename to download on the PATH of the API.

Filename of the data file which will be downloaded.

\n","type":"text/plain"},"type":"any","value":"BioStar2_20220124_152253.tgz","key":"exported_file"}]}},"response":[],"_postman_id":"40152929-5744-443d-82e3-aa403a649776"},{"name":"Audit User Tracks","id":"2215960c-88a7-4339-900d-d154bfd4e88c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"offset\": 0,\r\n \"limit\": 101,\r\n \"conditions\": [\r\n {\r\n \"column\": \"DATE\",\r\n \"operator\": 3,\r\n \"values\": [\r\n \"2022-06-15T15:00:00.000Z\",\"2022-07-17T15:00:00.000Z\"\r\n ]\r\n },\r\n {\r\n \"column\": \"IP\",\r\n \"operator\": 0,\r\n \"values\": [\r\n \"192.168.1.5\"\r\n ]\r\n },\r\n {\r\n \"column\": \"USRID\",\r\n \"operator\": 0,\r\n \"values\": [\r\n \"Administrator(1)\"\r\n ]\r\n }\r\n ],\r\n \"total\": false\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/audit/search","description":"

Audit trail tracks user access information as well as all the information changed in the system.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
offset	Number	N	Shift the response records by the specified number.
limit	Number	Y	Limit the number of response records by the specified number.
conditions:column	String	N	Column name which being used for filtering response records.
conditions:operator	Number	N	Condition Operator EQUAL : 0 NOT_EQUAL : 1 CONTAINS : 2 BETWEEN : 3 (\"from\",\"until\"), LIKE : 4
conditions:values	String	N	Condition value
total	Boolean	N	Toggle true to only show the total number of records

This API is used to create or update User Private Message.

This API is available starting from BioStar 2 version 2.9.8.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
phrase	String	Y	Phrase which will be set as User Private Message. This has a 128-byte limit. Any phrase exceeding this will be truncated.

Response Example:

{\n    \"code\": \"0\",\n    \"message\": \"Successful\"\n}\n\n

User ID of the user to whom the private message will be configured.

\n","type":"text/plain"},"type":"any","value":"12","key":"userId"}]}},"response":[],"_postman_id":"e200e13f-ec32-46cf-a734-e3dcc36d017c"},{"name":"Delete User Private Message","id":"90d7c485-260f-4e8b-87dc-7132b483a971","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/v2/users/phrase/:userId","description":"

This API is used to delete User Private Message.

This API is available starting from BioStar 2 version 2.9.8.

Response Example:

{\n    \"code\": \"0\",\n    \"message\": \"Successful\"\n}\n\n

User ID of the user to whom the private message will be deleted.

\n","type":"text/plain"},"type":"any","value":"12","key":"userId"}]}},"response":[],"_postman_id":"90d7c485-260f-4e8b-87dc-7132b483a971"},{"name":"Fetch User Private Message","id":"4671bb89-3051-4862-8273-c52bd5dd40bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/v2/users/phrase/:userId","description":"

This API is used to fetch User Private Message.

This API is available starting from BioStar 2 version 2.9.8.

Response Example:

{\n    \"user_id\": \"12\",\n    \"phrase\": \"Good morning. You're expected at meeting room 1 at 09.00\"\n}\n\n

User ID of the user to whom the private message will be fetched.

\n","type":"text/plain"},"type":"any","value":"12","key":"userId"}]}},"response":[],"_postman_id":"4671bb89-3051-4862-8273-c52bd5dd40bb"},{"name":"Download File from File Upload Custom Field","id":"712e306c-7b97-481f-b1d5-bbe470103376","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/user_document/:UserID/:customFieldID","description":"

This API is used to download the file which contained in a File Upload Custom Field.

This API is available starting from BioStar 2 v2.9.8.

After receiving the response, convert the Base64 data on key document to file type specified on key mimetype.

Response Example:

{\n    \"Data\": {\n        \"document\": \"U1c1IGlzIHRoZSBiZXN0IGRldmVsb3Blcg==\",\n        \"mimetype\": \"text/plain\",\n        \"item\": \"ACCOUNTS.TXT\"\n    },\n    \"Response\": {\n        \"code\": \"0\",\n        \"link\": \"https://support.supremainc.com/en/support/home\",\n        \"message\": \"Success\"\n    }\n}\n\n

ID of the user which have the intended file.

\n","type":"text/plain"},"type":"any","value":"3","key":"UserID"},{"id":"5e41d99e-5466-498a-bb39-e5999363e9b1","description":{"content":"

ID of the File Upload Custom Field which contain the file.

\n","type":"text/plain"},"type":"any","value":"5","key":"customFieldID"}]}},"response":[],"_postman_id":"712e306c-7b97-481f-b1d5-bbe470103376"}],"id":"ef8753df-20fc-4fcd-a24a-02a22e5a9ba2","description":"

This section contains all API related to Users

\n","event":[{"listen":"prerequest","script":{"id":"b1c1b1da-2673-42bc-a9d2-ad32775619a7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"040cd22c-5f95-46c8-922e-473b38da9c7a","type":"text/javascript","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"]}}],"_postman_id":"ef8753df-20fc-4fcd-a24a-02a22e5a9ba2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Device Group","item":[{"name":"View All Device Group","id":"eee5899f-bdd5-4d88-8d5e-d91f816558f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order_by\": \"depth:false\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/device_groups/search","description":"

This API is used to list all device groups recorded on BioStar 2 database.

This API is used to create new device group.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the device group
description	String	N	Description of the device group
parent_id:id	Number	Y	ID of the parent group of this device group

This API is used to update a device group.

ID of the device group which will be updated

\n","type":"text/plain"},"type":"any","value":"5","key":"id"}]}},"response":[],"_postman_id":"5365b03d-ec5d-4224-904b-0eec121c2a07"},{"name":"Delete Device Group","id":"e18aad93-72fc-4f28-8c8a-b660915c47c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/device_groups/:id","description":"

This API is used to delete device group.

ID of the device group which will be deleted

\n","type":"text/plain"},"type":"any","value":"5","key":"id"}]}},"response":[],"_postman_id":"e18aad93-72fc-4f28-8c8a-b660915c47c1"}],"id":"f52b0ceb-e41e-4782-97db-216b2ce79a44","event":[{"listen":"prerequest","script":{"id":"8261c3c7-f470-4ad4-905a-f0b31d0ea2f8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d4604485-209e-4d47-b599-28626626c2ce","type":"text/javascript","exec":[""]}}],"_postman_id":"f52b0ceb-e41e-4782-97db-216b2ce79a44","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Device","item":[{"name":"Verify Fingerprint Scan","id":"fcab81e7-0445-4688-8381-3af4ce54597d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"FingerprintTemplate\": {\r\n \"template0\": \"RSoQFLAAVUYMBEBvBBlEsWSLFITAEIUGBgEYBA/G0W0IAwcgdgEbh2ANixfIMGUKEshwF4QOCbBzhjXEsaCFJITQAYohRSBViCSGoUsRLAcQooYoh6GlCDpIgZ2GKMkARgkyCXCehDhJgEIDG0sxYJsOy0BziBaMcGmPG4ywUaAVTdBokwxOEXgHEE6AeIIVT0FoERfPYBsxGg9gK9EK0QB4jRxSYRqFEhNAbxkXk1AUChiTUHSHL8zwl4EmDiE3CCHPADWKK5DAOo8nUZAqDS5SIUKXK9JhOZj////g/////////eAB///////d4AEi/////N3gASM////M3eABIzT/+7zd4BIzRE+7u83gEjNET7u7zeASNERFu7vN4BI0REW6u8zgIzRERaqqvOAjRERFqqq84TREREWqqrziNFVUT6mqvOJFVVVfqqq9BFVVVU/5qrqHd2ZU//+qqZiIdkT///qqqZh1T///+6qqqYX/////u6uqj///\",\r\n \"template1\": \"RSgQFK8AVUYRBDBvhxqEgBGFHsSRZwsIhRF1BQtGIRuEFsZxawgJRwB5AR4H4GULGYgQF4UUyYB0hyqEsAOJJsTRWIgrRkBKjyKG4QoLMsbwooQvB3GkBi9I0EYHOUnBnQMJSgF4ghXK8HWKHYwQZ5EIzQAfhRPN4XsEHA4BbBYXzhB5hRzO8WaYB89AdoQeT0AdsQgQAHiJDlFQdoIiSvFfHCLMcE4iNszwmAIszkE2hihO8DQJIM9QKkMxEJA3CC4RwCeOIlKBHAMxEsBFIv///d3////////M3eD/////+8zd4BL///+7zN3gEj//+rvM3eASM/+qu8zd4BIzT6q7vM3gEjRFqqq7zeASNESqqrvN4CNERaqqq7zhI0RFqqqrvdfsagfsgagOE0REWqqqq84jRFVaqqqrwDRFVVqqmavQRVVVWqqqq9JVVVVvq7qqmHdmZv/6qqqZiHZm//+qqqmZhV////u6qqmFT///+7uqqoT/8=\"\r\n },\r\n \"VerifyFingerprintOption\": {\r\n \"security_level\": \"0\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/devices/:dev_id/verify_fingerprint","description":"

This API is used to compare 2 fingerprint scan to determine whether it's the same finger or not.

As shown on the example, it is applied on template0 and template1 where template0 is the 1st scan of the finger and template1 is the 2nd scan.

To get the value for these parameters, use POST /api/devices/:dev_id/scan_fingerprint two times. The first scan for template0 and second scan for template1.

It will return HTTP 200 and shows message result: true on success, HTTP 500 and shows message result: false on failure.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
template0	Base64	Y	1st scan template of the fingerprint
template1	Base64	Y	2nd scan template of the fingerprint
security_level	Number	N	Set the verification security level. Higher number will have stricter requirement.

ID of the device which used to scan fingerprint.

\n","type":"text/plain"},"type":"any","value":"544140034","key":"dev_id"}]}},"response":[],"_postman_id":"fcab81e7-0445-4688-8381-3af4ce54597d"},{"name":"Verify Duplicate Fingerprint","id":"208186d1-b91e-4ff2-a3f3-b559a5202723","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ServerMatching\": {\r\n \"template\": \"AA4NE6cAVUYXwGEODRaBgWmJGoLhCoUTw+BohB0EYWaJIMKAWIkiAsAJijED4K6JJ8ehAwkwCFCyhCYIoFcLLQjRVoQeyTFligMJUG2GD0vxcQYezkFpjAIO4HWbFU9RcwUgD4Fnkx9QsWwPCpDhcgkfkZFoiydJwAMJJQrRXAknDABTCCsP4aCJJhBABJ4m0PGqoSqRYKkXKRIQCJ7//93v//////3d7/////zN3uAP//zM3e4AH8zMzN7gAfzMzM3uARK8zM3e4AEbvMzd7gARu8zM3uARHMzMze4BEczMzN3gESu7vMzeARK7u8zN4BI7u7vM3gIjqru7vOAzT6u7u84TRP+7zMzRNE//zMzN4jP//8zM3hLw\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/server_matching/identify_finger","description":"

This API is used to verify duplicate fingerprint.

If fingerprint already exist, it will return success (HTTP 200) and response will show the user which currently using the fingerprint.

Use the result of POST /api/devices/:dev_id/scan_fingerprint for the value of parameter template (either the 1st or 2nd scan).

If fingerprint available, it will return server error (HTTP 500) with response showing message \"Failed to identify fingerprint.\".

BODY Parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
template	Base64	Y	Template of the fingerprint which will be validated.

This API is used to scan a fingerprint.

On calling this API, it is required to specify the device which will be used as fingerprint scanner. It is done by specifying Device ID on the API Path, which marked by :dev_id.

The procedure to add a fingerprint as follows:
- Scan a finger using this API
- Use POST /api/server_matching/identify_finger to check if it's already exist
- If it doesn't exist, then run a second scan using this API for the same finger as the first scan
- Compare 1st and 2nd scan result using POST /api/devices/:dev_id/verify_fingerprint to make sure that 1st and 2nd scan are the same finger
- Assign the enrolled finger to a user using POST|PUT /api/users/:id

BODY parameters on this API as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
enroll_quality	Number	N	Set a fingerprint enrollment quality level. Any fingerprint which does not meet the quality requirement will not be enrolled.
raw_image	Boolean	N	Set this option to view the original image when a fingerprint is scanned.

ID of the device which will be used to scan fingerprint.

\n","type":"text/plain"},"type":"any","value":"544140034","key":"dev_id"}]}},"response":[],"_postman_id":"d6763ed8-1368-4dee-a0bb-4cf9b7a1a684"},{"name":"View Waiting Devices","event":[{"listen":"test","script":{"id":"98aebfbd-39c0-4df8-a574-008b4db92fc2","exec":[""],"type":"text/javascript"}}],"id":"530d43b7-4a6c-435e-97c4-af770f4da25d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/devices/waiting","description":"

This API is used to view device(s) which is on waiting list after changing connection mode from Server > Device to Device > Server.

This API is used to add device to BioStar 2.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the device which will be added
name	String	Y	Name of the device which will be added
device_group_id:id	Number	Y	ID of the device group which the device will be under
isDisabled	Boolean	N	Toggle to disable or enable the device
lan:enable_dhcp	Boolean	N	Toggle to enable or disable DHCP
lan:ip	String	Y	If DHCP disabled. Put the device's IP on this parameter
lan:device_port	Number	N	Port of the device which will be used by BioStar 2 to communicate

This example shows how to add slave device to BioStar 2.

This API is used to update device's configuration.
Put value which will be updated on the respective BODY parameter and remove any parameters which will not be updated.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	N	Name of the device
device_group_id:id	Number	N	Group ID of the device
lan:connection_mode	Number	N	Connection mode of the device: 0 = Server > Device 1 = Device > Server
lan:enable_dhcp	Boolean	N	Toggle true to enable DHCP
lan:use_dns	Boolean	N	Toggle true to use DNS
lan:ip	String	N	IP of the device
lan:device_port	Number	N	Connection port which the device use
lan:gateway	String	N	IP gateway which the device use
lan:subnet_mask	String	N	Subnet of the device
lan:server_port	Number	N	Connection port of the server
lan:server_ip	String	N	IP of the server
usb:enable_usb	Boolean	N	Use USB
usb:enable_usb_memory	Boolean	N	Use USB memory
wlan:enabled	Boolean	N	Toggle true to use WLAN (only for supported devices)
wlan:operation_mode	Number	N	Operation mode of the device
wlan:auth_type	Number	N	WLAN authorization type
wlan:encryption_type	Number	N	WLAN encryption type
rs485:mode	Number	N	RS485 Mode: 1 = Master 2 = Slave 3 = Default
rs485:channels:mode	Number	N	Channel usage (same as mode)
rs485:channels:baudrate	Number	N	Baudrate value
authentication:matching_timeout	String	N	Matching Timeout
authentication:auth_timeout	String	N	Authentication Timeout
authentication:enable_private_auth	Boolean	N	Use Private Authentication
authentication:enable_server_matching	Boolean	N	Use Server Matching
authentication:face_detection_level	String	N	Face Detection Level
authentication:enable_full_access	Boolean	N	Use Full Access
authentication:operation_modes:mode	Number	N	Operation/Authentication Mode
authentication:operation_modes:schedule_id:id	Number	N	Schedule applied for Operation/Authentication Mode
authentication:enable_card_Id_from_keypad	Boolean	N	Use Card ID from Keypad
card:use_csn	Boolean	N	Use CSN
card:use_mifare_felica	Boolean	N	Use Mifare Felica
card:use_em	Boolean	N	Use EM
card:use_wiegand	Boolean	N	Use Wiegand
card:use_iclass	Boolean	N	Use Iclass
card:use_HIDprox	Boolean	N	Use HIDprox
card:use_smart	Boolean	N	Use Smart
card:use_SEOS	Boolean	N	Use SEOS
card:use_SR_SE	Boolean	N	Use SR SE
card:use_desfire_ev1	Boolean	N	Use Desfire EV1
card:use_classic_plus	Boolean	N	Use Classic Plus
card:use_mobile	Boolean	N	Use Mobile
card:use_BLE	Boolean	N	Use BLE
card:use_NFC	Boolean	N	Use NFC
card:byte_order	String	N	Card Byte Order
card:use_wiegand_format	Boolean	N	Use Wiegand Format
display:language	String	N	Language
display:background	String	N	Background
display:background_theme	String	N	Background Theme
display:volume	String	N	Volume
display:use_voice	Boolean	N	Use Voice
display:menu_timeout	String	N	Menu Timeout
display:message_timeout	String	N	Message Timeout
display:backlight_timeout	String	N	Backlight Timeout
display:display_datetime	Boolean	N	Display DateTime
display:date_type	String	N	Date Type
display:time_format	String	N	Time Format
display:home_formation	String	N	Home Formation
display:shortcut_home	String	N	Shortcut Home
display:device_private_message	Boolean	N	Device Private Message
display:server_private_message	Boolean	N	Server Private Message
system:timezone	Integer	N	Time Zone
system:sync_time	Boolean	N	Sync Time
system:locked	Boolean	N	Locked
system:interphone_type	Integer	N	Interphone Type
system:camera_frequency	String	N	Camera Frequency
system:use_alphanumeric	Boolean	N	Use Alphanumeric
system:enable_clear_on_tamper	Boolean	N	Use Clear Tamper
system:enable_data_encryption	Boolean	N	Use Date Encryption
system:use_card_operation	Boolean	N	Use Card Operation
wiegand:wiegand_in_out	string	N	desc: Wiegand In Out
wiegand:out_pulse_width	string	N	desc: Out Pulse Width
wiegand:out_pulse_interval	string	N	desc: Out Pulse Interval
wiegand:enable_bypass_mode	boolean	N	desc: Use Bypass Mode
wiegand:format_id:id	string	N	desc: Format ID
wiegand:enable_fail_code	boolean	N	desc: Use Fail Code
wiegand:fail_code	string	N	desc: Fail Code
wiegand:wiegand_output_info	string	N	desc: Wiegand Output Information
wiegand:wiegand_csn_id:id	string	N	desc: Wiegand CSN ID
wiegand:wiegand_cards	Array	N	desc: Wiegand Cards
wiegand:wiegand_inputs	Array	N	desc: Wiegand Inputs
tna:mode	string	N	desc: TnA Mode
tna:fixed_code	integer	N	desc: TnA Fixed Code
tna:required	boolean	N	desc: TnA Required
tna:tna_keys:order	integer	N	desc: TnA keys order
tna:tna_keys:key	integer	N	desc: TnA Key
tna:tna_keys:keyName	string	N	desc: TnA KeyName
tna:tna_keys:schedule_id	Number	N	Schedule ID
tna:tna_keys:label	string	N	desc: Label
input:input_port_num	string	N	desc: Input Port Number
input:supervised_inputs	string	N	desc: Supervised Inputs
event_filter	Array	N	desc: List of event filters in which image logs are saved on the device
voip:use	boolean	N	desc: Use Voip
voip:server:address	string	N	desc: Address
voip:server:user_id	string	N	desc: User ID
voip:server:password	string	N	desc: Password
voip:server:port	string	N	desc: Port
voip:dtmf:mode	string	N	desc: DTMF Mode
voip:dtmf:exit_button	string	N	desc: Exit Button
voip:phonebook_list	string	N	desc: List of extension numbers on the intercom
thermal_config:enable_thermal_camera	string	N	desc: Thermal Camera Use Not Use : 0 Use (Deny access when exceeded threshold temperature) : 1 Use (Allow access after leaving log when exceeded threshold temperature) : 2
thermal_config:enable_centigrade	string	N	desc: Celsius (1)
thermal_config:temperature_threshold	string	N	desc: Threshold Temperature (Celsius, 38.0 -> 3800)
thermal_config:enable_audit_temperature	boolean	N	desc: Save Temperature Data
thermal_config:enable_temperature_reject_sound	boolean	N	desc: Temperature Fail Sound
thermal_config:enable_overlap_thermal	boolean	N	desc: Show Infrared Image (Device not supported)
thermal_config:temperature_checkmode	string	N	desc: Check Mode Check after authentication : 0 Check before authentication : 1 Check without authentication : 2
thermal_config:enable_mask	string	N	desc : Mask Detection Not Use : 0 Use (Deny access when failed to detect mask) : 1 Use (Allow access after leaving log when failed to detect mask) : 2
thermal_config:mask_detection_level	string	N	desc : Mask Detect Level Off : 0 Strict : 1 More Strict : 2 Most Strict : 3
thermal_config:enable_dynamic_roi	boolean	N	desc: Dynamic ROI (Device not supported)
thermal_camera_config:distance	string	N	desc: Distance (cm)
thermal_camera_config:emission_rate	string	N	desc: Emission Rate (0.95 -> 95, 0.97 -> 97, 0.98 -> 98)
thermal_camera_config:roi_x	string	N	desc: ROI X (%)
thermal_camera_config:roi_y	string	N	desc: ROI Y (%)
thermal_camera_config:roi_width	string	N	desc: ROI Width (%)
thermal_camera_config:roi_height	string	N	desc: ROI Height (%)
thermal_camera_config:compensation_temperature	string	N	desc: Temperature Correction (Celsius)
authmode:id	string	N	desc: Authmode Id
authmode:extAuthModeSupported	boolean	N	desc: Use Authmode ExtAuthModeSupported
authmode:cardAuthSupported	boolean	N	desc: Use Authmode CardAuthSupported
authmode:cardAuthMask	string	N	desc: Authmode CardAuthMask
authmode:fingerprintAuthSupported	boolean	N	desc: Use Authmode FingerprintAuthSupported
authmode:fingerprintAuthMask	string	N	desc: Authmode FingerprintAuthMask
authmode:faceAuthSupported	boolean	N	desc: Use Authmode FaceAuthSupported
authmode:faceAuthMask	string	N	desc: Authmode FaceAuthMask
authmode:idAuthSupported	boolean	N	desc: Use Authmode IdAuthSupported
authmode:idAuthMask	string	N	desc: Authmode IdAuthMask
card_supported_from_device:mask	string	N	desc: Card Supported From Device Mask
card_supported_from_device:em4100	boolean	N	desc: Use Card Supported From Device Em4100
card_supported_from_device:HIDProx	boolean	N	desc: Use Card Supported From Device HIDProx
card_supported_from_device:mifare_felica	boolean	N	desc: Use Card Supported From Device Mifare Felica
card_supported_from_device:iCLASS	boolean	N	desc: Use Card Supported From Device ICLASS
card_supported_from_device:mifareClassic_Plus	boolean	N	desc: Use Card Supported From Device MifareClassic Plus
card_supported_from_device:Desfire_ev1	boolean	N	desc: Use Card Supported From Device Desfire Ev1
card_supported_from_device:iCLASSSRSE	boolean	N	desc: Use Card Supported From Device ICLASSSRSE
card_supported_from_device:iCLASSSEOS	boolean	N	desc: Use Card Supported From Device ICLASSSEOS
card_supported_from_device:NFC	boolean	N	desc: Use Card Supported From Device NFC
card_supported_from_device:BLE	boolean	N	desc: Use Card Supported From Device BLE
card_supported_from_device:use_card_operation	boolean	N	desc: Use Card Supported From Device Operation
capability:thermalAuthSupported	string	N	desc: Capability ThermalAuthSupported
capability:maskAuthSupported	string	N	desc: Capability MaskAuthSupported
imageLogEventInfo:imageLogEventItems	Array	N	desc: Image Log Event Items
use_image_log	boolean	N	desc: Use Image Log
dst1	string	N	desc: dst1
dst2	string	N	desc: dst2

ID of the device which will be updated

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"03c61115-19f8-4e6f-917c-f566fae51d4e"},{"name":"Update Device Homescreen","id":"5f1272f9-946d-4757-85b4-40ac94730d8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DeviceCollection\": {\r\n \"total\": 2,\r\n \"rows\": [\r\n {\r\n \"id\": \"538152248\"\r\n },\r\n {\r\n \"id\": \"538152254\"\r\n }\r\n ]\r\n },\r\n \"ResourceDataCollection\": {\r\n \"total\": 1,\r\n \"type\": \"2\",\r\n \"rows\": [\r\n {\r\n \"slot\": 0,\r\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAtAAAA...--redacted\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/resources/update","description":"

This API is used to update Device's homescreen.

Before running this API, you must set the Device's homescreen parameter to either Notice or Logo using Update Device API (/api/devices/:id)

{\n  \"Device\": {\n    \"display\": {\n      \"background\": \"0\"\n      \"background_theme\": \"2\"\n    }\n  }\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
background	0 = Default 2 = Slide Show
background_theme	0 = Normal 1 = Notice 2 = Logo

To set it as Slide Show mode, set both background and background_theme value to 2.

Then run this API to adjust the display accordingly.

BODY Parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
DeviceCollection.total	Number	Y	Total number of devices which will be updated.
DeviceCollection.rows.id	String	Y	ID of the device which will be updated. May contain multiple value by repeating the parameter separated by comma (,). Do note that total number of device need to be the same as total number of device listed.
ResourceDataCollection.total	Number	Y	Total number of data which will be applied.
ResourceDataCollection.type	String	Y	1 = Use this if background_theme is set to Notice. 2 = Use this if background_theme is set to Logo. 3 = Use this to set it as Logo Slide Show.
ResourceDataCollection.rows.slot	Number	Y	Data display sequence. For Type 1 and 2 set it as 0.
ResourceDataCollection.rows.data	Base64	Y	Data which will be used for homescreen display. Use base64 encoding for its value.

This API is used to list Suprema devices recorded on BioStar 2.

This API is used to view device(s) based on its enrollment capabilities.

Device enrollment type. 0=All, 1=Finger, 2=CSN, 3= Smart, 4=Face, 5=Visual Face

\n","type":"text/plain"},"key":"type","value":"0"}],"variable":[]}},"response":[],"_postman_id":"b6c75a7c-3cb3-449a-8550-5d07b2a1b817"},{"name":"List All Added Device(s)","id":"4e56695a-9d81-4e1b-b863-0bdb59add36a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/devices","description":"

This API is used to view all devices recorded on BioStar 2 database.

Status response for this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
status	Integer	Connection status of the device. 0: Disconnected 1: Connected 2: Sync Error

This API is used to list devices with parameters to filter the result.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
limit	Number	N	limit the number of responses according to the specified value
exclude_device_type_id	Number	N	Exclude device to show on the response according to the device type id specified
order_by	String	N	Order the response according to the specified value

It is required to at least put {} for the API to run correctly.

Status response for this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
status	Integer	Connection status of the device. 0: Disconnected 1: Connected 2: Sync Error
user_sync_status	Integer	User sync status of the device. -1: Exceeded max user count 0: Normal >0: User Sync Error

This API is used to view device's information.

ID of the device which information will be viewed

\n","type":"text/plain"},"type":"any","value":"542353521","key":"id"}]}},"response":[],"_postman_id":"f0ebb40f-12d0-427c-b679-58c02a207396"},{"name":"View Device Configuration","id":"4542fed2-a4d7-4dcd-8b83-085bf9129109","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/devices/:id/config","description":"

This API is used to view device's configuration.

ID of the device which information will be viewed

\n","type":"text/plain"},"type":"any","value":"543720368","key":"id"}]}},"response":[],"_postman_id":"4542fed2-a4d7-4dcd-8b83-085bf9129109"},{"name":"View User Data Summary on a Device","id":"5f0d7ed3-669e-41a8-b732-b66e317fc35f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/devices/:id/discover_userdata","description":"

This API is used to view user data on a device.

ID of the device which user data will be viewed

\n","type":"text/plain"},"type":"any","value":"543308153","key":"id"}]}},"response":[],"_postman_id":"5f0d7ed3-669e-41a8-b732-b66e317fc35f"},{"name":"Enroll Face Credential","id":"c850e4b4-9f51-4605-a966-c4b2e622f3e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/devices/:id/credentials/face?pose_sensitivity=4","description":"

This API is used to enroll face credential from a device.

Set the sensitivity for the position, angle, and distance of a face when registering the face. Set the sensitivity high if you wish to obtain a detailed face template. 0-9

\n","type":"text/plain"},"key":"pose_sensitivity","value":"4"}],"variable":[{"description":{"content":"

ID of the device which will be used to enroll

\n","type":"text/plain"},"type":"any","value":"543720368","key":"id"}]}},"response":[],"_postman_id":"c850e4b4-9f51-4605-a966-c4b2e622f3e2"},{"name":"Remove Device(s)","id":"f5420474-28bd-411e-be43-508b14a285e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/devices?id=543408590","description":"

This API is used to delete device(s).

ID of the device(s) which will be deleted. To delete multiple device use plus (+) sign as separator.

\n","type":"text/plain"},"key":"id","value":"543408590"}],"variable":[]}},"response":[],"_postman_id":"f5420474-28bd-411e-be43-508b14a285e1"},{"name":"View Device Capabilities","id":"bbedfdd9-6084-4e7b-b5f7-f4b61c922e3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DeviceCollection\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"543720368\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/devices/capability","description":"

This API is used to list device's capabilities such as fingerprint, wifi, etc.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the device

This API is used to sync device's data with BioStar 2.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the device that the data will be synced

Toggle true to delete data on the device before sync process.

\n","type":"text/plain"},"key":"clean","value":"false"}],"variable":[]}},"response":[],"_postman_id":"84e16d7f-4050-436f-803d-95d022fcc72f"},{"name":"Unlock Device","id":"e0b53282-6fe1-4619-a0da-f2bbd8af1a37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DeviceCollection\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"543720368\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/devices/unlock","description":"

This API is used to unlock a device.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the device which will be unlocked

This API is used to view device's information using TCP.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
ip	String	Y	IP of the device
device_port	Number	Y	Port of the device

This API only works for devices which haven't been added to BioStar 2.

This API is used to search devices through UDP.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
timeout	Number	N	Search devices until the specified second reached
with_rs485	Boolean	N	Toggle to find device(s) with RS485
hide_known_devices	Boolean	N	Toggle to show device(s) which already known (added to BioStar 2) or not.

This API is used to get the IP settings of a device which have not been added to BioStar 2.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the device which the IP setting will be viewed.

This API is used to update IP settings on device which have not been added to BioStar 2.

It is required to fill in the id parameter with the id of the device which the IP settings will be updated.

Fill in the required value on the respective parameters and remove those which is not required.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the device which will be updated.
lan:connection_mode	Number	N	Connection mode of the device: 0 = Server > Device 1 = Device > Server
lan:enable_dhcp	Boolean	N	Toggle true to enable DHCP
lan:use_dns	Boolean	N	Toggle true to use DNS
lan:ip	String	N	IP of the device
lan:device_port	Number	N	Connection port which the device use
lan:gateway	String	N	IP gateway which the device use
lan:subnet_mask	String	N	Subnet of the device
lan:server_port	Number	N	Connection port of the server
lan:server_ip	S	N	IP of the server
device_type_id:id	Number	N	Device type ID

This API is used to connect a device which have been disconnected.

ID of the device which will be connected

\n","type":"text/plain"},"type":"any","value":"542353521","key":"id"}]}},"response":[],"_postman_id":"196394e2-8aef-4f4f-b3c2-0e8ea25558b4"},{"name":"Disconnect Device","id":"4ba49191-7d91-4177-88d8-097a98efed3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://127.0.0.1/api/devices/:id/disconnect","description":"

This API is used to disconnect a device connection from BioStar 2 Server.

ID of the device which will be disconnected

\n","type":"text/plain"},"type":"any","value":"542353521","key":"id"}]}},"response":[],"_postman_id":"4ba49191-7d91-4177-88d8-097a98efed3b"},{"name":"Find Wiegand","id":"19cf90f2-2826-47c9-999b-596c3ca107ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://127.0.0.1/api/devices/:id/discover_wiegand","description":"

This API is used to find wiegand device attached to master device.

ID of the master device

\n","type":"text/plain"},"type":"any","value":"544140034","key":"id"}]}},"response":[],"_postman_id":"19cf90f2-2826-47c9-999b-596c3ca107ba"},{"name":"Find Slave Device","id":"2c815160-acb6-43a9-b5f2-520ec772854b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://127.0.0.1/api/devices/:id/discover","description":"

This API is used to find slave device attached to a master device.

ID of the master device

\n","type":"text/plain"},"type":"any","value":"544140034","key":"id"}]}},"response":[],"_postman_id":"2c815160-acb6-43a9-b5f2-520ec772854b"},{"name":"Enroll Card Credential","id":"006aaa53-1c15-4107-913d-06bd8cd68985","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://127.0.0.1/api/devices/:id/scan_card","description":"

This API is used to enroll card credential using specified device.

ID of the device which will be used for enrollment

\n","type":"text/plain"},"type":"any","value":"543720368","key":"id"}]}},"response":[],"_postman_id":"006aaa53-1c15-4107-913d-06bd8cd68985"},{"name":"Write Card Data","id":"335c40fa-e934-484c-97d3-e807a298f0c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SmartCard\": {\r\n \"user_id\": {\r\n \"user_id\": \"2\",\r\n \"fingerprint_templates\": [\r\n {\r\n \"finger_index\": \"0\"\r\n }\r\n ],\r\n \"visual_face_templates\": []\r\n },\r\n \"card_id\": {\r\n \"card_id\": \"2\",\r\n \"card_type_id\": {\r\n \"id\": \"3\"\r\n },\r\n \"use_alphanumeric_user_id\": \"false\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/devices/:id/write_card","description":"

This API is used to write data to a card (Smart Card, etc.).

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
user_id:user_id	String	Y	ID of the user which will be written on the card.
user_id:fingerprint_templates:finger_index	Number	N	Fingerprint index template which will be written on the card.
user_id:visual_face_templates	Number	N	Visual face index template which will be written on the card.
card_id:card_id	Number	N	ID of the card
card_id:card_type_id:id	Number	N	Card Type ID 1: CSN 2: SECURE 3: ACCESS 4: WIEGAND
card_id:use_alphanumeric_user_id	Boolean	N	Toggle true if using alphanumeric user ID.

ID of the device which will be used to write the card. Do set the Smart Card layout of the device before running this API.

\n","type":"text/plain"},"type":"any","value":"542353521","key":"id"}]}},"response":[],"_postman_id":"335c40fa-e934-484c-97d3-e807a298f0c3"},{"name":"Clear Device Alarm","id":"bd9dcf55-247a-45e9-9469-6be190717bf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DeviceCollection\": {\r\n \"rows\": [\r\n {\r\n \"id\": 542353521\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/devices/clear_alarm","description":"

This API is used to clear alarm from a device.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the device which alarm will be cleared.

This API is used to view user statistics in a device.

ID of the device which will be viewed

\n","type":"text/plain"},"type":"any","value":"538152248","key":"id"}]}},"response":[],"_postman_id":"560295eb-aa7b-4f82-9c87-bf47118c9aaa"},{"name":"View Total User on a Device","id":"290276fd-b8a2-4a71-9de9-6ed418836f62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/devices/:id/users?limit=20&page=0","description":"

This API is used to view user data summary from a device.

Limit the number of response's records by the specified value. Default value = 50

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

Filter the response based on the specified page number. Default value = 1

\n","type":"text/plain"},"key":"page","value":"0"}],"variable":[{"type":"any","value":"543308153","key":"id"}]}},"response":[],"_postman_id":"290276fd-b8a2-4a71-9de9-6ed418836f62"},{"name":"Delete User from a Device","id":"27370948-994d-429a-8a43-632cd1ee1b2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/devices/:id/users?id=*","description":"

This API is used to delete user data on a device.

ID of the user which will be deleted. Use (*) for all user.

\n","type":"text/plain"},"key":"id","value":"*"}],"variable":[{"description":{"content":"

ID of the device which the user data will be deleted

\n","type":"text/plain"},"type":"any","value":"543720368","key":"id"}]}},"response":[],"_postman_id":"27370948-994d-429a-8a43-632cd1ee1b2e"},{"name":"Export User Data from a Device to BioStar 2","id":"bcaba0b5-71d8-48b0-ae2c-437fc0ffde03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://127.0.0.1/api/devices/:id/users/export?id=44004","description":"

This API is used to export user data from a device to BioStar 2.

Response Example:

{\n    \"UserCollection\": {\n        \"total\": \"0\",\n        \"rows\": [\n            {\n                \"user_id\": \"44004\",\n                \"updated_count\": \"2\",\n                \"disabled\": \"false\",\n                \"flag\": \"1\",\n                \"cards_count\": \"0\",\n                \"fingerprint_templates_count\": \"0\",\n                \"face_count\": \"1\",\n                \"start_datetime\": \"2001-01-01T00:00:00.00Z\",\n                \"expiry_datetime\": \"2030-12-31T23:59:00.00Z\",\n                \"security_level\": \"0\",\n                \"private_operation_modes\": \"\",\n                \"name\": \"김승제_03(인증O)\",\n                \"credentials\": {\n                    \"visualFaces\": [\n                        {\n                            \"template_ex_normalized_image\": \"\\/9j\\/4AAQSkZJRgABAQAAAQABAAD\\/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr\\/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr\\/wAARCABwAHADASIAAhEBAxEB\\/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL\\/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6\\/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL\\/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6\\/9oADAMBAAIRAxEAPwD9dY0GOp61N5JHVhRFEwYvkVOsW48gVxmZEsTgZByPauB\\/aS\\/aQ+Fn7LPw+ufiT8WNbe1sYUP2e1to99xduP4IlOB3GWYhFyNxGRnu9f1SDw3oN3r1x\\/qrK1eeTBx8qgk\\/yr8Z\\/wBtTxb4w+M2l6p8W\\/jb4rvLg37+dY6ajiGKztBskt7WGIjCIpLK3dnDFssSaCox5tjX+Nn\\/AAWh\\/a5+PniW\\/wDC3wSXSvh34XETSC\\/ceZflACQrXD8KzcAhE74DZ5r5Inl0jxN40vx4q8cTalqgkWXV7t7hpJbqaeVk2oWOS3ylssQACp4xXP6FoHxS\\/aDvI7XwT4ZYafbySI14kW2N1Z3+UY5DYJGD0GPTNer+Av2ItZg16W91Nbq4urpIVkllgJP7sAY+X+Zrjr5lhMK7N3Z6OHyzF4jVRsiHVfCngbU7ix+FXw8u5ZbMLjVLpY1LTTl4wXHBYBQ0qhACZJBEOFLOOI8f\\/BPw8IZbPwcNLnZZGivLwzyXDFw2CkRztnYEHJUrGvPLBXK+ueJv2c\\/FHgLSLiHw8syS3kp85kJDHsM4O4Y3MfqK4PxHJ468J6Hc6JB4VZ2vYtlxcyQsZZIE2gxDkBIsLgqAN3ckVNDNcHiHa9jerk2MpRva55r8IfjH+0h+yj4mT4h\\/s\\/fFPWvDcSPiRrXU1t7G9wc7JLecNFcD22yH0x1H6tfsA\\/8ABc34S\\/tD3Gm\\/CP8AaasrTwR46ucQQalFcqdH1Sbou2Qsfsrt\\/cf5M9GHAr8ZvjP8UviLN4iuPGOreFJryeVWS1iCuLexXssapjPIwdwAPZcYryxPjz4vk1L7J4j0G1tQzAjEDAj22gEtXanTqL3Hc82rSnB++rM\\/rikUqdpXH4e2ajkRSp+UZ+lfjh\\/wSg\\/4LMeNvhXqWl\\/Av9rLWrrUfAd2Eg0XxXfOz3Ph4k4RbjcBK1qcquWBMYAIJQ4X9jba5tb61ivbK5jmgniWSCaJwySIwyrKwJDKQQQRwQQRxRy2MHoyMrjqKryqeSR3qeVyGxmoJXyCC3eoEdjFGSvKnrU3yINxGOgoTp+NcB+0t8So\\/hV8ItY8bzXXkR6dYT3UsgfBxHGSFH+87IuewYntWjAj+Mv7Q3gT4ZeHp7jWF+0qYWBRCCrjoQM8H0r8if2ktN079p\\/41Q\\/D3wjBdLpU82ZY5E8v7NFu3MuSRwPbNb37Sv7SE\\/jf4e2Gvaj4nkafUpHtobXSbZS9xIijI8x8tsQED5FPqSK5b9hHTrK98dXfiiW3k8yb9xHLNOZCI1x0Y9R3yBj3rgzKrUw+HbXU9bJ8NHEYtRkfUfwn+A3gf4c+GofC\\/hPSUt4bOHZHIkQyx756f5NaGoaDDod6ix2bF5nyWEJHA9Tj3rttADXEqR28PyO38PpWnrmi29zZxia32Sjltg4+lfGTpynq3qfoUYxhotjyfVvD2nagEeVEVsnYGXIzivOfiX4K0eeXN7YRkumwkRj\\/ADzXsuuQRxXbJBAPLiYsGUdDj09K4DxvB9vmRuFAblj0FcsounqjeEVM8J8UfBLwnqekXIutDtgzru3eXz0weDXyZ8cv2crG6F1HoEgtdpOLeJdqH6bcEV9vfES9k0u3ljjAlLAbeo7nP8q+evipcR2us4hlQCX7vOeCM\\/8A1vwrqwOLxNKpdSObF4HD1qXLJHw34O1bUPh940m8LeJrGeCNm2NJbzSOvoHwT7+9fsR\\/wRP\\/AOChWpWj6Z+xX8YvFEWoW8wl\\/wCFfa3JMN0QRQ39nSA\\/MAw3PFnG0o6DhlA\\/L79o7wnGviaz8R2Fv+9BKsY52iJOfVTxVPR\\/FXiHwl4g03XNF1WW11W1uIrqxluflntZ42DwyxyDG7a4Ddvxr7zD1vrFBT6n5xjcN9WxDgtj+nyS8DncG7\\/r9fxFQyToc815r+zn8ddN+PfwJ8J\\/F7TL1Zv7c0SCW9C8eVcqoWZCPUSiVcdgo9a7Qaqpbk\\/XmtJbHAeshkHQ18uf8Fjp5rH\\/AIJ8+NtYs9R+zTW8umRvMWIBhl1K1jlGQM\\/dY9Oykd6+oK8V\\/wCChPw1Hxc\\/Y78b+BTM8SXNhDK0sdr5xRYp45S2zK7sbM9R9RVCvZn4U\\/Dz46eDPFenWWlaxbiK2Syc6i21stbwr8tohQZjE03LnkkIzEnK5+rv2EdH1PXtJHjHVpVgWeYtaWlrFtjhj6Ki5HTuee9fmjq+i+N\\/gJ8Zr74OSiRtVGpS2jSRwsiOzuqjbkA7SxX2OOCRgn9VPDWox\\/sm\\/s+WEEuiS6vrP2dFhsbQqrzTkAfxcAAnt2rx89qXpxpdWfVcPQSlOq+h9K6JfPpqKhceaq4HTJP8qXxBrWuraNNsKqrBicKc\\/kK+Jpvi3\\/wUzvrWTxn4a+F+mQ2xn3fZpIGkZU4+UZYZ9ypJ7gVd8G\\/8FJ\\/iVpsdx4e+PnwjGm3sczeXLa7gJjg5HJII4BBHZueleMsFUUbto+kp42nKdrM+n7jVhqEkOGCmRmU54BPcVyfifT9WubsW1pas6byZT2x9a81+GX7Tug\\/Erx0+kR201lbjM8rysAAnQL\\/wInGa6DS\\/j9YTadqGoW6pINN1NopljfJ2BFJHpnLdfTPpXnyouUuVnqe0hBcxzvxc0k2enR3FrFEsQJ8yUMdzdcjGOBz1r5l+ISW0108ksREiSMIkbkqM+v6\\/jUf7Qv8AwUxh07UG0Cy8FC5eA4IE5G4454we+a8Qvv25ZfEhe41n4Z3Eal8vLDkqo+uK6qeVYhR5keXiM2wvNyXE+PlnLeaNNI8IYIuVLDg4\\/wD118+nxozTnSLlvJ8sFBHcKHjYZ6YABU+4r6OHibQPjZ4PvY\\/DMjGRIzmKbhgTx0FfKuq6NPJ4um8JazL9nnhmKliPvDtyeh9+nNfS5S5Qi6ct0fJZxaUlUWzP20\\/4ICfF\\/VPEP7JfiDwrqdz5kWheL2Wy3MSVjmtYXKnd6Orkf75r7si8TxOwPmDr0z1r81f+CImk3fgH9lfUtfltJbdfEHiWWSOGRQMrbxRw7hjgjeJBkcHHtX2jY+PnSTDyEZPFdk6q5mkfPn3EykngU1oVkASVFZScMrAEEdwR6VKwAPBprDIrbcVz8N\\/+Cnf7Pd3N\\/wAFkND0ofDvT9J0zW7vS7rTJ7G3McV3CoV5JT0XePKKkKBgjp3r6y8Vad4U0u+PivXAJV061Yw25iLnOP4VGWZj6AE10X\\/BUz4Q67N+1r8FPj+LZ5tJsnvtJvXHItp2illic+m7LDPqKb4avLK41KaC00BJpPLBkumA6H+7xmvk88qS+tJdj73h2jD6jzLqfIHxJ\\/4Kd\\/tBeEtEu5bL9mDV9O0CGXZbHxBpj2zToSQGQ53HAUM3yYUMuSc184aN\\/wAFAPCfxz1k3PjT4c3OkxXVz5crXiZiEuMgc\\/d+oNfp34zHiLWdPl8F2GvR2UF7I4Swu7SNhIdo6Ak9h1rxBv2DvDnirxQLjW7b+0p5ZCzQrZokO712hcMMZrz5V8OqduR83e\\/6Hu0sNiFV5+ZcvaxyXwb\\/AGcfFHj3OtfDvSkeymgffqLyhdygHKLg8gY614x8Ztf174UeI9T8KaxfAXN2BNMQrriYrtKKD97AH3gOa\\/SvwT4Oj+FPguz8JaTDJGmnrIAWAUAvnK49O2PevgP9unwva3Xxnt\\/EV3aLNja1x5mCpKnOOenpWTmoNXO5QU09DwTwr4r\\/AGY\\/B0F14t+K3hy68Q6jH\\/rbeFCsED8ny3ZVZgxCsfugcYznisjxr+2x+zp4u0CXTPCvwxtNK00SeUHWBgA3oTJGnOMHrX254a8CfDDxh8ICnhH4PaLcwzQA31nPpMG4vjO4krlj3yT796+dfGH7P7XlzLpmh\\/CHS9ItySzSyW4JC+ygEV1RxODaSnzX9dDzKuDxjk3Hl5fNHjnw00zwPf3KeLPBs1qod8GaEcOpPQ4PBryj9or4exT\\/ALS9jpOmWfmSatDabI0OGZ5JPLIHb0x7mvoG58DeBfC90mhaW01rfREK8kVq0Qdc5JIxtI9O9cb4v8Oadrn7V3w4aa3MiCZftIz95Y5kK89shj+VergcUvbOV9LHhZngr0FBJXv0P1G+Eei6F4I8Gab4I8KWa2+naTYRWtlAv8MaDAzjGSeST3LE9661ZXJBzXC\\/C\\/Uft0XnBsrtGPpXbI6nGDXp25nc+LkveP0dZSelMxzipKY2ck\\/rXpWRi9zwb9vm7L\\/DTTdMMKsp1qGYk\\/wsqvjH615b8IvD+jx2VvZzMsYuAPPmEeSB6jNeq\\/t5aZcXfw2sb+2YBbbVIzKfXcCoH8\\/zr5m\\/4WHdaHo8Op2t61qYIxvd5ioQAcnjnHavkc9mo41N9kff8KxTwTV+rOr+M\\/i\\/wT8ORc3lzdwypbvskklA9cKcg8HHp6V5v8FPGHxD+OXiGfxF4ciSz8LaTf8AltcsCXvZcZCKOyLlSSevAA5JHlXiK78UftBeOoLe21KKPQba7D3btvIuCMZLMy\\/OODwi4BJyx6D1XxDb\\/FnwV4Ht9E\\/Zt8e6boN9JcCaWLWtLNzFID975UZSvCrjB4xXi04Sq1rpaH2bnSo0LX1PeIfDGs6\\/ZzQ21uryWdmZJvLjIZMc72yfunHSvg39sLSF1XxO89xFbpJNMibGz8ik8nj6frX0D4n\\/AG1Pi38HPh9cS\\/FFS93PYmO\\/utIDGCdiNoIQ\\/MBk8DnFfnJ+1B+0r8Ydd8YzXHh7wFqTSuxCm+Roosbu4PLD6V2VKLm0ob9Thp1lFOUnp0sey\\/CT4ieMP2W\\/FNlpfiC+h1Lw1rEiDriW0Y5AGW+8mBX1j4pk8E+I\\/CC6rplnBIJ1ASaEjoec579a\\/LjT\\/iH8XfHdxav8Sdlv9nmRmW0uCRtX7qqD04617n8Nf2hdU8P6Y3hi11sXMZU+VBcTBWUY6Lnr9BXPWpyprVa+R0UpU6mt9C78dtH8PJcTWVswWdCwR9w5Oe\\/rXm\\/wk8P6Ne\\/EWLxPfQCW8sLGWOzYjOzdIuSPfjAqj8Svihf3PiCeS8OBISu3uM5wa1fgvPCddknRmc\\/ZwrexLqf6GvRy1NNOXU+dz2ajSlydD7M+B9wzaNu6nGDmvRonJIGOODXmfwcKQ6RH5bfw9+9ei280hYH1FfQH5\\/Ja6H6VU0uc4Ap2360jKMZA5r1Dl5Thf2gPAp8c\\/C\\/VdHgCtci2aa1V+nmopZf1GPxr89vEsE2sQaj4bj2iaW1d4EmXaGB3AcduR07YPpX6ezxC4RomPVSM18Rfto\\/s+6r8PPiHD8TPDtqx0jUHIknhwBbTuSXjbHI3csD07Cvnc+wftaKqparc+r4ZxqoVnQk7J7Hytf8AxutP2etItJdW8H3+pRx2gOpT6XYmR49pw7Kg+Y\\/gfwro\\/gj+3V+zn+0LdXkXw\\/vru7u7FRJcWS20iXNvGOMyRbdyqDjJPFadpp1rdeKFju1SXMwaPzDuLA5yCP1z3z7Vu3HwY8N\\/DDx\\/F8dfhFoVpo+r3Fkbe9vrezVPOiaQM8Mg3YdDtDAHp0BHSvFwDUoNNan286MpyvFr5nKfHe4+F\\/xJtbe81jWrvT7ayAee2lX5Jgx+XIbb1GCAMV83fG\\/40fCLVdKTw4Znup7PcUugqpgKRxhdxxg96+4viV+0X8RNV8B6v4G+IfwV8Kave3USRRS22oeUgCxbAHEkbhODn5GI4rwT9prxppN\\/oep3mk\\/BLwZ4XEvh97GVjdec8btg7o\\/LijGAAeoyc10ypS5tzOn9ZlZOh87qx+f3xC+N3wu0KdpJ7l7RC52tLwGHPIxz+ner\\/wAKV1b4qa5o9xo2kzfZLi6R7S6khZQw3ckZwcVhS\\/Cbwf4v8bP4j8RTSatNG6LG0yKkCKqhcRxg4GcdSTxzXv8A8Ob3TdGjjMNxGgtU80EpgLEo59Ng7D1NOu6dKklDWTMI0sQ6zc2kuyPN\\/wBpJLLTfi62mWOAkWyKV16Z2\\/8A6q7H9nGB7iP+1ZVJ8wqiDHXBGf1rzTVrl\\/iD48lvLcNK91eM\\/JztXd98n29PevdfhZp1tpU9tpdm52QbVAI9+a68BTtBOR89nmITvTj1Pqz4cwJbaLCXAHyDiuutrlRjHp1rkvBrbdKgU\\/8APMGugguMJjOOa9M+UP1AZt3amM5BwKbNIFXIJFVvPB+6xbnBA5r1Dld7k7EqcjvWL45s\\/CWq+FdQsvHX2NdHktWXUJdQlWOFI8H5mdsKgHYk8Fc18zft0f8ABXD9nD9jaO98IW2pR+LPGtvCzP4d0y6AjssfxXc4yIQP7i5kPoK\\/FD9oT\\/goX+1X+3742h8UfGL4mXkfhdtQceH\\/AAbpjm10+BQWxM0MZAkbI4L7mPUnmhxTi7roXTU3NWP058R+H\\/C+j\\/Ei80Hw5r0N\\/pr3L\\/2Dq9tcrKl5Bn5CsifK5C45Gc12NiZYNJXTjL8iqVBeLdubOcN7Hp0rjtL+HGlL8MdG0ayVo4tI0+CKBoSQ8IjRVVwfXIyfrT4vijceFrQ6B8QIGjkmXyxqBH7q4UjGT\\/db+dfAU61N13bTU\\/WaMZxpxU9dFc8w+OVj4jfU5G0NrVYUkKy+RfOSXADFFTHXB59K+b\\/izoPjnxiJk1G7hkgZiIs33ylQPvkkAFT0B9c19U+JrrwPPZX1zpUttLPLeO8iMRk5UfVueuB3rwPxv47+HugXdvJr8dijW37tJFhRdyRsMZPZjjrW\\/tvetbU9hKgqXNzux4Vpfwq1TSbJ9XuprdYC7iEqcIVUctx74AH8XauI+IPxBudJVvC+kXMm+aMfaSj5MhwM5\\/HtXX\\/G\\/wDaFXxg40Tw5ZDyobl5k8scuzdT7D29s15no3hm+1DUje3pMtxM2T3IzWyTT5qh4WKmqkuSht3O0+D1xpeihU1C8ggur6UJCJZQrSsBnYuT8xxzgc4r3L4cWjvrUcm8fKQSPxr5b\\/aI8K28fwjmuGlaKfTLiC6tblCQyzBwnBHIysjjj0FcR8If2wvjN8LZoZ7bX01S3AGbHWVMqEZ5CuMOn1B\\/A17eBpqvQ5o9D4vN4SoYpp9T9c\\/Dd2E0+II44Qcg1tRXAdcl+frXyR+z3\\/wUv+Cvj6C20H4hs3hHVHAVGvpN9jKfRZwBtPs4X6mvp2w1m3uYI7y2uI5YZE3pPHKGjZezKw4YH1HFayhKDszxbpn\\/2QAAAAAAAAAAAAAAAAA=\",\n                            \"index\": \"0\",\n                            \"templates\": [\n                                {\n                                    \"template_ex\": \"AAADAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB3hoF9hIJtgm5piFVlioaSc4aMc3qPi5dgiIV0e4mBh42MfXGId4ZxhIGGbmyXg4VpgoGEo3x9ZIJudm6bj4aTc3iSfWWMh3uFiICKcpp7lYyGhoqRfmhzi3mDlH2BcoJugG2aZGNydYlzlmxvYndgloGFfYtyd3aIY5KRbZKRi4J8f3d0kZyFgnuZgIaAiXNgYIZ0lpCGbZdxeIJeboGPfJFwgJByiXyEdIV+dI6IbZl5gYNzjn+FbIeJfX2Fc5l2dHxzboeHgYBzgIGLknuBfn1kjXRqhXeEhmuKd3tvfoF3eotxl41xf4N9coiObG+UhYWIdIeNbG6Eh41xi3WId3WQoWJvaXt5jIt0eWCSX6N1gHWXfHhleZCCgoVtiH51c46Lg3p7b5F0goF3gnx2cWxtgn2WmYNugH2idot3h3mQhHeHfX2Lgn+Kd5F0j22BgXlsfJt3d1aDhn2AcYNxfHRpgoiIeXOJZIuSc3aBc29ukLWCaG6NiINvi4CLgn50imOIjX5tdHx2YIV1gHCehHmQgXiBfIyPdY1ph3Z8kHGGd5+Cb3CClY2UfZeIc36Ad3ZYfId4fniFeX6Qcnxsi3l4a317fZV9doh5ootvY256h4hzeIOCcnOGg3Z9bn9+fnyFe4+Ff4lyg4WAZm+Id4WQgpZqdoprcnx1fnt+eWtIV09iWTV6\",\n                                    \"credential_bin_type\": \"5\"\n                                },\n                                {\n                                    \"template_ex\": \"AAADABEBywGIALIAZAcF\\/SBiVHcAAJkAAAAAAAAAAAB5h399g39vgm9shlpnioWQdISKdHiQipJhhoJ1eIiChoyLfW+GdoZ1g4GHb2+XgYVog4OCo3h5ZYRweW6bjoaTcnaOemaOhniFin6Kcpl3lIiHhYeSf2p0iHqDkn2DcoJtgG+YZ2Fxdol0lWpwX3ddmH6GfItyenaGYpCObpKRjIF9fHhzj5uGgHuXgIR\\/iXJfYYd3l46CbJVvd39fcX6Peo9xfo9yiHuCcoOAco2Hbph5gYN0jH6DboaJfHyDcph3dn5za4eFgoByfoCJjnqAf31liHVqg3iFhGyLdXtyfoF2fIxxl4xygIF9c4SQbG+Ug4OHdYeMam+Dh4tyi3WHeXSPn2RwZ3l3i4pzemORYaB1gXKXe3hjeIyBf4ZthXt0cYuIg3p6bo13goF4gHt2b29vgn2UmYJwfn2fdol3iniQg3aEfH6LgYCJdpBzkG6BgHhse5lzdVeEhHyAcYNxfHNogYeIeHGJaIqSc3eBdHBvjrKDZ2+Og4NvioGLgn50h2WFi3tsdH54YYN0gG+cg3iRgHiAfYmNdoxsh3d8kHKGeJyDcHOAkoySgZWGcn9+dXdafIZ4gHaFeH+PcXttjHR7bn19e5N6eYd6ootwYm97h4Z2dYCDcHWFhXR+cH1\\/fHuCeouDfod0g4KAZ3KId4OQg5Frd4xucHx2fnl9fAAAAAAAAAAA\",\n                                    \"credential_bin_type\": \"5\"\n                                },\n                                {\n                                    \"template_ex\": \"AAADAOcAyQGJALAAZA4J9ChYNXkAAJMAAAAAAAAAAAB3h4B+g4Bxg3BthlpniYSScoOLdHqPjpRghoR1eYSCho2Le26HeIV0goCGb22Wg4Zrg4GAont4ZIRwd2+ajYORc3qPfGWNh3qHiH+Kc5d5koqEiYiRf2hyiniGkXyDcoBvgW2XZmNydoZ0lmptYndfl36Geoxwd3eFY42RbpKRioR9e3dyj5qFg3uWf4WAiHFhYYZxlI+EcJVweIFdcoCNepFzfo9ziHuFdIZ+coyIcJp6gIF1i3+EbYWIfn2Cc5Z2dn9za4aDgYB0goKHj3yBf3tminJpg3mFhGmLdntxf4B4e4tuloxygIN8c4WObW+Th4OKc4aMaW6EiYtyjXWGdXWSoWZxa3p3i4x0emGQZKF2gHWXe3dmeI2DgYRvg391bo6Hg3t7bpB0f4F3f3l5b25sg32UmYFvgX6hdIZ3iHmRg3iGf4CIgH+LdpBzj29\\/gnlqepd3dliEiH1+cIRxfHZrg4iIeXGHaImRcXSAc3BujbODaG6OhYNwioKLg390hWSFjX1wdX13YYR2gHCch3mQgHiCfYmMdY5nhXd9kXKFd5uDcHCDk4qSfpaDcX5+eHVZfoh4fXiDdn6Qcnlri3V4bn97fZF9doh6oYtwZXN5hYh1doOEcHSEg3l8cH9+fXyBeY2DfodzgoF\\/Z3GGdYGRgpRqeIltcX10fXt7eAAAAAAAAAAA\",\n                                    \"credential_bin_type\": \"5\"\n                                },\n                                {\n                                    \"template_ex\": \"AAADAOEAfAGyANsAY+j+DStRTmQAAIcAAAAAAAAAAAB1h39+f31sgXFph1pnioSUdIaKdXiPipRihYJ2eYiEhouLfXCGeIVyg4OEcWuXhIRqhYGDonp6ZINudm6akIaRdHiOfGaMiHmGh3+IcZh7l4yFhYqRfmpzjHmDk32BcoJxgm2YY2NxdYhzlGltYnRhloCFfYxzdnaFYZCPbo+OiIN6gHdzkZmHg3qXfoWAinJhYYV0lJCDb5RwdoFecH+QeZBxfpJzh32GcYWCdY6GbZl3gIJyjH2Fa4aHfH+Cc5h1dHx2bIeGg390g3+Kj3qBf3xmjHNogneGgmuKd3txfoF2fI1zl41yfoN9coiObW6Sh4SIc4aNbG6Chotyi3aKd3eQnmVxa3x2jYh3eWKSYKB3f3OXenhmd4uCg4ZvhX52cYmJhXl6bY52gH94gHx4cm1sgX6XmoFxf32fdYp2hXiPgneGfn6MgYGKdI5yjm+BgXhse5Z3eVmFh3yAcoJwe3JogYaHeHSIZomSc3SAdHFtj7GBaG2Ng4NwiYKJgoJ0iGSHin5vd3x1X4R0gW6bhXaQgXiCfIyLd41ohnR8kHCGdZyDb3OAko6Sf5WJc3x+d3VbfoZ4gHiDeYCRdH5tinh2bYB7fJZ+dIl5o4xvZXB4h4R2d3+DcHWEgXV+cYCBfHuEe4yDf4l0hIN\\/ZnCGdYGOgpJqd4ltcnx1fnt8egAAAAAAAAAA\",\n                                    \"credential_bin_type\": \"5\"\n                                }\n                            ],\n                            \"flag\": \"1\"\n                        }\n                    ]\n                }\n            }\n        ]\n    },\n    \"DeviceResponse\": {\n        \"rows\": [\n            {\n                \"id\": \"538152248\",\n                \"code\": \"0\"\n            }\n        ],\n        \"result\": \"true\"\n    },\n    \"Response\": {\n        \"code\": \"0\",\n        \"link\": \"https:\\/\\/support.supremainc.com\\/en\\/support\\/home\",\n        \"message\": \"Success\"\n    }\n}\n\n

ID of the user which will be uploaded. Use plus symbol ( + ) to separate multiple user ID, ex: 1+2+3.

\n","type":"text/plain"},"key":"id","value":"44004"}],"variable":[{"id":"c6f7d59e-bc3d-4b0d-a32f-39f5185af30d","description":{"content":"

ID of the device which the user data will be uploaded to.

\n","type":"text/plain"},"type":"any","value":"538152248","key":"id"}]}},"response":[],"_postman_id":"bcaba0b5-71d8-48b0-ae2c-437fc0ffde03"},{"name":"View RS485 Devices","id":"0cbe5f8f-9fed-4369-b41a-427a4bc3baed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/devices/rs485/:dev_id","description":"

This API is used to list devices which connected using RS-485.

ID of the device which will be viewed

\n","type":"text/plain"},"type":"any","value":"542071155","key":"dev_id"}]}},"response":[],"_postman_id":"0cbe5f8f-9fed-4369-b41a-427a4bc3baed"},{"name":"Delete All Event Logs in Device","id":"163f7b49-a85b-42c8-80e1-b28b26e05841","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/devices/clear_log?id=String&group_id=Integer&offset=Integer&limit=Integer","description":"

Delete all event logs stored inside one or more devices.

This endpoint instructs selected devices to remove all event logs stored locally on the device.

Deleted logs cannot be recovered and cannot be restored from the server.

Before using this API, ensure that the device event logs have already been successfully uploaded to the server.

Devices that do not store logs are automatically excluded from the deletion process:

Slave devices
\n
Virtual devices
\n
Wiegand devices
\n

Permissions

This endpoint requires Administrator privileges.

Behavior

Case 1: Clear logs for specific devices

If id contains one or more device IDs, the endpoint clears logs only for those devices.

Example

DELETE /api/devices/clear_log?id=1001 1002 1003\nOR\nDELETE /api/devices/clear_log?id=1001+1002+1003\n\n

Case 2: Clear logs for all devices

If id=*, the endpoint targets all devices.

Example

DELETE /api/devices/clear_log?id=*\n\n

Case 3: Clear logs for filtered devices

If id=*, optional filters may be used to restrict the target set.

Example

DELETE /api/devices/clear_log?id=*&group_id=10&offset=0&limit=50\n\n

This means:

target all devices
\n
restrict to group 10
\n
apply paging with offset=0 and limit=50
\n

Notes

This API deletes only the event logs stored in the device.
\n
Event logs already stored on the server are not affected.
\n
Deleted logs cannot be recovered.
\n
Devices that do not store logs (Slave, Virtual, Wiegand) are automatically excluded.
\n

Device ID(s) to clear logs from. Required.\nOne device ID: id=1001\nMultiple device ID: id=1001 1002 OR 1001+1002\nAll devices: id=*

Notes:\nIn URLs, spaces must be encoded as %20\nExample encoded value:\nid=1001%201002%201003

\n","type":"text/plain"},"key":"id","value":"String"},{"description":{"content":"

Optional\nOnly meaningful when id=*

Device group filter.

Notes:\nIgnored unless id=*

\n","type":"text/plain"},"key":"group_id","value":"Integer"},{"description":{"content":"

Optional\nOnly meaningful when id=*

Paging offset.

Notes:\nIgnored unless id=*

\n","type":"text/plain"},"key":"offset","value":"Integer"},{"description":{"content":"

Optional\nOnly meaningful when id=*

Paging limit.

Notes:\nIgnored unless id=*

\n","type":"text/plain"},"key":"limit","value":"Integer"}],"variable":[]}},"response":[{"id":"1d1eca42-754d-4aa5-b3f3-f64bed83666e","name":"Delete All Event Logs in Device","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://127.0.0.1/api/devices/clear_log?id=544140034","host":["https://127.0.0.1"],"path":["api","devices","clear_log"],"query":[{"key":"id","value":"544140034","description":"Device ID(s) to clear logs from. Required.\nOne device ID: id=1001\nMultiple device ID: id=1001 1002 OR 1001+1002\nAll devices: id=*\nNotes:\nIn URLs, spaces must be encoded as %20\nExample encoded value:\nid=1001%201002%201003"},{"key":"group_id","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nDevice group filter.\n\nNotes:\nIgnored unless id=*","disabled":true},{"key":"offset","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nPaging offset.\n\nNotes:\nIgnored unless id=*","disabled":true},{"key":"limit","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nPaging limit.\n\nNotes:\nIgnored unless id=*","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"DeviceResponse\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"544140034\",\r\n \"code\": \"0\"\r\n }\r\n ],\r\n \"result\": \"true\"\r\n },\r\n \"Response\": {\r\n \"code\": \"0\",\r\n \"link\": \"https://support.supremainc.com/en/support/home\",\r\n \"message\": \"Success\"\r\n }\r\n}"},{"id":"9931cf1b-66cb-4ac1-8ebf-2e5ef4547ef1","name":"Clear Logs for Multiple Devices","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://127.0.0.1/api/devices/clear_log?id=544140034 543408590","host":["https://127.0.0.1"],"path":["api","devices","clear_log"],"query":[{"key":"id","value":"544140034 543408590","description":"Device ID(s) to clear logs from. Required.\nOne device ID: id=1001\nMultiple device ID: id=1001 1002 OR 1001+1002\nAll devices: id=*\nNotes:\nIn URLs, spaces must be encoded as %20\nExample encoded value:\nid=1001%201002%201003"},{"key":"group_id","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nDevice group filter.\n\nNotes:\nIgnored unless id=*","disabled":true},{"key":"offset","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nPaging offset.\n\nNotes:\nIgnored unless id=*","disabled":true},{"key":"limit","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nPaging limit.\n\nNotes:\nIgnored unless id=*","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"DeviceResponse\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"543408590\",\r\n \"code\": \"0\"\r\n },\r\n {\r\n \"id\": \"544140034\",\r\n \"code\": \"0\"\r\n }\r\n ],\r\n \"result\": \"true\"\r\n },\r\n \"Response\": {\r\n \"code\": \"0\",\r\n \"link\": \"https://support.supremainc.com/en/support/home\",\r\n \"message\": \"Success\"\r\n }\r\n}"},{"id":"844026ce-b2f3-473a-8ef3-84014da7ca6c","name":"Clear Logs for All Devices","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://127.0.0.1/api/devices/clear_log?id=*","host":["https://127.0.0.1"],"path":["api","devices","clear_log"],"query":[{"key":"id","value":"*","description":"Device ID(s) to clear logs from. Required.\nOne device ID: id=1001\nMultiple device ID: id=1001 1002 OR 1001+1002\nAll devices: id=*\nNotes:\nIn URLs, spaces must be encoded as %20\nExample encoded value:\nid=1001%201002%201003"},{"key":"group_id","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nDevice group filter.\n\nNotes:\nIgnored unless id=*","disabled":true},{"key":"offset","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nPaging offset.\n\nNotes:\nIgnored unless id=*","disabled":true},{"key":"limit","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nPaging limit.\n\nNotes:\nIgnored unless id=*","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"DeviceResponse\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"538152248\",\r\n \"code\": \"0\"\r\n },\r\n {\r\n \"id\": \"543408590\",\r\n \"code\": \"0\"\r\n },\r\n {\r\n \"id\": \"544140034\",\r\n \"code\": \"0\"\r\n }\r\n ],\r\n \"result\": \"true\"\r\n },\r\n \"Response\": {\r\n \"code\": \"0\",\r\n \"link\": \"https://support.supremainc.com/en/support/home\",\r\n \"message\": \"Success\"\r\n }\r\n}"},{"id":"3f233628-6c2e-471c-9fbc-3f81afc0d792","name":"Clear Logs for All Devices Matching a Group","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://127.0.0.1/api/devices/clear_log?id=*&group_id=2","host":["https://127.0.0.1"],"path":["api","devices","clear_log"],"query":[{"key":"id","value":"*","description":"Device ID(s) to clear logs from. Required.\nOne device ID: id=1001\nMultiple device ID: id=1001 1002 OR 1001+1002\nAll devices: id=*\nNotes:\nIn URLs, spaces must be encoded as %20\nExample encoded value:\nid=1001%201002%201003"},{"key":"group_id","value":"2","description":"Optional\nOnly meaningful when id=*\n\nDevice group filter.\n\nNotes:\nIgnored unless id=*"},{"key":"offset","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nPaging offset.\n\nNotes:\nIgnored unless id=*","disabled":true},{"key":"limit","value":"Integer","description":"Optional\nOnly meaningful when id=*\n\nPaging limit.\n\nNotes:\nIgnored unless id=*","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"DeviceResponse\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"543408590\",\r\n \"code\": \"0\"\r\n }\r\n ],\r\n \"result\": \"true\"\r\n },\r\n \"Response\": {\r\n \"code\": \"0\",\r\n \"link\": \"https://support.supremainc.com/en/support/home\",\r\n \"message\": \"Success\"\r\n }\r\n}"},{"id":"d6d3a99a-1c71-4997-bfae-0831bcea5941","name":"Clear Logs for Paged Filtered Results","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://127.0.0.1/api/devices/clear_log?id=*&group_id=2&offset=0&limit=1","host":["https://127.0.0.1"],"path":["api","devices","clear_log"],"query":[{"key":"id","value":"*","description":"Device ID(s) to clear logs from. Required.\nOne device ID: id=1001\nMultiple device ID: id=1001 1002 OR 1001+1002\nAll devices: id=*\nNotes:\nIn URLs, spaces must be encoded as %20\nExample encoded value:\nid=1001%201002%201003"},{"key":"group_id","value":"2","description":"Optional\nOnly meaningful when id=*\n\nDevice group filter.\n\nNotes:\nIgnored unless id=*"},{"key":"offset","value":"0","description":"Optional\nOnly meaningful when id=*\n\nPaging offset.\n\nNotes:\nIgnored unless id=*"},{"key":"limit","value":"1","description":"Optional\nOnly meaningful when id=*\n\nPaging limit.\n\nNotes:\nIgnored unless id=*"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"DeviceResponse\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"543408590\",\r\n \"code\": \"0\"\r\n },\r\n {\r\n \"id\": \"544140034\",\r\n \"code\": \"0\"\r\n }\r\n ],\r\n \"result\": \"true\"\r\n },\r\n \"Response\": {\r\n \"code\": \"0\",\r\n \"link\": \"https://support.supremainc.com/en/support/home\",\r\n \"message\": \"Success\"\r\n }\r\n}"}],"_postman_id":"163f7b49-a85b-42c8-80e1-b28b26e05841"}],"id":"2bc0a8d6-536a-48e2-bb56-913b21a7b444","event":[{"listen":"prerequest","script":{"id":"6311af3c-8fa7-4fac-ac14-b460e81db9e3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4441836c-223b-4165-8580-014593eba874","type":"text/javascript","exec":[""]}}],"_postman_id":"2bc0a8d6-536a-48e2-bb56-913b21a7b444","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Door Groups","item":[{"name":"View All Door Groups","id":"7ad09d97-62af-404f-b2f2-32ebfb943e04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/door_groups/search","description":"

This API is used to view all available door groups.

It is required to put {} on the body parameter to run the API successfully.

This API is used to view all door groups while sorting the response using available fields.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
order_by	String	Y	Sort the response records by value which inputted on this parameter
:boolean	String	Y	Value which the sorting will be based on. Available fields: id, name, depth

This API is used to create door groups.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
parent_id:id	Number	Y	Parent ID of the group.
depth	Number	Y	Depth of the group in accordance with the parent group (parent depth+1). Value between 1 to 8.
name	String	Y	Name of the group. Do not put empty value on this parameter. Max 48 characters.

Known issue:
- Duplicate group name within one parent group
- depth value not within 1-8
- Using parent_id which doesn't exist will result in success but the created group will not be visible.
- Using empty value on name will success creating a door with name: undefined. This door can't be deleted. To resolve this, update the door name then it will be able to be deleted.

This API is used to delete door group.

Put the door's ID on the id parameters of this API to delete door.

Note:
- Deleting parent group will also delete child group
- Deleting groups with door(s) will also remove door(s) under that group. This will consequently remove doors from Access Levels
- Can't delete groups with parent_id which doesn't exist
- Can't delete groups with undefined name

ID of the door which will be deleted

\n","type":"text/plain"},"key":"id","value":"33"}],"variable":[]}},"response":[],"_postman_id":"150b332d-b9d4-486c-82a7-5118df112a36"},{"name":"Update Door Group","id":"313636c9-342c-4372-bf1d-a97a77f05182","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"DoorGroup\": {\r\n \"name\": \"New11\",\r\n \"parent_id\": {\r\n \"id\": 45\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/door_groups/:id","description":"

This API is used to update door group.

Put the door's ID on the id parameters of this API to update door.

Note:
- When parent_id updated, any child group will follow the parent group

This API is used to view a Door details.

ID of the door which will be viewed

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"50a13272-17cd-4953-a00b-bdca71341163"},{"name":"View All Doors","id":"f23456b9-2e0d-4c75-ba81-3eece2985d77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/doors?limit=0&order_by=id:true","description":"

This API is used to view Doors which is recorded on BioStar 2 database.

Limit the number of records according with the value specified

\n","type":"text/plain"},"key":"limit","value":"0"},{"description":{"content":"

Sort the records based on the id, toggle true/false to switch asceding/descending

\n","type":"text/plain"},"key":"order_by","value":"id:true"}],"variable":[]}},"response":[],"_postman_id":"f23456b9-2e0d-4c75-ba81-3eece2985d77"},{"name":"View All Doors v2","id":"2934e489-e33b-4bc1-8b34-94fc03e59081","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"limit\": 25,\r\n \"search_text\": \"\",\r\n \"door_group_id\": \"1\",\r\n \"order_by\": \"door_group_id.name:true\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/doors/search","description":"

This API is used to view door records from BioStar 2 database.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
limit	Number	N	Limit the number of records on the response according to the value specified
search_text	String	N	Find records with the specified string
door_group_id	Number	N	Limit the records to only those with door_group_id specified
order_by	String	N	Sort the response by stated value (id, door_group_id.name). Toggle boolean to switch ascending or descending.

It is required to at least put {} on the body for the API to run correctly.

This API is used to create a door.

BODY parameter on this API:

Parameter	Type	Required	Description
name	String	Y	Name of the door
description	String	N	Description of the door
door_group_id:id	Number	Y	ID of the Door Group which the door will be under
open_timeout	Number	N	Configure the maximum allowed time for the door to remain open. Default: 10.
open_duration	Number	N	Set the duration for which the door will remain open after a user authentication is completed. When the authentication is successful, the relay will be activated for the set time. When this time elapses, the relay no longer sends the signal to the door. Open Time may vary depending on the type of door lock used.
open_once	Boolean	N	Lock when door is closed: When the door sensor detects that the door is closed, the door is locked. Set this option to false if unconditional_lock is true. Set true to enable this parameter. Default: false.
unconditional _lock	Boolean	N	Use Automatic Door: When using an automatic door as an entrance door, a relay can operate regardless of the status of a door sensor. Set this option as false if open_once is set to true.
relay_output_id:device_id:id	Number	Y	Device ID which the relay will be used to control the door lock.
relay_output_id:relay_index	Number	Y	Relay index of the device which will be used.
exit_button_input_id:device_id:id	Number	Y	Device ID which will be used as exit control.
exit_button_input_id:input_index	Number	Y	Exit index of the device which will be used.
exit_button_input_id:type	Boolean	Y	1: Normally Closed, 0: Normally Open
sensor_input_id:device_id:id	Number	Y	Device ID which will be used as sensor control.
sensor_input_id:input_index	Number	Y	Sensor index of the device which will be used.
sensor_input_id:type	Boolean	Y	1: Normally Closed, 0: Normally Open
sensor_input_id:apb_use_door_sensor	Boolean	Y	Set whether to use the door sensor when using Entry Confirmed APB.

This API is used to update a Door details.

Leave the values to be edited, and remove everything else.

ID of the door which will be updated

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"489812dc-9bc1-438f-8a7a-b60b3796961a"},{"name":"Delete Door(s)","id":"72a6e446-c452-41fe-98be-d55949ba109f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/doors?id=","description":"

This API is used to delete Door(s).

ID of the door which will be deleted. To delete multiple doors, separate the IDs with space.

\n","type":"text/plain"},"key":"id","value":""}],"variable":[]}},"response":[],"_postman_id":"72a6e446-c452-41fe-98be-d55949ba109f"},{"name":"View Door Status","id":"c1b6e377-8543-48f4-99c6-bc93a44ae248","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"monitoring_permission\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/doors/status","description":"

This API is used to view various door status information such as the door status, relay status, alarm and last event.

Fire alarm unlocked: A state where the door designated as a fire alarm zone is unlocked because a fire has broken out.
Manual Lock: A state where the door is locked because the administrator has locked it manually.
Manual Unlock: A state where the door is unlocked and able to enter without an authentication because the administrator has unlocked it manually.
Schedule Locked: A state where the door is locked by the schedule that has been set.
Schedule Unlocked: A state where the door is unlocked by the schedule that has been set.
Normal: A state where a user can enter the door after an authentication.

This API is used to clear alarms of all doors. If an alarm is
set in the Zone, the alarm may be continuously output even if the door alarm is released.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the door which the alarm will be cleared

This API is used to reset the anti-passback violation by selecting all or each user.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the door which will be cleared
User	Array	N	List of user(s) which the APB will be cleared
UserType	Number	Y	AntiPassback config User Type.
target	String	Y	Doors target

This example shows how to clear APB for specific user(s).

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the Door which will be cleared
user_id	Number	Y	User ID of the user which will be cleared
UserType	Number	Y	AntiPassback config User Type.
target	String	Y	Doors target

This API is used to lock a door manually. If you set Manual Lock, the door will have remained inaccessible even if a user authenticates.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the door which will be locked

This API is used to unlock a door manually. If you set Manual Unlock, the door will have remained accessible even if a user does not authenticate.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the door which will be unlocked

This API is used to release the manual lock or manual unlock set by the administrator.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the door which will be released from Manual Lock/Unlock

This API is used to clear Timed APB access record. It is accessible in BioStar 2 version 2.9.5 and later.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
TimedAntiPassBackConfig.Door.DoorCollection.rows.id	Number	Y	Timed APB’s selected Door IDs.
User.user_id	String	N	List of User ID which will be cleared.
UserType	Number	N	1: All, 2: Specific
target	String	N	User target, all users or single user.

Response Example:

{\n  \"DeviceResponse\": {\n    \"rows\": [\n      {\n        \"id\": \"50335900\",\n        \"code\": \"0\"\n      }\n    ],\n    \"result\": \"true\"\n  },\n  \"Response\": {\n    \"code\": \"0\",\n    \"link\": \"https://support.supremainc.com/en/support/home\",\n    \"message\": \"Success\"\n  }\n}\n\n

Response Properties:

- DeviceResponse : The response from device.\n    - result : success/error.\n    - rows : affected devices with success/error code\n- Response : the response from web server, each with the following properties:\n    - code : success/error code.\n    - link : Suprema support link.\n    - message : Success/error message.\n\n

Errors:

This API uses the following error codes:

400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorized: The API key provided was invalid or missing.
404 Not Found: The requested resource was not found.
500 Internal Server Error: An unexpected error occurred on the server.

This API is used to open a door.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the door which will be opened.

This API is used to list doors which use devices that connected to the system using RS485.

ID of the door which will be viewed

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"65227bf2-8b32-45a7-a846-b7b01a3e3e55"}],"id":"129165e2-d118-4ea5-a7b9-363675780416","event":[{"listen":"prerequest","script":{"id":"cbef58f5-e08e-4aa8-973e-d86962e06f83","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9567e8c7-77fb-4320-9069-f84df7a131d0","type":"text/javascript","exec":[""]}}],"_postman_id":"129165e2-d118-4ea5-a7b9-363675780416","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Elevator Groups","item":[{"name":"Create Elevator Group","id":"498b8a88-fb5c-41fb-b283-231327874a97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ElevatorGroup\": {\r\n \"parent_id\": {\r\n \"id\": 1\r\n },\r\n \"isElevatorGroups\": true,\r\n \"depth\": 1,\r\n \"sync_device_groups\": [],\r\n \"sync_devices\": [],\r\n \"inherited\": true,\r\n \"iconCls\": \"elevatorGroupIcon\",\r\n \"text\": \"New Elevator Group 1\",\r\n \"name\": \"New Elevator Group 2\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/elevator_groups","description":"

This API is used to create elevator group.

Required Values is parent_id, isElevatorGroups, depth, inherited, name
Elevator groups may be created in up to 8 levels.
Up to 48 characters may be entered for an elevator group name.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
parent_id:id	Number	Y	ID of the parent of the elevator group which will be created
isElevatorGroups	Boolean	Y	Marker for elevator group
depth	Number	Y	Depth of the group in accordance with the parent group (parent depth+1). Value between 1 to 8.
inherited	Boolean	Y	Inheritance marker of the group
name	String	Y	Name of the elevator group

This API is used to list elevator groups recorded on BioStar 2 database.

It is required to at least put {} on body for the API to run correctly.

This API is used to view elevator groups with criteria and permissions.

BODY Parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
order_by	String	N	Order the response results based on the specified field.

This API is used to update elevator group.

Up to 48 characters may be entered for an elevator group name.

ID of the elevator group which will be updated

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"28faf7d8-1239-4701-9796-990e47229082"},{"name":"Delete Elevator Group","id":"1d40c1da-835a-4013-97ae-a0506be4f7a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/v2/elevator_groups/:id","description":"

This API is used to delete elevator group.

Deleting a group deletes all elevators in the group.

ID of the elevator group which will be deleted

\n","type":"text/plain"},"type":"any","value":"5","key":"id"}]}},"response":[],"_postman_id":"1d40c1da-835a-4013-97ae-a0506be4f7a4"}],"id":"150b28b8-8a10-4c68-a6c5-01f6aeb4518d","event":[{"listen":"prerequest","script":{"id":"de395125-146c-4259-ae71-ece733a8eec0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9016c884-af81-496d-b4f3-fa28866b6794","type":"text/javascript","exec":[""]}}],"_postman_id":"150b28b8-8a10-4c68-a6c5-01f6aeb4518d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Elevators","item":[{"name":"Create Elevator","id":"b49f84a8-7eb4-414e-ab04-b25abf4b3e23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Elevator\": {\r\n \"name\": \"Odds\",\r\n \"description\": \"Odds elevator\",\r\n \"elevator_group_id\": {\r\n \"id\": 6,\r\n \"name\": \"New Elevator Group 2\"\r\n },\r\n \"reader_devices\": [\r\n {\r\n \"device_id\": {\r\n \"id\": \"544140034\",\r\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\"\r\n }\r\n }\r\n ],\r\n \"control_device_id\": {\r\n \"id\": \"544140034\",\r\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\",\r\n \"device_type_id\": {\r\n \"id\": \"13\",\r\n \"name\": \"BioEntry W2\"\r\n }\r\n },\r\n \"floors\": [\r\n {\r\n \"name\": \"Odds - 1\",\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 788930600,\r\n \"name\": \"OM-120 788930600\"\r\n },\r\n \"relay_index\": 0\r\n },\r\n \"order\": 0\r\n },\r\n {\r\n \"name\": \"Odds - 2\",\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 788930600,\r\n \"name\": \"OM-120 788930600\"\r\n },\r\n \"relay_index\": 1\r\n },\r\n \"order\": 1\r\n },\r\n {\r\n \"name\": \"Odds - 3\",\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 788930600,\r\n \"name\": \"OM-120 788930600\"\r\n },\r\n \"relay_index\": 2\r\n },\r\n \"order\": 2\r\n },\r\n {\r\n \"name\": \"Odds - 4\",\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 788930600,\r\n \"name\": \"OM-120 788930600\"\r\n },\r\n \"relay_index\": 3\r\n },\r\n \"order\": 3\r\n }\r\n ],\r\n \"module_devices\": [\r\n {\r\n \"device_id\": {\r\n \"id\": \"788930600\",\r\n \"name\": \"OM-120 788930600\"\r\n }\r\n }\r\n ],\r\n \"trigger_actions\": [],\r\n \"active_timeout\": \"10\",\r\n \"dual_authentication\": {\r\n \"device\": 0,\r\n \"approval_type\": \"0\",\r\n \"timeout\": 15,\r\n \"schedule_id\": {\r\n \"id\": \"1\"\r\n },\r\n \"approval_groups\": []\r\n },\r\n \"tamper_device\": {\r\n \"device_id\": {},\r\n \"switch_type\": \"0\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/elevators","description":"

This API is used to create elevator.

The minimum values is name, elevator_group_id(id, name), reader_devices(id, name), control_device_id(id, name, device_type_id), floors(name, order, elevator_device_id, relay_index). The rest can be removed.

Controller - control_device_id
Select a device that controls the elevator access permission.
▪ Only a master device can be selected.
▪ You can select it from the list of registered devices.

Reader - reader_devices
Select a device you intend to use for authentication.
▪ You can select a device among the master device, slave device, and Wiegand device.
▪ You can select up to 4 readers.
▪ OM-120 cannot be set as the reader.

Module - module_devices
Select OM-120 to control the elevator button relay.
▪ Only OM-120 can be selected.

Total Number of Floors - floors
Enter the total number of floors that you can move using the elevator.
▪ Up to 192 floors can be entered.

This API is used to list elevators recorder on BioStar 2 database.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
limit	Number	N	Limit the response records by the number specified on this parameter
search_text	String	N	Search records based on the value specified
elevator_group_id	Number	N	List elevators with specified group id
order_by	String	N	Sort response by specified value

It is required to at least put {} for the API to run correctly.

This API is used to view an elevator details.

ID of the elevator which will be viewed

\n","type":"text/plain"},"type":"any","value":"32770","key":"id"}]}},"response":[],"_postman_id":"4939a132-56df-43e6-a0ae-28f8190130e2"},{"name":"Update Elevator","id":"8a07b5ed-ac68-4b54-9642-d75172122721","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"Elevator\": {\r\n \"name\": \"Odds\",\r\n \"description\": \"Odds elevator\",\r\n \"elevator_group_id\": {\r\n \"id\": 6,\r\n \"name\": \"New Elevator Group 2\"\r\n },\r\n \"reader_devices\": [\r\n {\r\n \"device_id\": {\r\n \"id\": \"544140034\",\r\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\"\r\n }\r\n }\r\n ],\r\n \"control_device_id\": {\r\n \"id\": \"544140034\",\r\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\",\r\n \"device_type_id\": {\r\n \"id\": \"13\",\r\n \"name\": \"BioEntry W2\"\r\n }\r\n },\r\n \"floors\": [\r\n {\r\n \"name\": \"Odds - 1\",\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 788930600,\r\n \"name\": \"OM-120 788930600\"\r\n },\r\n \"relay_index\": 0\r\n },\r\n \"order\": 0\r\n },\r\n {\r\n \"name\": \"Odds - 2\",\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 788930600,\r\n \"name\": \"OM-120 788930600\"\r\n },\r\n \"relay_index\": 1\r\n },\r\n \"order\": 1\r\n },\r\n {\r\n \"name\": \"Odds - 3\",\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 788930600,\r\n \"name\": \"OM-120 788930600\"\r\n },\r\n \"relay_index\": 2\r\n },\r\n \"order\": 2\r\n },\r\n {\r\n \"name\": \"Odds - 4\",\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 788930600,\r\n \"name\": \"OM-120 788930600\"\r\n },\r\n \"relay_index\": 3\r\n },\r\n \"order\": 3\r\n }\r\n ],\r\n \"module_devices\": [\r\n {\r\n \"device_id\": {\r\n \"id\": \"788930600\",\r\n \"name\": \"OM-120 788930600\"\r\n }\r\n }\r\n ],\r\n \"trigger_actions\": [],\r\n \"active_timeout\": \"10\",\r\n \"dual_authentication\": {\r\n \"device\": 0,\r\n \"approval_type\": \"0\",\r\n \"timeout\": 15,\r\n \"schedule_id\": {\r\n \"id\": \"1\"\r\n },\r\n \"approval_groups\": []\r\n },\r\n \"tamper_device\": {\r\n \"device_id\": {},\r\n \"switch_type\": \"0\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/elevators/:id","description":"

This API is used to update an elevator configuration.

Leave values which will be edited and remove everything else.

ID of the elevator which will be updated

\n","type":"text/plain"},"type":"any","value":"32771","key":"id"}]}},"response":[],"_postman_id":"8a07b5ed-ac68-4b54-9642-d75172122721"},{"name":"Delete Elevator","id":"346e2078-3ac5-4e69-a126-ce2f1e3a325f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/elevators?id","description":"

This API is used to delete elevator.

ID of the elevator which will be deleted

\n","type":"text/plain"},"key":"id","value":null}],"variable":[]}},"response":[],"_postman_id":"346e2078-3ac5-4e69-a126-ce2f1e3a325f"},{"name":"View Elevator(s) Status","id":"06e542be-1441-44dd-b6d2-ce2fe6460cb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ElevatorCollection\": {\r\n \"rows\": [\r\n {\r\n \"id\": \"32770\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/elevators/status","description":"

This API is used to view elevator status.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the elevator which the status will be viewed

This API is used to lock elevator access to single/multiple floor manually. If you set Manual Lock, the floor will have remained inaccessible even if a user authenticates.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
rows:id	Number	Y	ID of the elevator which the floor will be locked
floors:order	Number	Y	Index of the floor which will be updated.

floors:order correlates with order on GET /api/elevators/:id or with floor_id:index on POST /api/elevators/status

This API is used to unlock a door manually. If you set Manual Unlock, the door will have remained accessible even if a user does not authenticate.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
rows:id	Number	Y	ID of the elevator which the floor will be unlocked
floors:order	Number	Y	Index of the floor which will be updated.

floors:order correlates with order on GET /api/elevators/:id or with floor_id:index on POST /api/elevators/status

This API is used to release the manual lock or manual unlock set by the administrator. When running this API, it will also reset the status caused by POST /api/elevators/open

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
rows:id	Number	Y	ID of the elevator which the floor will be released from Manual Lock/Unlock
floors:order	Number	Y	Index of the floor which will be updated.

floors:order correlates with order on GET /api/elevators/:id or with floor_id:index on POST /api/elevators/status

This API is used to open a floor.
Will only works if the floor status is clear/default (not manually locked/unlocked or there's active alarm)

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
rows:id	Number	Y	ID of the elevator which the floor will be released from Manual Lock/Unlock
floors:order	Number	Y	Index of the floor which will be updated.

floors:order correlates with order on GET /api/elevators/:id or with floor_id:index on POST /api/elevators/status

This API is used to clear alarms of all doors. If an alarm is
set in the Zone, the alarm may be continuously output even if the elevator alarm is released.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the elevator which the alarm will be cleared

This API is used to update a device's firmware.

Firmware file need to be placed on [BioStar 2 Install Path]\\firmware folder.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
filename	String	Y	Complete file name (include extension) of the firmware file which will be used to update
device_type	String	Y	Type of the device which the firmware file intended to
id	String	Y	ID of the device which will be updated
device_type_id	String	Y	Type of the device which will be updated

Use /api/device_types to find device_type and device_type_id, find the device's name and get the id for the parameters value.

This API is used to view firmwares information which is placed on folder [BioStar 2 Install Path]\\firmware.

Response Information Table

Device Type	Value
BS2_DEVICE_TYPE_UNKNOWN	0
BIOENTRY_PLUS	1
BIOENTRY_W	2
BIOLITE_NET	3
XPASS	4
XPASS_S2	5
SECURE_IO_2	6
DOOR_MODULE_20	7
BIOSTATION_2	8
BIOSTATION_A2	9
FACESTATION_2	10
IO_DEVICE	11
BIOSTATION_L2	12
BIOENTRY_W2	13
CORESTATION_40	14
OUTPUT_MODULE	15
INPUT_MODULE	16
BIOENTRY_P2	17
BIOLITE_N2	18
XPASS2	19
NOT USED	20
BIOENTRY_R2	21
XPASS_D2	22
DOOR_MODULE_21	23
XPASS_D2_KEYPAD	24
FACELITE	25
XPASS2_KEYPAD	26
XPASS_D2_REV	27
XPASS_D2_KEYPAD_REV	28
FACESTATION_F2_FP	29
FACESTATION_F2	30
XSTATION_2_QR	31
XSTATION_2	32
IM_120	33
XSTATION_2_FP	34
BIOSTATION_3	35
3RD_OSDP_DEVICE	36
3RD_OSDP_IO_DEVICE	37
BIOSTATION_2A	38
UZ_OSDP_MODULE	39
UZ_OSDP_DOOR_HANDLE	40
UZ_OSDP_DOOR_KNOB	41
BIOENTRY_W3	42

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Card Model	Value
OMPW	0
OIPW	1
OEPW	2
OHPW	3
ODPW	4
OAPW	5
ODSPW	6
PMPW	20
PIPW	21
PEPW	22
PHPW	23
PDPW	24
PAPW	25
PDSPW	26
ALL	30

Model Code

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Position	Description
O	Front	Optical FP Sensor
P	Front	PIV Certified Optical FP Sensor
A	Middle	All Cards
M	Middle	Mifare & DESFire
I	Middle	iClass
E	Middle	EM
H	Middle	HID
D	Middle	Dual Frequency (Mifare/DESFire [13.56 MHz], EM [125 kHz])
DS	Middle	Dual Frequency with SAM Card Slot
P	End	PoE
W	End	WiFi

Note:

PoE and WiFi may differ by device. Please check the devices specification from Suprema website (https://www.supremainc.com)

This API is used to view floor levels recorded on BioStar 2 database.

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":null},{"description":{"content":"

Order the response result either ascending or descending

\n","type":"text/plain"},"key":"order_by","value":"id:false"}],"variable":[]}},"response":[],"_postman_id":"d3c13d69-b64e-4113-8cfe-a8aedadeafdf"},{"name":"View a Floor Level Detail","id":"42c7adb5-8156-4080-b2cc-cba4dc9d58d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/floor_levels/:id","description":"

This API is used to view the details of a floor level.

ID of the floor level which will be viewed

\n","type":"text/plain"},"type":"any","value":"32769","key":"id"}]}},"response":[],"_postman_id":"42c7adb5-8156-4080-b2cc-cba4dc9d58d7"},{"name":"Create Floor Levels","id":"ba415537-ff3a-43bd-b805-94bcaa46e14b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"FloorLevel\": {\r\n \"name\": \"aaaax\",\r\n \"description\": \"aaaa\",\r\n \"floor_level_items\": [\r\n {\r\n \"elevator_id\": {\r\n \"id\": 32769,\r\n \"floors\": [\r\n {\r\n \"id\": 5,\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 100000115\r\n },\r\n \"relay_index\": 4\r\n },\r\n \"index\": 4\r\n }\r\n ]\r\n },\r\n \"schedule_id\": {\r\n \"id\": \"1\"\r\n }\r\n },\r\n {\r\n \"elevator_id\": {\r\n \"id\": 32769,\r\n \"floors\": [\r\n {\r\n \"id\": 4,\r\n \"elevator_device_id\": {\r\n \"device_id\": {\r\n \"id\": 100000115\r\n },\r\n \"relay_index\": 3\r\n },\r\n \"index\": 3\r\n }\r\n ]\r\n },\r\n \"schedule_id\": {\r\n \"id\": \"1\"\r\n }\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/floor_levels","description":"

This API is used to create floor level.
You can configure the floor access privileges by using elevators and floor information.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the floor level
description	String	N	Description of the floor level
elevator_id:id	Number	Y	ID of the elevator
floors:id	Number	Y	ID of the floor in correspondence with the elevator
device_id:id	Number	Y	Id of the device used by the elevator
elevator_device_id:relay_index	Number	Y	Relay index used on the device according to the floors:id
floors:index	Number	Y	Index of the floor
schedule_id:id	Number	Y	ID of the schedule used

Known errors:

Duplicate name

This API is used to update floor level.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the floor level
description	String	N	Description of the floor level
elevator_id:id	Number	Y	ID of the elevator
floors:id	Number	Y	ID of the floor in correspondence with the elevator
device_id:id	Number	Y	Id of the device used by the elevator
elevator_device_id:relay_index	Number	Y	Relay index used on the device according to the floors:id
floors:index	Number	Y	Index of the floor
schedule_id:id	Number	Y	ID of the schedule used

Known errors:

Duplicate name

ID of the floor level which will be updated

\n","type":"text/plain"},"type":"any","value":"32776","key":"id"}]}},"response":[],"_postman_id":"bf15cc8a-88e3-442b-9e82-4a9bb6ef688d"},{"name":"Delete Floor Level","id":"a637d931-8991-49b5-8821-cef560dffce8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/floor_levels/:id","description":"

This API is used to delete floor levels.

ID of the floor level which will be deleted

\n","type":"text/plain"},"type":"any","value":"32775","key":"id"}]}},"response":[],"_postman_id":"a637d931-8991-49b5-8821-cef560dffce8"}],"id":"d6fcd602-e372-4842-b0f7-491922991a91","event":[{"listen":"prerequest","script":{"id":"e97f4f73-b9b9-4797-bbd5-fefa47e4dfcd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6f68b2d9-15ed-4d7a-ba4f-0b3d85a73fe2","type":"text/javascript","exec":[""]}}],"_postman_id":"d6fcd602-e372-4842-b0f7-491922991a91","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Schedules","item":[{"name":"View Schedules","id":"cc3f3fdd-b696-4c89-8812-2902e71bbf13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/schedules?limit&offset","description":"

This API is used to view all schedules recorded on BioStar 2 Database.

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[],"_postman_id":"cc3f3fdd-b696-4c89-8812-2902e71bbf13"},{"name":"View a Schedule Detail","id":"efd448bf-063c-41b5-a7f8-bc672abc0f4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/schedules/:id","description":"

This API is used to view a schedule detail recorded on BioStar 2 Database.

ID of the schedule which will be viewed

\n","type":"text/plain"},"type":"any","value":"2","key":"id"}]}},"response":[],"_postman_id":"efd448bf-063c-41b5-a7f8-bc672abc0f4f"},{"name":"Delete Schedules","id":"c5a37842-48b4-4656-b4f9-a70ab33b3cb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/schedules/:id","description":"

This API is used to delete schedules recorded on BioStar 2 Database.

ID of the schedule which will be deleted

\n","type":"text/plain"},"type":"any","value":"5","key":"id"}]}},"response":[],"_postman_id":"c5a37842-48b4-4656-b4f9-a70ab33b3cb1"},{"name":"Create Schedule (Weekly)","id":"f5b6abf6-f5ce-4b0a-8e43-a6fd2ed8a627","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Schedule\": {\r\n \"name\": \"Weekly6\",\r\n \"description\": \"Desc\",\r\n \"daily_schedules\": [\r\n {\r\n \"day_index\": 0,\r\n \"time_segments\": []\r\n },\r\n {\r\n \"day_index\": 1,\r\n \"time_segments\": [\r\n {\r\n \"start_time\": 0,\r\n \"end_time\": 360\r\n },\r\n {\r\n \"start_time\": 1080,\r\n \"end_time\": 1440\r\n }\r\n ]\r\n },\r\n {\r\n \"day_index\": 2,\r\n \"time_segments\": []\r\n },\r\n {\r\n \"day_index\": 3,\r\n \"time_segments\": [\r\n {\r\n \"start_time\": 0,\r\n \"end_time\": 1440\r\n }\r\n ]\r\n },\r\n {\r\n \"day_index\": 4,\r\n \"time_segments\": []\r\n },\r\n {\r\n \"day_index\": 5,\r\n \"time_segments\": []\r\n },\r\n {\r\n \"day_index\": 6,\r\n \"time_segments\": [\r\n {\r\n \"start_time\": 900,\r\n \"end_time\": 960\r\n },\r\n {\r\n \"start_time\": 540,\r\n \"end_time\": 600\r\n },\r\n {\r\n \"start_time\": 360,\r\n \"end_time\": 420\r\n },\r\n {\r\n \"start_time\": 720,\r\n \"end_time\": 780\r\n },\r\n {\r\n \"start_time\": 1080,\r\n \"end_time\": 1140\r\n }\r\n ]\r\n }\r\n ],\r\n \"holiday_schedules\": [\r\n {\r\n \"holiday_group_id\": {\r\n \"id\": \"1\"\r\n },\r\n \"time_segments\": [\r\n {\r\n \"start_time\": 780,\r\n \"end_time\": 840\r\n }\r\n ]\r\n }\r\n ],\r\n \"days_of_iteration\": 7,\r\n \"start_date\": \"2022-04-27T16:18:06.19Z\",\r\n \"use_daily_iteration\": false\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/schedules","description":"

This API example shows how to create weekly schedule.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the schedule
description	String	N	Description of the schedule
day_index	Number	Y	Day of the Week(0-sun, 1-mon, 2-tue, 3-wed, 4-thu, 5-fri, 6-sat)
time_segments:start_time	Number	Y	Start time of the day (in minutes)
time_segments:end_time	Number	Y	End time of the day (in minutes)
holiday_group_id:id	Number	N	ID of the holiday group
days_of_iteration	Number	N	Repeat schedule every n days
start_date	Date	N	Enable schedule from specified date
use_daily_iteration	Boolean	Y	Specify schedule weekly or daily. False for weekly

This API example shows how to create daily schedule.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the schedule
description	String	N	Description of the schedule
day_index	Number	Y	Day of the Week(0-sun, 1-mon, 2-tue, 3-wed, 4-thu, 5-fri, 6-sat)
time_segments:start_time	Number	Y	Start time of the day (in minutes)
time_segments:end_time	Number	Y	End time of the day (in minutes)
holiday_schedules	Array	N	Holiday schedules used.
days_of_iteration	Number	Y	Repeat schedule every n days
start_date	Date	Y	Enable schedule from specified date
use_daily_iteration	Boolean	Y	Specify schedule weekly or daily. False for weekly

This API is used to update a schedule.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the schedule
description	String	N	Description of the schedule
day_index	Number	Y	Day of the Week(0-sun, 1-mon, 2-tue, 3-wed, 4-thu, 5-fri, 6-sat)
time_segments:start_time	Number	Y	Start time of the day (in minutes)
time_segments:end_time	Number	Y	End time of the day (in minutes)
holiday_schedules	Array	N	Holiday schedules used.
days_of_iteration	Number	Y	Repeat schedule every n days
start_date	Date	Y	Enable schedule from specified date
use_daily_iteration	Boolean	Y	Specify schedule weekly or daily. False for weekly

ID of the schedule which will be updated

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"9c45cadd-d92d-4b20-8d9b-e42cf9f639f0"}],"id":"986578d7-33b7-435a-b1e5-5bbb4b19b8a0","event":[{"listen":"prerequest","script":{"id":"371de9db-b022-4f43-a35d-f387cc7f236b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b8f1d813-a6fa-40d6-bf62-c6654ed7e73a","type":"text/javascript","exec":[""]}}],"_postman_id":"986578d7-33b7-435a-b1e5-5bbb4b19b8a0","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Holiday Groups","item":[{"name":"View Holiday Groups","id":"41fe6bb1-2237-4a51-a59e-9daf560390e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/holiday_groups?limit&offset","description":"

This API is used to view all holiday groups recorded on BioStar 2 database.

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[],"_postman_id":"41fe6bb1-2237-4a51-a59e-9daf560390e5"},{"name":"Create Holiday Group","id":"f2f519b3-73c2-404c-895f-077e959bb08c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"HolidayGroup\": {\r\n \"name\": \"Idul Fitri 2022\",\r\n \"description\": \"Idul Fitri for year 2022\",\r\n \"holidays\": [\r\n {\r\n \"repeat_interval\": 0,\r\n \"start_date\": \"2022-05-02T00:00:00.00Z\"\r\n },\r\n {\r\n \"repeat_interval\": 0,\r\n \"start_date\": \"2022-05-03T00:00:00.00Z\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/holiday_groups","description":"

This API is used to create holiday groups on BioStar 2.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the holiday group
description	String	N	Description of the holiday group
repeat_interval	Number	Y	0=no repeat, 1=repeat every year
start_date	Datetime	Y	Date of the holiday group

This API is used to update holiday groups on BioStar 2.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the holiday group
description	String	N	Description of the holiday group
repeat_interval	Number	Y	0=no repeat, 1=repeat every year
start_date	Datetime	Y	Date of the holiday group

ID of the holiday group which will be updated.

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"6e84936a-3c0b-4d49-a9bc-761ff34f6b31"},{"name":"Delete Holiday Group","id":"2ef1a256-f395-4e82-824d-66be7f8be5f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/holiday_groups/:id","description":"

This API is used to delete holiday group.

ID of the holiday group which will be deleted

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"2ef1a256-f395-4e82-824d-66be7f8be5f9"}],"id":"a8484ed4-4998-4afc-9504-1bcddb916202","event":[{"listen":"prerequest","script":{"id":"d26c19eb-dc70-4049-b9e1-f59c60c5470c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8fa389e4-15ad-420e-9819-0b44d043dc4f","type":"text/javascript","exec":[""]}}],"_postman_id":"a8484ed4-4998-4afc-9504-1bcddb916202","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Trigger Actions","item":[{"name":"View Trigger Actions","id":"ad6a8f0b-802b-420f-b1f6-d46a451f8ffe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/trigger_actions?limit&offset","description":"

This API is used to view all Trigger & Actions.

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[],"_postman_id":"ad6a8f0b-802b-420f-b1f6-d46a451f8ffe"},{"name":"Create Trigger Actions (Device - Device Send Signal)","id":"7ca69073-b6c6-4028-b312-9f28c72c8e28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TriggerAction\": {\r\n \"name\": \"Test\",\r\n \"priority\": 0,\r\n \"schedule_id\": {\r\n \"id\": \"1\"\r\n },\r\n \"trigger\": {\r\n \"source_type\": 1,\r\n \"event_types\": [\r\n {\r\n \"code\": 18432\r\n }\r\n ],\r\n \"devices\": [\r\n {\r\n \"id\": 543408590\r\n },\r\n {\r\n \"id\": 543308153\r\n }\r\n ]\r\n },\r\n \"action\": {\r\n \"device_action_id\": {\r\n \"device_id\": {\r\n \"id\": 543308153\r\n },\r\n \"relay_signal_id\": {\r\n \"id\": \"1\"\r\n },\r\n \"relay_index\": 0\r\n }\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/trigger_actions","description":"

You can set the device or BioStar to do a specific operation when a specific event has occurred at the devices, doors and zones.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter a name of the trigger & action.
priority	Number	Y	Priority index of the trigger & action.
schedule_id:id	Number	Y	ID of the schedule which will be used by the trigger & action.
trigger:source_type	Number	Y	Select a device/door/zone at which a specific event will be monitored. Multiple devices/doors/zones can be selected. The devices/doors/zones work independently even when they are disconnected from the BioStar server. 1=Device, 2=Door, 3=Zone
event_types:code	Number	Y	ID of the events which will trigger an action. At least one event must be selected. Event lists may be activated differently depending on the options selected in Device, Door, and Zone.
devices:id	Number	Y	Select a device which performs the action. You can select a device or BioStar 2 to perform an action.
device_action_id:device_id:id	Number	Y	ID of the device which will perform an action.
device_action_id:relay_signal_id:id	Number	Y	Relay of the device which will be used to perform an action.
device_action_id:relay_index	Number	Y	Relay index of the device.

You can set the device or BioStar to do a specific operation when a specific event has occurred at the devices, doors and zones.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter a name of the trigger & action.
priority	Number	Y	Priority index of the trigger & action.
schedule_id:id	Number	Y	ID of the schedule which will be used by the trigger & action.
trigger:source_type	Number	Y	Select a device/door/zone at which a specific event will be monitored. Multiple devices/doors/zones can be selected. The devices/doors/zones work independently even when they are disconnected from the BioStar server. 1=Device, 2=Door, 3=Zone
event_types:code	Number	Y	ID of the events which will trigger an action. At least one event must be selected. Event lists may be activated differently depending on the options selected in Device, Door, and Zone.
doors:id	Number	Y	ID of the door which will trigger an action.
email_action_id:receipients	Number	Y	List email recipients which BioStar 2 will send notifications to. Use comma (,) to separate each email.
smtp_id:id	Number	Y	ID of the SMTP setting which will be used to send notification email.

You can set the device or BioStar to do a specific operation when a specific event has occurred at the devices, doors and zones.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter a name of the trigger & action.
priority	Number	Y	Priority index of the trigger & action.
schedule_id:id	Number	Y	ID of the schedule which will be used by the trigger & action.
trigger:source_type	Number	Y	Select a device/door/zone at which a specific event will be monitored. Multiple devices/doors/zones can be selected. The devices/doors/zones work independently even when they are disconnected from the BioStar server. 1=Device, 2=Door, 3=Zone
event_types:code	Number	Y	ID of the events which will trigger an action. At least one event must be selected. Event lists may be activated differently depending on the options selected in Device, Door, and Zone.
zones:id	Number	Y	ID of the zone which will trigger an action.
email_action_id:receipients	Number	Y	List email recipients which BioStar 2 will send notifications to. Use comma (,) to separate each email.
smtp_id:id	Number	Y	ID of the SMTP setting which will be used to send notification email.

This API is used to update Trigger/Actions.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter a name of the trigger & action.
priority	Number	Y	Priority index of the trigger & action.
schedule_id:id	Number	Y	ID of the schedule which will be used by the trigger & action.
trigger:source_type	Number	Y	Select a device/door/zone at which a specific event will be monitored. Multiple devices/doors/zones can be selected. The devices/doors/zones work independently even when they are disconnected from the BioStar server. 1=Device, 2=Door, 3=Zone
event_types:code	Number	Y	ID of the events which will trigger an action. At least one event must be selected. Event lists may be activated differently depending on the options selected in Device, Door, and Zone.
doors:id	Number	Y	ID of the door which will trigger an action.
email_action_id:receipients	Number	Y	List email recipients which BioStar 2 will send notifications to. Use comma (,) to separate each email.
smtp_id:id	Number	Y	ID of the SMTP setting which will be used to send notification email.

ID of the Trigger & Actions which will be updated.

\n","type":"text/plain"},"type":"any","value":"2","key":"id"}]}},"response":[],"_postman_id":"a983261c-97cf-4bb1-8342-c12d4ae70d7a"},{"name":"Delete Trigger Actions","id":"51d721f3-d072-42d9-9320-9e4179a2eb2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/trigger_actions/:id","description":"

This API is used to view all Trigger & Actions.

ID of the Trigger & Action which will be deleted.

\n","type":"text/plain"},"type":"any","value":"2","key":"id"}]}},"response":[],"_postman_id":"51d721f3-d072-42d9-9320-9e4179a2eb2d"},{"name":"Create Multiple Trigger Actions","id":"f1ed5183-0bd9-404e-b2a3-ce32994d19f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TriggerAction\": {\r\n \"name\": \"sample triggeraction\",\r\n \"priority\": 0,\r\n \"schedule_id\": {\r\n \"id\": \"1\"\r\n },\r\n \"is_quick_action\": \"N\",\r\n \"trigger\": {\r\n \"source_type\": 2,\r\n \"event_types\": [\r\n {\r\n \"code\": 22016\r\n }\r\n ],\r\n \"devices\": [\r\n \r\n ],\r\n \"doors\": [\r\n {\r\n \"id\": 1\r\n }\r\n ],\r\n \"zones\": [\r\n \r\n ]\r\n },\r\n \"action\": {\r\n \"device_action_id\": {\r\n \"device_id\": {\r\n \"id\": 50355072\r\n },\r\n \"relay_signal_id\": {\r\n \"id\": \"1\"\r\n },\r\n \"relay_index\": 0\r\n },\r\n \"email_action_id\": {\r\n \"receipients\": [\r\n \"abc@xyz.co\",\r\n\t\t\t\t\t\"abe@xyz.co\"\r\n ]\r\n },\r\n \"smtp_id\": {\r\n \"id\": \"1\"\r\n },\r\n \"door_action\": [\r\n {\r\n \"door_id\": {\r\n \"id\": 1\r\n },\r\n \"door_signal\": 346\r\n }\r\n ]\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/multiple/trigger_actions","description":"

This API is used to create multiple trigger actions. It is accessible in BioStar 2 version 2.9.5 and later.

BODY Parameters:

Parameter	Type	Required	Description
name	String	Y	Enter a name of the trigger & action.
priority	Number	Y	Priority index of the trigger & action.
is_quick_action	Character	N	Fill with character “Y” or “N”. This parameter used to describe that the Trigger & Action can be use as a Quick Action
schedule:id	Number	Y	ID of the schedule which will be used by the trigger & action.
trigger:source_type	Number	Y	Select a device/door/zone at which a specific event will be monitored. Multiple devices/doors/zones can be selected. The devices/doors/zones work independently even when they are disconnected from the BioStar server. 1=Device, 2=Door, 3=Zone
event_types:code	Number	Y	ID of the events which will trigger an action. At least one event must be selected. Event lists may be activated differently depending on the options selected in Device, Door, and Zone.
devices:id	Number	Y	Select a device which performs the action. You can select a device or BioStar 2 to perform an action.
doors:id	Number	Y	ID of the door which will trigger an action.
zones:id	Number	Y	ID of the zone which will trigger an action.
device_action_id:device_id:id	Number	Y	ID of the device which will perform an action.
device_action_id:relay_signal_id:id	Number	Y	Relay of the device which will be used to perform an action.
device_action_id:relay_index	Number	Y	Relay index of the device.
door_action:door_id:id	Number	Y	ID of the door which will perform an action
door_action:door_signal	Number	Y	Door signal as operation of an action. Value between 345 and 348
email_action_id:recipients	Array String	Y	List email recipients which BioStar 2 will send notifications to. Use comma (,) to separate each email.
smtp_id:id	Number	Y	ID of the SMTP setting which will be used to send notification email.

Response Example:

{\n  \"TriggerAction\": {\n    \"name\": \"ta 1\",\n    \"priority\": \"0\",\n    \"trigger\": {\n      \"source_type\": \"1\"\n    },\n    \"schedule_id\": {\n      \"id\": \"1\"\n    },\n    \"action\": {\n      \"id\": \"800001\",\n      \"device_action_id\": {\n        \"device_id\": {\n          \"id\": \"50355260\"\n        },\n        \"relay_index\": \"0\",\n        \"relay_signal_id\": {\n          \"id\": \"1\"\n        }\n      },\n      \"email_action_id\": {\n        \"receipients\": [\n          \"wawe@test.com\"\n        ]\n      },\n      \"smtp_id\": {\n        \"id\": \"1\"\n      }\n    }\n  },\n  \"Response\": {\n    \"code\": \"0\",\n    \"link\": \"https://support.supremainc.com/en/support/home\",\n    \"message\": \"Success\"\n  }\n}\n\n

Response Properties:

- Response : The web server response.\n    - code : success/error code.\n    - link : suprema link\n    - message : success/error message\n\n

Errors:

400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorized: The API key provided was invalid or missing.
404 Not Found: The requested resource was not found.
500 Internal Server Error: An unexpected error occurred on the server.

This API is used to update multiple trigger actions by ID. It is accessible in BioStar 2 version 2.9.5 and later.

BODY Parameters:

Parameter	Type	Required	Description
name	String	Y	Enter a name of the trigger & action.
priority	Number	Y	Priority index of the trigger & action.
is_quick_action	Character	N	Fill with character “Y” or “N”. This parameter used to describe that the Trigger & Action can be use as a Quick Action
schedule:id	Number	Y	ID of the schedule which will be used by the trigger & action.
trigger:source_type	Number	Y	Select a device/door/zone at which a specific event will be monitored. Multiple devices/doors/zones can be selected. The devices/doors/zones work independently even when they are disconnected from the BioStar server. 1=Device, 2=Door, 3=Zone
event_types:code	Number	Y	ID of the events which will trigger an action. At least one event must be selected. Event lists may be activated differently depending on the options selected in Device, Door, and Zone.
devices:id	Number	Y	Select a device which performs the action. You can select a device or BioStar 2 to perform an action.
doors:id	Number	Y	ID of the door which will trigger an action.
zones:id	Number	Y	ID of the zone which will trigger an action.
device_action_id:device_id:id	Number	Y	ID of the device which will perform an action.
device_action_id:relay_signal_id:id	Number	Y	Relay of the device which will be used to perform an action.
device_action_id:relay_index	Number	Y	Relay index of the device.
door_action:door_id:id	Number	Y	ID of the door which will perform an action
door_action:door_signal	Number	Y	Door signal as operation of an action. Value between 345 and 348
email_action_id:recipients	Array String	Y	List email recipients which BioStar 2 will send notifications to. Use comma (,) to separate each email.
smtp_id:id	Number	Y	ID of the SMTP setting which will be used to send notification email.

Response Example:

{\n  \"Response\": {\n    \"code\": \"0\",\n    \"link\": \"https://support.supremainc.com/en/support/home\",\n    \"message\": \"Success\"\n  }\n}\n\n

Response Properties:

- Response : The web server response.\n    - code : success/error code.\n    - link : suprema link\n    - message : success/error message\n\n

Errors:

400 Bad Request: The request was malformed or missing required parameters.
\n
401 Unauthorized: The API key provided was invalid or missing.
\n
404 Not Found: The requested resource was not found.
\n
500 Internal Server Error: An unexpected error occurred on the server.
\n

Trigger & Action's ID

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"33ec7969-90b9-4012-8127-1460b270d450"},{"name":"Delete Multiple Trigger Actions Copy","id":"8d97b73e-c4bf-4029-b7e6-e2e149cb7186","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/multiple/trigger_actions?id=","description":"

This API is used to delete multiple trigger actions by ID. It is accessible in BioStar 2 version 2.9.5 and later.

Response Example:

{\n  \"Response\": {\n    \"code\": \"0\",\n    \"link\": \"https://support.supremainc.com/en/support/home\",\n    \"message\": \"Success\"\n  }\n}\n\n

Response Properties:

- Response : The web server response.\n    - code : success/error code.\n    - link : suprema link\n    - message : success/error message\n\n

Errors:

400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorized: The API key provided was invalid or missing.
404 Not Found: The requested resource was not found.
500 Internal Server Error: An unexpected error occurred on the server.

Trigger and Action ID(s). Delimit each ID by using plus symbol (+; ex: 1+2+3)

\n","type":"text/plain"},"key":"id","value":""}],"variable":[]}},"response":[],"_postman_id":"8d97b73e-c4bf-4029-b7e6-e2e149cb7186"},{"name":"View Multiple Trigger Actions","id":"2be0ada3-68b3-4959-a50b-294389596240","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/multiple/trigger_actions/:id","description":"

This API is used to view trigger actions by ID. It is accessible in BioStar 2 version 2.9.5 and later.

Response Example:

{\n    \"TriggerAction\": {\n        \"id\": \"1\",\n        \"name\": \"sample triggeraction\",\n        \"priority\": \"0\",\n        \"trigger\": {\n            \"source_type\": \"2\",\n            \"doors\": [\n                {\n                    \"id\": \"1\",\n                    \"name\": \"door1\"\n                }\n            ],\n            \"event_types\": [\n                {\n                    \"code\": \"22016\",\n                    \"name\": \"FORCED_OPEN_ALARM\"\n                }\n            ]\n        },\n        \"schedule_id\": {\n            \"id\": \"1\",\n            \"name\": \"Always\"\n        },\n        \"action\": {\n            \"id\": \"1\",\n            \"device_action_id\": {\n                \"device_id\": {\n                    \"id\": \"50355072\"\n                },\n                \"relay_index\": \"0\",\n                \"relay_signal_id\": {\n                    \"id\": \"1\",\n                    \"name\": \"sinyal1\",\n                    \"delay\": \"0\",\n                    \"count\": \"0\",\n                    \"on_duration\": \"0\",\n                    \"off_duration\": \"0\"\n                }\n            },\n            \"email_action_id\": {\n                \"receipients\": [\n                    \"abc@xyz.co\"\n                ]\n            },\n            \"smtp_id\": {\n                \"id\": \"1\",\n                \"name\": \"aaa\",\n                \"smtp_server_addr\": \"localhost\",\n                \"smtp_server_port\": \"25\",\n                \"smtp_security\": \"1\"\n            },\n            \"door_action\": [\n                {\n                    \"door_id\": {\n                        \"id\": \"1\",\n                        \"name\": \"door1\"\n                    },\n                    \"door_signal\": \"346\"\n                }\n            ]\n        },\n        \"is_quick_action\": \"N\",\n        \"number_quick_actions\": \"0\"\n    },\n    \"Response\": {\n        \"code\": \"0\",\n        \"link\": \"https:\\/\\/support.supremainc.com\\/en\\/support\\/home\",\n        \"message\": \"Success\"\n    }\n}\n\n

Response Properties:

- TriggerAction : a trigger action.\n    - name : The trigger action name.\n    - is_quick_action : Indicates if this trigger action is also a quick action or not.\n    - number_quick_actions : count of quick actions.\n    - priority : The trigger action priority.\n    - action : List of actions. It can be device action, door action and email action\n    - trigger : List of triggers. It can be device, door, and zone.\n- Response : The web server response.\n    - code : success/error code.\n    - link : suprema link\n    - message : success/error message\n\n

Errors:

400 Bad Request: The request was malformed or missing required parameters.
\n
401 Unauthorized: The API key provided was invalid or missing.
\n
404 Not Found: The requested resource was not found.
\n
500 Internal Server Error: An unexpected error occurred on the server.
\n

ID of the Trigger and Action which will be viewed.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"2be0ada3-68b3-4959-a50b-294389596240"}],"id":"55545e69-f418-4575-8aab-9f79383a9c66","_postman_id":"55545e69-f418-4575-8aab-9f79383a9c66","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Quick Action","item":[{"name":"Trigger Quick Action by ID","id":"a4e0500e-62fc-4b94-bf01-b86e43a7f986","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/quick_action/:id","description":"

This API is used to trigger Quick Action by ID. It is accessible in BioStar 2 version 2.9.5 and later.

Response Example:

{\n  \"QuickActionID\": \"1\",\n  \"Response\": {\n    \"code\": \"0\",\n    \"link\": \"https://support.supremainc.com/en/support/home\",\n    \"message\": \"Success\"\n  }\n}\n\n

Response Properties:

- QuickActionID : quick action ID.\n- Response : The web server response.\n    - code : success/error code.\n    - link : suprema link\n    - message : success/error message\n\n

Errors:

This API uses the following error codes:

400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorized: The API key provided was invalid or missing.
404 Not Found: The requested resource was not found.
500 Internal Server Error: An unexpected error occurred on the server.

ID of the Quick Action which will be viewed.

\n","type":"text/plain"},"type":"any","value":"2","key":"id"}]}},"response":[],"_postman_id":"a4e0500e-62fc-4b94-bf01-b86e43a7f986"},{"name":"View Trigger Action with Quick Action Enabled","id":"57857661-67e4-4a7f-bcaf-02cda150bc7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/quick_action/alarm_set","description":"

This API is used to fetch Trigger Actions with Quick Action status enabled. It is accessible in BioStar 2 version 2.9.5 and later.

Response Example:

{\n  \"Response\": {\n    \"code\": \"0\"\n  },\n  \"alarm_sets\": [\n    {\n      \"alarmSetUID\": 1,\n      \"name\": \"ta 1\",\n      \"prio\": 0,\n      \"scheduleUID\": 1,\n      \"alarmType\": 1,\n      \"alarmActionUID\": 800001,\n      \"quickAction\": \"Y\"\n    }\n  ]\n}\n\n

Response Properties:

- Response : The response from web server.\n    - code : success/error code.\n- alarm_sets : An array of trigger action objects, each with the following properties:\n    - alarmActionUID : The alarm action ID.\n    - alarmSetUID: The trigger action ID.\n    - alarmType: The alarm type.\n    - name : The trigger action name.\n    - prio : The priority.\n    - quickAction : is quick action enabled or not.\n    - scheduleUID : The schedule ID\n\n

Errors:

This API uses the following error codes:

400 Bad Request: The request was malformed or missing required parameters.
\n
401 Unauthorized: The API key provided was invalid or missing.
\n
404 Not Found: The requested resource was not found.
\n
500 Internal Server Error: An unexpected error occurred on the server.
\n

This API is used to fetch all configured quick actions. It is accessible in BioStar 2 version 2.9.5 and later.

Response Example:

{\n  \"Response\": {\n    \"code\": \"0\"\n  },\n  \"quick_action\": [\n    {\n      \"id\": 1,\n      \"name\": \"qc 1\",\n      \"description\": \"quick action test\",\n      \"order_number\": 1,\n      \"status\": \"I\",\n      \"confirm_before_run\": \"Y\",\n      \"operator_levels\": [\n        {\n          \"id\": 1,\n          \"permission\": {\n            \"id\": 1,\n            \"name\": \"Administrator\",\n            \"description\": \"this is a permission for Administrator\",\n            \"jsonText\": \"{\\n \\n   \\\"module\\\": {\\n \\n     \\\"Dashboard\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"User\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Device\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Door\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Elevator\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Zone\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"AccessControl\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Monitoring\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"TA\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Setting\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Video\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Visitor\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n  \\\"Report\\\": {\\n \\n    \\\"read\\\": true,\\n \\n    \\\"write\\\": true\\n \\n  }\\n \\n   },\\n \\n   \\\"filter\\\": {\\n \\n     \\\"UserGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"DeviceGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"DoorGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"ElevatorGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"ZoneType\\\": [\\n \\n       \\\"-1\\\"\\n \\n     ],\\n \\n     \\\"AccessGroup\\\": [\\n \\n       0\\n \\n     ],\\n \\n     \\\"GraphicMapGroup\\\": [\\n \\n       1\\n \\n     ]\\n \\n   }\\n \\n }\",\n            \"createdAt\": \"2023-11-06T10:00:55.000+00:00\"\n          }\n        }\n      ],\n      \"trigger_actions\": [\n        {\n          \"id\": 1,\n          \"alarm_set\": {\n            \"alarmSetUID\": 1,\n            \"name\": \"ta 1\",\n            \"prio\": 0,\n            \"scheduleUID\": 1,\n            \"alarmType\": 1,\n            \"alarmActionUID\": 800001,\n            \"quickAction\": \"Y\"\n          }\n        }\n      ]\n    }\n  ]\n}\n\n\n

Response Properties:

- Response : The web server response.\n    - code : success/error code\n- quick_action : An array of quick action objects, each with the following properties:\n    - confirm_before_run : The confirm before run flag. Y = enabled, N = disabled.\n    - description : The description of quick action.\n    - id : The quick action ID.\n    - name : The quick action name.\n    - operator_levels : The operator levels.\n    - order_number : The order number of quick action.\n    - status : The status of quick action.\n    - trigger_actions: The trigger actions.\n\n

Errors:

This API uses the following error codes:

400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorized: The API key provided was invalid or missing.
404 Not Found: The requested resource was not found.
500 Internal Server Error: An unexpected error occurred on the server.

This API is used to fetch Quick Actions by Permission ID. It is accessible in BioStar 2 version 2.9.5 and later.

Response Example:

{\n  \"Response\": {\n    \"code\": \"0\"\n  },\n  \"quick_action\": [\n    {\n      \"id\": 1,\n      \"name\": \"qc 1 bla\",\n      \"description\": \"quick action bla\",\n      \"order_number\": 2,\n      \"status\": \"I\",\n      \"confirm_before_run\": \"Y\",\n      \"operator_levels\": [\n        {\n          \"id\": 2,\n          \"permission\": {\n            \"id\": 1,\n            \"name\": \"Administrator\",\n            \"description\": \"this is a permission for Administrator\",\n            \"jsonText\": \"{\\n \\n   \\\"module\\\": {\\n \\n     \\\"Dashboard\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"User\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Device\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Door\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Elevator\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Zone\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"AccessControl\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Monitoring\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"TA\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Setting\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Video\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Visitor\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n  \\\"Report\\\": {\\n \\n    \\\"read\\\": true,\\n \\n    \\\"write\\\": true\\n \\n  }\\n \\n   },\\n \\n   \\\"filter\\\": {\\n \\n     \\\"UserGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"DeviceGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"DoorGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"ElevatorGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"ZoneType\\\": [\\n \\n       \\\"-1\\\"\\n \\n     ],\\n \\n     \\\"AccessGroup\\\": [\\n \\n       0\\n \\n     ],\\n \\n     \\\"GraphicMapGroup\\\": [\\n \\n       1\\n \\n     ]\\n \\n   }\\n \\n }\",\n            \"createdAt\": \"2023-11-06T10:00:55.000+00:00\"\n          }\n        }\n      ],\n      \"trigger_actions\": [\n        {\n          \"id\": 2,\n          \"alarm_set\": {\n            \"alarmSetUID\": 1,\n            \"name\": \"ta 1\",\n            \"prio\": 0,\n            \"scheduleUID\": 1,\n            \"alarmType\": 1,\n            \"alarmActionUID\": 800001,\n            \"quickAction\": \"Y\"\n          }\n        }\n      ]\n    }\n  ]\n}\n\n

Response Properties:

- Response : The web server response.\n    - code : success/error code\n- quick_action : An array of quick action objects, each with the following properties:\n    - confirm_before_run : The confirm before run flag. Y = enabled, N = disabled.\n    - description : The description of quick action.\n    - id : The quick action ID.\n    - name : The quick action name.\n    - operator_levels : The operator levels.\n    - order_number : The order number of quick action.\n    - status : The status of quick action.\n    - trigger_actions: The trigger actions.\n\n

Errors:

This API uses the following error codes:

400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorized: The API key provided was invalid or missing.
404 Not Found: The requested resource was not found.
500 Internal Server Error: An unexpected error occurred on the server.

Permission ID of the Quick Action which will be viewed.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"13036ca5-de04-46f7-8692-338eeab700ca"},{"name":"View Quick Action by ID","id":"f9ad1f0f-303a-48a6-8660-57efb7b239c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/quick_action/:id","description":"

This API is used to fetch Quick Action information by ID. It is accessible in BioStar 2 version 2.9.5 and later.

Response Example:

{\n  \"Response\": {\n    \"code\": \"0\"\n  },\n  \"quick_action\": [\n    {\n      \"id\": 1,\n      \"name\": \"qc 1 bla\",\n      \"description\": \"quick action bla\",\n      \"order_number\": 2,\n      \"status\": \"I\",\n      \"confirm_before_run\": \"Y\",\n      \"operator_levels\": [\n        {\n          \"id\": 2,\n          \"permission\": {\n            \"id\": 1,\n            \"name\": \"Administrator\",\n            \"description\": \"this is a permission for Administrator\",\n            \"jsonText\": \"{\\n \\n   \\\"module\\\": {\\n \\n     \\\"Dashboard\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"User\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Device\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Door\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Elevator\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Zone\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"AccessControl\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Monitoring\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"TA\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Setting\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Video\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n     \\\"Visitor\\\": {\\n \\n       \\\"read\\\": true,\\n \\n       \\\"write\\\": true\\n \\n     },\\n \\n  \\\"Report\\\": {\\n \\n    \\\"read\\\": true,\\n \\n    \\\"write\\\": true\\n \\n  }\\n \\n   },\\n \\n   \\\"filter\\\": {\\n \\n     \\\"UserGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"DeviceGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"DoorGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"ElevatorGroup\\\": [\\n \\n       1\\n \\n     ],\\n \\n     \\\"ZoneType\\\": [\\n \\n       \\\"-1\\\"\\n \\n     ],\\n \\n     \\\"AccessGroup\\\": [\\n \\n       0\\n \\n     ],\\n \\n     \\\"GraphicMapGroup\\\": [\\n \\n       1\\n \\n     ]\\n \\n   }\\n \\n }\",\n            \"createdAt\": \"2023-11-06T10:00:55.000+00:00\"\n          }\n        }\n      ],\n      \"trigger_actions\": [\n        {\n          \"id\": 2,\n          \"alarm_set\": {\n            \"alarmSetUID\": 1,\n            \"name\": \"ta 1\",\n            \"prio\": 0,\n            \"scheduleUID\": 1,\n            \"alarmType\": 1,\n            \"alarmActionUID\": 800001,\n            \"quickAction\": \"Y\"\n          }\n        }\n      ]\n    }\n  ]\n}\n\n

Response Properties:

- Response : The web server response.\n    - code : success/error code\n- quick_action : An array of quick action objects, each with the following properties:\n    - confirm_before_run : The confirm before run flag. Y = enabled, N = disabled.\n    - description : The description of quick action.\n    - id : The quick action ID.\n    - name : The quick action name.\n    - operator_levels : The operator levels.\n    - order_number : The order number of quick action.\n    - status : The status of quick action.\n    - trigger_actions: The trigger actions.\n\n

Errors:

This API uses the following error codes:

400 Bad Request: The request was malformed or missing required parameters.
401 Unauthorized: The API key provided was invalid or missing.
404 Not Found: The requested resource was not found.
500 Internal Server Error: An unexpected error occurred on the server.

ID of the Quick Action which will be viewed.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"f9ad1f0f-303a-48a6-8660-57efb7b239c6"},{"name":"Save/Update/Delete Quick Action","id":"c5b4791a-721c-4aa1-b27b-986dd8f869bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"QuickActions\": [\r\n {\r\n \"name\": \"qa 1\",\r\n \"description\": \"sfsf\",\r\n \"confirm_before_run\": \"Y\",\r\n \"operator_level_ids\": [\r\n 2,\r\n 3\r\n ],\r\n \"trigger_action_ids\": [\r\n 3\r\n ],\r\n \"order_number\": 1\r\n },\r\n {\r\n \"name\": \"qa 2\",\r\n \"description\": \"dsfsdf\",\r\n \"confirm_before_run\": \"Y\",\r\n \"operator_level_ids\": [\r\n 1,\r\n 254\r\n ],\r\n \"trigger_action_ids\": [\r\n 4\r\n ],\r\n \"order_number\": 2,\r\n \"id\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/quick_action","description":"

This API is used to save/update/delete Quick Action. It is accessible in BioStar 2 version 2.9.5 and later.

To CREATE: Fill in all Quick Action(s) parameter (excluding ID). It is possible to create multiple Quick Action in one payload.
In the case creating new one while there's existing Quick Action(s), the new one doesn't require ID while the existing require it.

To DELETE: Fill in all Quick Action(s) parameter (including ID). Input all Quick Action(s) besides the one that will be deleted. To delete all, simply send an empty payload.

To UPDATE: Fill in all Quick Action(s) parameter (including ID). Input all Quick Action(s) including any which will not be updated.

BODY Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Quick Action name.
description	String	Y	Quick Action description.
confirm_before_run	String	Y	Confirmation before run (enabled/disabled). Y = enabled, N = disabled.
operator_level_ids	Array	Y	List Operator Level ID(s) which allowed to run the Quick Action.
trigger_action_ids	Array	Y	List Trigger & Action ID(s) which will be executed when Quick Action triggered.
order_number	Number	Y	Quick Action order number.
id	Number	N	Quick Action's ID. Will be generated after Quick Action created. Required to be filled when update or adding.

Response Example:

{\n  \"Response\": {\n    \"code\": \"0\"\n  }\n}\n\n

Response Properties:

- Response : The web server response.\n    - code : success/error code.\n\n

Errors:

This API uses the following error codes:

400 Bad Request: The request was malformed or missing required parameters.
\n
401 Unauthorized: The API key provided was invalid or missing.
\n
404 Not Found: The requested resource was not found.
\n
500 Internal Server Error: An unexpected error occurred on the server.
\n

This API is used to test BioStar 2 connection with Windows Active Directory.

Successful connection will return code : 0.

BODY Parameters:

Parameter	Type	Required	Description
serverAddress	String	Y	IP Address of the Domain Controller
userName	String	Y	User Name which will be used to connect to the Domain Controller
password	String	Y	User Name's corresponding password
userDomainName	String	Y	BaseDN of the Domain Controller
useSSL	Boolean	Y	Option to use encryption when communicating with a Windows Active Directory server. Install Active Directory Certificate Services and set the keystore password by referring to Active Directory Encryption.
adlogin	Boolean	Y	Enable logging into BioStar 2 using the Windows Active Directory account.
RedirectionUri	String	Y	Required for EntraId interworking.
adEnable	String	Y	If BioStar2 is upgraded from a version earlier than 2.9.9, it needs to be set to 'U'. Otherwise, set to 0.
adType	String	Y	Interworking target classification. Active Directory: A EntraId: E
prevAdType	String	Y	It is required to enter the previous connection information when modifying the interworking target. If there is no change, enter the current connection information.
prevDomainName	String	Y	It is required to enter the previous connection information when modifying the interworking target. If there is no change, enter the current connection information.
prevServerAddr	String	Y	It is required to enter the previous connection information when modifying the interworking target. If there is no change, enter the current connection information.
resetSync	Boolean	Y	Delete existing users and user groups due to changes in connection information and set them to true if new settings are required. default is false.
scheduleSyncInterval	Number	Y	Set the time interval for automatic synchronization. 0: Manual synchronization 30 to 10080: Automatic synchronization
syncEvtCheck	Boolean	Y	Settings for whether to leave event logs on BioStar2. true: event logs are kept on BioStar 2 as usual.
syncType	String	Y	Toggle automatic synchronization. Manual synchronization: N Automatic synchronization: A

See these articles for more information on connecting BioStar 2 with Active Directory:

Changes:

v2.9.9:
\n
- Supports both Active Directory and EntraID
  \n
- Added parameter: RedirectionUri, adEnable, adType, prevAdType, prevDomainName, prevServerAddr, resetSync, scheduleSyncInterval, syncEvtCheck, syncType.
  \n
\n

To run BioStar 2 AD APIs, it is required to be connected to the AD server.

This API is used to get User Group information from the Domain Controller.

It is required to put domain name information on the body.

The response value is returned in JSON format. At this time, Collection.rows.userGroups is used for the next user group update.

Based on the user group information queried in User Group Search, the user group which will be linked is updated.

Update the user group and save it to the Biostar server.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
allUserGroup	Boolean	Y	Toggle True when selecting all User Groups.
dn	String	Y	Domain Name
lastSyncVersion	Number	Y	Set to 0
userGroups	Array	Y	Put Collection.rows.userGroups from User Group Search
userGroupFilters	Array	Y	Place the id and name of the user groups to be synchronized into an array.

This API is used to set the user field configuration.

The payload is in the form of a JSON array.
Each array has BioStar 2 column name (columnm), AD column name (adcolumnm), whether to use (use), and column description (columnmdescription).

\n
[
\n

\n
{\"columnm\":\"usrid\",\"adcolumnm\":\"sAMAccountName\",\"use\":\"true\",\"columnmdescription\":\"userid\"} {\"columnm\":\"nm\",\"adcolumnm\":\"displayName\" ,\"use\":\"true\",\"columnmdescription\":\"User NAME\"}
\n

\n
]
\n

If you set the payload as above, you can sync the username as well.

This API is used to synchronizes AD user information with Biostar 2.
If there is no user group change or field reorganization then only this synchronization operation is sufficient.

serverAddress, userName, password, userDomainName, and useSSL must be sent in the payload.

lastSyncTime, lastSyncResult, lastUpdateTime fields on response are \"recent sync time with ad server\", \"recent sync result\", \"recent update time of ad server information\",
It can be checked through GET /api/v2/setting/adserversetting

BODY Parameters:

Parameter	Type	Required	Description
serverAddress	String	Y	IP Address of the Domain Controller
userName	String	Y	User Name which will be used to connect to the Domain Controller
password	String	Y	User Name's corresponding password
userDomainName	String	Y	BaseDN of the Domain Controller
useSSL	Boolean	Y	Option to use encryption when communicating with a Windows Active Directory server. Install Active Directory Certificate Services and set the keystore password by referring to Active Directory Encryption.
adlogin	Boolean	Y	Enable logging into BioStar 2 using the Windows Active Directory account.
RedirectionUri	String	Y	Required for EntraId interworking.
adEnable	String	Y	If BioStar2 is upgraded from a version earlier than 2.9.9, it needs to be set to 'U'. Otherwise, set to 0.
adType	String	Y	Interworking target classification. Active Directory: A EntraId: E
prevAdType	String	Y	It is required to enter the previous connection information when modifying the interworking target. If there is no change, enter the current connection information.
prevDomainName	String	Y	It is required to enter the previous connection information when modifying the interworking target. If there is no change, enter the current connection information.
prevServerAddr	String	Y	It is required to enter the previous connection information when modifying the interworking target. If there is no change, enter the current connection information.
resetSync	Boolean	Y	Delete existing users and user groups due to changes in connection information and set them to true if new settings are required. default is false.
scheduleSyncInterval	Number	Y	Set the time interval for automatic synchronization. 0: Manual synchronization 30 to 10080: Automatic synchronization
syncEvtCheck	Boolean	Y	Settings for whether to leave event logs on BioStar2. true: event logs are kept on BioStar 2 as usual.
syncType	String	Y	Toggle automatic synchronization. Manual synchronization: N Automatic synchronization: A
useCustomField	Boolean	Y	Set this parameter to true if a custom user field has been added via Change AD User Mapping. If no custom user field is being used, set the parameter to false.

Changes:

v2.9.9:
\n
- Added parameter: RedirectionUri, adEnable, adType, prevAdType, prevDomainName, prevServerAddr, resetSync, scheduleSyncInterval, syncEvtCheck, syncType, useCustomField.
\n

Retrieves AD server configurations.

Changes:

v2.9.9:
\n
- Added example response for AD and EntraID.
\n

Retrieves the mapping relationships between user attribute fields in BioStar 2 and those used in Active Directory or Entra ID.

Please note that the required mapping information differs between Entra ID and Active Directory.

Retrieve user property information used by Active Directory or EntraID.

View group information, subgroup information and filter information that Active Directory or EntraID is using.

Checks whether Entra ID SSO Login is enabled.

If the \"BioStar 2 Login with Entra ID\" option is enabled in the Directory Integration settings, the returned value is 'E'. If it is disabled (default), the value is 'D'.

This API is used to set email template for Visual Face and BioStar 2 QR.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
title	String	Y	Enter the title of the email.
company_name	String	N	Enter the company name.
company_logo	Base64	N	Supported image file formats are GIF, JPG, JPEG, JPE, JFIF, PNG. Supported image file size is up to 5MB.
admin_contact	String	N	Enter the contact information of the person in charge.
use_setting	Boolean	Y	To use the enrollment set it as Use. If you set it as Not Use, BioStar 2 will be unable to send the visual face mobile enrollment link or QR to users.

1:Visual face mobile enrollment contents, 2:QR credential contents

\n","type":"text/plain"},"key":"email_type","value":"1"}],"variable":[]}},"response":[],"_postman_id":"3eaf1c0e-3c60-443b-9a9f-edd7dfb6854b"},{"name":"Update Email Setting (Visual Face / QR)","id":"c7317225-67bc-4e16-9709-db250eec1d9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"VisualFace\",\r\n \"company_name\": \"Oddbit\",\r\n \"company_logo\": \"\",\r\n \"admin_contact\": \"Hello\",\r\n \"use_setting\": \"1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/setting_email?email_type=1","description":"

This API is used to set email template for Visual Face and BioStar 2 QR.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
title	String	Y	Enter the title of the email.
company_name	String	N	Enter the company name.
company_logo	Base64	N	Supported image file formats are GIF, JPG, JPEG, JPE, JFIF, PNG. Supported image file size is up to 5MB.
admin_contact	String	N	Enter the contact information of the person in charge.
use_setting	Boolean	Y	To use the enrollment set it as Use. If you set it as Not Use, BioStar 2 will be unable to send the visual face mobile enrollment link or QR to users.

1:Visual face mobile enrollment contents, 2:QR credential contents

\n","type":"text/plain"},"key":"email_type","value":"1"}],"variable":[]}},"response":[],"_postman_id":"c7317225-67bc-4e16-9709-db250eec1d9a"},{"name":"View SMTP Setting","id":"32dbb4f2-445e-4d5d-92de-0d303b69a541","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/setting/alarm_smtps","description":"

This API is used to view the SMTP (Simple Mail Transfer Protocol) for sending emails.

This API is used to set the SMTP (Simple Mail Transfer Protocol) for sending emails.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter the SMTP server name.
smtp_server_addr	String	Y	Enter the SMTP server address. SMTP server address is the same form as 'smtp. Email Service Provider.com', and you can check it on the settings screen of email to use as an SMTP.
smtp_server_port	String	Y	Enter the port number of the SMTP server. you can check it on the settings screen of email to use as an SMTP.
smtp_username	String	Y	Enter the account of the SMTP service.
smtp_password	String	Y	Enter the password of the SMTP service.
smtp_security	String	Y	Select security type.
smtp_sender	String	Y	Enter the email address of the sender.
description	String	N	Enter the description.

Note:

When using the SMTP server as an email account with two-factor authentication and change the password of the account, note the following: Once you set up two-factor authentication, the SMTP password is the same as the app password generated using two-factor authentication, not the password of the email account. At this time, if the password of the email account is changed, the app
password is automatically deleted, and the SMTP password is no longer available. When changing the password for the email account, regenerate the app password and then set the SMTP password again.

This API is used to update the SMTP (Simple Mail Transfer Protocol) for sending emails.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter the SMTP server name.
smtp_server_addr	String	Y	Enter the SMTP server address. SMTP server address is the same form as 'smtp. Email Service Provider.com', and you can check it on the settings screen of email to use as an SMTP.
smtp_server_port	String	Y	Enter the port number of the SMTP server. you can check it on the settings screen of email to use as an SMTP.
smtp_username	String	Y	Enter the account of the SMTP service.
smtp_password	String	Y	Enter the password of the SMTP service.
smtp_security	String	Y	Select security type.
smtp_sender	String	Y	Enter the email address of the sender.
description	String	N	Enter the description.

Note:

When using the SMTP server as an email account with two-factor authentication and change the password of the account, note the following: Once you set up two-factor authentication, the SMTP password is the same as the app password generated using two-factor authentication, not the password of the email account. At this time, if the password of the email account is changed, the app
password is automatically deleted, and the SMTP password is no longer available. When changing the password for the email account, regenerate the app password and then set the SMTP password again.

ID of the SMTP setting which will be updated.

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"cd4c003f-2fb2-4b30-be26-b7e846a1c5bf"},{"name":"Test SMTP Connection","id":"e46eaff0-5268-4441-a23a-5a7c7012083c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"target_email\": \"email address here\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/test_smtp_connection","description":"

This API is used to test SMTP connection by sending an email to the specified address.

Do note that the address input here need to be a complete email address.

This API is used to view preference information.

ID of the user which preference will be viewed.

\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[],"_postman_id":"6e55d665-b3f0-46a3-ac02-d1c877754934"},{"name":"Add","id":"b4541f55-76e2-4976-88a3-850023f3fd73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Preference\": {\r\n \"language\": \"en\",\r\n \"date_format\": \"yyyy/MM/dd\",\r\n \"time_format\": \"HH:mm\",\r\n \"time_long_term_format\": \"HH:mm:ss\",\r\n \"time_zone\": \"25\",\r\n \"dst1\": \"0\",\r\n \"dst2\": \"0\",\r\n \"depend_on_os\": true,\r\n \"user_id\": {\r\n \"user_id\": \"6\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/preferences","description":"

This API is used to add preference configuration.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
language	String	N	Preference language. Example: ko, en
date_format	String	N	Format of the date
time_format	String	N	Format of the time
time_long_term_format	String	N	Format for long term time
time_zone	String	N	UTC-12 0 UTC-11 1 UTC-10 2 UTC-9.30 3-1 UTC-9 3 UTC-8 4 UTC-7 5 UTC-6 6 UTC-5 7 UTC-4.30 8-1 UTC-4 8 UTC-3.30 9 UTC-3 10 UTC-2 11 UTC-1 12 UTC 13 UTC+1 14 UTC+2 15 UTC+3 16 UTC+3.30 17 UTC+4 18 UTC+4.30 19 UTC+5 20 UTC+5.30 21 UTC+5.45 22 UTC+6 23 UTC+6.30 23+1 UTC+7 24 UTC+8 25 UTC+8.30 25+1 UTC+8.45 25+2 UTC+9 26 UTC+9.30 27 UTC+10 28 UTC+10.30 28+1 UTC+11 29 UTC+12 30 UTC+12.45 30+1 UTC+13 31 UTC+14 32
dst1	String	N	ID of the first Daylight Saving Time applied. 0 for none.
dst2	String	N	ID of the second Daylight Saving Time applied. 0 for none.
depend_on_os	Boolean	N
user_id:user_id	String	Y	ID of the user

This API is used to update preference configuration.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
language	String	N	Preference language. Example: ko, en
date_format	String	N	Format of the date
time_format	String	N	Format of the time
time_long_term_format	String	N	Format for long term time
time_zone	String	N	UTC-12 0 UTC-11 1 UTC-10 2 UTC-9.30 3-1 UTC-9 3 UTC-8 4 UTC-7 5 UTC-6 6 UTC-5 7 UTC-4.30 8-1 UTC-4 8 UTC-3.30 9 UTC-3 10 UTC-2 11 UTC-1 12 UTC 13 UTC+1 14 UTC+2 15 UTC+3 16 UTC+3.30 17 UTC+4 18 UTC+4.30 19 UTC+5 20 UTC+5.30 21 UTC+5.45 22 UTC+6 23 UTC+6.30 23+1 UTC+7 24 UTC+8 25 UTC+8.30 25+1 UTC+8.45 25+2 UTC+9 26 UTC+9.30 27 UTC+10 28 UTC+10.30 28+1 UTC+11 29 UTC+12 30 UTC+12.45 30+1 UTC+13 31 UTC+14 32
dst1	String	N	ID of the first Daylight Saving Time applied. 0 for none.
dst2	String	N	ID of the second Daylight Saving Time applied. 0 for none.

This API is used to view BioStar 2 settings.

This API is used to create user custom field(s) on BioStar 2.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
order	Number	Y	Unique
name	String	Y	Unique
type	Number	Y	0: Text Input, 1: Number Input, 2: Combo Box, 3: File Upload.
enable	Boolean	Y	Toggle true to enable custom field.
data	String	N	Combo Box options, use (;) as separator of each value.

Response Example:

{\n    \"Response\": {\n        \"code\": \"0\",\n        \"link\": \"https://support.supremainc.com/en/support/home\",\n        \"message\": \"Success\"\n    }\n}\n\n

Changes:

v2.9.8:
\n
- Added type 3 for File Upload
\n

This example shows how to update custom field.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
id	Number	Y	ID of the custom field.
order	Number	Y	Order sequence of the custom field.
name	String	Y	Name of the custom field.
type	Number	Y	0: Text Input, 1: Number Input, 2: Combo Box, 3: File Upload.
data	String	N	Combo Box options, use (;) as separator of each value.

Note:

The main difference between Create and Updating custom field(s) is on Update, ID needs to be specified.
\n
To get the custom field's ID, use GET /api/setting/custom_fields
\n
When updating a custom field when there are more than 1 custom fields, the custom fields which are not updated need to be specified since the API is using PUT method.
\n

Changes:

v2.9.8:
\n
- Added type 3 for File Upload.
\n

This API is used to delete user custom fields which recorded on BioStar 2.

ID of the Custom Field(s) which will be deleted. Use space ( ) as separator for multiple IDs.

\n","type":"text/plain"},"key":"id","value":null}],"variable":[]}},"response":[],"_postman_id":"b97490cf-881b-47c1-a699-d8d99dbe6482"},{"name":"List Available Custom Field(s)","id":"864660d4-fafd-46f0-8489-f3fb371faae6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/setting/custom_fields","description":"

This API is used to view all available user custom fields.

Response Properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
total	Number	Total of Custom Fields
rows	Array	List of Custom Fields definition
rows.id	Number	ID of the Custom Field
rows.name	String	Name of the Custom Field
rows.type	Number	Type of the Custom Field. 0 = Text Input 1 = Number Input 2 = Combo Box 3 = File Upload
rows.order	Number	Display order of the Custom Field
rows.data	String	Only for Combo Box Type. Data for combo box options, delimited by semicolon.

This API is used to view output signals which used on certain actions for setting the relay of the device to trigger in certain signals. The trigger & action from the device configuration is one of them.

This API is used to create output signal.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the output signal
delay	Number	N	Set the signal delay
count	Number	N	Set the signal count
on_duration	Number	N	Set the signal ON duration
off_duration	Number	N	Set the signal OFF duration

ID of the output signal which will be updated.

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"733664a4-9d61-42b3-822f-1d6315dcd616"},{"name":"Delete Output Signal","id":"2776ea0d-98d2-4567-8468-71fcfffc9fc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/setting/output_signals/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}},"urlObject":{"path":["api","setting","output_signals",":id"],"host":["https://127.0.0.1"],"query":[],"variable":[{"description":{"content":"

ID of the output signal which will be deleted.

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"2776ea0d-98d2-4567-8468-71fcfffc9fc1"},{"name":"Update Server Matching","id":"f3ecec25-b0f5-4d90-a58e-613357b9fb37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"BioStar\": {\r\n \"server_matching\": {\r\n \"use-server-matching\": \"false\",\r\n \"security-level\": 6,\r\n \"face-security-level\": 1,\r\n \"fast-mode\": \"true\",\r\n \"matching-concurrency-count\": \"2\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/setting/biostar/server_matching","description":"

If server matching enabled, the user’s fingerprint will be matched from BioStar 2, not the device. The Server Matching can be used when the Advance or higher license is activated.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
use-server-matching	Boolean	Y	Activates/Deactivates server matching.
security-level	Number	N	Configure the server matching’s security level for fingerprints. The higher the security level is set, the more the false rejection rate (FRR) can occur.
face-security-level	Number	N	Configure the server matching’s security level for faces. The higher the security level is set, the more the false rejection rate (FRR) can occur.
fast-mode	Boolean	N	Configure the fingerprint matching speed.
matching-concurrency-count	Number	N	Configure how many matchings can be done simultaneously. Max. Simultaneous Server Matching Count depends on the PC's CPU performance.

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}},"urlObject":{"path":["api","setting","biostar","server_matching"],"host":["https://127.0.0.1"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3ecec25-b0f5-4d90-a58e-613357b9fb37"},{"name":"Update BioStar Settings","id":"a12ff119-be40-4392-bcf9-1eba63e888ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"BioStar\": {\r\n \"session_timeout\": \"216000\",\r\n \"server_port\": \"51212\",\r\n \"server_matching\": {\r\n \"matching-concurrency-count\": \"2\",\r\n \"use-server-matching\": \"false\",\r\n \"security-level\": \"6\",\r\n \"fast-mode\": \"true\",\r\n \"face-security-level\": \"1\"\r\n },\r\n \"user_sync_method\": \"1\",\r\n \"user_by_device_sync_method\": \"0\",\r\n \"log_sync_method\": \"0\",\r\n \"check_duplicate_id_at_devices\": \"0\",\r\n \"automatic_server_upgrade\": \"0\",\r\n \"upgrade_when\": \"0\",\r\n \"fingerprint_format\": \"0\",\r\n \"licese_server_addr\": \"http://license.biostar2.com\",\r\n \"backup\": {\r\n \"use\": \"false\",\r\n \"cycle\": \"2\",\r\n \"day\": \"28\",\r\n \"weekday\": \"2\",\r\n \"time\": \"10800\",\r\n \"path\": \".\\\\bk\",\r\n \"overwritable\": \"false\"\r\n },\r\n \"support_mobile_credential\": \"true\",\r\n \"language\": \"en\",\r\n \"server_addr\": \"\",\r\n \"delete_credential_after_aoc\": \"false\",\r\n \"secure_communication\": {\r\n \"mode\": \"0\",\r\n \"use_external_cert\": \"false\",\r\n \"enable_data_encryption\": \"false\",\r\n \"enable_db_data_encryption\": \"false\",\r\n \"ischanged_data_encryption\": \"false\",\r\n \"ischanged_db_data_encryption\": \"false\",\r\n \"enable_db_encryption\": \"false\",\r\n \"is_random_encryption_key\": \"true\",\r\n \"is_random_hash_key\": \"true\",\r\n \"has_encryption_key\": \"false\",\r\n \"has_hash_key\": \"true\"\r\n },\r\n \"system_security\": {\r\n \"password_strength\": \"2\",\r\n \"use_password_update_cycle\": \"false\",\r\n \"password_update_cycle\": \"60\",\r\n \"use_allow_login_failed\": \"false\",\r\n \"allow_login_failed_count\": \"5\",\r\n \"allow_login_failed_minutes\": \"10\",\r\n \"use_allow_password_change\": \"false\",\r\n \"allow_password_change_count\": \"1\",\r\n \"use_allow_simultaneous_connection\": \"true\"\r\n },\r\n \"web_request_timeout\": \"60\",\r\n \"imglog_dir\": \".\\\\imagelog\\\\\",\r\n \"websocket_cors\": \"*\",\r\n \"enable_websocket_connection_bsSessionId\": \"false\",\r\n \"enckey_dir\": \"C:\\\\Program Files\\\\BioStar 2(x64)\\\\util\",\r\n \"device_event_log_skip_enroll_success_user\": \"false\",\r\n \"http\": {\r\n \"port\": \"80\",\r\n \"root_path\": \"html\"\r\n },\r\n \"https\": {\r\n \"use_ssl\": \"1\",\r\n \"port\": \"443\",\r\n \"ssl_addr\": \"192.168.1.5\",\r\n \"server.ssl.key-store-password.use_enc\": \"1\"\r\n },\r\n \"cloud\": {\r\n \"use_cloud\": \"0\",\r\n \"server_address\": \"api.biostar2.com\",\r\n \"http_port\": \"52000\",\r\n \"version\": \"v2\",\r\n \"sub_domain\": \"oddbit\",\r\n \"email\": \"team-suprema@oddbit.id\",\r\n \"account_id\": \"611dcbe1f3e8e50a179b105c\",\r\n \"email_use_enc\": \"1\"\r\n },\r\n \"tna\": {\r\n \"use_tna\": \"true\",\r\n \"http_port\": \"3000\",\r\n \"https_port\": \"3002\",\r\n \"ngrok_port\": \"51000\"\r\n },\r\n \"video\": {\r\n \"use_video\": \"true\",\r\n \"http_port\": \"3010\",\r\n \"https_port\": \"3012\",\r\n \"ngrok_port\": \"52002\"\r\n },\r\n \"licenses\": [\r\n {\r\n \"product_type\": \"1\",\r\n \"name\": \"biostar_def\",\r\n \"available\": {\r\n \"ZONE\": \"false\",\r\n \"ELEVATOR\": \"false\",\r\n \"SERVER_MATCHING\": \"false\",\r\n \"CLOUD\": \"false\",\r\n \"MOBILE_CARD\": \"false\",\r\n \"GRAPHICMAP\": \"false\"\r\n },\r\n \"activated\": \"true\"\r\n },\r\n {\r\n \"product_type\": \"2\",\r\n \"name\": \"biostar_std\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"3\",\r\n \"name\": \"biostar_tna\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"4\",\r\n \"name\": \"biostar2_basic\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"5\",\r\n \"name\": \"biostar2_std\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"6\",\r\n \"name\": \"biostar2_adv\",\r\n \"available\": {\r\n \"ZONE\": \"true\",\r\n \"ELEVATOR\": \"true\",\r\n \"SERVER_MATCHING\": \"true\",\r\n \"CLOUD\": \"true\",\r\n \"MOBILE_CARD\": \"true\",\r\n \"GRAPHICMAP\": \"true\"\r\n },\r\n \"activated\": \"true\",\r\n \"customer\": \"Oddbit\",\r\n \"expires_on\": \"permanent\"\r\n },\r\n {\r\n \"product_type\": \"7\",\r\n \"name\": \"biostar2_pro\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"8\",\r\n \"name\": \"biostar2_ent\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"9\",\r\n \"name\": \"biostar2_video\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"10\",\r\n \"name\": \"biostar2_visitor\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"11\",\r\n \"name\": \"biostar2_tna_std\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"12\",\r\n \"name\": \"biostar2_tna_adv\",\r\n \"activated\": \"false\"\r\n },\r\n {\r\n \"product_type\": \"13\",\r\n \"name\": \"biostar2_tna_pro\",\r\n \"activated\": \"false\"\r\n }\r\n ],\r\n \"mobile\": {\r\n \"use_mobile_credential\": \"1\",\r\n \"email\": \"agni@supremainc.com\",\r\n \"password\": \"****************\",\r\n \"mc_server_addr\": \"https://api.mc.suprema.io\",\r\n \"mc_port\": \"443\",\r\n \"siteid\": \"6482\",\r\n \"site_type\": \"REGULAR\"\r\n },\r\n \"log_level\": {\r\n \"enable\": \"true\",\r\n \"log_retain_days\": \"60\",\r\n \"level\": \"none\",\r\n \"filter\": {\r\n \"SYS\": \"info\",\r\n \"DBG\": \"none\",\r\n \"NET\": \"info\",\r\n \"WEB\": \"info\",\r\n \"SQL\": \"none\",\r\n \"WSS\": \"none\"\r\n }\r\n },\r\n \"server_ip_list\": [\r\n {\r\n \"ip\": \"192.168.1.5\",\r\n \"version\": \"v4\"\r\n }\r\n ],\r\n \"use_alphanumeric\": \"false\",\r\n \"is_set_new_administrator_password\": \"false\",\r\n \"ischanged_db_data_encryption\": \"false\",\r\n \"ischanged_data_encryption\": \"false\",\r\n \"eventlog\": {\r\n \"event_log_retain_days\": \"60\",\r\n \"active\": \"false\"\r\n },\r\n \"log\": {\r\n \"log_retain_days\": \"60\",\r\n \"cron\": \"0 0 0 * * *\",\r\n \"path\": \"logs\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/setting/biostar","description":"

This API is used to update various BioStar 2 settings.

BODY Parameter on this API:

Parameter	Type	Required	Description
session_timeout	String	N	Set a session timeout period. If there is no activity on BioStar 2 for the set time after logging in, the session is logged out automatically. This value represents second.
server_port	String	N	Port number that BioStar 2 uses.
server_matching >use-server-matching	Boolean	N	Activates/Deactivates server matching. Toggle true to activate.
>matching-concurrency-count	Number	N	Configure how many matchings can be done simultaneously.
>security-level	Number	N	Configure the server matching’s security level for fingerprints. The higher the security level is set, the more the false rejection rate (FRR) can occur.
>fast-mode	Boolean	N	Configure the fingerprint matching speed.
>face-security-level	Number	N	Configure the server matching’s security level for faces. The higher the security level is set, the more the false rejection rate (FRR) can occur.
user_sync_method	Number	N	Automatic user synchronization setting. Need to be combined with user_by_device_sync_method to use. Not Used : user_sync_method : \"0\" & user_by_device_sync_method:\"0\" All Devices : user_sync_method : \"1\" & user_by_device_sync_method:\"0\" All Devices (Including user update from device) : user_sync_method : \"1\" & user_by_device_sync_method:\"1\" Specific Devices (Only devices belonging to the access group) : user_sync_method : \"3\" & user_by_device_sync_method:\"0\"
user_by_device_sync_method	Number	N	See user_sync_method
log_sync_method	Number	N	Toggle value to 1 to set the Log Upload to manual, and 0 for automatic.

This API is used to check BioStar 2's version.

This API is used to delete Mobile Access Card in Airfob Portal.

There are three variations in using this API:

Using Card ID
Using User ID
Using ALL parameter on User ID

BODY Parameters in this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
card_id	Array	Y	Mobile Access Card's card ID
user_id	Array	Y	ID of the user which Mobile Access Card will be removed.

To delete multiple card_id or user_id, separate each value with comma (,). Ex: [\"1\", \"2\", \"3\"]

Response:

200 OK

{\n    \"failedUsers\": [],\n    \"failedCards\": [],\n    \"mobileUsers\": [],\n    \"status\": 0,\n    \"errorMessage\": \"\",\n    \"Response\": {\n        \"code\": \"0\"\n    }\n}\n\n

failedUsers : User information that fails after requesting to delete airfob
\n
failedCards : Card information that fails after requesting to delete airfob
\n

This API is used to delete Mobile Access Card in Airfob Portal.

There are three variations in using this API:

Using Card ID
Using User ID
Using ALL parameter on User ID

BODY Parameters in this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
card_id	Array	Y	Mobile Access Card's card ID
user_id	Array	Y	ID of the user which Mobile Access Card will be removed.

To delete multiple card_id or user_id, separate each value with comma (,). Ex: [\"1\", \"2\", \"3\"]

Response:

200 OK

{\n    \"failedUsers\": [],\n    \"failedCards\": [],\n    \"mobileUsers\": [\n        \"3\",\n        \"4\"\n    ],\n    \"status\": 0,\n    \"errorMessage\": \"\",\n    \"Response\": {\n        \"code\": \"0\"\n    }\n}\n\n

failedUsers : User information that fails after requesting to delete airfob
\n
failedCards : Card information that fails after requesting to delete airfob
\n

This API is used to delete Mobile Access Card in Airfob Portal.

There are three variations in using this API:

Using Card ID
Using User ID
Using ALL parameter on User ID

BODY Parameters in this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
card_id	Array	Y	Mobile Access Card's card ID
user_id	String	Y	The use of ALL parameter will remove Airfob's Mobile Access Card from all user which have Mobile Access Card on their credential list.
param:UserIDs	String	Y	Will only be required if using ALL parameter on mobile:user_id. Default value: ALL
param:query:group_id	Number	Y	Will only be required if using ALL parameter on mobile:user_id. Default value: 1

To delete multiple card_id or user_id, separate each value with comma (,). Ex: [\"1\", \"2\", \"3\"]
This API only remove Mobile Access Card information from Airfob Portal. To remove Mobile Access credential from the user, use PUT /api/users/:id

Response:

200 OK

{\n    \"failedUsers\": [],\n    \"failedCards\": [],\n    \"mobileUsers\": [\n        \"3\",\n        \"4\"\n    ],\n    \"status\": 0,\n    \"errorMessage\": \"\",\n    \"Response\": {\n        \"code\": \"0\"\n    }\n}\n\n

failedUsers : User information that fails after requesting to delete airfob
failedCards : Card information that fails after requesting to delete airfob

This API is used to create Mobile Access Card in Airfob Portal.

BODY Parameters on this API:

Parameter	Type	Required	Description
user_id	String	Y	User ID
name	String	N	User Name
title	String	N	User's Title
department	String	N	Department Name
phone	String	N	Phone Number
email	String	Y	Email
portraitData	String	N	Photo encoding data. Base64.
card_id	String	Y	Card ID
startDate	Timestamp	Y - Dynamic Site	Start Date for Dynamic Site
endDate	Timestamp	Y - Dynamic Site	End Date for Dynamic Site
startTime	Timestamp	Y	User period start date
endTime	Timestamp	Y	User period end date
issueCount	Number	Y - ToM	ToM card issue round
duressMask	String	N	Duress value
useAlphanumericID	Number	N	0: Numeric 1: Alphanumeric
cardAuthModeEx	String	N	See below
pin		N	PIN number
accessGroupId		N	Access Group ID
mobileCardType		Y	4: CSN Mobile 14: ToM_AoC 15: ToM_SCC

When creating mobile access cards, Airfob portal sites are divided into regular and dynamic
The startDate and endDate fields are used when the sites are dynamic sites

ToM

ToM uses Extend mode for personal authentication mode when creating a card
If another device supports ToM in the future, a value mapped to cardAuthMode (standard) and cardAuthModeEx (extend) should be added for compatibility with devices that do not support Extend
In API, if you put in the cardAuthModeEx value, the server internally maps the cardAuthMode value

Card AuthMode Mapping Table:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

cardAuthModeEx	cardAuthMode
21 - Card	2 - Card only
22 - Card + Face	3 - Card + Fingerprint
23 - Card + Fingerprint	3 - Card + Fingerprint
24 - Card + PIN	4 - Card + PIN
25 - Card + Face or Fingerprint	5 - Card + Fingerprint or PIN
26 - Card + Face or PIN	5 - Card + Fingerprint or PIN
27 - Card + Fingerprint or PIN	5 - Card + Fingerprint or PIN
28 - Card + Face or Fingerprint or PIN	5 - Card + Fingerprint or PIN
29 - Card + Face + Fingerprint	6 - Card + Fingerprint + PIN
30 - Card + Face + PIN	6 - Card + Fingerprint + PIN
31 - Card + Fingerprint + Face	6 - Card + Fingerprint + PIN
32 - Card + Fingerprint + PIN	6 - Card + Fingerprint + PIN
33 - Card + Face or Fingerprint + PIN	6 - Card + Fingerprint + PIN
34 - Card + Face + Fingerprint or PIN	6 - Card + Fingerprint + PIN
35 - Card + Fingerprint + Face or PIN	6 - Card + Fingerprint + PIN

Response:
200 OK

{\n  \"MobileCollection\": {\n    \"listMobile\": [\n      {\n        \"apisnddt\": \"2023-12-26T04:03:17.382Z\",\n        \"userid\": \"2\",\n        \"crdid\": \"2\",\n        \"portalrslt\": \"\"\n      }\n    ],\n    \"recordMobile\": [\n      {\n        \"number\": \"2\",\n        \"status\": \"INACTIVE\",\n        \"cardType\": \"REGULAR\",\n        \"startDate\": \"0\",\n        \"endDate\": \"253402300799000\",\n        \"startTime\": \"978274800000\",\n        \"endTime\": \"1924959540000\",\n        \"name\": \"test2\",\n        \"department\": \"\",\n        \"title\": \"\",\n        \"issueCount\": \"1\",\n        \"cardAuthMode\": \"2\",\n        \"cardAuthModeEx\": \"21\",\n        \"mobileCardType\": \"4\"\n      }\n    ]\n  },\n  \"Response\": {\n    \"code\": \"0\"\n  }\n}\n\n

Response Description:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
apisnddt	API send time
userid	User ID
crdid	Card ID
portalrslt	Not used
number	Card ID
status	Sie status
cardType	Site type (Regular or Dynamic)
startDate	Start Date for Dynamic Site
endDate	End Date for Dynamic Site
startTime	User period start date
endTime	User period end date
name	User name
department	Department name
title	User's title
issueCount	ToM card issue round
cardAuthMode	Card standard AuthMode value (See ToM description above)
cardAuthModeEx	Card extended AuthMode value (See ToM description above)
mobileCardType	4: CSN Mobile 14: ToM_AoC 15: ToM_SCC

This API is available starting from BioStar 2 version 2.9.8.

It is used to fetch CSN Mobile information deleted from the list.

Response Example:

{\n  \"CardCollection\" : {\n    \"rows\" : [ {\n      \"id\" : \"11\",\n      \"card_id\" : \"1234\",\n      \"user_id\" : \"12\",\n      \"user_name\" : \"test3\",\n      \"display_card_id\" : \"1234\",\n      \"card_type\" : {\n        \"id\" : 4,\n        \"name\" : \"CSN Mobile\",\n        \"type\" : 4\n      }\n    }, {\n      \"id\" : \"12\",\n      \"card_id\" : \"5678\",\n      \"user_id\" : \"13\",\n      \"user_name\" : \"test4\",\n      \"display_card_id\" : \"5678\",\n      \"card_type\" : {\n        \"id\" : 4,\n        \"name\" : \"CSN Mobile\",\n        \"type\" : 4\n      }\n    }, {\n      \"id\" : \"15\",\n      \"card_id\" : \"2222\",\n      \"user_id\" : \"16\",\n      \"user_name\" : \"test7\",\n      \"display_card_id\" : \"2222\",\n      \"card_type\" : {\n        \"id\" : 4,\n        \"name\" : \"CSN Mobile\",\n        \"type\" : 4\n      }\n    } ],\n    \"total\" : \"3\"\n  },\n  \"Response\" : {\n    \"code\" : \"0\"\n  }\n}\n

Limit the number of responses by n records. Remove this parameter to view all.

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Offset the response shown by n records.

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Filter the response by card type (DELETED_CSN_MOBILE).

\n","type":"text/plain"},"key":"search_type","value":"DELETED_CSN_MOBILE"}],"variable":[]}},"response":[],"_postman_id":"5a08d497-bf1e-4372-b69f-ef96c14e3143"},{"name":"Delete CSN Mobile from Database","id":"29bdcaee-1610-4564-804e-17ab4899ee26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/v2/cards/mobile/enable?id=18,19,20","description":"

This API is available starting from BioStar 2 version 2.9.8.

It is used to delete CSN Mobile information from the database.

Response Example:

{\n    \"code\": \"0\"\n}\n\n

Card UID value, separate using comma (,). Use asterisk (*) to select all.

\n","type":"text/plain"},"key":"id","value":"18,19,20"}],"variable":[]}},"response":[],"_postman_id":"29bdcaee-1610-4564-804e-17ab4899ee26"},{"name":"Count Deleted CSN Mobile","id":"eb1b5929-5725-4a12-b591-4c96bc31ef39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cardUids\": \"11,12,13,16,17\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/cards/mobile/count","description":"

This API is available starting from BioStar 2 version 2.9.8.

It is used to count deleted CSN Mobile information.

BODY Parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
cardUids	String	Y	List Mobile Card UID(s) which will be counted.

Response Example:

{\n  \"CardCollection\" : {\n    \"count\" : 2\n  },\n  \"Response\" : {\n    \"code\" : \"0\"\n  }\n}\n\n

This API is used for listing event types recorded on BioStar 2 database.

Toggle true to list events that users have manually changed the name of. Toggle other parameters to false for this to work.

\n","type":"text/plain"},"key":"is_break_glass","value":"false"},{"description":{"content":"

Toggle true to list events which will trigger alert. Marked by 'alertable' parameter on the event. 'enable_alert' is used for marking which event will show a pop up notice on Bio Star 2.

\n","type":"text/plain"},"key":"setting_alert","value":"true"},{"description":{"content":"

Toggle true to list all events recorded on database.

\n","type":"text/plain"},"key":"setting_all","value":"true"}],"variable":[]}},"response":[],"_postman_id":"d54843e3-6ce2-4ddc-94f4-0da88334c304"},{"name":"Download Events Exported CSV","id":"6495f56c-cea9-4124-aa13-700d33344961","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/download/:exported_file","description":"

This API is used to download Events exported .csv from BioStar 2 Server.

Use the filename which resulted from POST /api/events/export

Put the filename to download on the PATH of the API.

File name which will be downloaded

\n","type":"text/plain"},"type":"any","value":"Report_20220204T165145.csv","key":"exported_file"}]}},"response":[],"_postman_id":"6495f56c-cea9-4124-aa13-700d33344961"},{"name":"Search Events","id":"95c58101-69b4-45ab-b12d-d3b389964075","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"limit\": 20,\r\n \"conditions\": [\r\n {\r\n \"column\": \"datetime\",\r\n \"operator\": 3,\r\n \"values\": [\r\n \"2022-03-01T15:00:00.000Z\",\r\n \"2024-03-02T16:59:59.000Z\"\r\n ]\r\n },\r\n {\r\n \"column\": \"id\",\r\n \"operator\": 1,\r\n \"values\": [\r\n \"60491\"\r\n ]\r\n }, \r\n {\r\n \"column\": \"user_id.user_id\",\r\n \"operator\": 0,\r\n \"values\": [\r\n \"2\"\r\n ]\r\n }\r\n ],\r\n \"orders\": [\r\n {\r\n \"column\": \"datetime\",\r\n \"descending\": true\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/events/search","description":"

This API is used to view events registered on BioStar 2.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
limit	Number	Y	Limit the response records by the value stated on this parameter
conditions	Array	N	When in use, certain key-value is mandatory.
conditions:column	String	Y	Field which the conditions will be based from
conditions:operator	Number	Y	Condition Operator EQUAL : 0, NOT_EQUAL : 1, CONTAINS : 2, BETWEEN : 3, LIKE : 4, GREATER : 5, LESS : 6 For field encrypted in encryption mode (ex. user_id.user_id), it only supports Equal (0), Not Equal (1), and Contains(2).
conditions:values	Datetime	Y	Value of the conditions
orders	Array	N	When in use, certain key-value is mandatory.
orders:column	String	Y	Field which the sorting will be based on
orders:descending	Boolean	N	Toggle true to set the sorting as descending

When query events through Search Events (/api/events/search), events that contain image logs include the following fields in the response:

\"image_id\": {\n  \"image_data\": \"1755062341_547838635_159337\",\n  \"image_type\": \"JPG\",\n  \"photo\": \"false\"\n}\n\n

The image_data value can be used to retrieve the corresponding image file.

(String, Required) – The identifier of the image, obtained from the event search response.

\n","type":"text/plain"},"type":"any","value":"","key":"image_data"}]}},"response":[],"_postman_id":"ec1464f4-9c2f-47d5-9817-0ddfa23a1c4b"},{"name":"Search Thermal Events","id":"3b7c9cc7-00ad-4abc-a0da-7a5b97dab633","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"limit\": 51,\r\n \"conditions\": [\r\n {\r\n \"column\": \"datetime\",\r\n \"operator\": 3,\r\n \"values\": [\r\n \"2021-01-27T16:00:00.000Z\",\r\n \"2022-01-28T15:59:59.000Z\"\r\n ]\r\n }\r\n ],\r\n \"orders\": [\r\n {\r\n \"column\": \"datetime\",\r\n \"descending\": false\r\n }\r\n ]\r\n }\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/events/search/thermal","description":"

This API is used to view events with thermal data.

Parameters on this API is the same as Search Events.

This API is used to export events as a .csv file.

Exported .csv will be saved on [BioStar 2 Server installation path]/nginx/html/download.

To get it from the server, use Download Events Exported CSV API.

BODY Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
conditions	Array	N	A set of conditions to filter the response of the API. On this case, it's using the datetime field to filter according to the values given.
offset	Number	N	Shift the response records by n records.
columns	Array	Y	List of fields which will be exported. Refer to the table below for list of available fields.
headers	Array	Y	Name of the header on the exported .csv file.

Available Column Fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Fields	Description
datetime	Device timestamp (timezone/DST applied)
device_id.id	Device ID (numeric)
device_id.name	Device name
door_id.name	Door name
elevator_id.name	Elevator name + floor information
event_type_id	Event type name (multilingual support)
user_id	User ID + name + IP
user_group_id	User group name
zone_id.name	Zone name
tna_key	TNA caption/key
temperature	Temperature (°C or °F depending on `use_centigrade` setting)
user_phone	User phone number (thermal export)
user_email	User email address (thermal export)

Shift time on the exported file by n minutes

\n","type":"text/plain"},"key":"time_offset","value":"480"},{"description":{"content":"

Toggle true to set temperature as celcius, false as fahrenheit.

\n","type":"text/plain"},"key":"use_centigrade","value":"true"}],"variable":[]}},"response":[],"_postman_id":"f4af266d-24f8-4b65-8f93-d321d563ad1e"},{"name":"List All Alerts","id":"5a04cabb-c65c-4528-87cf-bac9c2f4fd64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"offset\": 0,\r\n \"limit\": 50,\r\n \"conditions\": [\r\n {\r\n \"column\": \"status\",\r\n \"operator\": 0,\r\n \"values\": [\r\n \"1\"\r\n ]\r\n },\r\n {\r\n \"column\": \"event_id.datetime\",\r\n \"operator\": 3,\r\n \"values\": [\r\n \"2023-01-01T00:00:00.00Z\",\r\n \"2023-03-02T00:00:00.00Z\"\r\n ]\r\n }\r\n ],\r\n \"orders\": [\r\n {\r\n \"column\": \"event_id.datetime\",\r\n \"descending\": true\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/alerts/search","description":"

This API is used to view alert events which can be filtered using available parameters.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
offset	Number	N	Shift response records by n record(s)
limit	Number	N	Limit response records by n record(s)
conditions:column	String	N	Field which the condition will be based on
conditions:operator	Number	N
conditions:values	String	N	Value of the condition based on the field selected on conditions:column
orders:column	String	N	Parameter which the sorting will be based on
orders:descending	Boolean	N	Sort by descending or ascending. True for descending.

It is required to at least put this on BODY to run the API successfully: {\"Query\": {}}

Running the API without parameters will show all alerts.

This example shows how to use the parameters on this API to filter the response according to the status of the alert events.

Where:
0 = Ignored Alert Events
1 = Acknowledged Alert Events

To show all alert events regardless of status, remove the condition from the BODY.

This example shows how to use the parameters on this API to filter responses according to the datetime of the alert events.

This API is used to log alertable: true events (GET /api/event_types) to Alert Collection (POST /api/alerts/search)

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
event_id:datetime	DateTime	Y	Datetime as shown on events
status	Number	Y	Default: 1
user_id	String	Y	User ID/Name which will be recorded on the Alert Log. Default: 1
ack_message	String	Y	Custom message which will be recorded on the Alert Log

Unique ID recorded on hint parameter (POST /api/events/search)

\n","type":"text/plain"},"type":"any","value":"164379073505437203680000021611","key":"alert_id"}]}},"response":[],"_postman_id":"ea7f14f2-d604-4ea8-99f4-5374e895bf5b"},{"name":"View a Muster Zone Status","id":"b2a1125c-d5ff-47be-b723-0cf29024d0f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"limit\": 51\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/zones/:id/tracking","description":"

This API is used to view a muster zone status.

BODY Parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
limit	Number	Y	Specify the number of records which shown on the response

This API is used to view Audit Trail logs.

It is possible to use multiple conditions in a request. Separate each condition using comma (,).

Example:

[ {condition 1}, {condition 2}, .. ]

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
offset	Number	N	Offset the response's records by the specified value.
limit	Number	Y	Limit the number of response's records by the specified value.
total	Boolean	N	Default: false Toggle true to get total count of the Audit Trail based on condition(s) set.
conditions	Array	N	A set of conditions to filter the Audit Trails logs.
conditions.column	String	N	See below
conditions.operator	Number	N	See belo
conditions.values	Array	N	See below

Condition Operator:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

column	operator	values
DATE	3	ISO-8601 date format. Value of from and to are separated using comma (,)
USRID	2	Make use of Audit Search User to get the required value. Value format: [\"UserName(UserID)\"]. Use comma (,) to separate values.
PERM	2	Make use of Audit Search Oerator Level to get the required value. Use comma (,) to separate values.
IP	2	Make use of Audit Search IP List to get the required value. Use comma (,) to separate values.
MENU	2	Values: \"access_level\" \"access_group\" \"setting\" \"setting.permission\" \"setting.preference\" \"setting.server\" \"setting.wiegand_format\" \"setting.smartcard\" \"setting.trigger_action\" \"setting.event_type\" \"setting.image_filter\" \"setting.custom_field\" \"setting.system_config\" \"setting.face_group\" \"setting.schedule\" \"setting.holiday_group\" \"setting.output_signal\" \"setting.dst\" \"setting.mobileCredential\" \"system\" \"user\" \"device\" \"door\" \"elevator\" \"zone\" \"floor_level\" \"graphicmap\" Use comma (,) to separate values.
TARGET	2	Make use of Audit Search Target List to get the required value. Use comma (,) to separate values.
METHOD	2	1: Add 3: Update 4: Delete 5: Action Use comma (,) to separate values.

This API is used to filter user by the specified input.

Do note the API will only show records of user which have Audit Trail logs only.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
search	String	N	Search term to filter the user with Audit Trail log. To show all users which have Audit Trail logs, simply remove this parameter from the request.
limit	Number	N	Limit the number of response's records by the specified value.
offset	Number	N	Offset the response's records by the specified value.

This API is used to filter Operator Level by the specified input.

Do note the API will only show records of Operator Level which have Audit Trail logs only.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
search	String	N	Search term to filter the Operator Level with Audit Trail log. To show all Operator Level which have Audit Trail logs, simply remove this parameter from the request.
limit	Number	N	Limit the number of response's records by the specified value.
offset	Number	N	Offset the response's records by the specified value.

This API is used to filter IP records by the specified input.

Do note the API will only show records which have Audit Trail logs only.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
search	String	N	Search term to filter the IP with Audit Trail log. To show all IP which have Audit Trail logs, simply remove this parameter from the request.
limit	Number	N	Limit the number of response's records by the specified value.
offset	Number	N	Offset the response's records by the specified value.

This API is used to filter Target records by the specified input.

Do note the API will only show records which have Audit Trail logs only.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
search	String	N	Search term to filter the Target with Audit Trail log. To show all Target which have Audit Trail logs, simply remove this parameter from the request.
limit	Number	N	Limit the number of response's records by the specified value.
offset	Number	N	Offset the response's records by the specified value.

This API is used to generate CSV file based on the parameters.

Make use of Events\\Download Events Exported CSV API to download the exported CSV.

BODY Parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
offset	Number	N	Offset the response's records by the specified value.
conditions	Array	N	See `Audit Search` for usage.
columns	Array	N	List of columns which will be included on the CSV.
headers	Array	N	Header name which will be used on the CSV.

Adjust the time value according to the required Time Zone. If the required TZ is UTC+8, then the value will be 480 (60 x 8).

\n","type":"text/plain"},"key":"time_offset","value":"480"}],"variable":[]}},"response":[],"_postman_id":"8f8da8ed-5f59-4adf-8b6a-6e994b3de8c7"}],"id":"dc98acd2-977b-4dc9-a3ae-fee45b709876","_postman_id":"dc98acd2-977b-4dc9-a3ae-fee45b709876","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"Zones","item":[{"name":"Occupancy Limit","item":[{"name":"Occupancy: Create New","id":"e5799555-fc5c-4c64-b934-940db9d9dcc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"is_enabled\": 1,\r\n \"name\": \"OccupancyZone1\",\r\n \"zone_type\": 11,\r\n \"status\": 0,\r\n \"occupancy_detail\": {\r\n \"limit_count\": \"100\",\r\n \"entry_devices\": [\r\n \"543720368\"\r\n ],\r\n \"exit_devices\": [\r\n \"542353521\"\r\n ],\r\n \"almost_full_alert_setting\": {\r\n \"level\": 1,\r\n \"step_1\": \"95\",\r\n \"step_2\": 0\r\n },\r\n \"auto_reset_count_time\": {\r\n \"is_enabled\": \"1\",\r\n \"minute\": 1439\r\n },\r\n \"network_fail_action\": \"0\",\r\n \"bypass_groups\": [\r\n {\r\n \"acsgruid\": \"1\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/zones/occupancy?time_zone=25","description":"

You can manage and control the population density of certain areas with Occupancy Limit Zone to prevent overcrowding. You can also monitor the occupancy limit zone status or set an alert to get notified when the zone has reached capacity.

Up to 100 occupancy limit zones can be added.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
is_enabled		Deactivate the occupancy limit zone. If the zone is deactivated, both Count that refers to the number of users in the zone and Count Bypass settings will be initialized. Select Active to enable it.
name	String	Enter an occupancy limit zone name. Name can be up to 48 characters in length and cannot be set to the same name as other zones.
zone_type	Number	View the zone type.
status	Number
limit_count	Number	Enter the number of users who will be restricted from entering the zone. If the number of users in the zone reaches the limit, entry will be restricted. You can enter a number from 0 to 10,000, and if it is set to 0, people can enter the zone without limit.
entry_devices	Number	Select a device to use for entry. You can select a device from the list of added devices.
exit_devices	Number	Select a device to use at exit. You can select a device from the list of added devices.
almost_full_alert_setting:level	Number	Set an alert to an administrator or set to save event logs before Count reaches the occupancy limit.
almost_full_alert_setting:step_1	Number	The first alert for occupancy limit.
almost_full_alert_setting:step_2	Number	The second alert for occupancy limit.
auto_reset_count_time:is_enabled	Boolean	Toggle to set the time to automatically reset occupancy limit Count.
auto_reset_count_time:minute	Number	The Count will be initialized at the time you set every day.
network_fail_action	Number	Set whether to allow users to enter or leave when a network error occurs in the device set in the zone. If you set it to Allow Entry and Exit, it stops entry restrictions when the device loses network connection, and people can enter the zone even if Count in the zone exceeds the occupancy limit.
bypass_groups:acsgruid	Number	Set Count Bypass by selecting bypass groups to allow users in the group to enter the zone at any time without affecting the number of Count. The Bypass Count column displays the number of people from Count Bypass in the zone list. It is not able to use the Count Bypass feature when you set Thermal & Mask Check Mode as Check without authentication while using the device with a thermal camera. Up to 16 bypass groups can be added.

Notes:

Devices and firmware versions that are compatible with the occupancy limit zone features are as follows:
- FaceStation F2 firmware version 1.1.0 or later
- FaceStation 2 firmware version 1.5.0 or later
\n
A device cannot be assigned to the entry device and exit device simultaneously.
You can set entry devices and exit devices up to 128 in total.
A device using Dual Authentication cannot be set as the entry or exit device.
Set the time of Auto Count Reset based on UTC in the country where the zone is located. For example, if the time is set to 00:00 in UTC+9, the count is automatically reset at 01:00 in UTC+10.
You can set up two alerts for Count Alert and only enter numbers smaller than the Limit value. The values of both alerts must be different.

Time Zone ID:\nid : 0, offset : -720\nid : 1, offset : -660\nid : 2, offset : -600\nid : 3-1, offset : -570\nid : 3, offset : -540\nid : 4, offset : -480\nid : 5, offset : -420\nid : 6, offset : -360\nid : 7, offset : -300\nid : 8-1, offset : -270\nid : 8, offset : -240\nid : 9, offset : -210\nid : 10, offset : -180\nid : 11, offset : -120\nid : 12, offset : -60\nid : 13, offset : 0\nid : 14, offset : +60\nid : 15, offset : +120\nid : 16, offset : +180\nid : 17, offset : +210\nid : 18, offset : +240\nid : 19, offset : +270\nid : 20, offset : +300\nid : 21, offset : +330\nid : 22, offset : +345\nid : 23, offset : +360\nid : 23+1, offset : +390\nid : 24, offset : +420\nid : 25, offset : +480\nid : 25+1, offset : +510\nid : 25+2, offset : +525\nid : 26, offset : +540\nid : 27, offset : +570\nid : 28, offset : +600\nid : 28+1, offset : +630\nid : 29, offset : +660\nid : 30, offset : +720\nid : 30+1, offset : +765\nid : 31, offset : +780\nid : 32, offset : +840

Default value : 26

\n","type":"text/plain"},"key":"time_zone","value":"25"}],"variable":[]}},"response":[],"_postman_id":"e5799555-fc5c-4c64-b934-940db9d9dcc1"},{"name":"Occupancy: Update","id":"13faba69-6562-41a4-8d31-47de5499a435","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"is_enabled\": 1,\r\n \"name\": \"OccupancyZone1\",\r\n \"zone_type\": 11,\r\n \"status\": 0,\r\n \"occupancy_detail\": {\r\n \"limit_count\": \"100\",\r\n \"entry_devices\": [\r\n \"543720368\"\r\n ],\r\n \"exit_devices\": [\r\n \"542353521\"\r\n ],\r\n \"almost_full_alert_setting\": {\r\n \"level\": 1,\r\n \"step_1\": \"95\",\r\n \"step_2\": 0\r\n },\r\n \"auto_reset_count_time\": {\r\n \"is_enabled\": \"1\",\r\n \"minute\": 1439\r\n },\r\n \"network_fail_action\": \"0\",\r\n \"bypass_groups\": [\r\n {\r\n \"acsgruid\": \"1\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/zones/occupancy/:id?time_zone=25","description":"

This API is used to update occupancy zone configuration.

\n","type":"text/plain"},"key":"time_zone","value":"25"}],"variable":[{"description":{"content":"

ID of the occupancy zone which will be updated.

\n","type":"text/plain"},"type":"any","value":"32784","key":"id"}]}},"response":[],"_postman_id":"13faba69-6562-41a4-8d31-47de5499a435"},{"name":"Occupancy: Delete","id":"282acc49-892e-4e57-be67-53c14e1455af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"ids\": [\r\n 542189540\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/zones/occupancy","description":"

This API is used to delete Occupancy Zone.

Name of the Occupancy Zone which will be searched.

\n","type":"text/plain"},"type":"any","value":"occ","key":"id"}]}},"response":[],"_postman_id":"f3fa6c63-097b-491e-86b4-69c9787dfd0d"},{"name":"Occupancy: View Details","id":"c221dc6f-b001-4a26-a9fc-851970489393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/v2/zones/occupancy/:id?time_zone=25","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}},"urlObject":{"path":["api","v2","zones","occupancy",":id"],"host":["https://127.0.0.1"],"query":[{"key":"time_zone","value":"25"}],"variable":[{"description":{"content":"

ID of the Occupancy Zone which will be viewed.

\n","type":"text/plain"},"type":"any","value":"32784","key":"id"}]}},"response":[],"_postman_id":"c221dc6f-b001-4a26-a9fc-851970489393"},{"name":"Occupancy: List Dual Auth. Devices","id":"817f4384-59d8-4adb-9dee-f04a426fb7f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/v2/zones/occupancy/devices/dual","description":"

This API is used to get a list of dual authentication devices.

This API is used to list assigned devices on a Occupancy Zone.

ID of the Occupancy Zone

\n","type":"text/plain"},"type":"any","value":"32784","key":"id"}]}},"response":[],"_postman_id":"aa0fd0aa-fe94-4b3e-a6de-840ba83f10ff"},{"name":"Occupancy: Increase Count","id":"48b05b7b-18a7-43bb-a4ef-186757d0da1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://127.0.0.1/api/v2/zones/occupancy/count/increase/:id","description":"

This API is used to increase an occupancy count.

Count will be higher or equal to 0 and will be lower or equal to Count Limit.

ID of the Occupancy Limit.

\n","type":"text/plain"},"type":"any","value":"32784","key":"id"}]}},"response":[],"_postman_id":"48b05b7b-18a7-43bb-a4ef-186757d0da1f"},{"name":"Occupancy: Decrease Count","id":"902b0ac7-62f3-4201-ae84-b8f15dbd8387","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://127.0.0.1/api/v2/zones/occupancy/count/decrease/:id","description":"

This API is used to decrease an occupancy count.

Count will be higher or equal to 0 and will be lower or equal to Count Limit.

ID of the Occupancy Limit

\n","type":"text/plain"},"type":"any","value":"32784","key":"id"}]}},"response":[],"_postman_id":"902b0ac7-62f3-4201-ae84-b8f15dbd8387"},{"name":"Occupancy: Set Count","id":"3032f53b-a055-4495-ae78-59a642822252","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"count\": \"85\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/zones/occupancy/count/set/:id","description":"

This API is used to set and occupancy limit count.

Count value will be higher or equal to 0 and will be lower or equal to Count Limit.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
count	Number	Y	Set count value

ID of the Occupancy Limit.

\n","type":"text/plain"},"type":"any","value":"32784","key":"id"}]}},"response":[],"_postman_id":"3032f53b-a055-4495-ae78-59a642822252"},{"name":"Occupancy: Reset Count","id":"6fe62423-874a-40fc-bc01-67b01f993987","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"ids\": [\r\n 32784\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/v2/zones/occupancy/reset","description":"

This API is used to reset current counts and bypass counts of the occupancy limit zone.

This API is used to disable Occupancy Limit Zone.

This API is used to enable Occupancy Limit Zone.

Anti-passback zone provides an enhanced function than the door based anti-passback feature.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter an anti-passback name.
description	String	N	Enter an anti-passback description.
zone_type	Number	Y	View the zone type.
is_global	Boolean	Y	It is possible to set either Local or Global for the range of zone application. If Local is set, the zone can be set only with the entry devices and devices connected with RS-485, and if Global is set, the zone can be set with all devices enrolled in BioStar 2.
enable	Boolean	Y	Toggle to disable the anti-passback zone.
status		N
apb_type	Boolean	Y	Select an Anti-passback type.
reset_time	Number	Y	You can set a time period so that all anti-passback violations can be deleted. This allows the user to be granted access after the time period. The maximum possible duration is 7 days (10080 minutes). If set to 0, anti-passpack violations will not be deleted and the users who have previously violated the anti-passback rule will not be granted access.
apb_use_door_sensor	Boolean	Y	0=OFF, 1=ON, 2=Door Config. You can set the range to apply the anti-passback. If Entry Confirmed APB is set to ON, the anti-passback is applied according to the actual operation of the door that the entry and exit device are configured. If this option is set to OFF, the rule is applied according to the user's authentication regardless of the door operation. When set to Follows door configuration, the anti-passback rule is applied according to the setting of the Use sensor when Entry Confirmed APB enabled option of the door.
entry_devices:id	Number	Y	Select a device to use for entry.
exit_devices:id	Number	Y	Select a device to use at exit.
bypass_groups:id	Number	N	Select an access level. Users who have the access level will not be restricted by the anti-passback rule.
alarm_actions	Array	N	Choose the operation to be triggered when an APB violation occurs.
apb_fail_action	Number	N	0=Open by Auth ,1=Open by Auth & Record APB Log ,2=Door Locked & Record APB Log. It is possible to set the door operation in case the communication between BioStar 2 and the device where anti-passback is set has been lost. Setting is available when Global is set for Mode. When Open by auth is set, the door opens when the user has been authenticated normally. When Open by auth & record APB log is set, an anti-passback violation alarm occurs and the door opens. When Door locked & record APB log is set, an anti-passback violation alarm occurs and the door does not open.

This endpoint allows administrators to reset the Anti-Passback state within a zone. It can be applied either to all users in the zone or to a specific set of users.

Body Parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
ZoneCollection.rows.id	String	Y	The ID of the APB zone to be cleared.
UserType	Integer	Y	Specifies the clear mode: 1 = Clear APB for all users. 2 = Clear APB for specific users.
User	Array	N	List of user objects with user_id. Required when UserType = 2.

Response Codes:

200 OK: Request successful
\n
400 Bad Request (Code 671): Zone ID mismatch (zone not found)
\n
401 Unauthorized: Login required or invalid session token
\n

This API is used to create new Fire Alarm Zone.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Name of the Fire Alarm Zone
description	String	N	Enter a fire alarm zone description.
zone_type	Number	Y	View the zone type.
is_global	Boolean	Y	You can set fire alarm in two different modes. Local mode will allow the master device and slave devices that are connected via RS-485 to be selected. Global mode will allow selection of all devices added to BioStar 2.
enable	Boolean	Y	Toggle to disable the fire alarm zone.
device_id:id	Number	Y	Add and configure the device to set off the fire alarm signal. When Local is set for Mode, either Door or Elevator can be set as the fire zone. When Global is set for Mode, both Door and Elevator can be set as the fire zone at the same time.
input_index	Number	Y	Input port of the device
type	Boolean	Y	0=Normally Open. 1=Normally Closed.
duration	Number	Y	Duration of the Alarm
doors:id	Number	N	Select the door(s) to include in the fire alarm zone.
elevators:id	Number	N	Select the elevators to include in the fire alarm zone. You can select multiple elevators.
alarm_actions	Array	N	Choose the operation to be triggered when a fire alarm signal occurs.

The muster zone is used as a place where users gather when an emergency occurs. It can also be used for the purpose of monitoring the number of users and list of users in a specific area, or for notifying the manager of alarms and alerts when a user stays in a specific area for a long time.

BODY parameter on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter a muster zone name.
zone_type	Number	Y	View the zone type.
is_global	Boolean	N	You can check the application range of the zone. Only Global mode is supported for muster zone, and the zone can be set with all devices added to BioStar 2.
enable	Boolean	N	Toggle to disable the muster zone.
status	Number	N
access_groups:id	Number	Y	Set the access group to which the user who will be staying in the muster zone. Up to 16 access groups can be set.
entry_devices:id	Number	Y	Select a device to use for entry.
exit_devices:id	Number	Y	Select a device to use at exit.
time_limit	Number	Y	Set the maximum amount of time that user can stay in the zone. It can be set up to 4320 minutes, and an alarm occurs when the user stays in the muster zone exceeding the specified time.
alarm_actions	Array	N	Set the alarm action to carry out when a specific event occurs at the muster zone.

You can configure the scheduled lock zone. The scheduled lock zone keeps the door locked based on the schedule that has been set.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter a scheduled lock zone name.
description	String	N	Enter a scheduled lock zone description.
zone_type	Number	Y	View the zone type
is_global	Boolean	Y	The scheduled lock zone only supports local mode (0).
enable	Boolean	Y	Toggle to disable the scheduled lock zone.
forced_lock:bi_directional_lock	Boolean	Y	0=Exit allowed. 1=Access not allowed. You can configure the zone to lock only the entering device, or to lock both entering and exiting device.
forced_lock:schedule_id:id	Number	Y	Select a schedule. You can configure a scheduled lock zone by selecting multiple doors in local mode.
forced_lock:doors:id	Number	Y	Select the door(s) to include in the scheduled lock zone.
forced_lock:bypass_groups:id	Number	N	Select an access level. Users who have the access level will not be restricted by the scheduled lock rule.
alarm_actions	Array	N	Select an access level. Users who have the access level will not be restricted by the scheduled lock rule.

You can configure the scheduled unlock zone. The scheduled unlock zone keeps the door open based on the schedule that has been set.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter a scheduled unlock zone name.
description	String	N	Enter a scheduled unlock zone description.
zone_type	Number	Y	View the zone type.
is_global	Boolean	Y	The scheduled unlock zone only supports local mode (0).
enable	Boolean	Y	Toggle to disable the scheduled unlock zone.
status	Number	N
isLift	Boolean	Y	You can set doors or elevators as schedule unlock zones.
first_man_in	Boolean	N	When set as Active (1), the user who belongs to the access group must authenticate in the configured schedule to start a schedule unlock. Inactive (2).
schedule_id:id	Number	Y	Select a schedule.
doors:id	Number	Y	If you select Door, the door list is activated. Select the door(s) to include in the scheduled unlock zone. You can configure a scheduled unlock zone by selecting multiple doors in local mode.
first_man_in_groups:id	Number	N	You can select the access group where the user belongs who can start a scheduled unlock.
alarm_actions	Array	N	Choose the operation to be triggered when a scheduled unlock signal occurs.

You can configure the scheduled unlock zone. The scheduled unlock zone keeps the door open based on the schedule that has been set.

BODY parameters on this API:

Parameter	Type	Required	Description
name	String	Y	Enter a scheduled unlock zone name.
description	String	N	Enter a scheduled unlock zone description.
zone_type	Number	Y	View the zone type.
is_global	Boolean	Y	The scheduled unlock zone only supports local mode (0).
enable	Boolean	Y	Toggle to disable the scheduled unlock zone.
status	Number	N
isLift	Boolean	Y	You can set doors or elevators as schedule unlock zones.
first_man_in	Boolean	N	When set as Active (1), the user who belongs to the access group must authenticate in the configured schedule to start a schedule unlock. Inactive (2).
schedule_id:id	Number	Y	Select a schedule.
doors:id	Number	Y	If you select Door, the door list is activated. Select the door(s) to include in the scheduled unlock zone. You can configure a scheduled unlock zone by selecting multiple doors in local mode.
lifts:id	Number	Y	If you select Elevator, the elevator list is activated. Select the elevators to include in the scheduled unlock zone. You can select multiple elevators.
lifts:floors:id	Number	Y	You can select the floor of the selected elevator.
lifts:control_device_id:id	Number	Y	Input the elevator control device id.
first_man_in_groups:id	Number	N	You can select the access group where the user belongs who can start a scheduled unlock.
alarm_actions	Array	N	Choose the operation to be triggered when a scheduled unlock signal occurs.

When intrusion alarm zone is used, you can detect trespassing of an unauthorized user to a designated zone without permission.

BODY parameters on this API:

Parameter	Type	Required	Description
name	String	Y	Enter an intrusion alarm zone name.
description	String	N	Enter an intrusion alarm zone description.
zone_type	Number	Y	Input the zone type.
is_global	Boolean	Y	Application range of the zone. Only Local mode is supported for intrusion alarm zone, and the zone can be set only with devices connected to the entry device and RS-485.
enable	Boolean	N	Toggle to disable the intrusion alarm zone.
status	Number	N
arm_delay	Number	Y	Delay time from the authentication to the arm
disarm_delay	Number	Y	Delay time from the intrusion detection to the alarm occurs.
doors:id	Number	Y	Select the doors to include in the intrusion alarm zone.
access_groups:id	Number	N	You can add an access group with permission to arm or disarm. You can register up to 128 access groups.
cards:id	Number	Y	You can add a card with permission to arm or disarm. You can register up to 128 access cards.
arm_inputs:device:id	Number	Y	You can set the arming and disarming by device or input signal. Select a device to control the intrusion alarm zone among the entry and exit devices of the door
arm_inputs:arm_type	String	Y	Option: arm, disarm, toggle
arm_inputs:input_type	String	Y	Option: card, input
arm_inputs:input_index	Number	Y	Input port of the selected device.
arm_inputs:duration	Number	Y	Duration which the device sensor connected to arm/disarm.
arm_inputs:normal_open	Boolean	Y	Default door status
intrusion_inputs:device:id	Number	Y	Select a device to control the intrusion alarm zone among the entry and exit devices of the door
intrusion_inputs:input_index	Number	Y	Input port of the selected device.
intrusion_inputs:duration	Number	Y	The device recognizes intrusion if N/O sensor connected to input port n for the set duration.
intrusion_inputs:normal_open	Boolean	Y	Default Door status
intrusion_inputs:input_type	String	Y	input
intrusion_actions	Array	N	Set the alarm action to carry out when a specific event occurs at the intrusion alarm zone.

Notes:

arm_inputs, intrusion_inputs, intrusion_actions is activated only when Door is set from Configuration.

Interlock zone monitors the status of two or more doors by door sensor and relay state to control that one door cannot be opened or close if other doors are open or
unlocked. You can also disable access if a user stays within the zone.

An interlock zone can be configured with up to 4 doors.
An interlock zone can only set the doors with the devices connected to the CoreStation.
A device set as an interlock zone cannot be set to another zone.
A door set as an interlock zone cannot be set to another zone other than the fire alarm zone.

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
name	String	Y	Enter an interlock zone name.
description	String	N	Enter an interlock zone description.
zone_type	Number	Y	View the zone type.
is_global	Number	Y	You can check the application range of the zone. Only Local mode is supported for interlock zone, and the zone can be set only with devices connected to the CoreStation and RS-485.
enable	Number	Y	You can disable the interlock zone. input 1 to enable it.
inter_lock:doors:id	Number	Y	Select the doors to include in the interlock zone. You must select at least two doors that are the door sensor is connected.
sensor_inputs:device:id	Number	Y	If a user stays in the zone, this option can prevent others from entering the zone. Input the device ID which will be used as sensor.
sensor_inputs:input_index	Number	Y	Index of the sensor which will be used.
sensor_inputs:duration	Number	Y	Set the duration.
sensor_inputs:normal_open	Number	Y	Set status between Normally Open or Closed.
sensor_inputs:input_type	String	Y	Type of the input.
alarm_actions	Array	N	Set the alarm action to carry out when a specific event occurs at the interlock zone.

This API is used to update a Zone.

ID of the Zone which will be updated.

\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"19f44187-35fb-4313-8987-fe232e551dd9"},{"name":"Zones: Delete","id":"774a90dc-3d11-458d-94a4-df5abe0c606b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://127.0.0.1/api/zones/:id","description":"

This API is used to delete a Zone.

ID of the zone which will be deleted.

\n","type":"text/plain"},"type":"any","value":"32786","key":"id"}]}},"response":[],"_postman_id":"774a90dc-3d11-458d-94a4-df5abe0c606b"},{"name":"View Zones","id":"ed18b5d6-b67e-48a1-ae07-a3f03a171a64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/zones","description":"

This API is used to view zones.

Limit the number of responses by n records.

\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"

Offset the responses by n records.

\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"

Limit the responses according to the zone_type. Leave empty for show all.\n0=Anti Passback, 1=Fire Alarm, 2=Scheduled Lock, 3=Scheduled Unlock - Door, 6=Intrusion, 7=Interlock, 8=Muster, 10=Scheduled Unlock - Elevator, 11=Occupancy

\n","type":"text/plain"},"key":"group_id","value":"4"}],"variable":[]}},"response":[],"_postman_id":"ed18b5d6-b67e-48a1-ae07-a3f03a171a64"},{"name":"View a Zone Detail","id":"b9b614c2-dedc-487f-9bd8-539b1a745554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/zones/:id","description":"

This API is used to view a zone detailed information.

ID of the zone which will be viewed.

\n","type":"text/plain"},"type":"any","value":"32787","key":"id"}]}},"response":[],"_postman_id":"b9b614c2-dedc-487f-9bd8-539b1a745554"}],"id":"1f573912-c490-4d42-a276-3bde153502d0","_postman_id":"1f573912-c490-4d42-a276-3bde153502d0","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"SbS: Event Log","item":[{"name":"01 Login","event":[{"listen":"test","script":{"id":"34b8a49c-73e2-49ae-b347-a879c8fce2d5","exec":["//put response's bs-session-id value to collection variable bsid\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","if(pm.response.to.have.status(200)) {\r"," let params = pm.response.headers.get('bs-session-id');\r"," pm.collectionVariables.set(\"bsid\", params);\r","}"],"type":"text/javascript"}}],"id":"a4cbafee-2f27-4110-8ded-dff459c44a23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"login_id\": \"admin\",\r\n \"password\": \"admin1234!\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/login","description":"

In order to view event log through Suprema BioStar 2 API, you will need a Session ID which will be available after you’re logged in.

To log in, make a form encoded server side POST request as shown on example below.

POST /api/login

Host: server_ip|domain_name[:port]

{“User”: {“login_id”: “user_login_id_here”, “password”: “password_here”}}

The parameters are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
login_id	String	Y	Your login ID
password	String	Y	Your password

If successful, you will receive back the following response:

Status: 200 OK\nbs-session-id: c52127fea7f645149083d04d89ad68e5\nContent-Type: application/json;charset=UTF-8\n{\"User\":{\"user_id\":\"1\",\"name\":\"Administrator\",\"gender\":\"1\",\"email\":\"admin111@gmail.com\",\"birthday\":\"1977-10-08T04:00:00.00Z\",\"photo_exists\":\"false\",\"pin_exists\":\"false\",\"login_id\":\"admin\",\"password_exists\":\"true\",\"updated_count\":\"15\",\"last_modified\":\"946\",\"idx_last_modified\":\"263\",\"start_datetime\":\"2001-01-01T00:00:00.00Z\",\"expiry_datetime\":\"2030-12-31T23:59:00.00Z\",\"security_level\":\"0\",\"display_duration\":\"20\",\"display_count\":\"3\",\"permission\":{\"id\":\"1\",\"name\":\"Administrator\",\"description\":\"this is a permission for Administrator\",\"filter\":{\"UserGroup\":[\"1\"],\"DeviceGroup\":[\"1\"],\"DoorGroup\":[\"1\"],\"ElevatorGroup\":[\"1\"],\"ZoneType\":[\"-1\"],\"AccessGroup\":[\"0\"],\"GraphicMapGroup\":[\"1\"]},\"module\":{\"Dashboard\":{\"read\":\"true\",\"write\":\"true\"},\"User\":{\"read\":\"true\",\"write\":\"true\"},\"Device\":{\"read\":\"true\",\"write\":\"true\"},\"Door\":{\"read\":\"true\",\"write\":\"true\"},\"Elevator\":{\"read\":\"true\",\"write\":\"true\"},\"Zone\":{\"read\":\"true\",\"write\":\"true\"},\"AccessControl\":{\"read\":\"true\",\"write\":\"true\"},\"Monitoring\":{\"read\":\"true\",\"write\":\"true\"},\"TA\":{\"read\":\"true\",\"write\":\"true\"},\"Setting\":{\"read\":\"true\",\"write\":\"true\"},\"Video\":{\"read\":\"true\",\"write\":\"true\"},\"Visitor\":{\"read\":\"true\",\"write\":\"true\"}},\"device\":{\"id\":\"542071155\",\"id\":\"543720368\",\"id\":\"939257394\"},\"user\":{\"id\":\"1\",\"id\":\"2\",\"id\":\"3\",\"id\":\"4\",\"id\":\"5\",\"id\":\"6\",\"id\":\"7\",\"id\":\"20\",\"id\":\"21\",\"id\":\"22\",\"id\":\"23\",\"id\":\"24\",\"id\":\"25\",\"id\":\"26\",\"id\":\"27\",\"id\":\"28\",\"id\":\"29\",\"id\":\"30\",\"id\":\"31\",\"id\":\"32\",\"id\":\"33\"}},\"inherited\":\"false\",\"user_group_id\":{\"id\":\"1\",\"name\":\"All Users\"},\"disabled\":\"false\",\"expired\":\"false\",\"department\":\"department 12\",\"user_title\":\"title\",\"idx_user_id\":\"1001\",\"idx_user_id_num\":\"1001\",\"idx_name\":\"2001\",\"idx_phone\":\"1001\",\"idx_email\":\"5001\",\"fingerprint_template_count\":\"0\",\"face_count\":\"0\",\"card_count\":\"0\",\"access_groups\":[{\"id\":\"1\",\"name\":\"Meeting Room 1 AG\"},{\"id\":\"2\",\"name\":\"Meeting Room 2 AG\"},{\"id\":\"22\",\"name\":\"Building Access\"}],\"user_custom_fields\":[{\"user_id\":{\"user_id\":\"1\",\"name\":\"Administrator\"},\"custom_field\":{\"id\":\"1\",\"name\":\"Test\",\"type\":\"0\",\"order\":\"1\"}},{\"user_id\":{\"user_id\":\"1\",\"name\":\"Administrator\"},\"custom_field\":{\"id\":\"2\",\"name\":\"33\",\"type\":\"0\",\"order\":\"2\"}}],\"need_to_update_pw\":\"false\"},\"Response\":{\"code\":\"0\",\"link\":\"https:\\/\\/support.supremainc.com\\/en\\/support\\/home\",\"message\":\"Success\"}}\n\n

There will be a key called bs-session-id, which is a consecutive strings of hex digits located on the header of the response:
bs-session-id: 643f64efb7114485a2fd89de17ca13fb

This value will be used as authorization of the APIs that will be called. To apply this value, put it on the header of the API that will be called with key name bs-session-id.

\n","urlObject":{"path":["api","login"],"host":["https://127.0.0.1"],"query":[],"variable":[]}},"response":[],"_postman_id":"a4cbafee-2f27-4110-8ded-dff459c44a23"},{"name":"02 Search Events","id":"7d5c2354-1d5a-42bb-9a73-b76051e3935e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Query\": {\r\n \"limit\": 20,\r\n \"conditions\": [\r\n {\r\n \"column\": \"datetime\",\r\n \"operator\": 3,\r\n \"values\": [\r\n \"2022-03-10T15:00:00.000Z\",\r\n \"2022-03-31T16:59:59.000Z\"\r\n ]\r\n },\r\n {\r\n \"column\": \"device_id\",\r\n \"operator\": 1,\r\n \"values\": [\r\n \"543308153\"\r\n ]\r\n },\r\n {\r\n \"column\": \"id\",\r\n \"operator\": 0,\r\n \"values\": [\r\n \"394\"\r\n ]\r\n }\r\n ],\r\n \"orders\": [\r\n {\r\n \"column\": \"datetime\",\r\n \"descending\": false\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/events/search","description":"

After logging in, you can use this API to view event log(s).

BODY parameters on this API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
limit	Number	N	Limit the response records by the value stated on this parameter
conditions:column	String		Field which the conditions will be based from
conditions:operator	Number		Condition Operator EQUAL : 0, NOT_EQUAL : 1, CONTAINS : 2, BETWEEN : 3, LIKE : 4, GREATER : 5, LESS : 6
conditions:values	Datetime		Value of the conditions
orders:column	String		Field which the sorting will be based on
orders:descending	Boolean		Toggle true to set the sorting as descending

There are two main components on this API: conditions and orders.

On conditions, you can put multiple criteria to filter the API response according to your need.

While on orders, it is used to sort the response according to specified parameter, either ascending or descending.

On this example, there are three criteria on the conditions component:

First criteria filter the response according to datetime parameter (column: datetime) with date range between (operator: 3) value specified on values: [].
Second criteria filter the response to show event log where the device id (column: device_id) is not (operator: 1) as specified (values []).
Third criteria filter the response to show event logs which have the specified value (values []) as its id (column:id, operator: 0).
The relation between multiple criteria on a single API call is AND.

For the orders component on this example, it will sort the response according to parameter datetime (column: datetime) ascending (descending: false).

Do note that the datetime that is shown on the response is based on UTC-0, so if you want to view event log from a device which use UTC+8, then you need to convert the datetime from UTC+8 to UTC-0 and use the conversion result as criteria value on the conditions.

Example:

Device: UTC+8. Event log occurred when datetime on the device is 2022-06-02 01:37
Convert the datetime to UTC-0 : 2022-06-01 17:37
Use this converted value as criteria value on the condition

This example shows how to view event log from device with id: 543308153 (device timezone set as UTC+8) and log with datetime between 2022-06-01 00:05 to 2022-06-30 23:58.

Note that the datetime used on the API criteria is different from what the user would like to see. This is because the device was set to use UTC+8, so to view the correct log, use datetime which have been converted to UTC-0.

This API is used for listing event types recorded on BioStar 2 database.

\n","type":"text/plain"},"key":"is_break_glass","value":"false"},{"description":{"content":"

Toggle true to list events which will trigger alert. Marked by 'alertable' parameter on the event. 'enable_alert' is used for marking which event will show a pop up notice on Bio Star 2.

\n","type":"text/plain"},"key":"setting_alert","value":"false"},{"description":{"content":"

Toggle true to list all events recorded on database.

\n","type":"text/plain"},"key":"setting_all","value":"true"}],"variable":[]}},"response":[],"_postman_id":"857517e3-5903-4779-a83c-15f6623266b8"}],"id":"141cd36d-b0a5-4714-a009-1c4dd650346e","_postman_id":"141cd36d-b0a5-4714-a009-1c4dd650346e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"bs-session-id"},{"key":"value","value":"---"}]},"isInherited":true,"source":{"_postman_id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","id":"7dba1759-9dd3-4185-8d65-8e3c91373f22","name":"BioStar 2 API","type":"collection"}}},{"name":"SbS: Create User","item":[{"name":"01 Login","event":[{"listen":"test","script":{"id":"34b8a49c-73e2-49ae-b347-a879c8fce2d5","exec":["//put response's bs-session-id value to collection variable bsid\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","if(pm.response.to.have.status(200)) {\r"," let params = pm.response.headers.get('bs-session-id');\r"," pm.collectionVariables.set(\"bsid\", params);\r","}"],"type":"text/javascript"}}],"id":"d7a75454-12ca-4233-8c05-e0290714d0bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"User\": {\r\n \"login_id\": \"admin\",\r\n \"password\": \"admin1234!\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/login","description":"

In order to create User through Suprema BioStar 2 API, you will need a Session ID which will be available after you’re logged in.

To log in, make a form encoded server side POST request as shown on example below.

POST /api/login

Host: server_ip|domain_name[:port]

{“User”: {“login_id”: “user_login_id_here”, “password”: “password_here”}}

The parameters are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
login_id	String	Y	Your login ID
password	String	Y	Your password

If successful, you will receive back the following response:

Status: 200 OK\nbs-session-id: c52127fea7f645149083d04d89ad68e5\nContent-Type: application/json;charset=UTF-8\n{\"User\":{\"user_id\":\"1\",\"name\":\"Administrator\",\"gender\":\"1\",\"email\":\"admin111@gmail.com\",\"birthday\":\"1977-10-08T04:00:00.00Z\",\"photo_exists\":\"false\",\"pin_exists\":\"false\",\"login_id\":\"admin\",\"password_exists\":\"true\",\"updated_count\":\"15\",\"last_modified\":\"946\",\"idx_last_modified\":\"263\",\"start_datetime\":\"2001-01-01T00:00:00.00Z\",\"expiry_datetime\":\"2030-12-31T23:59:00.00Z\",\"security_level\":\"0\",\"display_duration\":\"20\",\"display_count\":\"3\",\"permission\":{\"id\":\"1\",\"name\":\"Administrator\",\"description\":\"this is a permission for Administrator\",\"filter\":{\"UserGroup\":[\"1\"],\"DeviceGroup\":[\"1\"],\"DoorGroup\":[\"1\"],\"ElevatorGroup\":[\"1\"],\"ZoneType\":[\"-1\"],\"AccessGroup\":[\"0\"],\"GraphicMapGroup\":[\"1\"]},\"module\":{\"Dashboard\":{\"read\":\"true\",\"write\":\"true\"},\"User\":{\"read\":\"true\",\"write\":\"true\"},\"Device\":{\"read\":\"true\",\"write\":\"true\"},\"Door\":{\"read\":\"true\",\"write\":\"true\"},\"Elevator\":{\"read\":\"true\",\"write\":\"true\"},\"Zone\":{\"read\":\"true\",\"write\":\"true\"},\"AccessControl\":{\"read\":\"true\",\"write\":\"true\"},\"Monitoring\":{\"read\":\"true\",\"write\":\"true\"},\"TA\":{\"read\":\"true\",\"write\":\"true\"},\"Setting\":{\"read\":\"true\",\"write\":\"true\"},\"Video\":{\"read\":\"true\",\"write\":\"true\"},\"Visitor\":{\"read\":\"true\",\"write\":\"true\"}},\"device\":{\"id\":\"542071155\",\"id\":\"543720368\",\"id\":\"939257394\"},\"user\":{\"id\":\"1\",\"id\":\"2\",\"id\":\"3\",\"id\":\"4\",\"id\":\"5\",\"id\":\"6\",\"id\":\"7\",\"id\":\"20\",\"id\":\"21\",\"id\":\"22\",\"id\":\"23\",\"id\":\"24\",\"id\":\"25\",\"id\":\"26\",\"id\":\"27\",\"id\":\"28\",\"id\":\"29\",\"id\":\"30\",\"id\":\"31\",\"id\":\"32\",\"id\":\"33\"}},\"inherited\":\"false\",\"user_group_id\":{\"id\":\"1\",\"name\":\"All Users\"},\"disabled\":\"false\",\"expired\":\"false\",\"department\":\"department 12\",\"user_title\":\"title\",\"idx_user_id\":\"1001\",\"idx_user_id_num\":\"1001\",\"idx_name\":\"2001\",\"idx_phone\":\"1001\",\"idx_email\":\"5001\",\"fingerprint_template_count\":\"0\",\"face_count\":\"0\",\"card_count\":\"0\",\"access_groups\":[{\"id\":\"1\",\"name\":\"Meeting Room 1 AG\"},{\"id\":\"2\",\"name\":\"Meeting Room 2 AG\"},{\"id\":\"22\",\"name\":\"Building Access\"}],\"user_custom_fields\":[{\"user_id\":{\"user_id\":\"1\",\"name\":\"Administrator\"},\"custom_field\":{\"id\":\"1\",\"name\":\"Test\",\"type\":\"0\",\"order\":\"1\"}},{\"user_id\":{\"user_id\":\"1\",\"name\":\"Administrator\"},\"custom_field\":{\"id\":\"2\",\"name\":\"33\",\"type\":\"0\",\"order\":\"2\"}}],\"need_to_update_pw\":\"false\"},\"Response\":{\"code\":\"0\",\"link\":\"https:\\/\\/support.supremainc.com\\/en\\/support\\/home\",\"message\":\"Success\"}}\n\n

There will be a key called bs-session-id, which is a consecutive strings of hex digits located on the header of the response:
bs-session-id: 643f64efb7114485a2fd89de17ca13fb

This value will be used as authorization of the APIs that will be called. To apply this value, put it on the header of the API that will be called with key name bs-session-id.

\n","urlObject":{"path":["api","login"],"host":["https://127.0.0.1"],"query":[],"variable":[]}},"response":[],"_postman_id":"d7a75454-12ca-4233-8c05-e0290714d0bf"},{"name":"02 View BioStar Settings","id":"a3f437f2-85c2-4514-8512-c21986dfd036","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/setting/biostar","description":"

After logged in, use this API to view the User ID setting of the BioStar 2, is it AlphaNumeric or Number.

It can be seen on parameter use_alphanumeric, if the value is false then the current setting for User ID is Number, else it's AlphaNumeric.

After User ID setting of BioStar 2 is confirmed, use this API to get the next user_id for new user.

This API will only shows next available ID in number format.

Keep this ID for input on user_id parameter when creating new user.

Next step on creating a new user it to enroll the credential that the user will be using. Either it's Card, Face, Visual Face or Fingerprint.

This API is used to enroll card credential using the specified device.

Keep the card_id value on the response which shows after running this API to apply it to the user which will be created.

To view device(s) with capability to enroll a card, use View Device(s) Based on Enrollment Type API.

ID of the device which will be used for enrollment

\n","type":"text/plain"},"type":"any","value":"543720368","key":"id"}]}},"response":[],"_postman_id":"68545352-8f31-4eef-98af-c725400c2d71"},{"name":"04b Enroll Face Credential","id":"8c3d54fa-2081-4e7a-aeff-a0eafcd32e26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://127.0.0.1/api/devices/:id/credentials/face?pose_sensitivity=4","description":"

Use this API to enroll face credential from a device.

Set the pose_sensitivity to 0 if you're doing a Visual Face scan.

Keep the response of this API after running to apply it to the user which will be created.

To view device(s) with capability to enroll Face/Visual Face, use View Device(s) Based on Enrollment Type API.

Set the sensitivity for the position, angle, and distance of a face when registering the face. Set the sensitivity high if you wish to obtain a detailed face template. 0-9

\n","type":"text/plain"},"key":"pose_sensitivity","value":"4"}],"variable":[{"id":"cca198be-6257-43ae-8227-869aeec5e345","description":{"content":"

ID of the device which will be used to enroll

\n","type":"text/plain"},"type":"any","value":"543408590","key":"id"}]}},"response":[],"_postman_id":"8c3d54fa-2081-4e7a-aeff-a0eafcd32e26"},{"name":"04c Enroll Fingerprint","id":"06d56942-1eac-41ec-b8f3-f2161af086bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ScanFingerprintOption\": {\r\n \"enroll_quality\": \"80\",\r\n \"raw_image\": false\r\n },\r\n \"noblockui\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://127.0.0.1/api/devices/:dev_id/scan_fingerprint","description":"

Use this API to scan a fingerprint.

On calling this API, it is required to specify the device which will be used as fingerprint scanner. It is done by specifying Device ID on the API Path, which marked by :dev_id.

The procedure to add a fingerprint as follows:
- Scan a finger using this API
- Use POST /api/server_matching/identify_finger to check if it's already exist
- If it's not exist, then run a second scan using this API for the same finger
- Compare 1st and 2nd scan result using POST /api/devices/:dev_id/verify_fingerprint to make sure that 1st and 2nd scan are the same finger
- After running Verify Fingerprint Scan, keep the value of template 0 and 1 to assign the enrolled finger to a user using POST|PUT /api/users/:id

BODY parameters on this API as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
ScanFingerprintOption
:enroll_quality	Number	Y	Set a fingerprint enrollment quality level. Any fingerprint which does not meet the quality requirement will not be enrolled.
:raw_image	Boolean	Y	Set this option to view the original image when a fingerprint is scanned.
noblockui	Boolean	Y

After preparing available user_id and credential(s), use this API to create a new user using the basic configuration.

For applying configuration beyond this, such as credential(s) or custom fields, refer to the subsequent example.

The BODY parameters are:

Parameters	Type	Required	Description
user_id	String	Y	ID of the User. Unique. When User ID Type in Setting > Server is set to Number, a number between 1 and 4294967295 can be entered. When Alphanumeric is set, a combination of alphabetic characters and numbers can be entered. Do not use spaces when entering ID. Numbers or Alphanumeric characters can be set for user_id. For more details, refer to Setting Section of this documentation.
name	String	N	Name of the user. Up to 48 characters.
user_group_id	Number	Y	ID of the User Group that the user will be under. Refer to User Group Section of this documentation for listing available User Groups.
disabled	Boolean	N	Toggle User active or not; false for active, true for non-active.
start_datetime	Date/Time	Y	Start active period for the User.
expiry_datetime	Date/Time	Y	End active period for the User.
email	String	N	Email address of the User.
department	String	N	Department of the User. Up to 64 characters.
title	String	N	Title of the User.
photo	Base64	N	Photo of the User.
phone	String	N	Phone number of the User.
permission	Number	N	Operator Level of the User. None: The user has no operator privilege. To use this Operator Level, remove permission parameter from the API Request. Administrator: The user can use all menus. User Operator: The user can only use the USER and PREFERENCE menus. Monitoring Operator: The user can use the MONITORING and PREFERENCE menus and only view the DASHBOARD, USER, DEVICE, DOOR, ZONE and ACCESS CONTROL menus. Video Operator: The user can only use the VIDEO menu. T&A Operator: The user can only use the TIME ATTENDANCE menu and only view the USER menu. User: The user can only view own information and T&A records.
access_groups	Number	N	ID of the Access Group that the User will have access. Refer to Access Group Section of this documentation for listing available Access Groups. Can enter more than 1 Access Group.
login_id	String	N	Required when permission parameter is not removed.
password	String	N	Required when permission parameter is not removed.
user_ip	String	N	Limit the access of the User so he/she can only login from the registered IP Address. The user IP can be entered in the format xxx.xxx.xxx.xxx. Each octet can only be entered in numbers between 0 and 255. Users whose user IP is not registered can log in from any IP.
pin	Number	N	PIN of the user. Maximum 32 digit.

Known errors:

name is more than 48 characters
Using single quote on name
Duplicate user_id, email, or login_id
Empty user_id, user_group_id, start_datetime, expiry_datetime
Using user_group_id:id which doesn't exist
Putting \"/\" at the end of the endpoint
Password with 3 or more subsequent letter or number
Start and expiry date difference is more than 30 years

Use GET /api/setting/custom_fields to view available Custom Fields.

There are 3 type of Custom Fields: Text Input, Number Input and Combo Box. Text Input and Combo Box will accept any value, and Number Input will only receive number.

Body parameter for Creating/Updating Custom Field on a User:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
item	String	N	Content of the Custom Field
custom_field:id	Number	Y	ID of the Custom Field

To skip create/update a Custom Field, skip it from the Body.

On this example you can see how to use stated parameters to adjust misc. credential values.

Parameters on this example:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
pin	Number	N	PIN of the User
security_level	Number	N	To set the security level of the credential. The higher the security level is set, the false rejection rate (FRR) gets higher, but the false acceptance rate (FAR) gets lower. Acceptable value: 0 to 5
private_operation_modes
:operation_method	Number		The first credential of an Authentication Mode (0: ID, 1: Card, 2: Fingerprint/Biometric (Standard), 3: Face)
:operation_mode	Number		Authentication Mode combination (see below for reference, \"-1\" = do not use)
:exclude	Boolean		If Include Device Default Authentication Mode option is on, so when you want to also follow the Auth Modes that the devices have, “private_operation_modes” will have same number of elements that you actually configured. But if Exclude Device Default Authentication Mode is on, you need to add four or more elements because all the values of “operation_method” should be included to override device’s Auth Modes.

Authentication Mode Combination Table:

Value	Code	Description	Type
0	BS2_AUTH_MODE_BIOMETRIC_ONLY	Biometric only	Standard
1	BS2_AUTH_MODE_BIOMETRIC_PIN	Biometric + PIN	Standard
2	BS2_AUTH_MODE_CARD_ONLY	Card only	Standard
3	BS2_AUTH_MODE_CARD_BIOMETRIC	Card + Biometric	Standard
4	BS2_AUTH_MODE_CARD_PIN	Card + PIN	Standard
5	BS2_AUTH_MODE_CARD_BIOMETRIC_OR_PIN	Card + Biometric or PIN	Standard
6	BS2_AUTH_MODE_CARD_BIOMETRIC_PIN	Card + Biometric + PIN	Standard
7	BS2_AUTH_MODE_ID_BIOMETRIC	ID + Biometric	Standard
8	BS2_AUTH_MODE_ID_PIN	ID + PIN	Standard
9	BS2_AUTH_MODE_ID_BIOMETRIC_OR_PIN	ID + Biometric or PIN	Standard
10	BS2_AUTH_MODE_ID_BIOMETRIC_PIN	ID + Biometric + PIN	Standard
11	BS2_EXT_AUTH_MODE_FACE_ONLY	Face	Extended
12	BS2_EXT_AUTH_MODE_FACE_FINGERPRINT	Face + Fingerprint	Extended
13	BS2_EXT_AUTH_MODE_FACE_PIN	Face + PIN	Extended
14	BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_OR_PIN	Face + Fingerprint/PIN	Extended
15	BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_PIN	Face + Fingerprint + PIN	Extended
16	BS2_EXT_AUTH_MODE_FINGERPRINT_ONLY	Fingerprint	Extended
17	BS2_EXT_AUTH_MODE_FINGERPRINT_FACE	Fingerprint + Face	Extended
18	BS2_EXT_AUTH_MODE_FINGERPRINT_PIN	Fingerprint + PIN	Extended
19	BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_OR_PIN	Fingerprint + Face/PIN	Extended
20	BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_PIN	Fingerprint + Face + PIN	Extended
21	BS2_EXT_AUTH_MODE_CARD_ONLY	Card	Extended
22	BS2_EXT_AUTH_MODE_CARD_FACE	Cardn + Face	Extended
23	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT	Card + Fingerprint	Extended
24	BS2_EXT_AUTH_MODE_CARD_PIN	Card + PIN	Extended
25	BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT	Card + Face/Fingerprint	Extended
26	BS2_EXT_AUTH_MODE_CARD_FACE_OR_PIN	Card + Face/PIN	Extended
27	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_OR_PIN	Card + Fingerprint/PIN	Extended
28	BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_OR_PIN	Card + Face/Fingerprint/PIN	Extended
29	BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT	Card + Face + Fingerprint	Extended
30	BS2_EXT_AUTH_MODE_CARD_FACE_PIN	Card + Face + PIN	Extended
31	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE	Card + Fingerprint + Face	Extended
32	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_PIN	Card + Fingerprint + PIN	Extended
33	BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_PIN	Card + Face/Fingerprint + PIN	Extended
34	BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT_OR_PIN	Card + Face + Fingerprint/PIN	Extended
35	BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE_OR_PIN	Card + Fingerprint + Face/PIN	Extended
36	BS2_EXT_AUTH_MODE_ID_FACE	ID + Face	Extended
37	BS2_EXT_AUTH_MODE_ID_FINGERPRINT	ID + Fingerprint	Extended
38	BS2_EXT_AUTH_MODE_ID_PIN	ID + PIN	Extended
39	BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT	ID + Face/Fingerprint	Extended
40	BS2_EXT_AUTH_MODE_ID_FACE_OR_PIN	ID + Face/PIN	Extended
41	BS2_EXT_AUTH_MODE_ID_FINGERPRINT_OR_PIN	ID + Fingerprint/PIN	Extended
42	BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT_OR_PIN	ID + Face/Fingerprint/PIN	Extended
43	BS2_EXT_AUTH_MODE_ID_FACE_FINGERPRINT	ID + Face + Fingerprint	Extended
44	BS2_EXT_AUTH_MODE_ID_FACE_PIN	ID + Face + PIN	Extended
45	BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE	ID + Fingerprint + Face	Extended
46	BS2_EXT_AUTH_MODE_ID_FINGERPRINT_PIN	ID + Fingerprint + PIN	Extended
47	BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT_PIN	ID + Face/Fingerprint + PIN	Extended
48	BS2_EXT_AUTH_MODE_ID_FACE_FINGERPRINT_OR_PIN	ID + Face + Fingerprint/PIN	Extended
49	BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE_OR_PIN	ID + Fingerprint + Face/PIN	Extended

This example shows how to assign a card to a User, which is applicable to CSN, Wiegand, Smart, Mobile, and QR/Barcode.

First the card must be enrolled to the database by using POST /api/cards.

After enrolled, use GET /api/cards to view all Cards or GET /api/cards/unassigned to view all Cards which are unassigned.

Select a card from the response and apply it on the body as shown on the example to assign it to the selected user.

This example shows how to add a Face Credential on a User.

You can add the user's faces if the device supports face authentication.

When registering a face, maintain a distance of 40cm to 80cm between the device and the face.
Be careful not to change the facial expression. (smiling face, drawn face, wink, etc.)
If you do not follow the instructions on the screen, the face registration may take longer or may fail.
Be careful not to cover the eyes or eyebrows.
Do not wear hats, masks, sunglasses or eyeglasses.
Be careful not to display two faces on the screen. Register one person at a time.
It is recommended for a user wearing glasses to register both faces with and without glasses.

Parameters on this example:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
faces	Array	Y	Main container of the credential
:raw_image	Raw	Y	Raw image of the face scan
:templates	Array	Y	Container of the face templates
::template	Raw	Y	Face template of the User

To get data for parameter raw_image and template, use GET /api/devices/:device_id/credentials/face

Use POST /api/v2/devices/search to list all device which can support the selected credentials. See API documentation for details on the usage of the API.

When updating a User, it is required to put the credential data as acquired from GET /api/users/:id
This is done so the data won't be lost after update.

To delete a Face, skip the parameters on using this API.

You can use raw_image value as value on photo parameter of a User.

There are two ways to input a Visual Face: by scanning through a enrollment device, or by uploading an image.

Up to 2 visual faces can be added.
Use GET /api/devices/:device_id/credentials/face to scan Visual Face using an enrollment device.

You can enroll a visual face using FaceStation F2.
Use POST /api/v2/devices/search to list compatible devices.

{\n\"User\": {\n \"credentials\": {\n  \"visualFaces\": [{\n   \"template_ex_picture\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/ Truncated\"\n  }]\n }}\n}\n\n

Parameters on this example:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
visualFaces	Array	Y	Main container of Visual Face credential
:template_ex_normalized_image	Base64	Y	Cropped image ready for visual face extraction.
:templates	Array	Y	Container of the templates
::credential_bin_type	Number	Y	UNKNOWN = -1 FACE_TEMPLATE = 0 FACE_TEMPLATE_IMAGE = 1 FACE_RAW_IMAGE = 2 FACE_TEMPLATE_EX_VER2 = 5 (For FaceStation F2) FACE_TEMPLATE_EX_VER_3 = 9 (For BioStation 3 and W3) FACE_TEMPLATE_EX_NORMALIZED = 7 FACE_TEMPLATE_EX_PICTURE = 8
::template_ex	Raw	Y	Visual Face template data which includes FaceStation F2 and the new BioStation 3.
:template_ex_picture	Base64	Y	Parameter for Upload Picture raw data

This example shows how to update fingerprint data on a User.

The BODY parameters as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
fingerprint_templates
:finger_mask	Boolean	N	Set to True to mark the fingerprint as a duress fingerprint. When threatened by someone to open the door, the user can authenticate using this fingerprint to send an alarm signal to BioStar 2.
:template0	Raw	Y	First scan template of the fingerprint
:template1	Raw	Y	Second scan template of the fingerprint
:isNew	Boolean	N

Use POST /api/devices/:dev_id/scan_fingerprint to enroll fingerprint
Use POST /api/server_matching/identify_finger to check whether the fingerprint already recorded or not.

Raw data for template0 and template1 available after enrolling a fingerprint.
Fingerprint(s) used for regular access should not be registered as duress fingerprint.
If the fingerprint authentication rate is low, delete the existing fingerprint information and add a new fingerprint.
Use an adequate security level. If 1:1 Security Level is too high, the fingerprint authentication rate may be too low or the false rejection rate (FRR) may be too high.
For best fingerprint scanning quality, make sure to cover the entire surface of the fingerprint sensor with the finger.