{ "item": [ { "id": "56cd444d-960e-4e7d-8604-68745c63fc9b", "name": "Authorization", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f981e3e4-3770-42be-b12d-e57fad16e199", "name": "Login", "request": { "name": "Login", "description": { "content": "In order to create User through Suprema BioStar X API, you will need a Session ID which will be available after you’re logged in.\n\nTo log in, make a form encoded server side POST request as shown on example right.\nThere will be a key called bs-session-id, which is a consecutive strings of hex digits located on the header of the response: \n\n`bs-session-id: 643f64efb7114485a2fd89de17ca13fb`\n\nThis 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`.", "type": "text/plain" }, "url": { "path": [ "api", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"User\": {\n \"login_id\": \"\",\n \"password\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b94d6329-f508-4243-9a84-e563c0d02572", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"User\": {\n \"login_id\": \"admin\",\n \"password\": \"admin\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Session ID for authenticating subsequent API requests", "key": "bs-session-id", "value": "c52127fea7f645149083d04d89ad68e5" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\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 \"d_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 {\n \"id\": \"542071155\"\n },\n {\n \"id\": \"543720368\"\n },\n {\n \"id\": \"939257394\"\n }\n ],\n \"user\": [\n {\n \"id\": \"1\"\n },\n {\n \"id\": \"2\"\n },\n {\n \"id\": \"3\"\n },\n {\n \"id\": \"4\"\n },\n {\n \"id\": \"5\"\n },\n {\n \"id\": \"6\"\n },\n {\n \"id\": \"7\"\n },\n {\n \"id\": \"20\"\n },\n {\n \"id\": \"21\"\n },\n {\n \"id\": \"22\"\n },\n {\n \"id\": \"23\"\n },\n {\n \"id\": \"24\"\n },\n {\n \"id\": \"25\"\n },\n {\n \"id\": \"26\"\n },\n {\n \"id\": \"27\"\n },\n {\n \"id\": \"28\"\n },\n {\n \"id\": \"29\"\n },\n {\n \"id\": \"30\"\n },\n {\n \"id\": \"31\"\n },\n {\n \"id\": \"32\"\n },\n {\n \"id\": \"33\"\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 \"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__pw\": \"false\"\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bc0326f-ef6b-403d-8978-44423b4c1129", "name": "Logout", "request": { "name": "Logout", "description": { "content": "This API is used to Logout from the current session. There are no body parameter on this endpoint.\nIt is required to have `bs-session-id` key on the header, the value generated on successful login.\n**Known errors:**\n- Placing \"/\" at the end of the endpoint", "type": "text/plain" }, "url": { "path": [ "api", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "8f26260d-79bb-4cce-8982-26767e98a7c7", "name": "OK", "originalRequest": { "url": { "path": [ "api", "logout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Status", "value": "200 OK", "description": "" }, { "disabled": false, "key": "X-Content-Type-Options", "value": "nosniff", "description": "" }, { "disabled": false, "key": "X-XSS-Protection", "value": "1", "description": "" }, { "disabled": false, "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate", "description": "" }, { "disabled": false, "key": "Pragma", "value": "no-cache", "description": "" }, { "disabled": false, "key": "Expires", "value": "0", "description": "" }, { "disabled": false, "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "107", "description": "" }, { "disabled": false, "key": "Date", "value": "Tue, 21 Jan 2025 07:59:20 GMT", "description": "" }, { "disabled": false, "key": "Keep-Alive", "value": "timeout=5", "description": "" }, { "disabled": false, "key": "Connection", "value": "keep-alive", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ba4f71c9-5456-4359-ad91-f565df056ef6", "name": "Access Group", "description": { "content": "This section contains all API related to Access Group (AG)", "type": "text/plain" }, "item": [ { "id": "5641a205-79d5-47c1-aee1-02a6f8be5d7d", "name": "Create New Access Group", "request": { "name": "Create New Access Group", "description": { "content": "This request is used to make a new Access Group (AG).\n\n**Note:** If BioStar X does not have license for Elevator module, skip the floor_levels parameter or set it to an empty string.\n\n**Known errors:**\n- Placing \"/\" at the end of the endpoint - `name` is a required and unique parameter", "type": "text/plain" }, "url": { "path": [ "api", "access_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccessGroup\": {\n \"name\": \"\",\n \"description\": \"\",\n \"users\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ],\n \"user_groups\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"access_levels\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"floor_levels\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "59084306-bc53-4299-8a77-ee31e1eb2c26", "name": "OK", "originalRequest": { "url": { "path": [ "api", "access_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccessGroup\": {\n \"name\": \"ac_grp2\",\n \"description\": \"\",\n \"users\": [\n {\n \"user_id\": 1\n }\n ],\n \"user_groups\": [\n {\n \"id\": 1\n }\n ],\n \"access_levels\": [\n {\n \"id\": 2\n }\n ],\n \"floor_levels\": [\n {\n \"id\": \"32769\",\n \"name\": \"floor_test\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Status", "value": "200 OK", "description": "" }, { "disabled": false, "key": "X-Content-Type-Options", "value": "nosniff", "description": "" }, { "disabled": false, "key": "X-XSS-Protection", "value": "1", "description": "" }, { "disabled": false, "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate", "description": "" }, { "disabled": false, "key": "Pragma", "value": "no-cache", "description": "" }, { "disabled": false, "key": "Expires", "value": "0", "description": "" }, { "disabled": false, "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "1644", "description": "" }, { "disabled": false, "key": "Date", "value": "Mon, 17 Feb 2025 07:52:34 GMT", "description": "" }, { "disabled": false, "key": "Keep-Alive", "value": "timeout=5", "description": "" }, { "disabled": false, "key": "Connection", "value": "keep-alive", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccessGroup\": {\n \"id\": \"14\",\n \"name\": \"Test1\"\n },\n \"DeviceResponse\": {\n \"rows\": [\n {\n \"id\": \"40059001\",\n \"code\": \"0\"\n },\n {\n \"id\": \"40059002\",\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa41002c-1771-4100-8d1b-89f4a19abd7a", "name": "List All Access Group", "request": { "name": "List All Access Group", "description": { "content": "This API is used to view all available Access Groups.\n\nBy default the result will be sorted ascending by `id`.", "type": "text/plain" }, "url": { "path": [ "api", "access_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "54e2c2f4-5b9a-4c3f-8b3c-1d83812ceb8e", "name": "OK", "originalRequest": { "url": { "path": [ "api", "access_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Status", "value": "200 OK", "description": "" }, { "disabled": false, "key": "Set-Cookie", "value": "JSESSIONID=BEDFE7BF63ADDBD1A0B5B4E36C9F50D7; Path=/; Secure; HttpOnly", "description": "" }, { "disabled": false, "key": "X-Content-Type-Options", "value": "nosniff", "description": "" }, { "disabled": false, "key": "X-XSS-Protection", "value": "1", "description": "" }, { "disabled": false, "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate", "description": "" }, { "disabled": false, "key": "Pragma", "value": "no-cache", "description": "" }, { "disabled": false, "key": "Expires", "value": "0", "description": "" }, { "disabled": false, "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "4149", "description": "" }, { "disabled": false, "key": "Date", "value": "Mon, 17 Feb 2025 07:34:09 GMT", "description": "" }, { "disabled": false, "key": "Keep-Alive", "value": "timeout=5", "description": "" }, { "disabled": false, "key": "Connection", "value": "keep-alive", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccessGroupCollection\": {\n \"total\": \"3\",\n \"rows\": [\n {\n \"id\": \"1\",\n \"name\": \"Adminstrative\",\n \"description\": \"Administrative access group\",\n \"users\": [\n {\n \"name\": \"RB\",\n \"user_id\": \"2\"\n },\n {\n \"name\": \"AM\",\n \"user_id\": \"3\"\n }\n ],\n \"user_count\": \"2\",\n \"user_groups\": [\n {\n \"id\": \"1005\",\n \"name\": \"Administrative\",\n \"description\": \"Administrative user group\",\n \"parent_id\": {\n \"id\": \"1\",\n \"name\": \"All Users\"\n },\n \"depth\": \"1\",\n \"inherited\": \"true\",\n \"face_count\": \"0\",\n \"user_count\": \"241\"\n }\n ],\n \"access_levels\": [\n {\n \"id\": \"1\",\n \"name\": \"Administrative Employee\",\n \"description\": \"Access level for Administrative Employee\"\n }\n ]\n },\n {\n \"id\": \"2\",\n \"name\": \"Executive\",\n \"description\": \"Executive access group\",\n \"users\": [\n {\n \"name\": \"Sib Steketee\",\n \"user_id\": \"60014\"\n }\n ],\n \"user_count\": \"1\",\n \"user_groups\": [\n {\n \"id\": \"1004\",\n \"name\": \"Executive\",\n \"description\": \"Executive user group\",\n \"parent_id\": {\n \"id\": \"1\",\n \"name\": \"All Users\"\n },\n \"depth\": \"1\",\n \"inherited\": \"true\",\n \"face_count\": \"0\",\n \"user_count\": \"15\"\n }\n ],\n \"access_levels\": [\n {\n \"id\": \"2\",\n \"name\": \"Executive\",\n \"description\": \"Access level for Executive\"\n }\n ]\n },\n {\n \"id\": \"3\",\n \"name\": \"Test1\",\n \"description\": \"Test access group with floor levels\",\n \"user_count\": \"0\",\n \"user_groups\": [\n {\n \"id\": \"1005\",\n \"name\": \"Administrative\",\n \"description\": \"Administrative user group\",\n \"parent_id\": {\n \"id\": \"1\",\n \"name\": \"All Users\"\n },\n \"depth\": \"1\",\n \"inherited\": \"true\",\n \"face_count\": \"0\",\n \"user_count\": \"241\"\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\": \"First floor\"\n }\n ]\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f9dd2f8-d4ca-4ffe-8f4b-f46bf4e53173", "name": "Delete an Access Group", "request": { "name": "Delete an Access Group", "description": { "content": "Delete an Access Group specified by the **id** query parameter.\n\n**Note:** The id parameter is required and must be a valid access group ID.\n\nTo get an Access Group's id, you can use `GET /api/access_groups` to view all available Access Groups.\n\n**Known errors:**\n- Using id which doesn't exist - Using value other than number", "type": "text/plain" }, "url": { "path": [ "api", "access_groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "(Required) ID of the Access Group to be deleted" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "0ae7c55b-ffd5-49b8-94f4-67b14c1b5224", "name": "OK", "originalRequest": { "url": { "path": [ "api", "access_groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "12" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Status", "value": "200 OK", "description": "" }, { "disabled": false, "key": "X-Content-Type-Options", "value": "nosniff", "description": "" }, { "disabled": false, "key": "X-XSS-Protection", "value": "1", "description": "" }, { "disabled": false, "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate", "description": "" }, { "disabled": false, "key": "Pragma", "value": "no-cache", "description": "" }, { "disabled": false, "key": "Expires", "value": "0", "description": "" }, { "disabled": false, "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "107", "description": "" }, { "disabled": false, "key": "Date", "value": "Mon, 17 Feb 2025 07:24:47 GMT", "description": "" }, { "disabled": false, "key": "Keep-Alive", "value": "timeout=5", "description": "" }, { "disabled": false, "key": "Connection", "value": "keep-alive", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "966ad84c-8d72-4623-80e7-fa0ffc933edb", "name": "List All Access Group v2", "request": { "name": "List All Access Group v2", "description": { "content": "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.\n\n**Known errors:**\n- 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\n**Changes:**\n- v2.9.9:\n\n Trailing slashes (/) at the end of this endpoint are no longer supported.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "access_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"limit\": \"\",\n \"order_by\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31fe9634-2c12-4f7b-884f-e130106565e9", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "access_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 0,\n \"order_by\": \"id:false\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "X-Content-Type-Options", "value": "nosniff", "description": "" }, { "disabled": false, "key": "X-XSS-Protection", "value": "1", "description": "" }, { "disabled": false, "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate", "description": "" }, { "disabled": false, "key": "Pragma", "value": "no-cache", "description": "" }, { "disabled": false, "key": "Expires", "value": "0", "description": "" }, { "disabled": false, "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Transfer-Encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "Date", "value": "Mon, 17 Feb 2025 07:34:24 GMT", "description": "" }, { "disabled": false, "key": "Keep-Alive", "value": "timeout=5", "description": "" }, { "disabled": false, "key": "Connection", "value": "keep-alive", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccessGroupCollection\": {\n \"total\": 3,\n \"rows\": [\n {\n \"id\": 1,\n \"name\": \"Administrative\",\n \"users\": [\n {\n \"user_id\": \"2\",\n \"name\": \"RB\"\n },\n {\n \"user_id\": \"3\",\n \"name\": \"AM\"\n }\n ],\n \"user_groups\": [\n {\n \"id\": 1005,\n \"name\": \"Administrative\"\n }\n ],\n \"access_levels\": [\n {\n \"id\": 1,\n \"name\": \"Administrative Employee\"\n }\n ],\n \"floor_levels\": []\n },\n {\n \"id\": 2,\n \"name\": \"Executive\",\n \"users\": [\n {\n \"user_id\": \"60014\",\n \"name\": \"Sib Steketee\"\n }\n ],\n \"user_groups\": [\n {\n \"id\": 1004,\n \"name\": \"Executive\"\n }\n ],\n \"access_levels\": [\n {\n \"id\": 2,\n \"name\": \"Executive\"\n }\n ],\n \"floor_levels\": []\n },\n {\n \"id\": 12,\n \"name\": \"Test1\",\n \"users\": [],\n \"user_groups\": [\n {\n \"id\": 1005,\n \"name\": \"Administrative\"\n }\n ],\n \"access_levels\": [\n {\n \"id\": 3,\n \"name\": \"All Access\"\n }\n ],\n \"floor_levels\": [\n {\n \"id\": 32769,\n \"name\": \"FL1\"\n }\n ]\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62b48b47-48bc-4ce0-9375-f45ce830199d", "name": "View an Access Group", "request": { "name": "View an Access Group", "description": { "content": "To view an Access Group with id {id} or :id {id} or :id are markers for replacing with the required value.\n\n**Known errors:**\n- Using id which doesn't exist\n- Using value other than number\n- Placing \"/\" at the end of the endpoint", "type": "text/plain" }, "url": { "path": [ "api", "access_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Access Group to retrieve" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6819f163-2fef-40c6-902f-39a1b99c3158", "name": "OK", "originalRequest": { "url": { "path": [ "api", "access_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Access Group to retrieve" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Status", "value": "200 OK", "description": "" }, { "disabled": false, "key": "X-Content-Type-Options", "value": "nosniff", "description": "" }, { "disabled": false, "key": "X-XSS-Protection", "value": "1", "description": "" }, { "disabled": false, "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate", "description": "" }, { "disabled": false, "key": "Pragma", "value": "no-cache", "description": "" }, { "disabled": false, "key": "Expires", "value": "0", "description": "" }, { "disabled": false, "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "584", "description": "" }, { "disabled": false, "key": "Date", "value": "Mon, 17 Feb 2025 07:44:02 GMT", "description": "" }, { "disabled": false, "key": "Keep-Alive", "value": "timeout=5", "description": "" }, { "disabled": false, "key": "Connection", "value": "keep-alive", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"AccessGroup\": {\n \"id\": \"1\",\n \"name\": \"Administrative\",\n \"description\": \"Administrative access group\",\n \"users\": [\n {\n \"name\": \"RB\",\n \"user_id\": \"2\"\n },\n {\n \"name\": \"AM\",\n \"user_id\": \"3\"\n }\n ],\n \"user_count\": \"2\",\n \"user_groups\": [\n {\n \"id\": \"1005\",\n \"name\": \"Administrative\",\n \"description\": \"Administrative user group\",\n \"parent_id\": {\n \"id\": \"1\",\n \"name\": \"All Users\"\n },\n \"depth\": \"1\",\n \"inherited\": \"true\",\n \"face_count\": \"0\",\n \"user_count\": \"241\"\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "098ba9e4-b404-4909-9f98-7098b9ffb2fd", "name": "Update an Access Group", "request": { "name": "Update an Access Group", "description": { "content": "Update an existing Access Group by replacing it with new data.\n\n**Notes:**\n- To add/delete multiple, repeat the braces (see users example)\n \n- When you add/update data, it will remove any previous data and add the one that you input. \n \n Ex: If parameter description have value, and on update this parameter value is left empty, then the previous value will be removed.\n \n- To skip a record from updating, either skip the parameter or fill the current data on the update field.\n \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\n**Known Errors:**\n- Repeating the same value on parameter with multiple options", "type": "text/plain" }, "url": { "path": [ "api", "access_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Access Group which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccessGroup\": {\n \"name\": \"\",\n \"description\": \"\",\n \"users\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ],\n \"user_groups\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"access_levels\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"floor_levels\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"new_users\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ],\n \"delete_users\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1aeabc7d-854e-46d4-ad35-87b9120b7b30", "name": "OK", "originalRequest": { "url": { "path": [ "api", "access_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Access Group which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"AccessGroup\": {\n \"name\": \"Meeting Room Name\",\n \"description\": \"MR Description\",\n \"access_levels\": [\n {\n \"id\": 1\n }\n ],\n \"user_groups\": [\n {\n \"id\": 1\n }\n ],\n \"users\": [\n {\n \"user_id\": 17\n },\n {\n \"user_id\": 9932\n },\n {\n \"user_id\": 2\n }\n ],\n \"new_users\": [\n {\n \"user_id\": 1\n }\n ],\n \"delete_users\": [\n {\n \"user_id\": 17\n },\n {\n \"user_id\": 9932\n },\n {\n \"user_id\": 2\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Status", "value": "200 OK", "description": "" }, { "disabled": false, "key": "Set-Cookie", "value": "JSESSIONID=2FFEDBAE36C395555DECAFA23AA6205D; Path=/; Secure; HttpOnly", "description": "" }, { "disabled": false, "key": "X-Content-Type-Options", "value": "nosniff", "description": "" }, { "disabled": false, "key": "X-XSS-Protection", "value": "1", "description": "" }, { "disabled": false, "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate", "description": "" }, { "disabled": false, "key": "Pragma", "value": "no-cache", "description": "" }, { "disabled": false, "key": "Expires", "value": "0", "description": "" }, { "disabled": false, "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "107", "description": "" }, { "disabled": false, "key": "Date", "value": "Tue, 04 Feb 2025 08:02:39 GMT", "description": "" }, { "disabled": false, "key": "Keep-Alive", "value": "timeout=5", "description": "" }, { "disabled": false, "key": "Connection", "value": "keep-alive", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11133786-30e7-46b4-a05d-f4ea32feee3f", "name": "View List of Users from an Access Group", "request": { "name": "View List of Users from an Access Group", "description": { "content": "To view user information only from AG with id {id}\n**Known errors:**\n- Using id which doesn't exist will return success but show no record\n \n- Using value other than number\n \n- Placing \"/\" at the end of the endpoint", "type": "text/plain" }, "url": { "path": [ "api", "access_groups", ":id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Access Group to retrieve users from" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "266db08c-a095-402d-b337-46f9e2fe4ced", "name": "OK", "originalRequest": { "url": { "path": [ "api", "access_groups", ":id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Access Group to retrieve users from" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "Status", "value": "200 OK", "description": "" }, { "disabled": false, "key": "X-Content-Type-Options", "value": "nosniff", "description": "" }, { "disabled": false, "key": "X-XSS-Protection", "value": "1", "description": "" }, { "disabled": false, "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate", "description": "" }, { "disabled": false, "key": "Pragma", "value": "no-cache", "description": "" }, { "disabled": false, "key": "Expires", "value": "0", "description": "" }, { "disabled": false, "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Length", "value": "235", "description": "" }, { "disabled": false, "key": "Date", "value": "Mon, 17 Feb 2025 07:47:24 GMT", "description": "" }, { "disabled": false, "key": "Keep-Alive", "value": "timeout=5", "description": "" }, { "disabled": false, "key": "Connection", "value": "keep-alive", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ea160b20-3de5-4445-be02-182bee206d4a", "name": "Access Level", "description": { "content": "This section contains all API related to Access Level (AL)", "type": "text/plain" }, "item": [ { "id": "5d18f539-53a1-4091-90af-13cde7d14c73", "name": "Create New Access Level", "request": { "name": "Create New Access Level", "description": { "content": "Create a new Access Level (AL) with doors and schedule configuration.\n\n**Important Notes:**\n- Access level items link doors with schedules\n- Multiple doors can be assigned to the same schedule\n- Each door can only appear once in the access level items\n\n**Known errors:**\n- Placing \"/\" at the end of the endpoint\n- `name` is a required and unique parameter\n- Duplicate id on doors instance", "type": "text/plain" }, "url": { "path": [ "api", "access_levels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AccessLevel\": {\n \"name\": \"\",\n \"description\": \"\",\n \"access_level_items\": [\n {\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"schedule_id\": {\n \"id\": \"\"\n }\n },\n {\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"schedule_id\": {\n \"id\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1b7fdeb9-2102-47cf-9c85-644394dbd310", "name": "Access Level created successfully", "originalRequest": { "url": { "path": [ "api", "access_levels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AccessLevel\": {\n \"name\": \"Access Level Name\",\n \"description\": \"Access Level Description\",\n \"access_level_items\": [\n {\n \"doors\": [\n {\n \"id\": 75\n },\n {\n \"id\": 80\n }\n ],\n \"schedule_id\": {\n \"id\": \"1\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2b3c45e-3732-4921-b0a5-b042db1816a3", "name": "View All Access Level", "request": { "name": "View All Access Level", "description": { "content": "This request is used to view all Access Level (AL)\n\nThe parameter type is QUERY.\n\n**Known errors:**\n\n- Duplicate id on doors instance", "type": "text/plain" }, "url": { "path": [ "api", "access_levels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit response record(s) by the amount specified on this parameter. 0 for show all." }, { "disabled": false, "key": "offset", "value": "", "description": "Shift response record(s) by the amount specified on this parameter. default value = 0" }, { "disabled": false, "key": "order_by", "value": "", "description": "Order the response record(s) " } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "931fc26c-1971-4569-ac93-fd5b7f3dbf4c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "access_levels" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "order_by", "value": "id:false" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a35e7379-9af0-4f5f-bbbc-ecc102900d2a", "name": "Update an Access Level", "request": { "name": "Update an Access Level", "description": { "content": "This request is used to update an Access Level (AL)\n\n**Known errors:**\n\n- Placing \"/\" at the end of the endpoint\n \n- `name` is a required and unique parameter\n \n- Duplicate id on doors instance", "type": "text/plain" }, "url": { "path": [ "api", "access_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the AL that will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"access_level_items\": [\n {\n \"id\": \"\",\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"schedule_id\": {\n \"id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"schedule_id\": {\n \"id\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9b4695bb-9f61-4766-8145-fd998a7f5756", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "access_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the AL that will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"AccessLevel\": {\n \"name\": \"Test Update\",\n \"description\": \"Update\",\n \"access_level_items\": [\n {\n \"id\": 126,\n \"doors\": [\n {\n \"id\": 75\n },\n {\n \"id\": 80\n }\n ],\n \"schedule_id\": {\n \"id\": 1\n }\n },\n {\n \"id\": 128,\n \"doors\": [\n {\n \"id\": 75\n },\n {\n \"id\": 79\n }\n ],\n \"schedule_id\": {\n \"id\": 2\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25a7522c-b607-48d9-8f11-eefe10d0ae1e", "name": "Delete an Access Level", "request": { "name": "Delete an Access Level", "description": { "content": "This request is used to delete an existing Access Level (AL)\n\n**Known errors:**\n\n- Placing \"/\" at the end of the endpoint\n \n- Value other than number on PATH variable\n \n- Non-existent record id on PATH variable will return success but no action.", "type": "text/plain" }, "url": { "path": [ "api", "access_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the AL that will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "3a07a029-322f-4cf0-9abe-156da36f0cb2", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "access_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the AL that will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "cda5879f-e9ca-41d3-8540-11ab429a8139", "name": "Backup", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "77f50a49-a628-4a5b-aa69-a4051a578dd9", "name": "View Backup Configuration", "request": { "name": "View Backup Configuration", "description": { "content": "This API is used to view BioStar X Backup configuration.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "getBackupDbConfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8a00a888-9848-4cd0-9a3f-7c80faca14fe", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "getBackupDbConfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9212953-906d-43d7-b380-63ede3a64991", "name": "Check Running Schedule", "request": { "name": "Check Running Schedule", "description": { "content": "This API is used to check if there's any running backup process.\n\nMessage response will be `True` if there's any, and `False` if there's no running backup process.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "checkBackupScheduler" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "77c03dc0-56d9-49c6-93c1-3ac6063f65fb", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "checkBackupScheduler" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ed436d4-f3ef-48c4-bad3-b860cd123ca6", "name": "Update Backup Configuration", "request": { "name": "Update Backup Configuration", "description": { "content": "This API is used to modify BioStar X backup configuration.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "modifyBackupDbConfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"use\": \"\",\n \"cycle\": \"\",\n \"path\": \"\",\n \"minute\": \"\",\n \"hour\": \"\",\n \"days\": \"\",\n \"month\": \"\",\n \"weeks\": \"\",\n \"userId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8d80ad4b-8142-401d-af96-158fcaf56835", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "modifyBackupDbConfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"use\": \"true\",\n \"cycle\": \"10\",\n \"path\": \"C:\\\\\\\\Backup\",\n \"minute\": \"12\",\n \"hour\": \"0\",\n \"days\": \"*\",\n \"month\": \"*\",\n \"weeks\": \"?\",\n \"userId\": \"1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d396122c-d774-44d0-a779-445eb5828a37", "name": "Run Backup", "request": { "name": "Run Backup", "description": { "content": "This API is used to run Backup process.\n\nIt is required to have BODY parameters when running this API. Use `GET /api/v2/setting/getBackupDbConfig` for BODY payload.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "backupNow" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"use\": \"\",\n \"cycle\": \"\",\n \"path\": \"\",\n \"minute\": \"\",\n \"hour\": \"\",\n \"days\": \"\",\n \"month\": \"\",\n \"weeks\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0bcedc5b-42ba-49cd-aa69-0d99b9f25364", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "backupNow" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"use\": \"false\",\n \"cycle\": \"5\",\n \"path\": \"C:\\\\Program Files\\\\BioStar 2(x64)\\\\Backup\",\n \"minute\": \"0\",\n \"hour\": \"0\",\n \"days\": \"*\",\n \"month\": \"*\",\n \"weeks\": \"*\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "df27e79d-a70c-4ff4-a9fc-c6c488b41342", "name": "Cards", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "99a844b4-f4ee-43d7-8e49-e72387678551", "name": "Update Wiegand Formats", "request": { "name": "Update Wiegand Formats", "description": { "content": "It is possible to use a custom wiegand format.\nTo create a custom format, you can edit the provided formats which is between id number 5 to 14.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "wiegand_formats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the wiegand format which will be updated (5-14 for custom formats)." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"WiegandFormat\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"length\": \"\",\n \"use_facility_code\": \"\",\n \"id_fields\": [\n \"\",\n \"\"\n ],\n \"parity_fields\": [\n \"\",\n \"\"\n ],\n \"parity_types\": [\n \"\",\n \"\"\n ],\n \"parity_positions\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6798ac30-231a-4b45-8757-a1509c3dddca", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "wiegand_formats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the wiegand format which will be updated (5-14 for custom formats)." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"WiegandFormat\": {\n \"id\": \"5\",\n \"name\": \"Custom Format\",\n \"description\": \"Custom Wiegand format description\",\n \"length\": 32,\n \"use_facility_code\": true,\n \"id_fields\": [\n \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAHgAAAA=\",\n \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAf///4=\"\n ],\n \"parity_fields\": [\n \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIAAAAA=\",\n \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAE=\"\n ],\n \"parity_types\": [\n 1,\n 2\n ],\n \"parity_positions\": [\n 0,\n 31\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3e1a2da-7f3d-4682-a9b3-5abcb06ff61c", "name": "View Wiegand Format Detail", "request": { "name": "View Wiegand Format Detail", "description": { "content": "This API is used to view a wiegand format detail.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "wiegand_formats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ea7f8778-cbbd-4cb0-b075-331cf0d49801", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "wiegand_formats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bda6727-59dc-4948-9469-280bac22cf41", "name": "Delete Smart Card Layout", "request": { "name": "Delete Smart Card Layout", "description": { "content": "This API is used to delete smart card layout from BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "layouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "6c018e46-49f5-4b5a-bd0e-b596a89f0142", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "layouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95327e7c-1ef8-4aa5-9355-8b780b6d6b55", "name": "View Smart Cards Layout", "request": { "name": "View Smart Cards Layout", "description": { "content": "This API is used to view all available smart card layouts.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "layouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of responses by n records. Remove this parameter to view all." }, { "disabled": false, "key": "offset", "value": "", "description": "Offset the response shown by n records." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b584cb98-525c-4029-9396-a173ba1a2869", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "layouts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "null" }, { "key": "offset", "value": "null" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac077aef-0c8b-4ea9-bfa4-dbe0c098ea0a", "name": "Create Smart Card Layout", "request": { "name": "Create Smart Card Layout", "description": { "content": "This API is used to create smart card layout.\n\nFill the corresponding parameter with the card's specification.\n\nIf the card uses default configuration, then simply fill the name and run the API.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "layouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b2b962ee-912c-45d4-9c5c-0ad7e09a8866", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "layouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CardLayout\": {\n \"name\": \"smart_test\",\n \"use_second_key\": false,\n \"number_of_template\": 2,\n \"template_size\": 300,\n \"mifare_primary_key\": \"\",\n \"mifare_start_block_index\": 4,\n \"mifare_second_key\": \"\",\n \"iclass_primary_key\": \"\",\n \"iclass_second_key\": \"\",\n \"iclass_start_block_index\": 13,\n \"desfire_primary_key\": \"\",\n \"desfire_second_key\": \"\",\n \"desfire_app_id\": 1,\n \"desfire_file_id\": 1,\n \"desfire_encryption_type\": 0,\n \"desfire_advanced_mode\": 0,\n \"des_adv_app_master_key_index\": 0,\n \"des_adv_file_read_access_key_index\": 1,\n \"des_adv_file_write_access_key_index\": 2,\n \"seos_primary_key\": \"\",\n \"seos_second_key\": \"\",\n \"seos_adf\": \"2A8570811E1000070000020000\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a3936ac-2060-4183-939c-cee97e571858", "name": "View All Card Types", "request": { "name": "View All Card Types", "description": { "content": "This API is used to view all available card types.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7f3b479a-bd77-4cce-8189-87588ea800bd", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2a77467b-3644-4832-9101-72ce66a5f939", "name": "Check Card Availability", "request": { "name": "Check Card Availability", "description": { "content": "This API is used to check whether a card already posted on the system or not.\n\nIf card already posted, then it will show the card's detail on the response.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cards", "registered" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "card_id", "value": "", "description": "ID of the card which will be checked." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3c757386-2778-4f97-84da-94f3fda516e8", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "cards", "registered" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "card_id", "value": "123" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "69a38da6-6fcf-4051-9bd7-1847f2cc5f52", "name": "View a Card Detail", "request": { "name": "View a Card Detail", "description": { "content": "This API is used to find a card by card ID and find out who owns the card.", "type": "text/plain" }, "url": { "path": [ "api", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "query", "value": "", "description": "ID of the card which will be viewed" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8ef5fd77-d173-42c0-b775-ed47335f8dc3", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "1169166509350528" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04d7317f-87b2-495e-ab5d-babdd86980c2", "name": "Create BioStar X QR", "request": { "name": "Create BioStar X QR", "description": { "content": "This API is used to create BioStar X QR.\n**NOTE**: This API will return error if the card_id already exists in the database. Use Check [Card Availability](#checkCardAvailability) API to validate.", "type": "text/plain" }, "url": { "path": [ "api", "cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CardCollection\": {\n \"rows\": [\n {\n \"card_type\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"card_id\": \"\",\n \"user_id\": {\n \"user_id\": \"\"\n },\n \"display_card_id\": \"\"\n },\n {\n \"card_type\": {\n \"id\": \"\",\n \"type\": \"\"\n },\n \"card_id\": \"\",\n \"user_id\": {\n \"user_id\": \"\"\n },\n \"display_card_id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "03bdd87d-1dd6-4abd-b1ac-41e53ae3b105", "name": "Card created successfully", "originalRequest": { "url": { "path": [ "api", "cards" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CardCollection\": {\n \"rows\": [\n {\n \"card_type\": {\n \"id\": 7,\n \"type\": 7\n },\n \"card_id\": 27744052605381570,\n \"user_id\": {\n \"user_id\": \"13\"\n },\n \"display_card_id\": 27744052605381570\n },\n {\n \"card_type\": {\n \"id\": 7,\n \"type\": 7\n },\n \"card_id\": 27744052605381570,\n \"user_id\": {\n \"user_id\": \"13\"\n },\n \"display_card_id\": 27744052605381570\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04fbf2c3-7175-458d-9582-4e38dce562ae", "name": "List Unassigned Cards", "request": { "name": "List Unassigned Cards", "description": { "content": "This API is used to view all unassigned cards recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "unassigned" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "card_type", "value": "", "description": "Limit the response to show only the specified type of card. Use plus (+) sign as separator to filter by multiple types." }, { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of responses by n records. Remove this parameter to view all." }, { "disabled": false, "key": "offset", "value": "", "description": "Offset the response shown by n records." }, { "disabled": false, "key": "wiegand_format_id", "value": "", "description": "Limit the response to show only the specified wiegand format. Remove this parameter to show all." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "42337c00-cb00-499b-bfdc-36110da8eb1c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "unassigned" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "card_type", "value": "csn" }, { "key": "limit", "value": "null" }, { "key": "offset", "value": "null" }, { "key": "wiegand_format_id", "value": "4" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1bd0238-f6b0-43ca-80ad-fa2fa57646a5", "name": "List Assigned Cards", "request": { "name": "List Assigned Cards", "description": { "content": "This API is used to view all assigned cards recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "assigned" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "card_type", "value": "", "description": "Limit the response to show only the specified type of card. Use plus (+) sign as separator to filter by multiple types." }, { "disabled": false, "key": "offset", "value": "", "description": "Offset the response shown by n records." }, { "disabled": false, "key": "wiegand_format_id", "value": "", "description": "Limit the response to show only the specified wiegand format. Remove this parameter to show all." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "90f739f6-3a59-47d0-888f-73a8926b4fd3", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "assigned" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "card_type", "value": "wiegand" }, { "key": "offset", "value": "0" }, { "key": "wiegand_format_id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a713548f-0724-4292-a6d2-e3ec09a7524f", "name": "List Blacklisted Cards", "request": { "name": "List Blacklisted Cards", "description": { "content": "This API is used to view all blacklisted cards recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "blacklist" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of responses by n records. Remove this parameter to view all." }, { "disabled": false, "key": "offset", "value": "", "description": "Offset the response shown by n records." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ce18603a-8558-461f-8fd1-5ec561df3330", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "blacklist" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "1000" }, { "key": "offset", "value": "0" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a879ccd0-31ae-495d-abd1-68eca20cf0db", "name": "Delete Blacklisted Card", "request": { "name": "Delete Blacklisted Card", "description": { "content": "This API is used to remove a blacklisted card from the list.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "blacklist" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "ID of the blacklisted card which will be removed from the list." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "cc553a85-327e-4096-9bda-94772dee48a0", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "blacklist" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "50" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6af5ade6-e983-45e5-b58c-4b0961212a3c", "name": "Blacklist Card", "request": { "name": "Blacklist Card", "description": { "content": "This API is used to add a card to blacklist.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "blacklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Blacklist\": {\n \"card_id\": {\n \"id\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "579e020d-284d-4ac8-9cbf-fb33a1663ce2", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "blacklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Blacklist\": {\n \"card_id\": {\n \"id\": 49\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8663d6e-32c9-4fc9-b5ea-fd75a702daf9", "name": "View Wiegand Formats", "request": { "name": "View Wiegand Formats", "description": { "content": "This API is used to view all available wiegand format.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "wiegand_formats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "db8d7385-090a-4585-ab88-793aaf0d9f73", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "wiegand_formats" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5fd3f2fa-6e5b-4290-bbcf-a346909bbce9", "name": "View a Smart Card Layout Details", "request": { "name": "View a Smart Card Layout Details", "description": { "content": "This API is used to view a smart card layout details.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "layouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the card layout which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "6a138b4d-cfea-4cca-ae4f-f794114e10b3", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "layouts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the card layout which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4edf700-b032-4984-a2f0-87f6c2b54669", "name": "Write Card Data", "request": { "name": "Write Card Data", "description": { "content": "This API is used to create Access on Card and write data to a card (Smart Card, etc.) using the specified device. The device must have a Smart Card layout configured before running this API.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":device_id", "write_card" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "device_id", "description": "(Required) 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." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SmartCard\": {\n \"user_id\": {\n \"user_id\": \"\",\n \"fingerprint_templates\": [\n {\n \"finger_index\": \"\"\n },\n {\n \"finger_index\": \"\"\n }\n ],\n \"visual_face_templates\": [\n \"\",\n \"\"\n ]\n },\n \"card_id\": {\n \"card_id\": \"\",\n \"card_type_id\": {\n \"id\": \"\"\n },\n \"use_alphanumeric_user_id\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9cee3734-2a55-41d0-bb34-fc79ec5faf57", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":device_id", "write_card" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "device_id", "description": "(Required) 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." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SmartCard\": {\n \"user_id\": {\n \"user_id\": 8,\n \"fingerprint_templates\": [\n {\n \"finger_index\": 0\n }\n ]\n },\n \"card_id\": {\n \"card_id\": 8,\n \"card_type_id\": {\n \"id\": 3\n },\n \"use_alphanumeric_user_id\": false\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8aaafe84-2a8d-42ef-a77f-d52dd358948f", "name": "Create Mobile Card", "request": { "name": "Create Mobile Card", "description": { "content": "This API is used to create Mobile Card.", "type": "text/plain" }, "url": { "path": [ "api", "cards", "mobile_credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SmartCard\": {\n \"user_id\": {\n \"user_id\": \"\",\n \"fingerprint_templates\": [\n {\n \"finger_index\": \"\"\n },\n {\n \"finger_index\": \"\"\n }\n ]\n },\n \"card_id\": {\n \"card_id\": \"\",\n \"card_type_id\": {\n \"id\": \"\"\n }\n },\n \"card_layout_id\": {\n \"id\": \"\"\n },\n \"options\": {\n \"is_a_mobile_credential\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a1e6fab2-5937-43c7-a86d-5abcf878d447", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "cards", "mobile_credentials" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SmartCard\": {\n \"user_id\": {\n \"user_id\": 1,\n \"fingerprint_templates\": [\n {\n \"finger_index\": 0\n }\n ]\n },\n \"card_id\": {\n \"card_id\": 102,\n \"card_type_id\": {\n \"id\": 2\n }\n },\n \"card_layout_id\": {\n \"id\": 4\n },\n \"options\": {\n \"is_a_mobile_credential\": true\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f20d4f6-4567-4326-bcd6-2a4ca862eb6a", "name": "Format Smart Card", "request": { "name": "Format Smart Card", "description": { "content": "This API is used to remove the written smart card data from a Smart Card.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":dev_id", "erase_card" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "dev_id", "description": "(Required) Device ID with the corresponding layout set which will be used to write the card." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "9517f19d-4309-468a-8cd8-f951a9dd43a1", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":dev_id", "erase_card" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "dev_id", "description": "(Required) Device ID with the corresponding layout set which will be used to write the card." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "788da230-ed70-4479-876b-1eb60ec054a0", "name": "Send BioStar X QR by Email", "request": { "name": "Send BioStar X QR by Email", "description": { "content": "This API is used to send BioStar X QR by email.\n\nBefore using this API, make sure that:\n- SMTP is set\n- User email field is filled", "type": "text/plain" }, "url": { "path": [ "api", "v2", "send_email_qr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"language\": \"\",\n \"card_collection\": [\n {\n \"id\": \"\",\n \"card_id\": \"\",\n \"display_card_id\": \"\",\n \"card_type\": {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n }\n ],\n \"total\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8d5c5b94-1d4e-4924-83a9-27ef9ce397b8", "name": "QR code email sent successfully", "originalRequest": { "url": { "path": [ "api", "v2", "send_email_qr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"language\": \"en\",\n \"card_collection\": [\n {\n \"id\": 10072,\n \"card_id\": 3.045804110617691e+33,\n \"display_card_id\": 165113371684849,\n \"card_type\": {\n \"id\": 7,\n \"name\": \"SCQr\",\n \"type\": 7\n }\n }\n ],\n \"total\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2633898-3777-4d72-905e-698a21b802c1", "name": "Send Visual Face by Email", "request": { "name": "Send Visual Face by Email", "description": { "content": "This API is used to send Visual Face mobile enrollment link.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "send_email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"language\": \"\",\n \"adv_criteria\": {\n \"user_name\": \"\",\n \"user_operator_level_id\": \"\",\n \"user_group_id\": \"\",\n \"user_group_ids\": [\n \"\",\n \"\"\n ],\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "db59976e-5772-459d-a36a-bf5cee507536", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "send_email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"id\": \"1\",\n \"language\": \"en\",\n \"adv_criteria\": {\n \"user_name\": \"e\",\n \"user_operator_level_id\": \"0\",\n \"user_group_id\": 1,\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "99ac0952-8423-4d71-81e7-51089c6f4282", "name": "User Groups", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "51a17f85-909e-4748-963d-24987fee8e7e", "name": "List User Group", "request": { "name": "List User Group", "description": { "content": "This API is used to list all User Groups.", "type": "text/plain" }, "url": { "path": [ "api", "user_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e72566d2-4039-41ff-89ec-87211d89793c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "user_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "efa80665-311b-476d-86ed-9e38027d49ed", "name": "Create User Group", "request": { "name": "Create User Group", "description": { "content": "This API is used to create a new User Group.\n\n\n**Note:**\n\n- User groups may be created in up to 8 levels.\n\n- Up to 48 characters may be entered for a user group name.", "type": "text/plain" }, "url": { "path": [ "api", "user_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"UserGroup\": {\n \"parent_id\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"depth\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bd9f6eb8-f47b-4bf6-b6d7-6e36105f95cd", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "user_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"UserGroup\": {\n \"parent_id\": {\n \"id\": 1\n },\n \"name\": \"TestDataXFer3\",\n \"depth\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21f5ced0-38c4-4f26-aca5-9cee391d7334", "name": "Delete User Group", "request": { "name": "Delete User Group", "description": { "content": "This API is used to delete a User Group.", "type": "text/plain" }, "url": { "path": [ "api", "user_groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "Id of the User Group which will be deleted." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "81f28249-6039-4783-bf69-feb776b74ec0", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "user_groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "21436" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "facc545d-9c75-4493-902b-844ba08bc109", "name": "Search User Groups by ID", "request": { "name": "Search User Groups by ID", "description": { "content": "This API is used to list User Group(s) which are specified in the request body.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "user_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"user_group_id_list\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "badc8a44-75a8-4a54-bbf9-3da57c974245", "name": "User Groups retrieved successfully", "originalRequest": { "url": { "path": [ "api", "v2", "user_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_group_id_list\": [\n \"1004\",\n \"21109\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fd7c294-9f61-48dc-b999-c5397a139738", "name": "Update User Group", "request": { "name": "Update User Group", "description": { "content": "This API is used to update a User Group.", "type": "text/plain" }, "url": { "path": [ "api", "user_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the User Group which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"UserGroup\": {\n \"name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fad451d9-8c03-4265-b55a-9a2da04555e3", "name": "User Group updated successfully", "originalRequest": { "url": { "path": [ "api", "user_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the User Group which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserGroup\": {\n \"name\": \"TestDataXFer3xx\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4b0b446b-6ee3-4e1c-84ee-ffe08da655e9", "name": "User", "description": { "content": "This section contains all API related to Users", "type": "text/plain" }, "item": [ { "id": "26a090fe-c475-4380-80b2-4b84a315935c", "name": "Update User Fingerprint Credentials", "request": { "name": "Update User Fingerprint Credentials", "description": { "content": "This API is used to update fingerprint data on a User.\n\nUse `POST /api/devices/{dev_id}/scan_fingerprint` to enroll fingerprint.\nUse `POST /api/server_matching/identify_finger` to check whether the fingerprint already recorded or not.\n\n**Important Notes:**\n- 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", "type": "text/plain" }, "url": { "path": [ "api", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the user to update fingerprint credentials" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"User\": {\n \"fingerprint_templates\": [\n {\n \"template0\": \"\",\n \"template1\": \"\",\n \"finger_mask\": \"\",\n \"isNew\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "331bb65c-872d-4751-86ed-20ec7ac84189", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the user to update fingerprint credentials" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"User\": {\n \"fingerprint_templates\": [\n {\n \"template0\": \"RSoQFLAAVUYMBEBvBBlEsWSLFITAEIUGBgEYBA/G0W0IAwcgdgEbh2ANixfIMGUKEshwF4QOCbBzhjXEsaCFJITQAYohRSBViCSGoUsRLAcQooYoh6GlCDpIgZ2GKMkARgkyCXCehDhJgEIDG0sxYJsOy0BziBaMcGmPG4ywUaAVTdBokwxOEXgHEE6AeIIVT0FoERfPYBsxGg9gK9EK0QB4jRxSYRqFEhNAbxkXk1AUChiTUHSHL8zwl4EmDiE3CCHPADWKK5DAOo8nUZAqDS5SIUKXK9JhOZj////g/////////eAB///////d4AEi/////N3gASM////M3eABIzT/+7zd4BIzRE+7u83gEjNET7u7zeASNERFu7vN4BI0REW6u8zgIzRERaqqvOAjRERFqqq84TREREWqqrziNFVUT6mqvOJFVVVfqqq9BFVVVU/5qrqHd2ZU//+qqZiIdkT///qqqZh1T///+6qqqYX/////u6uqj///\",\n \"template1\": \"RSgQFK8AVUYRBDBvhxqEgBGFHsSRZwsIhRF1BQtGIRuEFsZxawgJRwB5AR4H4GULGYgQF4UUyYB0hyqEsAOJJsTRWIgrRkBKjyKG4QoLMsbwooQvB3GkBi9I0EYHOUnBnQMJSgF4ghXK8HWKHYwQZ5EIzQAfhRPN4XsEHA4BbBYXzhB5hRzO8WaYB89AdoQeT0AdsQgQAHiJDlFQdoIiSvFfHCLMcE4iNszwmAIszkE2hihO8DQJIM9QKkMxEJA3CC4RwCeOIlKBHAMxEsBFIv///d3////////M3eD/////+8zd4BL///+7zN3gEj//+rvM3eASM/+qu8zd4BIzT6q7vM3gEjRFqqq7zeASNESqqrvN4CNERaqqq7zhI0RFqqqrvOE0REWqqqq84jRFVaqqqrwDRFVVqqmavQRVVVWqqqq9JVVVVvq7qqmHdmZv/6qqqZiHZm//+qqqmZhV////u6qqmFT///+7uqqoT/8=\",\n \"finger_mask\": false,\n \"isNew\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1a8c6ab-2225-4cb5-9dbe-2d4999024884", "name": "View a User's Details", "request": { "name": "View a User's Details", "description": { "content": "This API is used to view a user's details which is recorded on BioStar X.\n\n**Known errors:**\n- Putting \"/\" at the end of the endpoint\n \n- Using User ID which doesn't exist", "type": "text/plain" }, "url": { "path": [ "api", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the User" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e97dd554-c47e-4a1e-acc7-2bb0cec10b4d", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the User" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f950992-43dc-4b84-ae6a-e5daf308871b", "name": "User: Bulk Update", "request": { "name": "User: Bulk Update", "description": { "content": "This API is used for updating user information in bulk.\n\nThe 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.\n\n**Warning:** The maximum number of users that can be modified in a single API call is **100**.\n\n**Response Codes:**\n- **ret_code** presents BioStar X response code for modifying each user\n- Response.code could be `0` (Overall success), `1` (Partial success), `8` (Overall failed)\n- For error code meanings, refer to `[BioStar X Install Path]\\nginx\\html\\resources\\messages_en`", "type": "text/plain" }, "url": { "path": [ "api", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"UserCollection\": {\n \"rows\": [\n {\n \"user_id\": \"\",\n \"name\": \"\",\n \"user_group_id\": {\n \"id\": \"\"\n },\n \"disabled\": \"\",\n \"start_datetime\": \"\",\n \"expiry_datetime\": \"\",\n \"email\": \"\",\n \"department\": \"\",\n \"user_title\": \"\",\n \"login_id\": \"\",\n \"password\": \"\",\n \"user_ip\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23705ead-6ba9-4c2b-ba08-140003fb9390", "name": "Bulk update completed (success, partial success, or failed)", "originalRequest": { "url": { "path": [ "api", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserCollection\": {\n \"rows\": [\n {\n \"user_id\": \"9\",\n \"name\": \"John Doe\",\n \"user_group_id\": {\n \"id\": \"1\"\n },\n \"disabled\": false,\n \"start_datetime\": \"2001-01-01T00:00:00.00Z\",\n \"expiry_datetime\": \"2030-12-31T23:59:00.00Z\",\n \"email\": \"SW1_00003@gmail.com\",\n \"department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"login_id\": \"myloginid\",\n \"password\": \"zlwRzi7Kcpi1kiQ\",\n \"user_ip\": \"191.59.135.73\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"UserCollection\": {\n \"rows\": [\n {\n \"user_id\": \"3\",\n \"ret_code\": \"0\"\n },\n {\n \"user_id\": \"3\",\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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1c79aad-f41d-403f-85dd-48fc1f56154a", "name": "Bad request - Invalid JSON data or parameters", "originalRequest": { "url": { "path": [ "api", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserCollection\": {\n \"rows\": [\n {\n \"user_id\": \"9\",\n \"name\": \"John Doe\",\n \"user_group_id\": {\n \"id\": \"1\"\n },\n \"disabled\": false,\n \"start_datetime\": \"2001-01-01T00:00:00.00Z\",\n \"expiry_datetime\": \"2030-12-31T23:59:00.00Z\",\n \"email\": \"SW1_00003@gmail.com\",\n \"department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"login_id\": \"myloginid\",\n \"password\": \"zlwRzi7Kcpi1kiQ\",\n \"user_ip\": \"191.59.135.73\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"700\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Failed to parse json data.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88367547-dcf8-4de2-840c-b14a548e8056", "name": "500 Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "users", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"UserCollection\": {\n \"rows\": [\n {\n \"user_id\": \"9\",\n \"name\": \"John Doe\",\n \"user_group_id\": {\n \"id\": \"1\"\n },\n \"disabled\": false,\n \"start_datetime\": \"2001-01-01T00:00:00.00Z\",\n \"expiry_datetime\": \"2030-12-31T23:59:00.00Z\",\n \"email\": \"SW1_00003@gmail.com\",\n \"department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"login_id\": \"myloginid\",\n \"password\": \"zlwRzi7Kcpi1kiQ\",\n \"user_ip\": \"191.59.135.73\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1413adb0-c83f-4890-b312-78da34ca9b52", "name": "Check Picture Specification", "request": { "name": "Check Picture Specification", "description": { "content": "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- Supported image file size is up to 10MB.\n- Supported image file formats are JPG, JPEG and PNG.", "type": "text/plain" }, "url": { "path": [ "api", "users", "check", "upload_picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"template_ex_picture\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ec30a60f-6d67-4820-b5f5-a0ee0c4389dc", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "check", "upload_picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"template_ex_picture\": \"/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCAABAAEDASIAAhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAv/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFQEBAQAAAAAAAAAAAAAAAAAAAAX/xAAUEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwBVD//Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84bb07bb-cc21-4ba2-a064-be6321228a2c", "name": "Delete User(s) with Advanced Search", "request": { "name": "Delete User(s) with Advanced Search", "description": { "content": "This API is used to delete user(s) which is collected from Advanced Search query.\n\nUsers matching the advanced search criteria will be deleted from the system.", "type": "text/plain" }, "url": { "path": [ "api", "users", "advance_search", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "adv", "value": "", "description": "(Required) Use this to enable Advanced Search query result" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"adv_criteria\": {\n \"limit\": \"\",\n \"order_by\": \"\",\n \"user_operator_level_id\": \"\",\n \"offset\": \"\",\n \"user_id\": \"\",\n \"user_group_id\": \"\",\n \"user_group_ids\": [\n \"\",\n \"\"\n ],\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"user_phone\": \"\",\n \"user_access_group_ids\": \"\",\n \"user_department\": \"\",\n \"user_title\": \"\",\n \"user_card\": \"\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fa647db6-41af-4cba-a998-17b47051fb8d", "name": "Users deleted successfully", "originalRequest": { "url": { "path": [ "api", "users", "advance_search", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "adv", "value": "mode1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adv_criteria\": {\n \"limit\": 50,\n \"order_by\": \"user_id:false\",\n \"user_operator_level_id\": 0,\n \"offset\": 0,\n \"user_id\": \"11\",\n \"user_group_id\": 1,\n \"user_group_ids\": [\n 1121\n ],\n \"user_name\": \"John\",\n \"user_email\": \"abc@gmail.com\",\n \"user_phone\": \"123-456-7890\",\n \"user_access_group_ids\": \"17,18\",\n \"user_department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"user_card\": \"123456\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "458ed68c-3825-4d7c-85f4-79688b361654", "name": "Send User Data to Device", "request": { "name": "Send User Data to Device", "description": { "content": "This API is used to send user data to a device.\nFor example when you want to send user John data after credential update to FaceStation F2.\n**Notes:**\n- Set `adv=mode1` on Query Parameter to enable advanced search compatibility. This parameter is optional. When not used, it will use the previous capability.\n- Maximum of 100 users can be processed in a single request\n- Request Body with Advanced Search example (see **Batch Edit with Advanced Search** for `adv_criteria` details)\n\n```json\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```", "type": "text/plain" }, "url": { "path": [ "api", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "overwrite", "value": "", "description": "Toggle to overwrite the data on the device. True to overwrite (default value)\n" }, { "disabled": false, "key": "id", "value": "", "description": "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" }, { "disabled": false, "key": "adv", "value": "", "description": "Use this to enable Advanced Search query result." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "89fe6d5e-5ee4-4b1b-871f-8dff3c22d37c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "overwrite", "value": "true" }, { "key": "id", "value": "15" }, { "key": "adv", "value": "mode1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"50362288\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DeviceResponse\": {\n \"rows\": [\n {\n \"id\": \"50362288\",\n \"code\": \"0\"\n },\n {\n \"id\": \"50362288\",\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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49cd436a-31fe-4068-a8c0-099957bf9b82", "name": "Delete User(s) From Device (Advanced Search)", "request": { "name": "Delete User(s) From Device (Advanced Search)", "description": { "content": "This API is used to delete user data from device(s) based on Advanced Search query results.\nUsers matching the advanced search criteria will have their data removed from the specified devices.\n**Notes:**\n- Requires `adv=mode1` query parameter to enable advanced search functionality\n- Only user data is removed from devices, not from the BioStar X database", "type": "text/plain" }, "url": { "path": [ "api", "users", "remove" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "adv", "value": "", "description": "Use this to enable Advanced Search query result." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n }\n ]\n },\n \"adv_criteria\": {\n \"limit\": \"\",\n \"order_by\": \"\",\n \"user_operator_level_id\": \"\",\n \"offset\": \"\",\n \"user_id\": \"\",\n \"user_group_id\": \"\",\n \"user_group_ids\": [\n \"\",\n \"\"\n ],\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"user_phone\": \"\",\n \"user_access_group_ids\": \"\",\n \"user_department\": \"\",\n \"user_title\": \"\",\n \"user_card\": \"\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3ed18de4-2206-421e-8a9d-226045b72fdd", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "remove" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "adv", "value": "mode1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"40000701\"\n }\n ]\n },\n \"adv_criteria\": {\n \"limit\": 50,\n \"order_by\": \"user_id:false\",\n \"user_operator_level_id\": 0,\n \"offset\": 0,\n \"user_id\": \"11\",\n \"user_group_id\": 1,\n \"user_group_ids\": [\n 1121\n ],\n \"user_name\": \"John\",\n \"user_email\": \"abc@gmail.com\",\n \"user_phone\": \"123-456-7890\",\n \"user_access_group_ids\": \"17,18\",\n \"user_department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"user_card\": \"123456\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DeviceResponse\": {\n \"rows\": [\n {\n \"id\": \"50362288\",\n \"code\": \"0\"\n },\n {\n \"id\": \"50362288\",\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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b00b4c1-2eb5-4715-af5c-f198f567b74b", "name": "List Idle Users - Multiple ID", "request": { "name": "List Idle Users - Multiple ID", "description": { "content": "This API shows a workaround using this API to get multiple users data by adjusting the parameters.\n\nThe advantage of this workaround is that the API response can be adjusted to only show only the required users directly.\n\n* Query parameter search_month value is set to 0 or removed\n* 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.\n\nFor BODY Parameter details refer to POST List Idle Users.", "type": "text/plain" }, "url": { "path": [ "api", "users", "absence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"offset\": \"\",\n \"limit\": \"\",\n \"conditions\": [\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"orders\": [\n {\n \"column\": \"\",\n \"descending\": \"\"\n },\n {\n \"column\": \"\",\n \"descending\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6b414e0d-a1d8-459c-9523-c16464a9269e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "absence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"offset\": 0,\n \"limit\": 0,\n \"conditions\": [\n {\n \"column\": \"user_id\",\n \"operator\": 2,\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"user_id\",\n \"operator\": 2,\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"orders\": [\n {\n \"column\": \"user_id\",\n \"descending\": false\n },\n {\n \"column\": \"user_id\",\n \"descending\": false\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa3ab297-9e69-4d9e-a2a0-670807ae55b8", "name": "Delete Idle Users", "request": { "name": "Delete Idle Users", "description": { "content": "This API is used to delete idle users.\n\nFor BODY parameter refer to POST List Idle Users.", "type": "text/plain" }, "url": { "path": [ "api", "users", "absence", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search_month", "value": "", "description": "Filter user(s) which idle for the last n month(s)." }, { "disabled": false, "key": "id", "value": "", "description": "ID of the idle users which will be deleted. Use space as separator to delete multiple users." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"offset\": \"\",\n \"limit\": \"\",\n \"conditions\": [\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"orders\": [\n {\n \"column\": \"\",\n \"descending\": \"\"\n },\n {\n \"column\": \"\",\n \"descending\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9d79ad7d-0065-4c86-9fcd-7a207ed02197", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "absence", "delete" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search_month", "value": "1" }, { "key": "id", "value": "10 11" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"offset\": 0,\n \"limit\": 0,\n \"conditions\": [\n {\n \"column\": \"user_id\",\n \"operator\": 2,\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"user_id\",\n \"operator\": 2,\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"orders\": [\n {\n \"column\": \"user_id\",\n \"descending\": false\n },\n {\n \"column\": \"user_id\",\n \"descending\": false\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f59ef4ec-1c0e-43e5-8435-c6ef84604f9f", "name": "Advanced Search", "request": { "name": "Advanced Search", "description": { "content": "This API is used to fetch user information via advanced search.\n\nSupports flexible searching across multiple user fields including personal information, group membership, access levels, and custom fields.\n**Notes:**\n- To search users without documents, use `\"user_custom_field_#\": \"No\"` for specific custom fields\n- To search users with documents, use `\"user_custom_field_#\": \"Yes\"` for specific custom fields \n- `user_operator_level_id` values: `-1` (None), `0` (All), or specific ID\n- Supports both encrypted and unencrypted field searches\n- Access group search format: \"1,2,3\" or \"*\" (any Access Group) or \"void\" (no Access Group)", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", "advance_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"limit\": \"\",\n \"order_by\": \"\",\n \"user_operator_level_id\": \"\",\n \"offset\": \"\",\n \"user_id\": \"\",\n \"user_group_id\": \"\",\n \"user_group_ids\": [\n \"\",\n \"\"\n ],\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"user_phone\": \"\",\n \"user_access_group_ids\": \"\",\n \"user_department\": \"\",\n \"user_title\": \"\",\n \"user_card\": \"\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a3281392-2089-4bd5-b75a-b167321f6148", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "users", "advance_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 50,\n \"order_by\": \"user_id:false\",\n \"user_operator_level_id\": 0,\n \"offset\": 0,\n \"user_id\": \"11\",\n \"user_group_id\": 1,\n \"user_group_ids\": [\n 1121\n ],\n \"user_name\": \"John\",\n \"user_email\": \"abc@gmail.com\",\n \"user_phone\": \"123-456-7890\",\n \"user_access_group_ids\": \"17,18\",\n \"user_department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"user_card\": \"123456\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"UserCollection\": {\n \"total\": 1,\n \"rows\": [\n {\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 {\n \"id\": 1,\n \"name\": \"access group 3\"\n },\n {\n \"id\": 1,\n \"name\": \"access group 3\"\n }\n ],\n \"user_custom_fields\": [\n {\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 {\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 ]\n },\n {\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 {\n \"id\": 1,\n \"name\": \"access group 3\"\n },\n {\n \"id\": 1,\n \"name\": \"access group 3\"\n }\n ],\n \"user_custom_fields\": [\n {\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 {\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 ]\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efea97a3-be8f-4419-a98c-a7dc668584a5", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "v2", "users", "advance_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 50,\n \"order_by\": \"user_id:false\",\n \"user_operator_level_id\": 0,\n \"offset\": 0,\n \"user_id\": \"11\",\n \"user_group_id\": 1,\n \"user_group_ids\": [\n 1121\n ],\n \"user_name\": \"John\",\n \"user_email\": \"abc@gmail.com\",\n \"user_phone\": \"123-456-7890\",\n \"user_access_group_ids\": \"17,18\",\n \"user_department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"user_card\": \"123456\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f823af10-da83-4b92-a996-acabc3725e55", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "v2", "users", "advance_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 50,\n \"order_by\": \"user_id:false\",\n \"user_operator_level_id\": 0,\n \"offset\": 0,\n \"user_id\": \"11\",\n \"user_group_id\": 1,\n \"user_group_ids\": [\n 1121\n ],\n \"user_name\": \"John\",\n \"user_email\": \"abc@gmail.com\",\n \"user_phone\": \"123-456-7890\",\n \"user_access_group_ids\": \"17,18\",\n \"user_department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"user_card\": \"123456\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58f647d7-3a6c-49a2-a16b-e3ad359dcae2", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v2", "users", "advance_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 50,\n \"order_by\": \"user_id:false\",\n \"user_operator_level_id\": 0,\n \"offset\": 0,\n \"user_id\": \"11\",\n \"user_group_id\": 1,\n \"user_group_ids\": [\n 1121\n ],\n \"user_name\": \"John\",\n \"user_email\": \"abc@gmail.com\",\n \"user_phone\": \"123-456-7890\",\n \"user_access_group_ids\": \"17,18\",\n \"user_department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"user_card\": \"123456\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cbcec23-2fab-4a70-8b01-d57c58df1a24", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "v2", "users", "advance_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 50,\n \"order_by\": \"user_id:false\",\n \"user_operator_level_id\": 0,\n \"offset\": 0,\n \"user_id\": \"11\",\n \"user_group_id\": 1,\n \"user_group_ids\": [\n 1121\n ],\n \"user_name\": \"John\",\n \"user_email\": \"abc@gmail.com\",\n \"user_phone\": \"123-456-7890\",\n \"user_access_group_ids\": \"17,18\",\n \"user_department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"user_card\": \"123456\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a831a34e-9c45-4867-b719-f24b5e28af7a", "name": "List All User v2", "request": { "name": "List All User v2", "description": { "content": "This API is used to list all users recorded on Bio Star X.\n\n**Known errors:**\n- At least one parameter must exist\n \n- Using unavailable `user_group_id` will show empty response", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"limit\": \"\",\n \"search_text\": \"\",\n \"user_group_id\": \"\",\n \"order_by\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "25048496-9c14-4f6c-b72a-3920a4e75869", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "users", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 50,\n \"search_text\": \"John\",\n \"user_group_id\": 1,\n \"order_by\": \"user_id:false\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "839fb5c0-2340-4dac-bbe4-dcc7b2abf2f6", "name": "View User by Account Level", "request": { "name": "View User by Account Level", "description": { "content": "This API is used to view all user permission grouped by user account level.\n\n1: Administrator \n2: User Operator \n3: Monitoring Operator \n4-252: Custom Account Level \n253: Video \n254: TA \n255: User \n100000: Visitor", "type": "text/plain" }, "url": { "path": [ "api", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "10c4cbbd-d805-4ffc-a721-b14a64e08ccd", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ccd34921-2734-4589-ab38-5f418b06aff4", "name": "List User Fields", "request": { "name": "List User Fields", "description": { "content": "This API is used to list user fields which can be processed as CSV.", "type": "text/plain" }, "url": { "path": [ "api", "users", "csv_option" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e80cb654-fe32-478b-a9a6-c0b485e3877e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "csv_option" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f760e1d7-b865-4d71-aff7-b163b7a3320d", "name": "Download CSV File", "request": { "name": "Download CSV File", "description": { "content": "This API is used to download exported CSV files from BioStar X Server.\n\nSupports downloading both user-related CSV files and events-related CSV files. The system automatically detects the file type based on the filename pattern.\n\n**Supported File Types:**\n- **User CSV files**: Generated from `POST /api/users/csv_export`\n- **Events CSV files**: Generated from `POST /api/events/export`\n\n**Usage:**\n1. Export data using the appropriate API (`csv_export` for users, `export` for events)\n2. Get the filename from the export response\n3. Use the filename as the path parameter in this download API", "type": "text/plain" }, "url": { "path": [ "download", ":csv_filename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "csv_filename", "description": "(Required) Name of the CSV file to download (supports both user and events files)" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a31809bf-72df-4246-b4c3-ae6d2067b330", "name": "Successful response", "originalRequest": { "url": { "path": [ "download", ":csv_filename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "csv_filename", "description": "(Required) Name of the CSV file to download (supports both user and events files)" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "47745303-9330-499f-8441-47f0d0087c4d", "name": "Upload User File (CSV/TGZ) to BioStar X Server", "request": { "name": "Upload User File (CSV/TGZ) to BioStar X Server", "description": { "content": "This API is used to upload a file to BioStar X Server.\n\nUsage of this API is to upload a .csv or .tgz file to BioStar X 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`.\n\nUploaded file will be located on: {{BioStar X Installation Path}}\\\\nginx\\\\html\\\\download\n\nDo note that if there's any file with the same name, it will be overwritten", "type": "text/plain" }, "url": { "path": [ "api", "attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "" } ] } }, "response": [ { "id": "46c9bf11-792d-490e-bfbd-8141eac029fc", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "file", "value": "/C:/Users/user/Desktop/BioStarX_20220124_173247.tgz", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6c8ef6f6-d82e-4f66-a0e0-feeddc9ad119", "name": "Export User Data as CSV (File Upload Example)", "request": { "name": "Export User Data as CSV (File Upload Example)", "description": { "content": "This API is used to export user data as CSV file with customizable columns and headers.\nSupports exporting user information including custom fields and file upload information. The exported CSV file can be downloaded using the `/download/{csv_filename}` endpoint.\n\n**Features:**\n- Customizable column selection and headers\n- Support for custom fields including file upload fields\n- Advanced search criteria integration\n- Flexible user selection (specific IDs, all users, or search results)\n\n**Usage Flow:**\n1. Call this API with desired query parameters and criteria\n2. Get the generated filename from the response\n3. Use the filename with `/download/{csv_filename}` to download the actual CSV file", "type": "text/plain" }, "url": { "path": [ "api", "users", "csv_export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "ID of the Users to export. Use `*` to export all users. To select multiple users use plus sign (+) or space ( ) as separator." }, { "disabled": false, "key": "adv", "value": "", "description": "Enable Advanced Search query result mode" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"offset\": \"\",\n \"group_by\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"headers\": [\n \"\",\n \"\"\n ]\n },\n \"adv_criteria\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "afd488b4-9505-43cb-ad10-e9d453257543", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "csv_export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "*" }, { "key": "adv", "value": "mode1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"offset\": 0,\n \"group_by\": 1,\n \"columns\": [\n \"user_id\",\n \"name\",\n \"email\",\n \"user_group_id\",\n \"access_groups\",\n \"start_datetime\",\n \"expiry_datetime\",\n \"operator_level\",\n \"fingerprint_template_count\",\n \"face_count\",\n \"visual_face_count\",\n \"card_count\",\n \"have_pin\",\n \"qr_count\",\n \"mobile_count\",\n \"disabled\"\n ],\n \"headers\": [\n \"ID\",\n \"Name\",\n \"Email\",\n \"Group\",\n \"Access Group\",\n \"Start datetime\",\n \"End datetime\",\n \"Operator Level\",\n \"Fingerprint\",\n \"Face\",\n \"Visual Face\",\n \"Card\",\n \"PIN\",\n \"QR/Barcode\",\n \"Mobile Access Card\",\n \"Status\"\n ]\n },\n \"adv_criteria\": \"\",\n \"reason\": \"For backup\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe7b79ef-af02-47e9-b619-df745c332cd9", "name": "Import User Data from CSV", "request": { "name": "Import User Data from CSV", "description": { "content": "This API is used to import User Data from a .csv file to the BioStar X database.\n\nTo run this API successfully, it is imperative to run POST `/api/attachments` first to upload the *.csv* file to the server install path.\n\nAfter *.csv* file got uploaded to the server, put the filename value from the above API to the uri and fileName parameter on this API.\n\nFields listed on Query parameter are also used for field mapping between *.csv* file and BioStar X database.\n\nFor example field user_id on Query:headers (*.csv*) will be matched with the first field of Query:columns (BioStar X). 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 X).\n\nTo skip a field from mapping, put empty string (\"\") on the intended field.\n\nIf there's no issue on the import process, the API will shows \"Success\" response. \nIf 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`\n\nIf 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.\n\nTo enter user information in a language other than English or Korean, save the CSV file in UTF-8 format.", "type": "text/plain" }, "url": { "path": [ "api", "users", "csv_import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"File\": {\n \"uri\": \"\",\n \"fileName\": \"\"\n },\n \"CsvOption\": {\n \"start_line\": \"\",\n \"import_option\": \"\"\n },\n \"Query\": {\n \"headers\": [\n \"\",\n \"\"\n ],\n \"columns\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "eb824ec2-13e7-4ea0-aa6d-6c02bb353ab9", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "csv_import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"File\": {\n \"uri\": \"User_Test.csv\",\n \"fileName\": \"User_Test.csv\"\n },\n \"CsvOption\": {\n \"start_line\": 2,\n \"import_option\": 1\n },\n \"Query\": {\n \"headers\": [\n \"user_id\",\n \"name\",\n \"department\",\n \"user_title\",\n \"phone\",\n \"email\",\n \"user_group\",\n \"start_datetime\",\n \"expiry_datetime\",\n \"csn\",\n \"\",\n \"\",\n \"\",\n \"qr\",\n \"26 bit SIA Standard-H10301\",\n \"HID 37 bit-H10302\",\n \"\",\n \"\",\n \"\",\n \"Purpose\",\n \"License Plate Number\",\n \"Hello\",\n \"Hair Color\",\n \"Hair Color 2\",\n \"\",\n \"\",\n \"\"\n ],\n \"columns\": [\n \"user_id\",\n \"name\",\n \"department\",\n \"user_title\",\n \"phone\",\n \"email\",\n \"user_group\",\n \"start_datetime\",\n \"expiry_datetime\",\n \"csn\",\n \"mobile_start_datetime\",\n \"mobile_expiry_datetime\",\n \"csn_mobile\",\n \"qr\",\n \"26 bit SIA Standard-H10301\",\n \"HID 37 bit-H10302\",\n \"HID 37 bit-H10304\",\n \"HID Corporate 1000\",\n \"HID Corporate 1000 48bit\",\n \"face_image_file1\",\n \"face_image_file2\",\n \"pin\",\n \"login_id\",\n \"access_groups\",\n \"fingerprint_template_count\",\n \"face_count\",\n \"visual_face_count\",\n \"card_count\",\n \"have_pin\",\n \"qr_count\",\n \"mobile_count\",\n \"disabled\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c3fb714-1bb2-4c65-889d-680e97a84e91", "name": "Data File Export", "request": { "name": "Data File Export", "description": { "content": "You can store the data file on external storage (USB) and import to BioStar X or device. Up to 500,000 users can be moved from server to device or from device to device.\n\n- The exported data file from devices using older firmware version cannot be imported into BioStar X. Make sure always use the latest version of firmware.\n \n- If you use BioStar 2.8.10 or later, data exported from the previous version of BioStar 2 cannot be imported.\n \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 \n - BioStation 2 FW 1.9.0 or later > device_type: 8\n \n - BioStation A2 FW 1.8.0 or later > device_type: 9\n \n - FaceStation 2 FW 1.4.0 or later > device_type: 10\n \n - FaceStation F2 FW 1.0.0 or later > device_type: 29\n \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 \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- 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 \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 \n- Be sure that the device is selected correctly. Otherwise, the device cannot recognize the data file.", "type": "text/plain" }, "url": { "path": [ "api", "users", "data_export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "User ID(s) to export. Use space as separator for multiple users." }, { "disabled": false, "key": "adv", "value": "", "description": "Enable Advanced Search query mode" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"device_type\": \"\",\n \"group_id\": \"\",\n \"adv_criteria\": \"\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "27daa9c2-01d3-4350-9093-e5dda5ceac3a", "name": "Export completed successfully", "originalRequest": { "url": { "path": [ "api", "users", "data_export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "14 15 16" }, { "key": "adv", "value": "mode1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"device_type\": 35,\n \"group_id\": 1,\n \"adv_criteria\": \"\",\n \"reason\": \"For device migration\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"File\": {\n \"uri\": \"BioStar2_20241103_143708.tgz\"\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25354f79-6344-4176-8788-93c2836f6836", "name": "Data File Import", "request": { "name": "Data File Import", "description": { "content": "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.\n\n* 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 \n * BioStation 2 FW 1.9.0 or later > device_type: 8\n \n * BioStation A2 FW 1.8.0 or later > device_type: 9\n \n * FaceStation 2 FW 1.4.0 or later > device_type: 10\n \n * FaceStation F2 FW 1.0.0 or later > device_type: 29\n \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\nSelect the desired file (*.tgz*) and then click Open.\n\nA success message will appear on the screen when import successfully.\nUse POST `/api/attachments` to upload the file (*.tgz*) to the BioStar 2 server.\nUse the resulting filename on the response as value on the BODY parameter.", "type": "text/plain" }, "url": { "path": [ "api", "users", "data_import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"file\": {\n \"originalName\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bc104fac-7143-4190-91b6-bad3a4274eb6", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "data_import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file\": {\n \"originalName\": \"BioStar2_20241103_143708.tgz\",\n \"name\": \"BioStar2_20241103_143708.tgz\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74826f5b-cfb2-411c-8b4f-55ab1d05915f", "name": "Export User(s) as PDF/SVG with Advanced Search", "request": { "name": "Export User(s) as PDF/SVG with Advanced Search", "description": { "content": "Generate customizable user reports in PDF or SVG format using Advanced Search criteria.\n\n**Prerequisites:**\n- Valid Advanced Search criteria must be provided\n- User must have appropriate permissions to generate reports\n\n**Report Configuration:**\n- Display fields can be customized to show specific user data columns\n- Supports various formatting options (page size, orientation, headers)\n- Includes pagination and footer customization options\n\n**Output Formats:**\n- PDF: For printable reports with consistent formatting\n- SVG: For web display and scalable graphics", "type": "text/plain" }, "url": { "path": [ "api", "users", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "use_centigrade", "value": "" }, { "disabled": false, "key": "adv", "value": "", "description": "Use this to enable Advanced Search query result." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"View\": {\n \"Query\": {\n \"collection_name\": \"\",\n \"object\": \"\",\n \"orders\": [\n {\n \"column\": \"\",\n \"descending\": \"\"\n },\n {\n \"column\": \"\",\n \"descending\": \"\"\n }\n ]\n },\n \"display_fields\": [\n {\n \"name\": \"\",\n \"display_name\": \"\",\n \"display_type\": \"\",\n \"width\": \"\",\n \"enum\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"content_type\": \"\",\n \"page_size\": \"\",\n \"page_portrait\": \"\",\n \"show_title_every_page\": false,\n \"group_by_page_break\": false,\n \"footer_report_date\": true,\n \"footer_comment\": \"\",\n \"footer_display_page_number\": true\n },\n \"adv_criteria\": {\n \"limit\": \"\",\n \"order_by\": \"\",\n \"user_operator_level_id\": \"\",\n \"offset\": \"\",\n \"user_id\": \"\",\n \"user_group_id\": \"\",\n \"user_group_ids\": [\n \"\",\n \"\"\n ],\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"user_phone\": \"\",\n \"user_access_group_ids\": \"\",\n \"user_department\": \"\",\n \"user_title\": \"\",\n \"user_card\": \"\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": \"\"\n },\n \"reaseon\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0a271b11-7314-41de-8331-ea3affe7bf75", "name": "Report generated successfully", "originalRequest": { "url": { "path": [ "api", "users", "report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "use_centigrade", "value": "true" }, { "key": "adv", "value": "mode1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"View\": {\n \"Query\": {\n \"collection_name\": \"UserCollection\",\n \"object\": \"query\",\n \"orders\": [\n {\n \"column\": \"user_id\",\n \"descending\": \"false\"\n }\n ]\n },\n \"display_fields\": [\n {\n \"name\": \"user_id\",\n \"display_name\": \"ID\",\n \"display_type\": \"string\",\n \"width\": 5\n },\n {\n \"name\": \"name\",\n \"display_name\": \"Name\",\n \"display_type\": \"string\",\n \"width\": 9\n },\n {\n \"name\": \"email\",\n \"display_name\": \"Email\",\n \"display_type\": \"string\",\n \"width\": 12\n },\n {\n \"name\": \"user_group_id.name\",\n \"display_name\": \"Group\",\n \"display_type\": \"string\",\n \"width\": 9\n },\n {\n \"name\": \"access_groups\",\n \"display_name\": \"Access Group\",\n \"display_type\": \"objects\",\n \"width\": 9\n },\n {\n \"name\": \"start_datetime\",\n \"display_name\": \"Start datetime\",\n \"display_type\": \"string\",\n \"width\": 7\n },\n {\n \"name\": \"expiry_datetime\",\n \"display_name\": \"End datetime\",\n \"display_type\": \"string\",\n \"width\": 7\n },\n {\n \"name\": \"operator_level\",\n \"display_name\": \"Operator Level\",\n \"display_type\": \"string\",\n \"width\": 9\n },\n {\n \"name\": \"fingerprint_template_count\",\n \"display_name\": \"Fingerprint\",\n \"display_type\": \"string\",\n \"width\": 4\n },\n {\n \"name\": \"face_count\",\n \"display_name\": \"Face\",\n \"display_type\": \"string\",\n \"width\": 4\n },\n {\n \"name\": \"visual_face_count\",\n \"display_name\": \"Visual Face\",\n \"display_type\": \"string\",\n \"width\": 4\n },\n {\n \"name\": \"card_count\",\n \"display_name\": \"Card\",\n \"display_type\": \"string\",\n \"width\": 4\n },\n {\n \"name\": \"have_pin\",\n \"display_name\": \"PIN\",\n \"display_type\": \"string\",\n \"width\": 4\n },\n {\n \"name\": \"qr_count\",\n \"display_name\": \"QR/Barcode\",\n \"display_type\": \"string\",\n \"width\": 4\n },\n {\n \"name\": \"mobile_count\",\n \"display_name\": \"Mobile Access Card\",\n \"display_type\": \"string\",\n \"width\": 4\n },\n {\n \"name\": \"disabled\",\n \"display_name\": \"Status\",\n \"display_type\": \"enum\",\n \"width\": 2,\n \"enum\": [\n \"false=\",\n \"true=Inactive\"\n ]\n }\n ],\n \"name\": \"All Users\",\n \"show_title_every_page\": false,\n \"group_by_page_break\": false,\n \"footer_report_date\": true,\n \"footer_comment\": \"Created by Administrator\",\n \"footer_display_page_number\": true,\n \"content_type\": \"PDF\",\n \"page_size\": \"A4\",\n \"page_portrait\": false\n },\n \"adv_criteria\": {\n \"limit\": 1000,\n \"user_group_ids\": [],\n \"user_group_id\": 1,\n \"user_operator_level_id\": 0,\n \"order_by\": \"user_id:false\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FileCollection\": {\n \"total\": \"1\",\n \"rows\": [\n {\n \"uri\": \"/report/list_20241030093819_7596.pdf\",\n \"type\": \"application/pdf\"\n },\n {\n \"uri\": \"/report/list_20241030093819_7596.pdf\",\n \"type\": \"application/pdf\"\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d823095b-4452-4d04-9427-4d1886473edb", "name": "Create/Update User Private Message", "request": { "name": "Create/Update User Private Message", "description": { "content": "This API is used to create or update User Private Message.\n\nThis API is available starting from BioStar 2 version 2.9.8.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", "phrase", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) User ID of the user to whom the private message will be configured." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"phrase\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bdfc18d2-5819-4225-b6a7-f6b009df91c1", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "users", "phrase", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) User ID of the user to whom the private message will be configured." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"phrase\": \"Good morning. Set private message here.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cde39bad-127f-45e6-b86e-593409f8aeb4", "name": "Delete User Private Message", "request": { "name": "Delete User Private Message", "description": { "content": "This API is used to delete User Private Message.\n\nThis API is available starting from BioStar 2 version 2.9.8.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", "phrase", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) User ID of the user to whom the private message will be deleted." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "cbe1086a-9bdb-4c76-9fb5-0893afa2f68b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "users", "phrase", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) User ID of the user to whom the private message will be deleted." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4226c9dd-6de2-4f39-87c7-497e5cfdcea5", "name": "Fetch User Private Message", "request": { "name": "Fetch User Private Message", "description": { "content": "This API is used to fetch User Private Message.\n\nThis API is available starting from BioStar 2 version 2.9.8.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "users", "phrase", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) User ID of the user to whom the private message will be fetched." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cf08af22-8402-4210-9608-76b56a39dc05", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "users", "phrase", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "userId", "description": "(Required) User ID of the user to whom the private message will be fetched." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user_id\": 12,\n \"phrase\": \"Good morning. You're expected at meeting room 1 at 09.00\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "436769f8-fbed-480b-96d4-a1fbe19b6f9f", "name": "Download File from File Upload Custom Field", "request": { "name": "Download File from File Upload Custom Field", "description": { "content": "This API is used to download the file which contained in a File Upload Custom Field.\n\nThis API is available starting from BioStar 2 v2.9.8.\n\nAfter receiving the response, convert the Base64 data on key `document` to file type specified on key `mimetype`.", "type": "text/plain" }, "url": { "path": [ "api", "user_document", ":UserID", ":customFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "UserID", "description": "(Required) ID of the user which have the intended file." }, { "disabled": false, "type": "any", "value": "", "key": "customFieldID", "description": "(Required) ID of the File Upload Custom Field which contain the file." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d3c860ba-cfed-4e59-926e-d1e2e7f0cc70", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "user_document", ":UserID", ":customFieldID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "UserID", "description": "(Required) ID of the user which have the intended file." }, { "disabled": false, "type": "any", "value": "", "key": "customFieldID", "description": "(Required) ID of the File Upload Custom Field which contain the file." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7919864f-febf-4a2c-953e-dd6811b75e22", "name": "View User & Group", "request": { "name": "View User & Group", "description": { "content": "Retrieves a combined list of **user groups** and **users**, including hierarchical relationships between groups and their members. \n \nThis endpoint is typically used to build a **tree structure** (group → subgroup → user) for user management, filtering, or selection interfaces.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "user", "filter", "user_and_group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "cba3234d-9c96-4870-a68f-68eb6d1b2006", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "user", "filter", "user_and_group" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "key": "transfer-encoding", "value": "chunked", "description": "" }, { "disabled": false, "key": "X-Content-Type-Options", "value": "nosniff", "description": "" }, { "disabled": false, "key": "X-XSS-Protection", "value": "1", "description": "" }, { "disabled": false, "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate", "description": "" }, { "disabled": false, "key": "Pragma", "value": "no-cache", "description": "" }, { "disabled": false, "key": "Expires", "value": "0", "description": "" }, { "disabled": false, "key": "Strict-Transport-Security", "value": "max-age=31536000 ; includeSubDomains", "description": "" }, { "disabled": false, "key": "X-Frame-Options", "value": "SAMEORIGIN", "description": "" }, { "disabled": false, "key": "Content-Security-Policy", "value": "default-src 'self' *.biostar2.com:* localhost:* 127.0.0.1:* blob: data: filesystem: mediastream:;script-src 'self' https://*.biostar2.com https://cdn.jsdelivr.net 'unsafe-inline' 'unsafe-eval';style-src 'self' https://*.biostar2.com 'unsafe-inline';worker-src 'self' blob:;img-src 'self' blob: https://*.openstreetmap.org data:;connect-src 'self' localhost:* https://*.openstreetmap.org;", "description": "" }, { "disabled": false, "key": "Date", "value": "Tue, 21 Oct 2025 07:12:06 GMT", "description": "" }, { "disabled": false, "key": "Referrer-Policy", "value": "no-referrer", "description": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"success\",\n \"by\": \"web\"\n },\n \"UserAndGroupCollection\": {\n \"total\": 10135,\n \"rows\": [\n {\n \"id\": \"userGroup-1\",\n \"name\": \"All\",\n \"disabled\": false,\n \"original_id\": \"1\",\n \"last_child\": false\n },\n {\n \"id\": \"userGroup-11241\",\n \"name\": \"Empty Users\",\n \"disabled\": true,\n \"original_id\": \"11241\",\n \"parent_id\": \"userGroup-1\",\n \"last_child\": true\n },\n {\n \"id\": \"userGroup-11024\",\n \"name\": \"Kumahira\",\n \"disabled\": false,\n \"original_id\": \"11024\",\n \"parent_id\": \"userGroup-1\",\n \"last_child\": false\n },\n {\n \"id\": \"user-9932\",\n \"name\": \"asdfsdfdsfa\",\n \"disabled\": false,\n \"original_id\": \"9932\",\n \"parent_id\": \"userGroup-11024\",\n \"parent_name\": \"Kumahira\",\n \"user_group\": \"Kumahira\",\n \"last_child\": true\n },\n {\n \"id\": \"user-9937\",\n \"name\": \"bobby\",\n \"disabled\": false,\n \"original_id\": \"9937\",\n \"parent_id\": \"userGroup-11024\",\n \"parent_name\": \"Kumahira\",\n \"user_group\": \"Kumahira\",\n \"last_child\": true\n },\n {\n \"id\": \"user-9938\",\n \"name\": \"Hildegaard\",\n \"disabled\": false,\n \"original_id\": \"9938\",\n \"parent_id\": \"userGroup-11024\",\n \"parent_name\": \"Kumahira\",\n \"user_group\": \"Kumahira\",\n \"last_child\": true\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1224cf7-3d81-438f-8a58-7c8d57ad8184", "name": "Delete User(s)", "request": { "name": "Delete User(s)", "description": { "content": "This API is used to delete user(s) from BioStar X.\n\n**Known errors:**\n\n- Empty parameter `id``\n \n- Using `id`` which doesn't exist", "type": "text/plain" }, "url": { "path": [ "api", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "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" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "73332571-eb98-4efd-8c2b-7f659ba8f86e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "{{iterIDVal}}" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "549b43a8-5a0e-4339-87fe-b5dad7f35682", "name": "Batch Edit with Advanced Search", "request": { "name": "Batch Edit with Advanced Search", "description": { "content": "By adding `adv=mode1` on Query Parameter, Batch Edit feature can works with Advanced Search result.\n\nThe API works by query users based on adv_criteria object, then apply new value based on input in User object.", "type": "text/plain" }, "url": { "path": [ "api", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "adv", "value": "", "description": "(Required) Use this to enable Advanced Search query result" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"User\": {\n \"start_datetime\": \"\",\n \"expiry_datetime\": \"\",\n \"disabled\": \"\",\n \"user_group_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"parent_id\": {\n \"id\": \"\"\n }\n },\n \"permission\": {\n \"id\": \"\"\n },\n \"access_groups\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n \"adv_criteria\": {\n \"limit\": \"\",\n \"order_by\": \"\",\n \"user_operator_level_id\": \"\",\n \"offset\": \"\",\n \"user_id\": \"\",\n \"user_group_id\": \"\",\n \"user_group_ids\": [\n \"\",\n \"\"\n ],\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"user_phone\": \"\",\n \"user_access_group_ids\": \"\",\n \"user_department\": \"\",\n \"user_title\": \"\",\n \"user_card\": \"\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "833a9b99-ce7b-4a47-85dc-d76c03653d15", "name": "Batch edit completed successfully", "originalRequest": { "url": { "path": [ "api", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "adv", "value": "mode1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"User\": {\n \"start_datetime\": \"2001-01-02T00:00:00.00Z\",\n \"expiry_datetime\": \"2035-12-31T23:59:00.00Z\",\n \"disabled\": true,\n \"user_group_id\": {\n \"id\": 242894,\n \"name\": \"test 2\",\n \"parent_id\": {\n \"id\": 1\n }\n },\n \"permission\": {\n \"id\": 2\n },\n \"access_groups\": [\n {\n \"id\": \"14\"\n },\n {\n \"id\": \"14\"\n }\n ]\n },\n \"adv_criteria\": {\n \"limit\": 50,\n \"order_by\": \"user_id:false\",\n \"user_operator_level_id\": 0,\n \"offset\": 0,\n \"user_id\": \"11\",\n \"user_group_id\": 1,\n \"user_group_ids\": [\n 1121\n ],\n \"user_name\": \"John\",\n \"user_email\": \"abc@gmail.com\",\n \"user_phone\": \"123-456-7890\",\n \"user_access_group_ids\": \"17,18\",\n \"user_department\": \"Engineering\",\n \"user_title\": \"Manager\",\n \"user_card\": \"123456\",\n \"user_custom_field_1\": \"\",\n \"user_custom_field_2\": \"\",\n \"user_custom_field_3\": \"\",\n \"user_custom_field_4\": \"\",\n \"user_custom_field_5\": \"\",\n \"user_custom_field_6\": \"\",\n \"user_custom_field_7\": \"\",\n \"user_custom_field_8\": \"\",\n \"user_custom_field_9\": \"\",\n \"user_custom_field_10\": \"\",\n \"user_status\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"FailedUserCollection\": {\n \"total\": \"0\",\n \"rows\": [\n {\n \"user_id\": \"string\",\n \"error_message\": \"string\"\n },\n {\n \"user_id\": \"string\",\n \"error_message\": \"string\"\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2267bb1e-075e-4a99-b3e4-df68408a0fa1", "name": "List All User", "request": { "name": "List All User", "description": { "content": "This API is used to list users which is recorded on BioStar X.\n\n**Known errors:**\n\n- Putting \"/\" at the end of the endpoint\n- Using `group_id` which doesn't exist will return success but no records\n\n**Note**: This API is deprecated in BioStar 2 v2.8.12, please use `/api/v2/users/search` instead.", "type": "text/plain" }, "url": { "path": [ "api", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "group_id", "value": "", "description": "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." }, { "disabled": false, "key": "limit", "value": "", "description": "Limit response record(s) by the amount specified on this parameter. 0 for show all." }, { "disabled": false, "key": "offset", "value": "", "description": "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." }, { "disabled": false, "key": "order_by", "value": "", "description": "Order the response record(s) by the User parameter such as user_id or name. False for ascending, True for descending." }, { "disabled": false, "key": "last_modified", "value": "", "description": "Show response record(s) with User last_modified value which is equal or greater than this parameter value." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4c4bcdef-093a-412f-9bb4-c12e1983cd97", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "group_id", "value": "1" }, { "key": "limit", "value": "0" }, { "key": "offset", "value": "0" }, { "key": "order_by", "value": "user_id:false" }, { "key": "last_modified", "value": "0" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "54a178fc-c390-4494-8749-972bf8e8124c", "name": "Device Group", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "af703552-7b52-448e-ae3e-2fc228a14aa7", "name": "View All Device Group", "request": { "name": "View All Device Group", "description": { "content": "This API is used to list all device groups recorded on BioStar X database.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "device_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ecd066e4-c6b8-49bc-a5ae-7a4a0f85f21e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "device_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order_by\": \"depth:false\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aefd43c2-4699-4435-ba45-5651c841cb45", "name": "View Device Group(s) with Criteria & Permission", "request": { "name": "View Device Group(s) with Criteria & Permission", "description": { "content": "This API is used to list all device groups recorded on BioStar 2 database.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "device_groups", "only_permission_item", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e1824759-809f-430d-bcca-66bf699a7c31", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "device_groups", "only_permission_item", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order_by\": \"depth:false\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c7da94a-212a-4875-a8b7-26fdbe8d3921", "name": "Create New Device Group", "request": { "name": "Create New Device Group", "description": { "content": "This API is used to create new device group.", "type": "text/plain" }, "url": { "path": [ "api", "device_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DeviceGroup\": {\n \"name\": \"\",\n \"description\": \"\",\n \"parent_id\": {\n \"id\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5aa2f1c2-caab-40d7-9a28-1d8ef08036a7", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "device_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DeviceGroup\": {\n \"name\": \"New Device Group 1\",\n \"description\": \"Description of the device group\",\n \"parent_id\": {\n \"id\": 1\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3af3ee25-7bda-4f4a-a9be-fb69f737a1f3", "name": "Update Device Group", "request": { "name": "Update Device Group", "description": { "content": "This API is used to update a device group.", "type": "text/plain" }, "url": { "path": [ "api", "device_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device group which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "65cdcc12-4b82-4920-a3d4-27c132dc9562", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "device_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device group which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb154121-2e6d-4eb0-98a7-39fdbd67840c", "name": "Delete Device Group", "request": { "name": "Delete Device Group", "description": { "content": "This API is used to delete device group.", "type": "text/plain" }, "url": { "path": [ "api", "device_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device group which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "8100ee9b-ffcb-4fbe-9ab2-f4de6e0e4518", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "device_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device group which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d592cfbe-3e01-4847-9a59-2d1bef7d21b2", "name": "Device", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e5a79cc8-29a3-4fa9-ab6e-c5b8a687581f", "name": "Write Card Data", "request": { "name": "Write Card Data", "description": { "content": "This API is used to create Access on Card and write data to a card (Smart Card, etc.) using the specified device. The device must have a Smart Card layout configured before running this API.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":device_id", "write_card" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "device_id", "description": "(Required) 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." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"SmartCard\": {\n \"user_id\": {\n \"user_id\": \"\",\n \"fingerprint_templates\": [\n {\n \"finger_index\": \"\"\n },\n {\n \"finger_index\": \"\"\n }\n ],\n \"visual_face_templates\": [\n \"\",\n \"\"\n ]\n },\n \"card_id\": {\n \"card_id\": \"\",\n \"card_type_id\": {\n \"id\": \"\"\n },\n \"use_alphanumeric_user_id\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5ac7ee5c-3daa-40f2-ab7f-67db5196f800", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":device_id", "write_card" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "device_id", "description": "(Required) 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." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"SmartCard\": {\n \"user_id\": {\n \"user_id\": 8,\n \"fingerprint_templates\": [\n {\n \"finger_index\": 0\n }\n ]\n },\n \"card_id\": {\n \"card_id\": 8,\n \"card_type_id\": {\n \"id\": 3\n },\n \"use_alphanumeric_user_id\": false\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cfc0f3d-5d76-43cc-ad0c-67c95c433df9", "name": "Verify Fingerprint Scan", "request": { "name": "Verify Fingerprint Scan", "description": { "content": "This API is used to compare 2 fingerprint scan to determine whether it's the same finger or not.\n\nAs 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.\n\nTo 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`.\n\nIt will return HTTP 200 and shows message result: true on success, HTTP 500 and shows message result: false on failure.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":dev_id", "verify_fingerprint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "dev_id", "description": "(Required) Unique identifier of the device to perform fingerprint verification" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FingerprintTemplate\": {\n \"template0\": \"\",\n \"template1\": \"\"\n },\n \"VerifyFingerprintOption\": {\n \"security_level\": \"0\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "455ecc11-8054-4a4a-b175-d92e9318e14b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":dev_id", "verify_fingerprint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "dev_id", "description": "(Required) Unique identifier of the device to perform fingerprint verification" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FingerprintTemplate\": {\n \"template0\": \"RSoQFLAAVUYMBEBvBBlEsWSLFITAEIUGBgEYBA/G0W0IAwcgdgEbh2ANixfIMGUKEshwF4QOCbBzhjXEsaCFJITQAYohRSBViCSGoUsRLAcQooYoh6GlCDpIgZ2GKMkARgkyCXCehDhJgEIDG0sxYJsOy0BziBaMcGmPG4ywUaAVTdBokwxOEXgHEE6AeIIVT0FoERfPYBsxGg9gK9EK0QB4jRxSYRqFEhNAbxkXk1AUChiTUHSHL8zwl4EmDiE3CCHPADWKK5DAOo8nUZAqDS5SIUKXK9JhOZj////g/////////eAB///////d4AEi/////N3gASM////M3eABIzT/+7zd4BIzRE+7u83gEjNET7u7zeASNERFu7vN4BI0REW6u8zgIzRERaqqvOAjRERFqqq84TREREWqqrziNFVUT6mqvOJFVVVfqqq9BFVVVU/5qrqHd2ZU//+qqZiIdkT///qqqZh1T///+6qqqYX/////u6uqj///\",\n \"template1\": \"RSgQFK8AVUYRBDBvhxqEgBGFHsSRZwsIhRF1BQtGIRuEFsZxawgJRwB5AR4H4GULGYgQF4UUyYB0hyqEsAOJJsTRWIgrRkBKjyKG4QoLMsbwooQvB3GkBi9I0EYHOUnBnQMJSgF4ghXK8HWKHYwQZ5EIzQAfhRPN4XsEHA4BbBYXzhB5hRzO8WaYB89AdoQeT0AdsQgQAHiJDlFQdoIiSvFfHCLMcE4iNszwmAIszkE2hihO8DQJIM9QKkMxEJA3CC4RwCeOIlKBHAMxEsBFIv///d3////////M3eD/////+8zd4BL///+7zN3gEj//+rvM3eASM/+qu8zd4BIzT6q7vM3gEjRFqqq7zeASNESqqrvN4CNERaqqq7zhI0RFqqqrvdfsagfsgagOE0REWqqqq84jRFVaqqqrwDRFVVqqmavQRVVVWqqqq9JVVVVvq7qqmHdmZv/6qqqZiHZm//+qqqmZhV////u6qqmFT///+7uqqoT/8=\"\n },\n \"VerifyFingerprintOption\": {\n \"security_level\": \"0\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79a959e4-34ab-4961-b39c-f11e19c37a79", "name": "Verify Duplicate Fingerprint", "request": { "name": "Verify Duplicate Fingerprint", "description": { "content": "This API is used to verify duplicate fingerprint.\n\nIf fingerprint already exist, it will return success (HTTP 200) and response will show the user which currently using the fingerprint.\n\nUse the result of `POST /api/devices/:dev_id/scan_fingerprint` for the value of parameter template (either the 1st or 2nd scan).\n\nIf fingerprint available, it will return server error (HTTP 500) with response showing message \"Failed to identify fingerprint.\".", "type": "text/plain" }, "url": { "path": [ "api", "server_matching", "identify_finger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ServerMatching\": {\n \"template\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4e1f47fb-9f9c-48e7-9956-35bf30d015b1", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "server_matching", "identify_finger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ServerMatching\": {\n \"template\": \"AA4NE6cAVUYXwGEODRaBgWmJGoLhCoUTw+BohB0EYWaJIMKAWIkiAsAJijED4K6JJ8ehAwkwCFCyhCYIoFcLLQjRVoQeyTFligMJUG2GD0vxcQYezkFpjAIO4HWbFU9RcwUgD4Fnkx9QsWwPCpDhcgkfkZFoiydJwAMJJQrRXAknDABTCCsP4aCJJhBABJ4m0PGqoSqRYKkXKRIQCJ7//93v//////3d7/////zN3uAP//zM3e4AH8zMzN7gAfzMzM3uARK8zM3e4AEbvMzd7gARu8zM3uARHMzMze4BEczMzN3gESu7vMzeARK7u8zN4BI7u7vM3gIjqru7vOAzT6u7u84TRP+7zMzRNE//zMzN4jP//8zM3hLw\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50adcd92-d108-40c7-9104-8ef684377ee8", "name": "View Waiting Devices", "request": { "name": "View Waiting Devices", "description": { "content": "This API is used to view device(s) which is on waiting list after changing connection mode from **Server** > **Device to Device** > **Server**.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "waiting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "66c83053-2d4a-4b43-a31b-a90fa7423b55", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "waiting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "833f2ae0-e397-4408-a8d9-5e842488a9ac", "name": "Add Slave Device", "request": { "name": "Add Slave Device", "description": { "content": "This example shows how to add slave device to BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"device_type_id\": {\n \"id\": \"\"\n },\n \"parent_device_id\": {\n \"id\": \"\"\n },\n \"rs485\": {\n \"mode\": \"\",\n \"connected_channel_index\": \"\",\n \"parent_rs485_info\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"device_type_id\": {\n \"id\": \"\"\n },\n \"parent_device_id\": {\n \"id\": \"\"\n },\n \"rs485\": {\n \"mode\": \"\",\n \"connected_channel_index\": \"\",\n \"parent_rs485_info\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4a12d170-6a72-47a6-ac31-3fa098d04b11", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"40059024\",\n \"name\": \"BioStation 3 40059024\",\n \"device_type_id\": {\n \"id\": 35\n },\n \"parent_device_id\": {\n \"id\": 40059023\n },\n \"rs485\": {\n \"mode\": \"2\",\n \"connected_channel_index\": \"0\",\n \"parent_rs485_info\": \"RS485 Port 0\"\n }\n },\n {\n \"id\": \"40059024\",\n \"name\": \"BioStation 3 40059024\",\n \"device_type_id\": {\n \"id\": 35\n },\n \"parent_device_id\": {\n \"id\": 40059023\n },\n \"rs485\": {\n \"mode\": \"2\",\n \"connected_channel_index\": \"0\",\n \"parent_rs485_info\": \"RS485 Port 0\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b433f7d-4ce7-43f4-9e10-b2065c75197d", "name": "List All Added Device(s)", "request": { "name": "List All Added Device(s)", "description": { "content": "This API is used to view all devices added to BioStar X.\n\n**Status response for this API:**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| status | Integer | Connection status of the device.
0: Disconnected
1: Connected
2: Sync Error |", "type": "text/plain" }, "url": { "path": [ "api", "devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0a4921d0-e79e-482f-b0a9-2b7dec8b5f16", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ee46827-1f8c-4ecb-bbfd-7227c85c602e", "name": "Remove Device(s)", "request": { "name": "Remove Device(s)", "description": { "content": "This API is used to delete device(s).", "type": "text/plain" }, "url": { "path": [ "api", "devices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "ID of the device(s) which will be deleted. To delete multiple device use plus (+) sign as separator." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "1083c3b7-db18-4150-b171-dd39a8a866e9", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "543408590" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4a23b47-5cf1-4a00-bce9-a5f56f00cf46", "name": "Update Device", "request": { "name": "Update Device", "description": { "content": "This API is used to update device's configuration. \nPut value which will be updated on the respective body parameter and remove any parameters which will not be updated.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Device\": {\n \"name\": \"\",\n \"device_group_id\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"lan\": {\n \"connection_mode\": \"\",\n \"enable_dhcp\": \"\",\n \"use_dns\": \"\",\n \"ip\": \"\",\n \"device_port\": \"\",\n \"gateway\": \"\",\n \"subnet_mask\": \"\",\n \"server_port\": \"\",\n \"server_ip\": \"\"\n },\n \"usb\": {\n \"enable_usb\": \"\",\n \"enable_usb_memory\": \"\"\n },\n \"wlan\": {\n \"enabled\": \"\",\n \"operation_mode\": \"\",\n \"auth_type\": \"\",\n \"encryption_type\": \"\"\n },\n \"rs485\": {\n \"mode\": \"\",\n \"intelligentInfo\": {\n \"supportIConfig\": \"\",\n \"useFailCode\": \"\",\n \"failCodeFormat\": \"\",\n \"failCode\": \"\",\n \"osdpID\": \"\",\n \"cardFormat\": \"\"\n },\n \"channels\": [\n {\n \"index\": \"\",\n \"mode\": \"\",\n \"baudrate\": \"\"\n },\n {\n \"index\": \"\",\n \"mode\": \"\",\n \"baudrate\": \"\"\n }\n ]\n },\n \"authentication\": {\n \"matching_timeout\": \"\",\n \"auth_timeout\": \"\",\n \"enable_private_auth\": \"\",\n \"enable_server_matching\": \"\",\n \"face_detection_level\": \"\",\n \"enable_full_access\": \"\",\n \"operation_modes\": [\n {\n \"mode\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"operators\": [\n \"\",\n \"\"\n ],\n \"enable_card_Id_from_keypad\": \"\"\n },\n {\n \"mode\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"operators\": [\n \"\",\n \"\"\n ],\n \"enable_card_Id_from_keypad\": \"\"\n }\n ]\n },\n \"card\": {\n \"use_csn\": \"\",\n \"use_mifare_felica\": \"\",\n \"use_em\": \"\",\n \"use_wiegand\": \"\",\n \"use_iclass\": \"\",\n \"use_HIDprox\": \"\",\n \"use_smart\": \"\",\n \"use_SEOS\": \"\",\n \"use_SR_SE\": \"\",\n \"use_desfire_ev1\": \"\",\n \"use_classic_plus\": \"\",\n \"use_mobile\": \"\",\n \"use_BLE\": \"\",\n \"use_NFC\": \"\",\n \"byte_order\": \"\",\n \"use_wiegand_format\": \"\",\n \"card_layout\": {\n \"id\": \"\"\n }\n },\n \"display\": {\n \"language\": \"\",\n \"background\": \"\",\n \"background_theme\": \"\",\n \"volume\": \"\",\n \"use_voice\": \"\",\n \"menu_timeout\": \"\",\n \"message_timeout\": \"\",\n \"backlight_timeout\": \"\",\n \"display_datetime\": \"\",\n \"date_type\": \"\",\n \"time_format\": \"\",\n \"home_formation\": \"\",\n \"shortcut_home\": \"\",\n \"device_private_message\": \"\",\n \"server_private_message\": \"\",\n \"use_screen_saver\": \"\",\n \"sounds\": [\n \"\",\n \"\"\n ]\n },\n \"system\": {\n \"timezone\": \"\",\n \"sync_time\": \"\",\n \"locked\": \"\",\n \"interphone_type\": \"\",\n \"camera_frequency\": \"\",\n \"use_alphanumeric\": \"\",\n \"enable_clear_on_tamper\": \"\",\n \"enable_data_encryption\": \"\",\n \"use_card_operation\": \"\"\n },\n \"wiegand\": {\n \"wiegand_in_out\": \"\",\n \"out_pulse_width\": \"\",\n \"out_pulse_interval\": \"\",\n \"enable_bypass_mode\": \"\",\n \"format_id\": {\n \"id\": \"\"\n },\n \"enable_fail_code\": \"\",\n \"fail_code\": \"\",\n \"wiegand_output_info\": \"\",\n \"wiegand_csn_id\": {\n \"id\": \"\"\n },\n \"wiegand_cards\": [\n \"\",\n \"\"\n ],\n \"wiegand_inputs\": [\n \"\",\n \"\"\n ]\n },\n \"tna\": {\n \"mode\": \"\",\n \"fixed_code\": \"\",\n \"required\": \"\",\n \"tna_keys\": [\n {\n \"order\": \"\",\n \"key\": \"\",\n \"keyName\": \"\",\n \"schedule_id\": {},\n \"label\": \"\"\n },\n {\n \"order\": \"\",\n \"key\": \"\",\n \"keyName\": \"\",\n \"schedule_id\": {},\n \"label\": \"\"\n }\n ]\n },\n \"input\": {\n \"input_port_num\": \"\",\n \"supervised_inputs\": \"\"\n },\n \"event_filter\": {\n \"rows\": [\n \"\",\n \"\"\n ],\n \"total\": \"\"\n },\n \"voip\": {\n \"use\": \"\",\n \"server\": {\n \"address\": \"\",\n \"user_id\": \"\",\n \"password\": \"\",\n \"port\": \"\"\n },\n \"dtmf\": {\n \"mode\": \"\",\n \"exit_button\": \"\"\n },\n \"phonebook_list\": [\n \"\",\n \"\"\n ]\n },\n \"barcode\": {\n \"use_barcode\": \"\",\n \"scan_timeout\": \"\"\n },\n \"pktversion\": \"\",\n \"support_occupancy\": \"\",\n \"thermal_config\": {\n \"enable_thermal_camera\": \"\",\n \"enable_centigrade\": \"\",\n \"temperature_threshold_high\": \"\",\n \"enable_audit_temperature\": \"\",\n \"enable_temperature_reject_sound\": \"\",\n \"enable_overlap_thermal\": \"\",\n \"temperature_checkmode\": \"\",\n \"enable_mask\": \"\",\n \"mask_detection_level\": \"\",\n \"enable_dynamic_roi\": \"\"\n },\n \"thermal_camera_config\": {\n \"distance\": \"\",\n \"emissivity\": \"\",\n \"roi_x\": \"\",\n \"roi_y\": \"\",\n \"roi_width\": \"\",\n \"roi_height\": \"\",\n \"enable_body_compensation\": \"\",\n \"compensation_temperature\": \"\"\n },\n \"trigger_actions\": \"\",\n \"authmode\": {\n \"id\": \"\",\n \"extAuthModeSupported\": \"\",\n \"cardAuthSupported\": \"\",\n \"cardAuthMask\": \"\",\n \"fingerprintAuthSupported\": \"\",\n \"fingerprintAuthMask\": \"\",\n \"faceAuthSupported\": \"\",\n \"faceAuthMask\": \"\",\n \"idAuthSupported\": \"\",\n \"idAuthMask\": \"\"\n },\n \"card_supported_from_device\": {\n \"mask\": \"\",\n \"em4100\": \"\",\n \"HIDProx\": \"\",\n \"mifare_felica\": \"\",\n \"iCLASS\": \"\",\n \"mifareClassic_Plus\": \"\",\n \"Desfire_ev1\": \"\",\n \"iCLASSSRSE\": \"\",\n \"iCLASSSEOS\": \"\",\n \"NFC\": \"\",\n \"BLE\": \"\",\n \"use_card_operation\": \"\"\n },\n \"capability\": {\n \"thermalAuthSupported\": \"\",\n \"maskAuthSupported\": \"\",\n \"intelligentPDSupported\": \"\"\n },\n \"imageLogEventInfo\": {\n \"imageLogEventItems\": [\n \"\",\n \"\"\n ]\n },\n \"use_image_log\": \"\",\n \"dst1\": \"\",\n \"dst2\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "08f4d881-d694-4101-a462-a6a31fd0adc5", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Device\": {\n \"name\": \"FaceStation 2 542353521 (192.168.1.23)\",\n \"device_group_id\": {\n \"id\": 47,\n \"name\": \"Suprema\"\n },\n \"lan\": {\n \"connection_mode\": 1,\n \"enable_dhcp\": false,\n \"use_dns\": false,\n \"ip\": \"192.168.1.23\",\n \"device_port\": 51211,\n \"gateway\": \"192.168.1.1\",\n \"subnet_mask\": \"255.255.255.0\",\n \"server_port\": 51212,\n \"server_ip\": \"192.168.1.5\"\n },\n \"usb\": {\n \"enable_usb\": false,\n \"enable_usb_memory\": false\n },\n \"wlan\": {\n \"enabled\": false,\n \"operation_mode\": 0,\n \"auth_type\": 0,\n \"encryption_type\": 0\n },\n \"rs485\": {\n \"mode\": 3,\n \"intelligentInfo\": {\n \"supportIConfig\": false,\n \"useFailCode\": false,\n \"failCodeFormat\": 1,\n \"failCode\": \"0000000000000000\",\n \"osdpID\": 0,\n \"cardFormat\": 0\n },\n \"channels\": [\n {\n \"index\": 0,\n \"mode\": 1,\n \"baudrate\": 115200\n },\n {\n \"index\": 0,\n \"mode\": 1,\n \"baudrate\": 115200\n }\n ]\n },\n \"authentication\": {\n \"matching_timeout\": \"5\",\n \"auth_timeout\": \"5\",\n \"enable_private_auth\": true,\n \"enable_server_matching\": false,\n \"face_detection_level\": \"0\",\n \"enable_full_access\": false,\n \"operation_modes\": [\n {\n \"mode\": 0,\n \"schedule_id\": {\n \"id\": 1\n },\n \"enable_card_Id_from_keypad\": false\n },\n {\n \"mode\": 0,\n \"schedule_id\": {\n \"id\": 1\n },\n \"enable_card_Id_from_keypad\": false\n }\n ]\n },\n \"card\": {\n \"use_csn\": true,\n \"use_mifare_felica\": true,\n \"use_em\": true,\n \"use_wiegand\": false,\n \"use_iclass\": false,\n \"use_HIDprox\": false,\n \"use_smart\": true,\n \"use_SEOS\": false,\n \"use_SR_SE\": false,\n \"use_desfire_ev1\": true,\n \"use_classic_plus\": true,\n \"use_mobile\": true,\n \"use_BLE\": false,\n \"use_NFC\": true,\n \"byte_order\": \"0\",\n \"use_wiegand_format\": false,\n \"card_layout\": {\n \"id\": \"2\"\n }\n },\n \"display\": {\n \"language\": \"1\",\n \"background\": \"0\",\n \"background_theme\": \"1\",\n \"volume\": \"50\",\n \"use_voice\": false,\n \"menu_timeout\": \"20\",\n \"message_timeout\": \"2000\",\n \"backlight_timeout\": \"20\",\n \"display_datetime\": true,\n \"date_type\": \"0\",\n \"time_format\": \"0\",\n \"home_formation\": \"5\",\n \"shortcut_home\": \"\",\n \"device_private_message\": false,\n \"server_private_message\": false,\n \"use_screen_saver\": false\n },\n \"system\": {\n \"timezone\": 28800,\n \"sync_time\": true,\n \"locked\": false,\n \"interphone_type\": 0,\n \"camera_frequency\": \"60\",\n \"use_alphanumeric\": false,\n \"enable_clear_on_tamper\": true,\n \"enable_data_encryption\": false,\n \"use_card_operation\": true\n },\n \"wiegand\": {\n \"wiegand_in_out\": \"0\",\n \"out_pulse_width\": \"40\",\n \"out_pulse_interval\": \"10000\",\n \"enable_bypass_mode\": false,\n \"format_id\": {\n \"id\": \"0\"\n },\n \"enable_fail_code\": false,\n \"fail_code\": \"0\",\n \"wiegand_output_info\": \"1\",\n \"wiegand_csn_id\": {\n \"id\": \"-1\"\n }\n },\n \"tna\": {\n \"mode\": \"1\",\n \"fixed_code\": 0,\n \"required\": false,\n \"tna_keys\": [\n {\n \"order\": 1,\n \"key\": 0,\n \"keyName\": \"Code 1\",\n \"schedule_id\": {},\n \"label\": \"\"\n },\n {\n \"order\": 1,\n \"key\": 0,\n \"keyName\": \"Code 1\",\n \"schedule_id\": {},\n \"label\": \"\"\n }\n ]\n },\n \"input\": {\n \"input_port_num\": \"0\",\n \"supervised_inputs\": \"\"\n },\n \"event_filter\": {\n \"total\": \"0\"\n },\n \"voip\": {\n \"use\": false,\n \"server\": {\n \"address\": \"\",\n \"user_id\": \"\",\n \"password\": \"\",\n \"port\": \"\"\n },\n \"dtmf\": {\n \"mode\": \"0\",\n \"exit_button\": \"0\"\n }\n },\n \"barcode\": {\n \"use_barcode\": false,\n \"scan_timeout\": \"4\"\n },\n \"pktversion\": \"3\",\n \"support_occupancy\": true,\n \"thermal_config\": {\n \"enable_thermal_camera\": \"0\",\n \"enable_centigrade\": \"1\",\n \"temperature_threshold_high\": \"3800\",\n \"enable_audit_temperature\": true,\n \"enable_temperature_reject_sound\": true,\n \"enable_overlap_thermal\": true,\n \"temperature_checkmode\": \"0\",\n \"enable_mask\": \"0\",\n \"mask_detection_level\": \"0\",\n \"enable_dynamic_roi\": false\n },\n \"thermal_camera_config\": {\n \"distance\": \"100\",\n \"emissivity\": \"98\",\n \"roi_x\": \"47\",\n \"roi_y\": \"45\",\n \"roi_width\": \"15\",\n \"roi_height\": \"10\",\n \"enable_body_compensation\": true,\n \"compensation_temperature\": \"0\"\n },\n \"trigger_actions\": \"\",\n \"authmode\": {\n \"id\": \"542353521\",\n \"extAuthModeSupported\": false,\n \"cardAuthSupported\": true,\n \"cardAuthMask\": \"0\",\n \"fingerprintAuthSupported\": true,\n \"fingerprintAuthMask\": \"0\",\n \"faceAuthSupported\": false,\n \"faceAuthMask\": \"990979\",\n \"idAuthSupported\": true,\n \"idAuthMask\": \"0\"\n },\n \"card_supported_from_device\": {\n \"mask\": \"2147483957\",\n \"em4100\": true,\n \"HIDProx\": false,\n \"mifare_felica\": true,\n \"iCLASS\": false,\n \"mifareClassic_Plus\": true,\n \"Desfire_ev1\": true,\n \"iCLASSSRSE\": false,\n \"iCLASSSEOS\": false,\n \"NFC\": true,\n \"BLE\": false,\n \"use_card_operation\": true\n },\n \"capability\": {\n \"thermalAuthSupported\": \"1\",\n \"maskAuthSupported\": \"0\",\n \"intelligentPDSupported\": \"0\"\n },\n \"imageLogEventInfo\": {},\n \"use_image_log\": false,\n \"dst1\": \"0\",\n \"dst2\": \"0\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "658faf16-15ad-44cb-9ddf-5497ac67c5ec", "name": "View Device Information", "request": { "name": "View Device Information", "description": { "content": "This API is used to view device's information.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which information will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "833b4bdd-765d-4fc1-9a9b-0a15bc8e53db", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which information will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec53177c-9678-41b3-8c7e-41ba35846b26", "name": "Update Device Homescreen", "request": { "name": "Update Device Homescreen", "description": { "content": "Updates the homescreen display resources for one or more BioStar X devices.\nThis API allows you to customize the device display with custom images, logos, or notices that appear on the device's homescreen.\n\n**Prerequisites**\nBefore using this API, you must first configure the device's display settings using the Update Device API (`/api/devices/{id}`) with the following parameters:\n- `background`: Display mode (`0`=Default, `2`=Slide Show)\n- `background_theme`: Content type (`0`=Normal, `1`=Notice, `2`=Logo)\n\n ``` json\n\n{\n \"Device\": {\n \"display\": {\n \"background\": \"0\"\n \"background_theme\": \"2\"\n }\n }\n}\n```\nFor Slide Show mode, set both `background` and `background_theme` to \"2\".", "type": "text/plain" }, "url": { "path": [ "api", "resources", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"total\": \"\",\n \"rows\": [\n {\n \"id\": \"\"\n }\n ]\n },\n \"ResourceDataCollection\": {\n \"total\": \"\",\n \"type\": \"\",\n \"rows\": [\n {\n \"slot\": \"\",\n \"data\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "454b99e4-917e-4ab2-bd24-b3bbc635f12e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "resources", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"total\": 2,\n \"rows\": [\n {\n \"id\": \"538152248\"\n },\n {\n \"id\": \"538152254\"\n }\n ]\n },\n \"ResourceDataCollection\": {\n \"total\": 1,\n \"type\": \"2\",\n \"rows\": [\n {\n \"slot\": 0,\n \"data\": \"iVBORw0KGgoAAAANSUhEUgAAAtAAAALg8gAAAABJRU5ErkJggg==\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfed7060-1941-4a27-baa8-515f742fa7fb", "name": "List Device Types", "request": { "name": "List Device Types", "description": { "content": "This API is used to list Suprema devices recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "device_types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c7fc80c6-8abb-407d-8d39-07ce8ade3c54", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "device_types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fdf1438b-81da-4d3f-8237-626f7948b71d", "name": "View Device(s) Based on Enrollment Type", "request": { "name": "View Device(s) Based on Enrollment Type", "description": { "content": "This API is used to view device(s) based on its enrollment capabilities.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "", "description": "Device enrollment type. `0`=All, `1`=Finger, `2`=CSN, `3`= Smart, `4`=Face, `5`=Visual Face" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e91dd67d-fd8d-42e8-8ee0-52e4577d4571", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "0" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4236464e-2761-434b-bbc5-1d60eddc48ae", "name": "List Added Device(s) with Criteria", "request": { "name": "List Added Device(s) with Criteria", "description": { "content": "This API is used to list devices with parameters to filter the result.\nIt is required to at least put {} for the API to run correctly.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "devices", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"limit\": \"\",\n \"exclude_device_type_id\": \"\",\n \"order_by\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "947f35c1-572e-4697-b3be-a1bae251629d", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "devices", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 0,\n \"exclude_device_type_id\": 254,\n \"order_by\": \"id:false\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": 1,\n \"user_sync_status\": 0\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ca88af0-bcb7-435b-83c1-d9f2072c103e", "name": "View Device Configuration", "request": { "name": "View Device Configuration", "description": { "content": "This API is used to view device's configuration.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which information will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3bba292c-cfac-4dde-90f9-373535bbae4e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which information will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c248ce66-940f-48ae-b289-1a0ab4172327", "name": "View User Statistics in a Device", "request": { "name": "View User Statistics in a Device", "description": { "content": "This API is used to view user statistics in a device.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "discover_userdata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b379c742-8567-4929-9465-b2677a8c0e40", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "discover_userdata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35935a33-bef5-4f6f-8712-bb76aeba6dce", "name": "View Device Capabilities", "request": { "name": "View Device Capabilities", "description": { "content": "This API is used to list device's capabilities such as fingerprint, wifi, etc.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "capability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b38d2f04-fb64-4c39-b28f-69ba88db6d1c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "capability" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": 544140034\n },\n {\n \"id\": 544140034\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5917427e-21ea-4d41-8ca1-d66a28241218", "name": "Sync Device Data", "request": { "name": "Sync Device Data", "description": { "content": "This API is used to sync device's data with BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "sync" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "clean", "value": "", "description": "Toggle true to delete data on the device before sync process." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8455bd56-a52a-40ee-8af1-89ab678a526e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "sync" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "clean", "value": "false" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": 544140034\n },\n {\n \"id\": 544140034\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abb07262-0116-43bc-b7e5-6fec7db1151b", "name": "Unlock Device", "request": { "name": "Unlock Device", "description": { "content": "This API is used to set a device state to unlocked.\n\nManually unlocked device state will persist until it's normalized.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "unlock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7d6628b1-efc3-4735-8673-99afa8ca489c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "unlock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": 544140034\n },\n {\n \"id\": 544140034\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7071f00d-7901-4eda-8a89-b91521c196a5", "name": "Search Devices (TCP)", "request": { "name": "Search Devices (TCP)", "description": { "content": "This API is used to view device's information using TCP.\n\n\nThis API only works for devices which haven't been added to BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "tcp_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Device\": {\n \"lan\": {\n \"ip\": \"\",\n \"device_port\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "00ef390a-89fe-49f7-ad84-33cb56239a68", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "tcp_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Device\": {\n \"lan\": {\n \"ip\": \"192.168.1.25\",\n \"device_port\": 51211\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "deff534c-f256-4a3f-a55c-f5bd3da26622", "name": "Search Devices (UDP)", "request": { "name": "Search Devices (UDP)", "description": { "content": "This API is used to search devices through UDP.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "udp_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"UdpSearchOption\": {\n \"timeout\": \"\",\n \"with_rs485\": \"\",\n \"hide_known_devices\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d2f19c8f-fbaa-493d-872b-b4aad00de99a", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "udp_search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"UdpSearchOption\": {\n \"timeout\": 3,\n \"with_rs485\": true,\n \"hide_known_devices\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f6cec51-c24f-4fbb-b308-09a8359ce94f", "name": "View Device IP Settings", "request": { "name": "View Device IP Settings", "description": { "content": "This API is used to get the IP settings of a device which have not been added to BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "udp_get" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Device\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "778da0cb-0c98-42ac-bf9c-5509bc82a502", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "udp_get" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Device\": {\n \"id\": 543408590\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd77d862-b4e6-4b72-9ae4-c61de457af84", "name": "Update Device IP Settings", "request": { "name": "Update Device IP Settings", "description": { "content": "This API is used to update IP settings on device which have not been added to BioStar X.\n\nIt is required to fill in the id parameter with the id of the device which the IP settings will be updated.\n\nFill in the required value on the respective parameters and remove those which is not required.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "udp_put" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Device\": {\n \"id\": \"\",\n \"lan\": {\n \"connection_mode\": \"\",\n \"enable_dhcp\": \"\",\n \"use_dns\": \"\",\n \"ip\": \"\",\n \"device_port\": \"\",\n \"gateway\": \"\",\n \"subnet_mask\": \"\",\n \"server_port\": \"\",\n \"server_ip\": \"\"\n },\n \"device_type_id\": {\n \"id\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f96ba6b1-d51d-45e9-809d-2eff680e913c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "udp_put" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Device\": {\n \"id\": 543408590,\n \"lan\": {\n \"connection_mode\": 0,\n \"enable_dhcp\": false,\n \"use_dns\": false,\n \"ip\": \"192.168.1.25\",\n \"device_port\": 51211,\n \"gateway\": \"192.168.1.1\",\n \"subnet_mask\": \"255.255.255.0\",\n \"server_port\": 51212,\n \"server_ip\": \"192.168.1.5\"\n },\n \"device_type_id\": {\n \"id\": 31\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e44f633e-057c-46b2-b801-5639e6d18f24", "name": "Connect Device", "request": { "name": "Connect Device", "description": { "content": "This API is used to connect a device which have been disconnected.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "connect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be connected" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "c25d8f15-a2ac-4212-894b-eeea247b5ec2", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "connect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be connected" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "51f52fce-26ce-4156-a91d-0b965dea7ea8", "name": "Disconnect Device", "request": { "name": "Disconnect Device", "description": { "content": "This API is used to disconnect a device connection from BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "disconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be disconnected" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "1b2a3cf2-d22d-4b99-ba1a-3cb19d676665", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "disconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be disconnected" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd7e62fd-3e70-448d-8311-71168cd548e1", "name": "Find Wiegand", "request": { "name": "Find Wiegand", "description": { "content": "This API is used to find wiegand device attached to master device.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "discover_wiegand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the master device" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "2e308e2e-9a95-418e-9008-9bad6efe34a9", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "discover_wiegand" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the master device" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8afdbb2-cae0-481f-8bb7-ea779dabd51d", "name": "Find Slave Device", "request": { "name": "Find Slave Device", "description": { "content": "This API is used to find slave device attached to a master device.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "discover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the master device" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "12be2ee5-9fe3-45a3-ab7b-e86405b2452c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "discover" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the master device" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "293f96ae-8095-4def-821a-a57a489b5a8c", "name": "Clear Device Alarm", "request": { "name": "Clear Device Alarm", "description": { "content": "This API is used to clear alarm from a device.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "clear_alarm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c92f0877-a345-4d48-839e-2c5f66ba48c7", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "clear_alarm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": 542353521\n },\n {\n \"id\": 542353521\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74eeed2e-1a97-4c4e-9e39-6151f5143413", "name": "View Total User on a Device", "request": { "name": "View Total User on a Device", "description": { "content": "This API is used to view user data summary from a device.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of response's records by the specified value. (Default=`50`)" }, { "disabled": false, "key": "page", "value": "", "description": "Filter the response based on the specified page number. (Default=`1`)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5203f1fe-341c-4a12-b4ac-2faded2f771e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "20" }, { "key": "page", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f23fe2b5-29c9-425f-99fb-100d5bfc8397", "name": "Delete User from a Device", "request": { "name": "Delete User from a Device", "description": { "content": "This API is used to delete user data on a device.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "ID of the user which will be deleted. Use (*) for all user." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which the user data will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "9a43bc6d-ed2d-48f6-aae8-681e51841ec1", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "*" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which the user data will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "732f5482-7d8d-47ab-9c4f-41dadc390ff2", "name": "Export User Data from a Device to BioStar X", "request": { "name": "Export User Data from a Device to BioStar X", "description": { "content": "This API is used to export user data from a device to BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "ID of the user which will be uploaded. Use plus symbol ( + ) to separate multiple user ID, ex: 1+2+3." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which the user data will be uploaded to." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "a6c361b2-7078-4fc2-8732-d9add6d6969b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "users", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "44004" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which the user data will be uploaded to." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"UserCollection\": {\n \"total\": \"string\",\n \"rows\": [\n {\n \"user_id\": \"string\",\n \"name\": \"string\",\n \"updated_count\": \"string\",\n \"disabled\": true,\n \"flag\": \"string\",\n \"cards_count\": \"string\",\n \"fingerprint_templates_count\": \"string\",\n \"face_count\": \"string\",\n \"start_datetime\": \"string\",\n \"expiry_datetime\": \"string\",\n \"security_level\": \"string\",\n \"private_operation_modes\": \"string\",\n \"credentials\": {}\n },\n {\n \"user_id\": \"string\",\n \"name\": \"string\",\n \"updated_count\": \"string\",\n \"disabled\": true,\n \"flag\": \"string\",\n \"cards_count\": \"string\",\n \"fingerprint_templates_count\": \"string\",\n \"face_count\": \"string\",\n \"start_datetime\": \"string\",\n \"expiry_datetime\": \"string\",\n \"security_level\": \"string\",\n \"private_operation_modes\": \"string\",\n \"credentials\": {}\n }\n ]\n },\n \"DeviceResponse\": {\n \"rows\": [\n {\n \"id\": \"50362288\",\n \"code\": \"0\"\n },\n {\n \"id\": \"50362288\",\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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c842fddc-5272-4838-8283-ba9863d7bcab", "name": "View RS485 Devices", "request": { "name": "View RS485 Devices", "description": { "content": "This API is used to list devices which connected using RS-485.", "type": "text/plain" }, "url": { "path": [ "api", "devices", "rs485", ":dev_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "dev_id", "description": "(Required) ID of the device which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "aecddc0f-58cd-4a52-9f94-667810ebcd56", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", "rs485", ":dev_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "dev_id", "description": "(Required) ID of the device which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e7c15eb5-47d0-4944-b13a-70fd966cdd41", "name": "Door Groups", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8ad97969-bc4b-4b04-a352-5ba6ba4d3032", "name": "View All Door Groups", "request": { "name": "View All Door Groups", "description": { "content": "This API is used to view all available door groups.\nIt is required to put {} on the body parameter to run the API successfully.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "door_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "df5060a6-fe43-4989-8952-cf17725538a8", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "door_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6390638-8c37-488e-bba4-7d48c13bcfc1", "name": "View All Door Groups (Sort)", "request": { "name": "View All Door Groups (Sort)", "description": { "content": "This API is used to view all door groups while sorting the response using available fields.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "door_groups", "only_permission_item", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"order_by\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "70016c90-5716-46d1-9be8-a448b21ef427", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "door_groups", "only_permission_item", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order_by\": \"depth:false\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a46448f7-3304-4534-889f-7374bdf077d9", "name": "Create Door Group", "request": { "name": "Create Door Group", "description": { "content": "This API is used to create door groups.\n**Known issue:**\n- Duplicate group name within one parent group\n \n- Depth value not within 1-8\n \n- Using `parent_id` which doesn't exist will result in success but the created group will not be visible.\n \n- 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.", "type": "text/plain" }, "url": { "path": [ "api", "door_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DoorGroup\": {\n \"parent_id\": {\n \"id\": \"\"\n },\n \"depth\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bbb944cd-6c73-4e16-a431-b95ffb22b769", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "door_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DoorGroup\": {\n \"parent_id\": {\n \"id\": 47\n },\n \"depth\": 1,\n \"name\": \"AAAAA5q\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb2d3555-0258-4300-92f7-7b1ab9ba2af6", "name": "Delete Door Group", "request": { "name": "Delete Door Group", "description": { "content": "This API is used to delete door group.\n\nPut the door's ID on the id parameters of this API to delete door.\n\n**Note:**\n- Deleting parent group will also delete child group\n \n- Deleting groups with door(s) will also remove door(s) under that group. This will consequently remove doors from Access Levels\n \n- Can't delete groups with `parent_id` which doesn't exist\n \n- Can't delete groups with undefined name", "type": "text/plain" }, "url": { "path": [ "api", "door_groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "ID of the door which will be deleted" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ca468283-7589-4b64-aab3-ab7d1c1530e1", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "door_groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "33" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "719d844c-0665-410a-aa70-eb8c77fdd9f5", "name": "Update Door Group", "request": { "name": "Update Door Group", "description": { "content": "This API is used to update door group.\n\nPut the door's ID on the id parameters of this API to update door.\n\n**Note:**\n\n- When parent_id updated, any child group will follow the parent group", "type": "text/plain" }, "url": { "path": [ "api", "door_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DoorGroup\": {\n \"name\": \"\",\n \"parent_id\": {\n \"id\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2a85ee95-9a20-4307-bc20-2249f029cea4", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "door_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"DoorGroup\": {\n \"name\": \"New11\",\n \"parent_id\": {\n \"id\": 45\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5f83562b-fa43-408f-a1a7-6b18577f7ed5", "name": "Doors", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b411af12-efb8-4cb7-936e-94cc6745640d", "name": "View a Door Details", "request": { "name": "View a Door Details", "description": { "content": "This API is used to view a Door details.", "type": "text/plain" }, "url": { "path": [ "api", "doors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the door which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "444d05b0-04c6-452d-97d3-8c97825cc5d2", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the door which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f82ce06b-d066-430e-9cd7-3b19f7e0c097", "name": "Update a Door", "request": { "name": "Update a Door", "description": { "content": "This API is used to update a Door details.\n\nLeave the values to be edited, and remove everything else.", "type": "text/plain" }, "url": { "path": [ "api", "doors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the door which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Door\": {\n \"name\": \"\",\n \"description\": \"\",\n \"door_group_id\": {\n \"id\": \"\"\n },\n \"open_timeout\": \"\",\n \"open_duration\": \"\",\n \"open_once\": \"\",\n \"unconditional_lock\": \"\",\n \"relay_output_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"exit_button_input_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"input_index\": \"\",\n \"type\": \"\"\n },\n \"sensor_input_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"input_index\": \"\",\n \"type\": \"\",\n \"apb_use_door_sensor\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "50d80dba-e640-4341-ac48-a27af1c33689", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the door which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Door\": {\n \"name\": \"Anywhere FS2\",\n \"description\": \"Test\",\n \"door_group_id\": {\n \"id\": 1\n },\n \"open_timeout\": 15,\n \"open_duration\": 5,\n \"open_once\": true,\n \"unconditional_lock\": true,\n \"entry_device_id\": {\n \"id\": 542353521\n },\n \"relay_output_id\": {\n \"device_id\": {\n \"id\": 542353521\n },\n \"relay_index\": 0\n },\n \"exit_button_input_id\": {\n \"device_id\": {\n \"id\": 542353521\n },\n \"input_index\": 0,\n \"type\": 1\n },\n \"sensor_input_id\": {\n \"device_id\": {\n \"id\": 542353521\n },\n \"input_index\": 1,\n \"type\": 1,\n \"apb_use_door_sensor\": 1\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81daf018-c483-4f1b-bc77-ccdb80ab810c", "name": "View All Doors", "request": { "name": "View All Doors", "description": { "content": "This API is used to view Doors which is recorded on BioStar 2 database.", "type": "text/plain" }, "url": { "path": [ "api", "doors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of records according with the value specified" }, { "disabled": false, "key": "order_by", "value": "", "description": "Sort the records based on the id, toggle true/false to switch asceding/descending" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7dcd58c6-88df-460e-9e3b-647bb67e8001", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "0" }, { "key": "order_by", "value": "id:true" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d57d498-0e7c-4636-abbe-35dce7c1c56a", "name": "Create a Door", "request": { "name": "Create a Door", "description": { "content": "This API is used to create a door.", "type": "text/plain" }, "url": { "path": [ "api", "doors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Door\": {\n \"name\": \"\",\n \"description\": \"\",\n \"door_group_id\": {\n \"id\": \"\"\n },\n \"open_timeout\": \"\",\n \"open_duration\": \"\",\n \"open_once\": \"\",\n \"unconditional_lock\": \"\",\n \"relay_output_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"exit_button_input_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"input_index\": \"\",\n \"type\": \"\"\n },\n \"sensor_input_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"input_index\": \"\",\n \"type\": \"\",\n \"apb_use_door_sensor\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2d8dce42-0f0e-4026-a7c3-5fe80444053d", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Door\": {\n \"name\": \"Anywhere FS2\",\n \"description\": \"Test\",\n \"door_group_id\": {\n \"id\": 1\n },\n \"open_timeout\": 15,\n \"open_duration\": 5,\n \"open_once\": true,\n \"unconditional_lock\": true,\n \"entry_device_id\": {\n \"id\": 542353521\n },\n \"relay_output_id\": {\n \"device_id\": {\n \"id\": 542353521\n },\n \"relay_index\": 0\n },\n \"exit_button_input_id\": {\n \"device_id\": {\n \"id\": 542353521\n },\n \"input_index\": 0,\n \"type\": 1\n },\n \"sensor_input_id\": {\n \"device_id\": {\n \"id\": 542353521\n },\n \"input_index\": 1,\n \"type\": 1,\n \"apb_use_door_sensor\": 1\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d06a4a8-1fa6-4851-aa22-cac681bffaf8", "name": "Delete Door(s)", "request": { "name": "Delete Door(s)", "description": { "content": "This API is used to delete Door(s).", "type": "text/plain" }, "url": { "path": [ "api", "doors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "ID of the door which will be deleted. To delete multiple doors, separate the IDs with space." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "255534ac-5daf-4118-aeb1-bdc713e436c4", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c284b43d-2386-4b6b-85b9-fab2ba92826c", "name": "View All Doors v2", "request": { "name": "View All Doors v2", "description": { "content": "This API is used to view door records from BioStar X.\n\nIt is required to at least put {} on the body for the API to run correctly.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "doors", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"limit\": \"\",\n \"search_text\": \"\",\n \"door_group_id\": \"\",\n \"order_by\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1d7bf3ca-0bf5-423c-8ef6-d62e38cdb7f7", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "doors", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 25,\n \"search_text\": \"\",\n \"door_group_id\": 1,\n \"order_by\": \"door_group_id.name:true\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "af95e423-be7a-4c52-9a10-c6e80d199fd0", "name": "View Door Status", "request": { "name": "View Door Status", "description": { "content": "This API is used to view various door status information such as the door status, relay status, alarm and last event.\n\n* Fire alarm unlocked: A state where the door designated as a fire alarm zone is unlocked because a fire has broken out.\n* Manual Lock: A state where the door is locked because the administrator has locked it manually.\n* Manual Unlock: A state where the door is unlocked and able to enter without an authentication because the administrator has unlocked it manually.\n* Schedule Locked: A state where the door is locked by the schedule that has been set.\n* Schedule Unlocked: A state where the door is unlocked by the schedule that has been set.\n* Normal: A state where a user can enter the door after an authentication.", "type": "text/plain" }, "url": { "path": [ "api", "doors", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"monitoring_permission\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "95ff8b14-603d-4828-abbb-b787fc96cc19", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"monitoring_permission\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b4c4869-21c3-48ef-a9ca-3c24a294715c", "name": "Clear Door Alarm", "request": { "name": "Clear Door Alarm", "description": { "content": "This API is used to clear alarms of all doors. If an alarm is \nset in the Zone, the alarm may be continuously output even if the door alarm is released.", "type": "text/plain" }, "url": { "path": [ "api", "doors", "clear_alarm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c4fad650-73d8-4fd3-addd-0bac9f3dffbb", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", "clear_alarm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac5f2660-7331-4363-aa90-977b9dc1c8eb", "name": "Clear Anti PassBack: Specific User(s)", "request": { "name": "Clear Anti PassBack: Specific User(s)", "description": { "content": "This example shows how to clear APB for specific user(s).", "type": "text/plain" }, "url": { "path": [ "api", "doors", "clear_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AntiPassBackConfig\": {\n \"AntiPassBackConfig\": {\n \"Door\": {\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"User\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ],\n \"UserType\": \"\"\n },\n \"target\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "21dbf677-3cc0-4f17-abbd-ad5c19b4a3a8", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", "clear_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AntiPassBackConfig\": {\n \"Door\": {\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": 35\n }\n ]\n }\n },\n \"User\": [\n {\n \"user_id\": \"10\"\n },\n {\n \"user_id\": \"12\"\n }\n ],\n \"UserType\": 2\n },\n \"target\": \"users:,[object Object],[object Object]\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48d70578-05be-4ab4-92db-37311651bef3", "name": "Manual Lock Door", "request": { "name": "Manual Lock Door", "description": { "content": "This API is used to lock a door manually. If you set the state to Manual Lock, the door will have remained inaccessible even if a user authentication succeeded.", "type": "text/plain" }, "url": { "path": [ "api", "doors", "lock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "59c2b9fe-4cac-4c7f-a762-2bb396e1968f", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", "lock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0f47faa-a068-4ff9-b19a-5ffffaa0b134", "name": "Manual Unlock Door", "request": { "name": "Manual Unlock Door", "description": { "content": "This API is used to unlock a door manually. If you set the state to Manual Unlock, the door will have remained accessible even if a user does not authenticate.", "type": "text/plain" }, "url": { "path": [ "api", "doors", "unlock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "73b3bfbc-98e4-4b58-b7fa-27fd63cf797c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", "unlock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f93642ce-4fbe-496a-a5d3-d7c0f1b5753a", "name": "Release Manual Lock/Unlock", "request": { "name": "Release Manual Lock/Unlock", "description": { "content": "This API is used to release the manual lock or manual unlock set by the administrator.", "type": "text/plain" }, "url": { "path": [ "api", "doors", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8c28b222-9043-4a78-b593-836c933abe3c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb40caf7-7667-47fb-b234-1f6552429f66", "name": "Clear Timed APB", "request": { "name": "Clear Timed APB", "description": { "content": "This API is used to clear Timed APB access record.", "type": "text/plain" }, "url": { "path": [ "api", "doors", "clear_timed_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"TimedAntiPassBackConfig\": {\n \"AntiPassBackConfig\": {\n \"Door\": {\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"User\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ],\n \"UserType\": \"\"\n },\n \"target\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4e6d160a-5766-4fd2-8e09-774c8f55eb7e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", "clear_timed_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TimedAntiPassBackConfig\": {\n \"Door\": {\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": 30\n }\n ]\n }\n },\n \"User\": [\n {\n \"user_id\": \"1\"\n }\n ],\n \"UserType\": 2\n },\n \"target\": \"users:,[object Object]\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"DeviceResponse\": {\n \"rows\": [\n {\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "218a3190-d2de-4197-8b6b-f25aa96c8738", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "doors", "clear_timed_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TimedAntiPassBackConfig\": {\n \"Door\": {\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": 30\n }\n ]\n }\n },\n \"User\": [\n {\n \"user_id\": \"1\"\n }\n ],\n \"UserType\": 2\n },\n \"target\": \"users:,[object Object]\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "602b66cd-64ef-44bc-aa44-bded223ae50e", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "doors", "clear_timed_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TimedAntiPassBackConfig\": {\n \"Door\": {\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": 30\n }\n ]\n }\n },\n \"User\": [\n {\n \"user_id\": \"1\"\n }\n ],\n \"UserType\": 2\n },\n \"target\": \"users:,[object Object]\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c714b4f-bff1-44a7-9a18-026d34ad2e0e", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "doors", "clear_timed_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TimedAntiPassBackConfig\": {\n \"Door\": {\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": 30\n }\n ]\n }\n },\n \"User\": [\n {\n \"user_id\": \"1\"\n }\n ],\n \"UserType\": 2\n },\n \"target\": \"users:,[object Object]\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bf0327f-1c27-4e51-a1e3-4ebdd50fcc63", "name": "Internal Server Error - An unexpected error occurred on the server.'", "originalRequest": { "url": { "path": [ "api", "doors", "clear_timed_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TimedAntiPassBackConfig\": {\n \"Door\": {\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": 30\n }\n ]\n }\n },\n \"User\": [\n {\n \"user_id\": \"1\"\n }\n ],\n \"UserType\": 2\n },\n \"target\": \"users:,[object Object]\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9dd84caf-3713-49c1-a5e7-387e027d0c1c", "name": "Open Door", "request": { "name": "Open Door", "description": { "content": "This API is used to open a door.", "type": "text/plain" }, "url": { "path": [ "api", "doors", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5ae119a8-be83-4b83-b47e-e01b5c5f0c9b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"DoorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f698155b-4854-42b0-8c30-edd01ab9c88f", "name": "View Doors with RS485", "request": { "name": "View Doors with RS485", "description": { "content": "This API is used to list doors which use devices that connected to the system using RS485.", "type": "text/plain" }, "url": { "path": [ "api", "doors", "rs485", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the door which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e36a501b-31d9-46c8-819a-8e145cee3261", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "doors", "rs485", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the door which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6d6aefb-2e1c-4531-8ce9-52e82137f361", "name": "Retrieve Door Tree", "request": { "name": "Retrieve Door Tree", "description": { "content": "Retrieves the hierarchical structure of door groups and doors, including device and status information.\n\nThis endpoint is commonly used to populate door monitoring trees, access control dashboards, or group-based door management UIs.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "door_tree", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"root_id\": \"\",\n \"max_recursion_depth\": \"\",\n \"collapsed_node_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fbdf6ed1-43af-4f9d-bfd1-d0102f8fc020", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "door_tree", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"root_id\": 1,\n \"max_recursion_depth\": 7,\n \"collapsed_node_ids\": [\n 2\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7256e73c-a523-4e1e-97a4-a93d8b0f816b", "name": "Elevator Groups", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "02319916-1439-45bd-a951-e55b87ff957a", "name": "Create Elevator Group", "request": { "name": "Create Elevator Group", "description": { "content": "This API is used to create elevator group.", "type": "text/plain" }, "url": { "path": [ "api", "elevator_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ElevatorGroup\": {\n \"parent_id\": {\n \"id\": \"\"\n },\n \"isElevatorGroups\": \"\",\n \"depth\": \"\",\n \"inherited\": \"\",\n \"name\": \"\",\n \"sync_device_groups\": [\n \"\",\n \"\"\n ],\n \"sync_devices\": [\n \"\",\n \"\"\n ],\n \"iconCls\": \"\",\n \"text\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fd71465e-5b59-4583-81e6-553e076bf2c9", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevator_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ElevatorGroup\": {\n \"parent_id\": {\n \"id\": 1\n },\n \"isElevatorGroups\": true,\n \"depth\": 1,\n \"inherited\": true,\n \"name\": \"New Elevator Group 2\",\n \"iconCls\": \"elevatorGroupIcon\",\n \"text\": \"New Elevator Group 2\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79a78f64-e557-4258-903f-db78ee3ce7ec", "name": "List Elevator Group", "request": { "name": "List Elevator Group", "description": { "content": "This API is used to list elevator groups recorded in BioStar X.\n\nIt is required to at least put {} on body for the API to run correctly.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "elevator_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dde206d8-4851-4337-b5d5-a7ddf988e908", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "elevator_groups", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f90099f-0a19-400e-b072-5812fe8b0403", "name": "List Elevator Group with Criteria & Permission", "request": { "name": "List Elevator Group with Criteria & Permission", "description": { "content": "This API is used to view elevator groups with criteria and permissions.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "elevator_groups", "only_permission_item", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"order_by\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7c2bfe47-3d91-4e23-aeb7-3c474966a948", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "elevator_groups", "only_permission_item", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"order_by\": \"depth:false\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12dda716-a82e-4a9f-a4e4-f06be2b5e6b2", "name": "Update Elevator Group", "request": { "name": "Update Elevator Group", "description": { "content": "This API is used to update elevator group.\n\nUp to 48 characters may be entered for an elevator group name.", "type": "text/plain" }, "url": { "path": [ "api", "elevator_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the elevator group which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ElevatorGroup\": {\n \"parent_id\": {\n \"id\": \"\"\n },\n \"isElevatorGroups\": \"\",\n \"depth\": \"\",\n \"inherited\": \"\",\n \"name\": \"\",\n \"sync_device_groups\": [\n \"\",\n \"\"\n ],\n \"sync_devices\": [\n \"\",\n \"\"\n ],\n \"iconCls\": \"\",\n \"text\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0cd0acf9-2036-422b-9dde-c8e36a384d01", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevator_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the elevator group which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ElevatorGroup\": {\n \"parent_id\": {\n \"id\": 1\n },\n \"isElevatorGroups\": true,\n \"depth\": 1,\n \"inherited\": true,\n \"name\": \"New Elevator Group 2\",\n \"iconCls\": \"elevatorGroupIcon\",\n \"text\": \"New Elevator Group 2\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1115937d-f13b-48ab-8295-bd3bce47260d", "name": "Delete Elevator Group", "request": { "name": "Delete Elevator Group", "description": { "content": "This API is used to delete elevator group.\n\nDeleting a group deletes all elevators in the group.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "elevator_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the elevator group which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "cbcf6e6a-68a0-405e-aa8b-4777afc96474", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "elevator_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the elevator group which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "43ed2335-d4f1-4d54-8ab3-0d1b39aff37b", "name": "Elevators", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9cc74f15-e9a3-49ae-ab32-e54456096d27", "name": "Create Elevator", "request": { "name": "Create Elevator", "description": { "content": "This API is used to create elevator.\n\nThe 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.\n\n**Controller - `control_device_id`**\n\nSelect a device that controls the elevator access permission.\n\n- Only a master device can be selected.\n \n- You can select it from the list of registered devices.\n**Reader - `reader_devices`**\nSelect a device you intend to use for authentication.\n\n- You can select a device among the master device, slave device, and Wiegand device.\n \n- You can select up to 4 readers.\n \n- OM-120 cannot be set as the reader.\n \n\n**Module - `module_devices`**\n\nSelect OM-120 to control the elevator button relay.\n\n- Only OM-120 can be selected.\n \n\n**Total Number of Floors - `floors`**\n\nEnter the total number of floors that you can move using the elevator.\n\n- Up to 192 floors can be entered.", "type": "text/plain" }, "url": { "path": [ "api", "elevators" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Elevator\": {\n \"name\": \"\",\n \"description\": \"\",\n \"elevator_group_id\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reader_devices\": [\n {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"control_device_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"device_type_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"floors\": [\n {\n \"name\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"order\": \"\"\n },\n {\n \"name\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"order\": \"\"\n }\n ],\n \"module_devices\": [\n {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"trigger_actions\": [\n \"\",\n \"\"\n ],\n \"active_timeout\": \"\",\n \"dual_authentication\": {\n \"device\": \"\",\n \"approval_type\": \"\",\n \"timeout\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"approval_groups\": [\n \"\",\n \"\"\n ]\n },\n \"tamper_device\": {\n \"device_id\": \"\",\n \"switch_type\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "05f6ab37-9554-47d3-ad38-5dfebefe24b8", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Elevator\": {\n \"name\": \"Odds\",\n \"description\": \"Odds elevator\",\n \"elevator_group_id\": {\n \"id\": 6,\n \"name\": \"New Elevator Group 2\"\n },\n \"reader_devices\": [\n {\n \"device_id\": {\n \"id\": \"544140034\",\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\"\n }\n },\n {\n \"device_id\": {\n \"id\": \"544140034\",\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\"\n }\n }\n ],\n \"control_device_id\": {\n \"id\": \"544140034\",\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\",\n \"device_type_id\": {\n \"id\": \"13\",\n \"name\": \"BioEntry W2\"\n }\n },\n \"floors\": [\n {\n \"name\": \"Odds - 1\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": 788930600,\n \"name\": \"OM-120 788930600\"\n },\n \"relay_index\": 0\n },\n \"order\": 0\n },\n {\n \"name\": \"Odds - 1\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": 788930600,\n \"name\": \"OM-120 788930600\"\n },\n \"relay_index\": 0\n },\n \"order\": 0\n }\n ],\n \"module_devices\": [\n {\n \"device_id\": {\n \"id\": \"788930600\",\n \"name\": \"OM-120 788930600\"\n }\n },\n {\n \"device_id\": {\n \"id\": \"788930600\",\n \"name\": \"OM-120 788930600\"\n }\n }\n ],\n \"active_timeout\": \"10\",\n \"dual_authentication\": {\n \"device\": 0,\n \"approval_type\": \"0\",\n \"timeout\": 15,\n \"schedule_id\": {\n \"id\": \"1\"\n }\n },\n \"tamper_device\": {\n \"device_id\": {},\n \"switch_type\": \"0\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4679470e-676e-472e-b92d-bbff7455c356", "name": "Delete Elevator", "request": { "name": "Delete Elevator", "description": { "content": "This API is used to delete elevator.", "type": "text/plain" }, "url": { "path": [ "api", "elevators" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "ID of the elevator which will be deleted" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "34a9496c-88cb-4163-b1ec-6736e3de6e97", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3473877a-6b1a-4b2a-bcdf-decf4884b9cb", "name": "List Elevators", "request": { "name": "List Elevators", "description": { "content": "This API is used to list elevators recorder in BioStar X\n\nIt is required to at least put {} for the API to run correctly.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "elevators", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"limit\": \"\",\n \"search_text\": \"\",\n \"elevator_group_id\": \"\",\n \"order_by\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9b6d4a68-a431-476a-8e57-a8bc35c0f596", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "elevators", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"limit\": 50,\n \"search_text\": \"Odds\",\n \"elevator_group_id\": 1,\n \"order_by\": \"elevator_group_id:false\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ea568f6-5bd6-4d5f-a569-4ecccd6b0bb8", "name": "View an Elevator Details", "request": { "name": "View an Elevator Details", "description": { "content": "This API is used to view an elevator details.", "type": "text/plain" }, "url": { "path": [ "api", "elevators", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the elevator which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "433660f7-5b18-4d09-a4d0-a7e5e037a2b9", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the elevator which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "903b612b-20fd-4356-8d89-a3a3f3684ecc", "name": "Update Elevator", "request": { "name": "Update Elevator", "description": { "content": "This API is used to update an elevator configuration.\n\nLeave values which will be edited and remove everything else.", "type": "text/plain" }, "url": { "path": [ "api", "elevators", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the elevator which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Elevator\": {\n \"name\": \"\",\n \"description\": \"\",\n \"elevator_group_id\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"reader_devices\": [\n {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"control_device_id\": {\n \"id\": \"\",\n \"name\": \"\",\n \"device_type_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"floors\": [\n {\n \"name\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"order\": \"\"\n },\n {\n \"name\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"order\": \"\"\n }\n ],\n \"module_devices\": [\n {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"device_id\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"trigger_actions\": [\n \"\",\n \"\"\n ],\n \"active_timeout\": \"\",\n \"dual_authentication\": {\n \"device\": \"\",\n \"approval_type\": \"\",\n \"timeout\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"approval_groups\": [\n \"\",\n \"\"\n ]\n },\n \"tamper_device\": {\n \"device_id\": \"\",\n \"switch_type\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cdb06ee5-d0cb-4465-a904-c4774621cbba", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the elevator which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Elevator\": {\n \"name\": \"Odds\",\n \"description\": \"Odds elevator\",\n \"elevator_group_id\": {\n \"id\": 6,\n \"name\": \"New Elevator Group 2\"\n },\n \"reader_devices\": [\n {\n \"device_id\": {\n \"id\": \"544140034\",\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\"\n }\n },\n {\n \"device_id\": {\n \"id\": \"544140034\",\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\"\n }\n }\n ],\n \"control_device_id\": {\n \"id\": \"544140034\",\n \"name\": \"BioEntry W2 544140034 (192.168.1.24)\",\n \"device_type_id\": {\n \"id\": \"13\",\n \"name\": \"BioEntry W2\"\n }\n },\n \"floors\": [\n {\n \"name\": \"Odds - 1\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": 788930600,\n \"name\": \"OM-120 788930600\"\n },\n \"relay_index\": 0\n },\n \"order\": 0\n },\n {\n \"name\": \"Odds - 1\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": 788930600,\n \"name\": \"OM-120 788930600\"\n },\n \"relay_index\": 0\n },\n \"order\": 0\n }\n ],\n \"module_devices\": [\n {\n \"device_id\": {\n \"id\": \"788930600\",\n \"name\": \"OM-120 788930600\"\n }\n },\n {\n \"device_id\": {\n \"id\": \"788930600\",\n \"name\": \"OM-120 788930600\"\n }\n }\n ],\n \"active_timeout\": \"10\",\n \"dual_authentication\": {\n \"device\": 0,\n \"approval_type\": \"0\",\n \"timeout\": 15,\n \"schedule_id\": {\n \"id\": \"1\"\n }\n },\n \"tamper_device\": {\n \"device_id\": {},\n \"switch_type\": \"0\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aeca8b4d-a569-40fb-8c47-5d359f5fe143", "name": "View Elevator(s) Status", "request": { "name": "View Elevator(s) Status", "description": { "content": "This API is used to view elevator status.", "type": "text/plain" }, "url": { "path": [ "api", "elevators", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2f4260a8-98c7-406a-9df6-6f608808223c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": 32770\n },\n {\n \"id\": 32770\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40ab495f-6c21-4952-8443-118a63856c89", "name": "Manual Lock Elevator", "request": { "name": "Manual Lock Elevator", "description": { "content": "This API is used to lock elevator access to single/multiple floor manually. If you set the state to Manual Lock, the elevator will have remained inaccessible even if a user authenticatation succeeded.\n\n`floors:order` correlates with `order` on `GET /api/elevators/:id` or with `floor_id:index` on `POST /api/elevators/status`", "type": "text/plain" }, "url": { "path": [ "api", "elevators", "lock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": \"\",\n \"floor\": {\n \"order\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"floor\": {\n \"order\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "96f8f22e-a738-4797-8b43-ef0a29047c90", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators", "lock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": 32770,\n \"floor\": {\n \"order\": 3\n }\n },\n {\n \"id\": 32770,\n \"floor\": {\n \"order\": 3\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e93d5cef-78d1-414b-801e-e4c7eefe9757", "name": "Manual Unlock Elevator", "request": { "name": "Manual Unlock Elevator", "description": { "content": "This API is used to unlock an elevator manually. If you set the state to Manual Unlock, the elevator will have remained accessible even if a user does not authenticate.\n\n`floors:order` correlates with `order` on `GET /api/elevators/:id` or with `floor_id:index` on `POST /api/elevators/status`", "type": "text/plain" }, "url": { "path": [ "api", "elevators", "unlock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": \"\",\n \"floor\": {\n \"order\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"floor\": {\n \"order\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b6b4d198-2f20-4b53-8ca3-f77d735ee6ca", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators", "unlock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": 32770,\n \"floor\": {\n \"order\": 3\n }\n },\n {\n \"id\": 32770,\n \"floor\": {\n \"order\": 3\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb731c0c-f549-456c-b788-75e2b5c0b4b4", "name": "Release Elevator Manual Lock/Unlock", "request": { "name": "Release Elevator Manual Lock/Unlock", "description": { "content": "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`\n`floors:order` correlates with `order` on `GET /api/elevators/:id` or with `floor_id:index` on `POST /api/elevators/status`", "type": "text/plain" }, "url": { "path": [ "api", "elevators", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": \"\",\n \"floor\": {\n \"order\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"floor\": {\n \"order\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "32d078ac-a1e5-440f-9e87-240e46149b85", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators", "release" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": 32770,\n \"floor\": {\n \"order\": 3\n }\n },\n {\n \"id\": 32770,\n \"floor\": {\n \"order\": 3\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb8b4bc5-6281-4c71-8a40-b340629ca14e", "name": "Open Elevator Floor(s)", "request": { "name": "Open Elevator Floor(s)", "description": { "content": "This API is used to open a floor.\n\nWill only works if the floor status is clear/default (not manually locked/unlocked or there's active alarm)\n\n`floors:order` correlates with `order` on `GET /api/elevators/:id` or with `floor_id:index` on `POST /api/elevators/status`", "type": "text/plain" }, "url": { "path": [ "api", "elevators", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": \"\",\n \"floor\": {\n \"order\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"floor\": {\n \"order\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "448d0c74-889c-4d1e-826a-56c4c3d19e83", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": 32770,\n \"floor\": {\n \"order\": 3\n }\n },\n {\n \"id\": 32770,\n \"floor\": {\n \"order\": 3\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da38483d-5cca-4224-84f5-79ac2a68c530", "name": "Clear Elevator Alarm", "request": { "name": "Clear Elevator Alarm", "description": { "content": "This API is used to clear alarms of all doors. If an alarm is \n\nset in the Zone, the alarm may be continuously output even if the elevator alarm is released.", "type": "text/plain" }, "url": { "path": [ "api", "elevators", "clear_alarm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2b532fdb-538b-45a7-9058-c6c65a817d46", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "elevators", "clear_alarm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ElevatorCollection\": {\n \"rows\": [\n {\n \"id\": 32770\n },\n {\n \"id\": 32770\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "32d0abda-6a14-4381-8e05-023b2465a820", "name": "Firmware", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6c30a339-e754-4cac-a784-e07b274e7d9e", "name": "Update Firmware", "request": { "name": "Update Firmware", "description": { "content": "This API is used to update a device's firmware.\n\nFirmware file need to be placed on `[BioStar X Install Path]\\firmware` folder.\n\nUse `/api/device_types` to find `device_type` and `device_type_id`, find the device's name and get the id for the parameters value.", "type": "text/plain" }, "url": { "path": [ "api", "firmwares", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FirmwareFile\": {\n \"filename\": \"\",\n \"device_type\": \"\"\n },\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"\",\n \"device_type_id\": {\n \"id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"device_type_id\": {\n \"id\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "40d53f3f-9023-4661-af43-40fa1c1d14e6", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "firmwares", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FirmwareFile\": {\n \"filename\": \"bs3-all_v1.1.1_20230621_sign.bin\",\n \"device_type\": \"35\"\n },\n \"DeviceCollection\": {\n \"rows\": [\n {\n \"id\": \"538201713\",\n \"device_type_id\": {\n \"id\": \"35\"\n }\n },\n {\n \"id\": \"538201713\",\n \"device_type_id\": {\n \"id\": \"35\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20f4a2a8-32ed-4431-ab0e-924d08444e2d", "name": "View Firmwares Information", "request": { "name": "View Firmwares Information", "description": { "content": "This API is used to view firmwares information which is placed on folder `[BioStar X Install Path]\\firmware`.\n\n**Response Information Table**\n\n| **Device Type** | **Value** |\n| --- | --- |\n| BS2_DEVICE_TYPE_UNKNOWN | 0 |\n| BIOENTRY_PLUS | 1 |\n| BIOENTRY_W | 2 |\n| BIOLITE_NET | 3 |\n| XPASS | 4 |\n| XPASS_S2 | 5 |\n| SECURE_IO_2 | 6 |\n| DOOR_MODULE_20 | 7 |\n| BIOSTATION_2 | 8 |\n| BIOSTATION_A2 | 9 |\n| FACESTATION_2 | 10 |\n| IO_DEVICE | 11 |\n| BIOSTATION_L2 | 12 |\n| BIOENTRY_W2 | 13 |\n| CORESTATION_40 | 14 |\n| OUTPUT_MODULE | 15 |\n| INPUT_MODULE | 16 |\n| BIOENTRY_P2 | 17 |\n| BIOLITE_N2 | 18 |\n| XPASS2 | 19 |\n| NOT USED | 20 |\n| BIOENTRY_R2 | 21 |\n| XPASS_D2 | 22 |\n| DOOR_MODULE_21 | 23 |\n| XPASS_D2_KEYPAD | 24 |\n| FACELITE | 25 |\n| XPASS2_KEYPAD | 26 |\n| XPASS_D2_REV | 27 |\n| XPASS_D2_KEYPAD_REV | 28 |\n| FACESTATION_F2_FP | 29 |\n| FACESTATION_F2 | 30 |\n| XSTATION_2_QR | 31 |\n| XSTATION_2 | 32 |\n| IM_120 | 33 |\n| XSTATION_2_FP | 34 |\n| BIOSTATION_3 | 35 |\n| 3RD_OSDP_DEVICE | 36 |\n| 3RD_OSDP_IO_DEVICE | 37 |\n| BIOSTATION_2A | 38 |\n| UZ_OSDP_MODULE | 39 |\n| UZ_OSDP_DOOR_HANDLE | 40 |\n| UZ_OSDP_DOOR_KNOB | 41 |\n| BIOENTRY_W3 | 42 |\n\n| **Card Model** | **Value** |\n| --- | --- |\n| OMPW | 0 |\n| OIPW | 1 |\n| OEPW | 2 |\n| OHPW | 3 |\n| ODPW | 4 |\n| OAPW | 5 |\n| ODSPW | 6 |\n| PMPW | 20 |\n| PIPW | 21 |\n| PEPW | 22 |\n| PHPW | 23 |\n| PDPW | 24 |\n| PAPW | 25 |\n| PDSPW | 26 |\n| ALL | 30 |\n\n**Model Code**\n\n| **Code** | **Position** | **Description** |\n| --- | --- | --- |\n| O | Front | Optical FP Sensor |\n| P | Front | PIV Certified Optical FP Sensor |\n| A | Middle | All Cards |\n| M | Middle | Mifare & DESFire |\n| I | Middle | iClass |\n| E | Middle | EM |\n| H | Middle | HID |\n| D | Middle | Dual Frequency (Mifare/DESFire \\[13.56 MHz\\], EM \\[125 kHz\\]) |\n| DS | Middle | Dual Frequency with SAM Card Slot |\n| P | End | PoE |\n| W | End | WiFi |\n\n**Note:**\n\n- PoE and WiFi may differ by device. Please check the devices specification from Suprema website ([https://www.supremainc.com)](https://www.supremainc.com)", "type": "text/plain" }, "url": { "path": [ "api", "firmwares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "14689347-aa9f-4fa3-9ad5-b8ad75b4f200", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "firmwares" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4e7e326b-d649-4f04-9e7c-00d6b8f08cfd", "name": "Floor Levels", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4b0085c7-5b16-4fb4-8c70-c6aa4a32926e", "name": "View Floor Levels", "request": { "name": "View Floor Levels", "description": { "content": "This API is used to view floor levels recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "floor_levels" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of responses by n records. Remove this parameter to view all." }, { "disabled": false, "key": "offset", "value": "", "description": "Offset the response shown by n records." }, { "disabled": false, "key": "order_by", "value": "", "description": "Order the response result either ascending or descending" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "32b56a75-e815-4c6b-b067-4dc8ea1ae3ca", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "floor_levels" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "order_by", "value": "id:false" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da5d9be7-e9c2-4cfe-a9ec-964986d0c47c", "name": "Create Floor Levels", "request": { "name": "Create Floor Levels", "description": { "content": "This API is used to create floor level.\n\nYou can configure the floor access privileges by using elevators and floor information.\n\n**Known errors:**\n- Duplicate `name`", "type": "text/plain" }, "url": { "path": [ "api", "floor_levels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FloorLevel\": {\n \"name\": \"\",\n \"description\": \"\",\n \"floor_level_items\": [\n {\n \"elevator_id\": {\n \"id\": \"\"\n },\n \"floors\": [\n {\n \"id\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"index\": \"\"\n },\n {\n \"id\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"index\": \"\"\n }\n ],\n \"schedule_id\": {\n \"id\": \"\"\n }\n },\n {\n \"elevator_id\": {\n \"id\": \"\"\n },\n \"floors\": [\n {\n \"id\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"index\": \"\"\n },\n {\n \"id\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"index\": \"\"\n }\n ],\n \"schedule_id\": {\n \"id\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4f17738f-cb6e-476a-9c09-2a6cea584115", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "floor_levels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"FloorLevel\": {\n \"name\": \"aaaax\",\n \"description\": \"aaaa\",\n \"floor_level_items\": [\n {\n \"elevator_id\": {\n \"id\": 32769,\n \"floors\": [\n {\n \"id\": 5,\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": 100000115\n },\n \"relay_index\": 4\n },\n \"index\": 4\n }\n ]\n },\n \"schedule_id\": {\n \"id\": 1\n }\n },\n {\n \"elevator_id\": {\n \"id\": 32769,\n \"floors\": [\n {\n \"id\": 4,\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": 100000115\n },\n \"relay_index\": 3\n },\n \"index\": 3\n }\n ]\n },\n \"schedule_id\": {\n \"id\": 1\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57bfe250-f211-402d-bc2c-64019814bafc", "name": "View a Floor Level Detail", "request": { "name": "View a Floor Level Detail", "description": { "content": "This API is used to view the details of a floor level.", "type": "text/plain" }, "url": { "path": [ "api", "floor_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the floor level which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "54f35b2c-58f6-4ed3-8879-850179bafa37", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "floor_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the floor level which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b4545a5-5247-4fd3-820c-5d993c9322ad", "name": "Update Floor Levels", "request": { "name": "Update Floor Levels", "description": { "content": "This API is used to update floor level.\n**Known errors:**\n- Duplicate `name`", "type": "text/plain" }, "url": { "path": [ "api", "floor_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the floor level which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"FloorLevel\": {\n \"name\": \"\",\n \"description\": \"\",\n \"floor_level_items\": [\n {\n \"elevator_id\": {\n \"id\": \"\"\n },\n \"floors\": [\n {\n \"id\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"index\": \"\"\n },\n {\n \"id\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"index\": \"\"\n }\n ],\n \"schedule_id\": {\n \"id\": \"\"\n }\n },\n {\n \"elevator_id\": {\n \"id\": \"\"\n },\n \"floors\": [\n {\n \"id\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"index\": \"\"\n },\n {\n \"id\": \"\",\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"index\": \"\"\n }\n ],\n \"schedule_id\": {\n \"id\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1f8dd650-a6a0-44e6-b5e2-300dedcb8284", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "floor_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the floor level which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"FloorLevel\": {\n \"name\": \"aaaaxxxx\",\n \"description\": \"aaaa\",\n \"floor_level_items\": [\n {\n \"elevator_id\": {\n \"id\": 32769,\n \"floors\": [\n {\n \"id\": 5,\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": 100000115\n },\n \"relay_index\": 4\n },\n \"index\": 4\n }\n ]\n },\n \"schedule_id\": {\n \"id\": 1\n }\n },\n {\n \"elevator_id\": {\n \"id\": 32769,\n \"floors\": [\n {\n \"id\": 4,\n \"elevator_device_id\": {\n \"device_id\": {\n \"id\": 100000115\n },\n \"relay_index\": 3\n },\n \"index\": 3\n }\n ]\n },\n \"schedule_id\": {\n \"id\": 1\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "204efd84-abda-40c8-9f49-e10c68bd3850", "name": "Delete Floor Level", "request": { "name": "Delete Floor Level", "description": { "content": "This API is used to delete floor levels.", "type": "text/plain" }, "url": { "path": [ "api", "floor_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the floor level which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e3ef57a2-1e2e-4c0d-ae71-b41be0189380", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "floor_levels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the floor level which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "66b48869-a917-4dec-bdbd-31a23ba7c6aa", "name": "Schedules", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "cb5afc96-1339-4519-bf46-8b07363fa60d", "name": "View Schedules", "request": { "name": "View Schedules", "description": { "content": "This API is used to view all schedules recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of responses by n records. Remove this parameter to view all." }, { "disabled": false, "key": "offset", "value": "", "description": "Offset the response shown by n records." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "74b42ba8-8c2b-4beb-88d9-c40988324501", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8169b974-4090-434d-b793-14bff0d4eb0d", "name": "Create Schedule (Daily)", "request": { "name": "Create Schedule (Daily)", "description": { "content": "This API example shows how to create daily schedule.", "type": "text/plain" }, "url": { "path": [ "api", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Schedule\": {\n \"name\": \"\",\n \"description\": \"\",\n \"daily_schedules\": [\n {\n \"day_index\": \"\",\n \"time_segments\": [\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n },\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ]\n },\n {\n \"day_index\": \"\",\n \"time_segments\": [\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n },\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ]\n }\n ],\n \"holiday_schedules\": [\n \"\",\n \"\"\n ],\n \"days_of_iteration\": \"\",\n \"start_date\": \"\",\n \"use_daily_iteration\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1e13f01d-53d2-4427-ab6d-b44c80b86acf", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "schedules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Schedule\": {\n \"name\": \"\",\n \"description\": \"\",\n \"daily_schedules\": [\n {\n \"day_index\": \"\",\n \"time_segments\": [\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n },\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ]\n },\n {\n \"day_index\": \"\",\n \"time_segments\": [\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n },\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ]\n }\n ],\n \"holiday_schedules\": [\n \"\",\n \"\"\n ],\n \"days_of_iteration\": \"\",\n \"start_date\": \"\",\n \"use_daily_iteration\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e846f7ab-cef6-4506-b316-43efee7b68f8", "name": "View a Schedule Detail", "request": { "name": "View a Schedule Detail", "description": { "content": "This API is used to view a schedule detail recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the schedule which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c3a13746-0380-4fa3-98bf-ab68dacae786", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the schedule which will be viewed" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5824e634-12bf-4fb6-975e-cfbd5cab36f7", "name": "Delete Schedules", "request": { "name": "Delete Schedules", "description": { "content": "This API is used to delete schedules recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the schedule which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7b60ca58-232a-4f72-a5bc-6373288e5e30", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the schedule which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "493959d6-e7ed-4791-a06e-4290ed99b27c", "name": "Update a Schedule", "request": { "name": "Update a Schedule", "description": { "content": "This API is used to update a schedule.", "type": "text/plain" }, "url": { "path": [ "api", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the schedule which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Schedule\": {\n \"name\": \"\",\n \"description\": \"\",\n \"daily_schedules\": [\n {\n \"day_index\": \"\",\n \"time_segments\": [\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n },\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ]\n },\n {\n \"day_index\": \"\",\n \"time_segments\": [\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n },\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ]\n }\n ],\n \"holiday_schedules\": [\n \"\",\n \"\"\n ],\n \"days_of_iteration\": \"\",\n \"start_date\": \"\",\n \"use_daily_iteration\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8e63e10c-87b0-4f1b-823b-1e1ef5eebe41", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "schedules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the schedule which will be updated" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Schedule\": {\n \"name\": \"\",\n \"description\": \"\",\n \"daily_schedules\": [\n {\n \"day_index\": \"\",\n \"time_segments\": [\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n },\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ]\n },\n {\n \"day_index\": \"\",\n \"time_segments\": [\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n },\n {\n \"start_time\": \"\",\n \"end_time\": \"\"\n }\n ]\n }\n ],\n \"holiday_schedules\": [\n \"\",\n \"\"\n ],\n \"days_of_iteration\": \"\",\n \"start_date\": \"\",\n \"use_daily_iteration\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "48508556-ae1d-4ce0-9908-0ecfe8df6325", "name": "Holiday Groups", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "056630a6-8970-421a-a569-49cc4c32fa56", "name": "View Holiday Groups", "request": { "name": "View Holiday Groups", "description": { "content": "This API is used to view all holiday groups recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "holiday_groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of responses by n records. Remove this parameter to view all." }, { "disabled": false, "key": "offset", "value": "", "description": "Offset the response shown by n records." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0309bc5c-67fc-4971-be32-53decad91902", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "holiday_groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2aae78eb-bd03-4555-9d87-26d173092b9a", "name": "Create Holiday Group", "request": { "name": "Create Holiday Group", "description": { "content": "This API is used to create holiday groups on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "holiday_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"HolidayGroup\": {\n \"name\": \"\",\n \"description\": \"\",\n \"holidays\": [\n {\n \"repeat_interval\": \"\",\n \"start_date\": \"\"\n },\n {\n \"repeat_interval\": \"\",\n \"start_date\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bc6f4592-3185-4122-a6c5-b437844b9333", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "holiday_groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"HolidayGroup\": {\n \"name\": \"Idul Fitri 2022\",\n \"description\": \"Idul Fitri for year 2022\",\n \"holidays\": [\n {\n \"repeat_interval\": 0,\n \"start_date\": \"2022-05-02T00:00:00.00Z\"\n },\n {\n \"repeat_interval\": 0,\n \"start_date\": \"2022-05-03T00:00:00.00Z\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b78196c1-5716-4a7d-858c-3774f2c65828", "name": "Update Holiday Group", "request": { "name": "Update Holiday Group", "description": { "content": "This API is used to update holiday groups on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "holiday_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the holiday group which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"HolidayGroup\": {\n \"name\": \"\",\n \"description\": \"\",\n \"holidays\": [\n {\n \"repeat_interval\": \"\",\n \"start_date\": \"\"\n },\n {\n \"repeat_interval\": \"\",\n \"start_date\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "38bea9c2-b408-4074-9c0a-3122e8289855", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "holiday_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the holiday group which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"HolidayGroup\": {\n \"name\": \"Idul Fitri 2022\",\n \"description\": \"Idul Fitri for year 2022\",\n \"holidays\": [\n {\n \"repeat_interval\": 0,\n \"start_date\": \"2022-05-02T00:00:00.00Z\"\n },\n {\n \"repeat_interval\": 0,\n \"start_date\": \"2022-05-03T00:00:00.00Z\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5500898f-e5d2-492a-a91a-ab20f9364518", "name": "Delete Holiday Group", "request": { "name": "Delete Holiday Group", "description": { "content": "This API is used to delete holiday group.", "type": "text/plain" }, "url": { "path": [ "api", "holiday_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the holiday group which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "028cbaad-d100-4049-9122-74137de7749c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "holiday_groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the holiday group which will be deleted" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "633b5244-40fa-4013-84e7-468e26ba92c7", "name": "Trigger Actions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f9f23ff8-6e75-40e5-9c0c-fbbbda5508e3", "name": "View Trigger Actions", "request": { "name": "View Trigger Actions", "description": { "content": "This API is used to view all Trigger & Actions.", "type": "text/plain" }, "url": { "path": [ "api", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of responses by n records. Remove this parameter to view all." }, { "disabled": false, "key": "offset", "value": "", "description": "Offset the response shown by n records." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c947532a-4ee5-448f-8473-d47e69abe02e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "21265b99-2d01-49d1-8177-acb0412ceb79", "name": "Create Trigger Actions (Zone)", "request": { "name": "Create Trigger Actions (Zone)", "description": { "content": "You can set the device or BioStar X to do a specific operation when a specific event has occurred at the devices, doors and zones.", "type": "text/plain" }, "url": { "path": [ "api", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n \"action\": {\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ec8db2ff-1856-49ec-a82d-06adbd822449", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n \"action\": {\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ac9adfd-515d-4b3d-baf0-b363e574d0c2", "name": "Update Trigger Actions", "request": { "name": "Update Trigger Actions", "description": { "content": "This API is used to update Trigger/Actions.", "type": "text/plain" }, "url": { "path": [ "api", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger & Actions which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n \"action\": {\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "80028c9e-f5fd-49cd-aa6d-946bac99dae5", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger & Actions which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n },\n \"action\": {\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c8321f03-18f8-4dd7-962f-2d9743d9c3f1", "name": "Delete Trigger Actions", "request": { "name": "Delete Trigger Actions", "description": { "content": "This API is used to view all Trigger & Actions.", "type": "text/plain" }, "url": { "path": [ "api", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger & Action which will be deleted." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "ba956281-ffb3-41bd-983d-d7ccf1b5d577", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger & Action which will be deleted." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0b88440-749a-4d45-bcc3-dbe0fb252ba0", "name": "Create Multiple Trigger Actions", "request": { "name": "Create Multiple Trigger Actions", "description": { "content": "This API is used to create multiple trigger actions.", "type": "text/plain" }, "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f039d288-be72-43dd-8969-cc3ae6937f2c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27ccb03c-b024-450c-a8c3-d39aad8132d1", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b175b85-ce27-4de3-9e49-52ecb01afd9d", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1752437b-e5a8-4e52-9a48-a84ea65e887b", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49a372bc-162c-43b0-8cbd-0611b3b8d64e", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b0fb4eb-38f0-4360-bda3-19bd4e2ceaa3", "name": "Delete Multiple Trigger Actions Copy", "request": { "name": "Delete Multiple Trigger Actions Copy", "description": { "content": "This API is used to delete multiple trigger actions by ID.", "type": "text/plain" }, "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "Trigger and Action ID(s). Delimit each ID by using plus symbol (+; ex: 1+2+3)" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "80afcef7-ad1c-4c8a-aecc-2194ea069cab", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c025eea9-2786-41bb-a766-94ad7e8fdd7b", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ecb3b6f-3049-432a-b630-70f1d0097ff8", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b8a8049-3ce3-4a45-9df6-92b132a36f8c", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d409767-63f4-4e55-a415-09a8b7115caa", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd6b2dc0-0e0e-4407-bb8e-3dd8c3fe5db9", "name": "Update Multiple Trigger Actions", "request": { "name": "Update Multiple Trigger Actions", "description": { "content": "This API is used to update multiple trigger actions by ID.", "type": "text/plain" }, "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Trigger & Action's ID" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d960eecd-1bf2-4c98-bdb1-9f9a976c5040", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Trigger & Action's ID" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "219bf87a-b20e-4708-9de3-429fefcabb0b", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Trigger & Action's ID" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "818f0d6f-0021-4fa7-b0f5-3dde81eec7b6", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Trigger & Action's ID" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cfea270-cf88-4888-9a47-11a296a4a5c0", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Trigger & Action's ID" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ea708ff-11b9-4a8f-9c88-13921e0ccb6b", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Trigger & Action's ID" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"TriggerAction\": {\n \"name\": \"\",\n \"priority\": \"\",\n \"schedule_id\": {\n \"id\": \"\"\n },\n \"trigger\": {\n \"source_type\": \"\",\n \"event_types\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"devices\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"zones\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n }\n },\n \"action\": {\n \"device_action_id\": {\n \"device_id\": {\n \"id\": \"\"\n },\n \"relay_signal_id\": {\n \"id\": \"\"\n },\n \"relay_index\": \"\"\n },\n \"door_action\": [\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n },\n {\n \"door_id\": {\n \"id\": \"\"\n },\n \"door_signal\": \"\"\n }\n ],\n \"email_action_id\": {\n \"receipients\": [\n \"\",\n \"\"\n ]\n },\n \"smtp_id\": {\n \"id\": \"\"\n }\n },\n \"is_quick_action\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b88f826-4cca-47b1-ba35-6dc36f2d42d4", "name": "View Multiple Trigger Actions", "request": { "name": "View Multiple Trigger Actions", "description": { "content": "This API is used to view trigger actions by ID.", "type": "text/plain" }, "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger and Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c0b4d4d3-6da6-4fee-b6a5-ff671dc5f7a2", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger and Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"TriggerAction\": {\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 \"id\": 1,\n \"name\": \"door1\"\n }\n ],\n \"event_types\": [\n {\n \"code\": 22016,\n \"name\": \"FORCED_OPEN_ALARM\"\n },\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\": \"Relay Signal 1\",\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\": \"SMTP Server\",\n \"smtp_server_addr\": \"smtp.example.com\",\n \"smtp_server_port\": 587,\n \"smtp_security\": 1\n }\n }\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b378c3b-f212-44a4-aad7-41961a604551", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger and Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bc6e0a0-d61a-4ea8-af85-258ae3db13d3", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger and Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fae73f9-4ff9-4f27-9bc0-97451be636b0", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger and Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc025456-e90a-44d4-9b8c-4589f4a8bb1a", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "multiple", "trigger_actions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Trigger and Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d39aebe5-b558-49d7-b061-f0984ff6188b", "name": "Quick Action", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c2fe820a-6d66-48ca-a349-ff2f91563bc1", "name": "Trigger Quick Action by ID", "request": { "name": "Trigger Quick Action by ID", "description": { "content": "This API is used to trigger Quick Action by ID.", "type": "text/plain" }, "url": { "path": [ "api", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "3b77e216-c50e-477c-874f-3bea151ee44e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"QuickActionID\": 1,\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6eda6fbf-33b1-475e-9b9b-2044e690fbfd", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e23a4160-40da-4277-bed8-a72760b76176", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4488346d-f9db-440d-a315-54e036f77f9b", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "628583f9-e36b-49ff-a080-018702d6f12c", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8bfaf6e-bd55-4f6e-9b55-57a164d766c1", "name": "View Trigger Action with Quick Action Enabled", "request": { "name": "View Trigger Action with Quick Action Enabled", "description": { "content": "This API is used to fetch Trigger Actions with Quick Action status enabled.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "quick_action", "alarm_set" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "31f085e1-3dc3-452e-84ae-13f2774442aa", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "alarm_set" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"alarm_sets\": {\n \"id\": 1,\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 \"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 \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18f3c7b4-4cf8-4915-9bea-ed874abab43b", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "alarm_set" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71dea2f0-8fab-4856-a522-2007c65cee97", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "alarm_set" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fb644e8-de35-4bf7-bde4-6ecdd9471bfd", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "alarm_set" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dff83f7f-a7ae-4c1c-acc8-4d2e7ff01719", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "alarm_set" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68297425-0f7c-45c4-aaa3-724775dc2f7f", "name": "View All Quick Action", "request": { "name": "View All Quick Action", "description": { "content": "This API is used to fetch all configured quick actions.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "31f0e050-2283-40b1-b938-4ff69622ebf4", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"quick_action\": [\n {\n \"id\": 1,\n \"name\": \"qc 1\",\n \"description\": \"quick action test\",\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 \"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 \"order_number\": 1,\n \"status\": \"I\",\n \"confirm_before_run\": \"Y\",\n \"trigger_actions\": {\n \"id\": 1,\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 \"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 \"id\": 1,\n \"name\": \"qc 1\",\n \"description\": \"quick action test\",\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 \"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 \"order_number\": 1,\n \"status\": \"I\",\n \"confirm_before_run\": \"Y\",\n \"trigger_actions\": {\n \"id\": 1,\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 \"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 \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce3594b2-aaab-4005-b977-89f4218aadcc", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d5cbe20-cacc-47fb-b2db-90e34a4ee2d1", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b0e42a2-cbcf-424b-89ee-a3e3b206d0f0", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aad4d3dd-75b6-4f6f-88c5-8f421b687efc", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ffadf576-677f-4dd6-80c9-5b34413e3e67", "name": "Save/Update/Delete Quick Action", "request": { "name": "Save/Update/Delete Quick Action", "description": { "content": "This API is used to save/update/delete Quick Action.\n\n`To CREATE`: Fill in all Quick Action(s) parameter (excluding ID). It is possible to create multiple Quick Action in one payload. \nIn the case creating new one while there's existing Quick Action(s), the new one doesn't require ID while the existing require it.\n\n`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.\n\n`To UPDATE`: Fill in all Quick Action(s) parameter (including ID). Input all Quick Action(s) including any which will not be updated.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"QuickActions\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d32cef8-cbb6-4124-9ea6-956cc25fc33c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"QuickActions\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b71d7fb-99e4-4dfb-aa4e-154ba90009a2", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"QuickActions\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4399bd75-5891-4bb6-a6ec-b61e014e6e2a", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"QuickActions\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b182eb8b-4816-4407-b164-991914e35568", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"QuickActions\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b50c35de-e1eb-49ce-9fce-a5005c82ecb1", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"QuickActions\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"confirm_before_run\": \"\",\n \"operator_level_ids\": [\n \"\",\n \"\"\n ],\n \"trigger_action_ids\": [\n \"\",\n \"\"\n ],\n \"order_number\": \"\",\n \"id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f837a91c-368e-4dc0-b901-be40d9c9017a", "name": "View All Quick Action by Permission ID", "request": { "name": "View All Quick Action by Permission ID", "description": { "content": "This API is used to fetch Quick Actions by Permission ID.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "quick_action", "permission", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Permission ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "45038808-22e2-4598-8158-0f6774b37642", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "permission", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Permission ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"quick_action\": [\n {\n \"id\": 1,\n \"name\": \"qc 1\",\n \"description\": \"quick action test\",\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 \"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 \"order_number\": 1,\n \"status\": \"I\",\n \"confirm_before_run\": \"Y\",\n \"trigger_actions\": {\n \"id\": 1,\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 \"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 \"id\": 1,\n \"name\": \"qc 1\",\n \"description\": \"quick action test\",\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 \"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 \"order_number\": 1,\n \"status\": \"I\",\n \"confirm_before_run\": \"Y\",\n \"trigger_actions\": {\n \"id\": 1,\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 \"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 \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66b89af1-5092-4167-ac98-95122d7b5c02", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "permission", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Permission ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fcfbbe5-943d-4e74-9f4d-055933df23f2", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "permission", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Permission ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dfdfc6c-7bb0-413b-a527-ad8f0f160e4c", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "permission", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Permission ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9c82a4e-1434-4e47-9cc8-f7e0de5c103b", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", "permission", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Permission ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2379024-6f70-4337-ba2d-f789cab9970e", "name": "View Quick Action by ID", "request": { "name": "View Quick Action by ID", "description": { "content": "This API is used to fetch Quick Action information by ID.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0f49a09a-0614-4927-a664-461c1ebe5e67", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"quick_action\": [\n {\n \"id\": 1,\n \"name\": \"qc 1\",\n \"description\": \"quick action test\",\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 \"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 \"order_number\": 1,\n \"status\": \"I\",\n \"confirm_before_run\": \"Y\",\n \"trigger_actions\": {\n \"id\": 1,\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 \"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 \"id\": 1,\n \"name\": \"qc 1\",\n \"description\": \"quick action test\",\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 \"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 \"order_number\": 1,\n \"status\": \"I\",\n \"confirm_before_run\": \"Y\",\n \"trigger_actions\": {\n \"id\": 1,\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 \"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 \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc0557e0-335a-4bca-bffa-d5a460dbeb37", "name": "Bad Request - The request was malformed or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c71ae26-17a2-4388-9ff4-34a317478b16", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd06b0b7-d79d-49fc-89ca-c2430f3d1a18", "name": "Not Found - The requested resource was not found.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "399e0509-4b56-4b99-9bcd-520fc47a9106", "name": "Internal Server Error - An unexpected error occurred on the server.", "originalRequest": { "url": { "path": [ "api", "v2", "quick_action", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Quick Action which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Settings", "item": [ { "id": "8b25aca5-29e0-47f7-94e0-56c6341c58d4", "name": "Setting", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "35ae23d8-ac26-419f-8845-118ae5814160", "name": "Update BioStar X Settings", "request": { "name": "Update BioStar X Settings", "description": { "content": "This API is used to update various BioStar X settings.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "biostar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"BioStar\": {\n \"session_timeout\": \"\",\n \"server_port\": \"\",\n \"server_matching\": {\n \"use-server-matching\": \"\",\n \"matching-concurrency-count\": \"\",\n \"security-level\": \"\",\n \"fast-mode\": \"\",\n \"face-security-level\": \"\"\n },\n \"user_sync_method\": \"\",\n \"user_by_device_sync_method\": \"\",\n \"log_sync_method\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5ecd3c9d-06c3-4f0d-a8f0-44eac5371bd8", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "biostar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"BioStar\": {\n \"session_timeout\": \"216000\",\n \"server_port\": \"51212\",\n \"server_matching\": {\n \"matching-concurrency-count\": 2,\n \"use-server-matching\": false,\n \"security-level\": 6,\n \"fast-mode\": true,\n \"face-security-level\": 1\n },\n \"user_sync_method\": 1,\n \"user_by_device_sync_method\": 0,\n \"log_sync_method\": 0,\n \"check_duplicate_id_at_devices\": 0,\n \"automatic_server_upgrade\": 0,\n \"upgrade_when\": 0,\n \"fingerprint_format\": 0,\n \"licese_server_addr\": \"http://license.biostar2.com\",\n \"backup\": {\n \"use\": false,\n \"cycle\": 2,\n \"day\": 28,\n \"weekday\": 2,\n \"time\": 10800,\n \"path\": \".\\\\bk\",\n \"overwritable\": \"false\"\n },\n \"support_mobile_credential\": \"true\",\n \"language\": \"en\",\n \"server_addr\": \"\",\n \"delete_credential_after_aoc\": \"false\",\n \"secure_communication\": {\n \"mode\": \"0\",\n \"use_external_cert\": \"false\",\n \"enable_data_encryption\": \"false\",\n \"enable_db_data_encryption\": \"false\",\n \"ischanged_data_encryption\": \"false\",\n \"ischanged_db_data_encryption\": \"false\",\n \"enable_db_encryption\": \"false\",\n \"is_random_encryption_key\": \"true\",\n \"is_random_hash_key\": \"true\",\n \"has_encryption_key\": \"false\",\n \"has_hash_key\": \"true\"\n },\n \"system_security\": {\n \"password_strength\": \"2\",\n \"use_password_update_cycle\": \"false\",\n \"password_update_cycle\": \"60\",\n \"use_allow_login_failed\": \"false\",\n \"allow_login_failed_count\": \"5\",\n \"allow_login_failed_minutes\": \"10\",\n \"use_allow_password_change\": \"false\",\n \"allow_password_change_count\": \"1\",\n \"use_allow_simultaneous_connection\": \"true\"\n },\n \"web_request_timeout\": \"60\",\n \"imglog_dir\": \".\\\\imagelog\\\\\",\n \"websocket_cors\": \"*\",\n \"enable_websocket_connection_bsSessionId\": \"false\",\n \"enckey_dir\": \"C:\\\\Program Files\\\\BioStar 2(x64)\\\\util\",\n \"device_event_log_skip_enroll_success_user\": \"false\",\n \"http\": {\n \"port\": \"80\",\n \"root_path\": \"html\"\n },\n \"https\": {\n \"use_ssl\": \"1\",\n \"port\": \"443\",\n \"ssl_addr\": \"192.168.1.5\",\n \"server.ssl.key-store-password.use_enc\": \"1\"\n },\n \"cloud\": {\n \"use_cloud\": \"0\",\n \"server_address\": \"api.biostar2.com\",\n \"http_port\": \"52000\",\n \"version\": \"v2\",\n \"sub_domain\": \"oddbit\",\n \"email\": \"team-suprema@oddbit.id\",\n \"account_id\": \"611dcbe1f3e8e50a179b105c\",\n \"email_use_enc\": \"1\"\n },\n \"tna\": {\n \"use_tna\": \"true\",\n \"http_port\": \"3000\",\n \"https_port\": \"3002\",\n \"ngrok_port\": \"51000\"\n },\n \"video\": {\n \"use_video\": \"true\",\n \"http_port\": \"3010\",\n \"https_port\": \"3012\",\n \"ngrok_port\": \"52002\"\n },\n \"licenses\": [\n {\n \"product_type\": \"1\",\n \"name\": \"biostar_def\",\n \"available\": {\n \"ZONE\": \"false\",\n \"ELEVATOR\": \"false\",\n \"SERVER_MATCHING\": \"false\",\n \"CLOUD\": \"false\",\n \"MOBILE_CARD\": \"false\",\n \"GRAPHICMAP\": \"false\"\n },\n \"activated\": \"true\"\n },\n {\n \"product_type\": \"2\",\n \"name\": \"biostar_std\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"3\",\n \"name\": \"biostar_tna\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"4\",\n \"name\": \"biostar2_basic\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"5\",\n \"name\": \"biostar2_std\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"6\",\n \"name\": \"biostar2_adv\",\n \"available\": {\n \"ZONE\": \"true\",\n \"ELEVATOR\": \"true\",\n \"SERVER_MATCHING\": \"true\",\n \"CLOUD\": \"true\",\n \"MOBILE_CARD\": \"true\",\n \"GRAPHICMAP\": \"true\"\n },\n \"activated\": \"true\",\n \"customer\": \"Oddbit\",\n \"expires_on\": \"permanent\"\n },\n {\n \"product_type\": \"7\",\n \"name\": \"biostar2_pro\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"8\",\n \"name\": \"biostar2_ent\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"9\",\n \"name\": \"biostar2_video\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"10\",\n \"name\": \"biostar2_visitor\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"11\",\n \"name\": \"biostar2_tna_std\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"12\",\n \"name\": \"biostar2_tna_adv\",\n \"activated\": \"false\"\n },\n {\n \"product_type\": \"13\",\n \"name\": \"biostar2_tna_pro\",\n \"activated\": \"false\"\n }\n ],\n \"mobile\": {\n \"use_mobile_credential\": \"1\",\n \"email\": \"agni@supremainc.com\",\n \"password\": \"****************\",\n \"mc_server_addr\": \"https://api.mc.suprema.io\",\n \"mc_port\": \"443\",\n \"siteid\": \"6482\",\n \"site_type\": \"REGULAR\"\n },\n \"log_level\": {\n \"enable\": \"true\",\n \"log_retain_days\": \"60\",\n \"level\": \"none\",\n \"filter\": {\n \"SYS\": \"info\",\n \"DBG\": \"none\",\n \"NET\": \"info\",\n \"WEB\": \"info\",\n \"SQL\": \"none\",\n \"WSS\": \"none\"\n }\n },\n \"server_ip_list\": [\n {\n \"ip\": \"192.168.1.5\",\n \"version\": \"v4\"\n }\n ],\n \"use_alphanumeric\": \"false\",\n \"is_set_new_administrator_password\": \"false\",\n \"ischanged_db_data_encryption\": \"false\",\n \"ischanged_data_encryption\": \"false\",\n \"eventlog\": {\n \"event_log_retain_days\": \"60\",\n \"active\": \"false\"\n },\n \"log\": {\n \"log_retain_days\": \"60\",\n \"cron\": \"0 0 0 * * *\",\n \"path\": \"logs\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8793a462-905c-4d51-abdc-dc40d0df7eab", "name": "Create Custom Field(s)", "request": { "name": "Create Custom Field(s)", "description": { "content": "This API is used to create user custom field(s) on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "custom_fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CustomFieldCollection\": {\n \"rows\": [\n {\n \"order\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"data\": \"\",\n \"enable\": \"\"\n },\n {\n \"order\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"data\": \"\",\n \"enable\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6d3b1baf-0ae3-4f44-a60e-fff69ae97fe7", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "custom_fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"CustomFieldCollection\": {\n \"rows\": [\n {\n \"order\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"data\": \"\",\n \"enable\": \"\"\n },\n {\n \"order\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"data\": \"\",\n \"enable\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc62537d-a872-4791-9bea-32f4645f6ed5", "name": "Update Custom Field(s)", "request": { "name": "Update Custom Field(s)", "description": { "content": "This example shows how to update custom field.\n\n**Note:**\n\n- 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.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "custom_fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"CustomFieldCollection\": {\n \"rows\": [\n {\n \"order\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"data\": \"\",\n \"enable\": \"\"\n },\n {\n \"order\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"data\": \"\",\n \"enable\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6283852b-543b-44e0-9e0c-3122d05b26e8", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "custom_fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"CustomFieldCollection\": {\n \"rows\": [\n {\n \"order\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"data\": \"\",\n \"enable\": \"\"\n },\n {\n \"order\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"data\": \"\",\n \"enable\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46b9ea1f-443a-48a2-9a79-266e043ecc82", "name": "Delete Custom Field(s)", "request": { "name": "Delete Custom Field(s)", "description": { "content": "This API is used to delete user custom fields which recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "custom_fields" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "ID of the Custom Field(s) which will be deleted. Use space ( ) as separator for multiple IDs." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "06bea600-5d46-4d76-8ed2-2582eb4c7115", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "custom_fields" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16262a0c-41b1-4971-9455-3fd38c6195fd", "name": "List Available Custom Field(s)", "request": { "name": "List Available Custom Field(s)", "description": { "content": "This API is used to view all available user custom fields.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "custom_fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fc0dcb14-b210-4fdf-800e-bfdaa64d01a7", "name": "OK", "originalRequest": { "url": { "path": [ "api", "setting", "custom_fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"CustomFieldCollection\": {\n \"total\": 5,\n \"rows\": [\n {\n \"id\": 1,\n \"name\": \"combo box 1\",\n \"type\": 2,\n \"order\": 1,\n \"data\": \"1; 2; 3\"\n },\n {\n \"id\": 3,\n \"name\": \"number input\",\n \"type\": 1,\n \"order\": 2\n },\n {\n \"id\": 4,\n \"name\": \"combo box 2\",\n \"type\": 2,\n \"order\": 3,\n \"data\": \"Option 1; Option 2\"\n },\n {\n \"id\": 5,\n \"name\": \"file upload\",\n \"type\": 3,\n \"order\": 4\n },\n {\n \"id\": 2,\n \"name\": \"text input box\",\n \"type\": 0,\n \"order\": 5\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3151de0-60d8-41fd-84ae-92de470b5726", "name": "View Output Signal", "request": { "name": "View Output Signal", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "output_signals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c54caf8a-89f4-4fd3-9424-630ba28f8d2e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "output_signals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bded7587-15d2-4692-8de7-677dd3f85f44", "name": "Create Output Signal", "request": { "name": "Create Output Signal", "description": { "content": "This API is used to create output signal.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "output_signals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"OutputSignal\": {\n \"name\": \"\",\n \"delay\": \"\",\n \"count\": \"\",\n \"on_duration\": \"\",\n \"off_duration\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "27a0c7b3-305e-4bde-98dc-dac187a55640", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "output_signals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"OutputSignal\": {\n \"name\": \"TestElevatorSignal2\",\n \"delay\": 0,\n \"count\": 0,\n \"on_duration\": 0,\n \"off_duration\": 0\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "68f5e1cb-e40c-43f8-b9af-4a707d0a61c1", "name": "Update Output Signal", "request": { "name": "Update Output Signal", "description": { "content": "This API is used to update output signal.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "output_signals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the output signal which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "53d7fa2a-a590-4a3f-b7f9-6818b26c068b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "output_signals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the output signal which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "993b7b68-e4c2-4c04-bac7-bcff746ff981", "name": "Delete Output Signal", "request": { "name": "Delete Output Signal", "description": { "content": "This API is used to delete output signal.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "output_signals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the output signal which will be deleted." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "75db25bc-c25f-412b-a6a5-fdb3f5b26686", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "output_signals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the output signal which will be deleted." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e503131-b6c7-4566-8259-460c19f2b905", "name": "Update Server Matching", "request": { "name": "Update Server Matching", "description": { "content": "If server matching enabled, the user’s fingerprint will be matched from BioStar X, not the device. The Server Matching can be used when the corresponding license is activated.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "biostar", "server_matching" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"BioStar\": {\n \"server_matching\": {\n \"use-server-matching\": \"\",\n \"matching-concurrency-count\": \"\",\n \"security-level\": \"\",\n \"fast-mode\": \"\",\n \"face-security-level\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e1b96bf5-7735-4bc5-a624-2691ca8e1ebb", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "biostar", "server_matching" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"BioStar\": {\n \"server_matching\": {\n \"use-server-matching\": false,\n \"security-level\": 6,\n \"face-security-level\": 1,\n \"fast-mode\": true,\n \"matching-concurrency-count\": 2\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5df07cdd-2914-4dc1-84b4-1e96f58861bd", "name": "Check BioStar X Version", "request": { "name": "Check BioStar X Version", "description": { "content": "This API is used to check BioStar X's version.", "type": "text/plain" }, "url": { "path": [ "js", "info.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "67ed6d8f-77fb-4d33-a8cf-00292fe2fe7b", "name": "Successful response", "originalRequest": { "url": { "path": [ "js", "info.json" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "69997bef-2021-4b68-9fcb-acee508ac47b", "name": "Active Directory", "description": { "content": "Active Directory integration and configuration", "type": "text/plain" }, "item": [ { "id": "ec94a679-b499-4367-8aeb-f5b12c112a47", "name": "Check Active Directory Connection", "request": { "name": "Check Active Directory Connection", "description": { "content": "This API is used to test BioStar X connection with Windows Active Directory.\n\nSuccessful connection will return `code : 0`.\n\nSee these articles for more information on connecting BioStar X with Active Directory:\n- [https://support.supremainc.com/en/support/solutions/articles/24000044140](https://support.supremainc.com/en/support/solutions/articles/24000044140)\n- [https://support.supremainc.com/en/support/solutions/articles/24000041940--biostar-2-how-to-confirm-active-directory-information/en](https://support.supremainc.com/en/support/solutions/articles/24000041940--biostar-2-how-to-confirm-active-directory-information/en)", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "adserverconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"serverAddress\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"userDomainName\": \"\",\n \"useSSL\": \"\",\n \"adlogin\": \"\",\n \"RedirectionUri\": \"\",\n \"adEnable\": \"\",\n \"adType\": \"\",\n \"prevAdType\": \"\",\n \"prevDomainName\": \"\",\n \"prevServerAddr\": \"\",\n \"resetSync\": false,\n \"scheduleSyncInterval\": \"\",\n \"syncEvtCheck\": \"\",\n \"syncType\": \"\",\n \"useCustomField\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "caf5f326-a664-4702-a1dc-b4d9a15d291e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "adserverconnect" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"serverAddress\": \"\",\n \"userName\": \"3323232-1111-33b6-a0a0-dfeq6bc7a762\",\n \"password\": \"asdfasdfas~!2sdfsdfasdf\",\n \"userDomainName\": \"test.onmicrosoft.com\",\n \"useSSL\": false,\n \"adlogin\": false,\n \"RedirectionUri\": \"https://127.0.0.1/api/v2/entraid/auth\",\n \"adEnable\": \"0\",\n \"adType\": \"E\",\n \"prevAdType\": \"E\",\n \"prevDomainName\": \"test.onmicrosoft.com\",\n \"prevServerAddr\": \"\",\n \"resetSync\": false,\n \"scheduleSyncInterval\": 0,\n \"syncEvtCheck\": false,\n \"syncType\": \"N\",\n \"useCustomField\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc75c2c4-9f5b-4744-b771-7ec20a68cde8", "name": "User Group Search", "request": { "name": "User Group Search", "description": { "content": "To run BioStar X AD APIs, it is required to be connected to the AD server.\n\nThis API is used to get User Group information from the Domain Controller.\n\nIt is required to put domain name information on the body.\n\nThe response value is returned in JSON format. At this time, `Collection.rows.userGroups` is used for the next user group update.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "adUserGroupList" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "941d2981-6313-45e6-aaf8-cd88323631ae", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "adUserGroupList" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "DC=domain,DC=com", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f365d5a6-e01c-487d-aab6-9ef03ea9280b", "name": "User Group Update", "request": { "name": "User Group Update", "description": { "content": "Based on the user group information queried in User Group Search, the user group which will be linked is updated.\n\nUpdate the user group and save it to the Biostar X server.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "adUserGroupFilterSetting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"allUserGroup\": \"\",\n \"dn\": \"\",\n \"lastSyncVersion\": \"\",\n \"userGroups\": [\n \"\",\n \"\"\n ],\n \"userGroupFilters\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3de9111a-d8e7-4df2-8c7c-4a66b5a1cbad", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "adUserGroupFilterSetting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"allUserGroup\": \"\",\n \"dn\": \"\",\n \"lastSyncVersion\": \"\",\n \"userGroups\": [\n \"\",\n \"\"\n ],\n \"userGroupFilters\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c4faac07-5641-47fd-8ffb-d302e1cdf668", "name": "View AD User Group Filter List", "request": { "name": "View AD User Group Filter List", "description": { "content": "View group information, subgroup information and filter information that Active Directory or EntraID is using.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "adUserGroupFilterSetting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0e2b5ead-c45f-4264-81ea-79bd7b06306f", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "adUserGroupFilterSetting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"success\",\n \"by\": \"web\"\n },\n \"Collection\": {\n \"total\": 1,\n \"rows\": [\n {\n \"allUserGroup\": false,\n \"dn\": \"supremabss.onmicrosoft.com\",\n \"lastSyncVersion\": 0,\n \"userGroups\": [\n {\n \"id\": 0,\n \"dn\": \"supremabss.onmicrosoft.com\",\n \"name\": \"supremabss.onmicrosoft.com\",\n \"objectGuid\": \"supremabss.onmicrosoft.com\",\n \"filter\": false,\n \"children\": [\n {\n \"id\": 1,\n \"dn\": \"OU=A,DC=supremabss.onmicrosoft.com\",\n \"name\": \"A\",\n \"objectGuid\": \"e1dd535c-76ce-4181-9f3b-869eea61b0b1\",\n \"filter\": true,\n \"children\": [\n {\n \"id\": 2,\n \"dn\": \"OU=B,OU=A,DC=supremabss.onmicrosoft.com\",\n \"name\": \"B\",\n \"objectGuid\": \"9745e0df-1723-4c42-8ea5-febb02865f28\",\n \"filter\": true,\n \"children\": [\n {\n \"id\": 3,\n \"dn\": \"OU=C,OU=B,OU=A,DC=supremabss.onmicrosoft.com\",\n \"name\": \"C\",\n \"objectGuid\": \"8754dd0a-d1a6-455d-8ffc-04357322ff1e\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 3,\n \"isGroup\": true\n }\n ],\n \"depth\": 2,\n \"isGroup\": true\n }\n ],\n \"depth\": 1,\n \"isGroup\": true\n },\n {\n \"id\": 4,\n \"dn\": \"OU=Test3,DC=supremabss.onmicrosoft.com\",\n \"name\": \"Test3\",\n \"objectGuid\": \"77952318-d550-4616-b516-6a65c3f44b57\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 1,\n \"isGroup\": true\n },\n {\n \"id\": 5,\n \"dn\": \"OU=Test4,DC=supremabss.onmicrosoft.com\",\n \"name\": \"Test4\",\n \"objectGuid\": \"cffad5c5-afe5-4029-a44e-4f67ba96baf9\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 1,\n \"isGroup\": true\n },\n {\n \"id\": 6,\n \"dn\": \"OU=Test9,DC=supremabss.onmicrosoft.com\",\n \"name\": \"Test9\",\n \"objectGuid\": \"ea407a19-c769-4db5-b4f6-c8e2ba28fc70\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 1,\n \"isGroup\": true\n }\n ],\n \"depth\": 0,\n \"isGroup\": true\n }\n ],\n \"userGroupFilters\": [\n {\n \"id\": 1,\n \"dn\": \"OU=A,DC=supremabss.onmicrosoft.com\",\n \"name\": \"A\",\n \"objectGuid\": \"e1dd535c-76ce-4181-9f3b-869eea61b0b1\",\n \"filter\": true,\n \"children\": [\n {\n \"id\": 2,\n \"dn\": \"OU=B,OU=A,DC=supremabss.onmicrosoft.com\",\n \"name\": \"B\",\n \"objectGuid\": \"9745e0df-1723-4c42-8ea5-febb02865f28\",\n \"filter\": true,\n \"children\": [\n {\n \"id\": 3,\n \"dn\": \"OU=C,OU=B,OU=A,DC=supremabss.onmicrosoft.com\",\n \"name\": \"C\",\n \"objectGuid\": \"8754dd0a-d1a6-455d-8ffc-04357322ff1e\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 3,\n \"isGroup\": true\n }\n ],\n \"depth\": 2,\n \"isGroup\": true\n }\n ],\n \"depth\": 1,\n \"isGroup\": true\n },\n {\n \"id\": 2,\n \"dn\": \"OU=B,OU=A,DC=supremabss.onmicrosoft.com\",\n \"name\": \"B\",\n \"objectGuid\": \"9745e0df-1723-4c42-8ea5-febb02865f28\",\n \"filter\": true,\n \"children\": [\n {\n \"id\": 3,\n \"dn\": \"OU=C,OU=B,OU=A,DC=supremabss.onmicrosoft.com\",\n \"name\": \"C\",\n \"objectGuid\": \"8754dd0a-d1a6-455d-8ffc-04357322ff1e\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 3,\n \"isGroup\": true\n }\n ],\n \"depth\": 2,\n \"isGroup\": true\n },\n {\n \"id\": 3,\n \"dn\": \"OU=C,OU=B,OU=A,DC=supremabss.onmicrosoft.com\",\n \"name\": \"C\",\n \"objectGuid\": \"8754dd0a-d1a6-455d-8ffc-04357322ff1e\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 3,\n \"isGroup\": true\n },\n {\n \"id\": 4,\n \"dn\": \"OU=Test3,DC=supremabss.onmicrosoft.com\",\n \"name\": \"Test3\",\n \"objectGuid\": \"77952318-d550-4616-b516-6a65c3f44b57\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 1,\n \"isGroup\": true\n },\n {\n \"id\": 5,\n \"dn\": \"OU=Test4,DC=supremabss.onmicrosoft.com\",\n \"name\": \"Test4\",\n \"objectGuid\": \"cffad5c5-afe5-4029-a44e-4f67ba96baf9\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 1,\n \"isGroup\": true\n },\n {\n \"id\": 6,\n \"dn\": \"OU=Test9,DC=supremabss.onmicrosoft.com\",\n \"name\": \"Test9\",\n \"objectGuid\": \"ea407a19-c769-4db5-b4f6-c8e2ba28fc70\",\n \"filter\": true,\n \"children\": [],\n \"depth\": 1,\n \"isGroup\": true\n }\n ]\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2cfc1a1-b8bd-487a-8755-8533fcac8cb4", "name": "Change AD User Mapping", "request": { "name": "Change AD User Mapping", "description": { "content": "This API is used to set the user field configuration.\n\nThe payload is in the form of a JSON array. \nEach array has BioStar X column name (columnm), AD column name (adcolumnm), whether to use (use), and column description (columnmdescription).\n\n```\n[ \n {\"columnm\":\"usrid\",\"adcolumnm\":\"sAMAccountName\", \"use\":\"true\",\"columnmdescription\":\"userid\"}\n {\"columnm\":\"nm\",\"adcolumnm\":\"displayName\", \"use\":\"true\",\"columnmdescription\":\"User NAME\"} \n]\n```\n\nIf you set the payload as above, you can sync the username as well.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "changeadusrmappinglist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "[\n {\n \"columnm\": \"\",\n \"adcolumnm\": \"\",\n \"use\": \"\",\n \"columnmdescription\": \"\"\n },\n {\n \"columnm\": \"\",\n \"adcolumnm\": \"\",\n \"use\": \"\",\n \"columnmdescription\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "70390c8e-4de0-4e05-8dc4-665762ee750b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "changeadusrmappinglist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"columnm\": \"usrid\",\n \"adcolumnm\": \"initials\",\n \"use\": \"true\",\n \"columnmdescription\": \"User ID\"\n },\n {\n \"columnm\": \"nm\",\n \"adcolumnm\": \"displayName\",\n \"use\": \"true\",\n \"columnmdescription\": \"User Name\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fd9c451-18bf-4b30-8f04-0d793737fc07", "name": "Synchronize", "request": { "name": "Synchronize", "description": { "content": "This API is used to synchronizes AD user information with Biostar X.\n\nIf there is no user group change or field reorganization then only this synchronization operation is sufficient.\n\nserverAddress, userName, password, userDomainName, and useSSL must be sent in the payload.\n\nlastSyncTime, lastSyncResult, lastUpdateTime fields on response are \"recent sync time with ad server\", \"recent sync result\", \"recent update time of ad server information\", \nIt can be checked through `GET /api/v2/setting/adserversetting`", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "syncadserver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"serverAddress\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"userDomainName\": \"\",\n \"useSSL\": \"\",\n \"adlogin\": \"\",\n \"RedirectionUri\": \"\",\n \"adEnable\": \"\",\n \"adType\": \"\",\n \"prevAdType\": \"\",\n \"prevDomainName\": \"\",\n \"prevServerAddr\": \"\",\n \"resetSync\": false,\n \"scheduleSyncInterval\": \"\",\n \"syncEvtCheck\": \"\",\n \"syncType\": \"\",\n \"useCustomField\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2ef7abe0-d679-498b-886b-028f29588eee", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "syncadserver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"adType\": \"E\",\n \"RedirectionUri\": \"https://192.168.12.161/api/v2/entraid/auth\",\n \"scheduleSyncInterval\": 0,\n \"syncType\": \"N\",\n \"useSSL\": false,\n \"adlogin\": false,\n \"adEnable\": \"0\",\n \"serverAddress\": \"\",\n \"userName\": \"3323232-1111-33b6-a0a0-dfeq6bc7a762\",\n \"password\": \"asdfasdfas~!2sdfsdfasdf\",\n \"userDomainName\": \"test.onmicrosoft.com\",\n \"syncEvtCheck\": true,\n \"prevAdType\": \"E\",\n \"prevDomainName\": \"\",\n \"prevServerAddr\": \"\",\n \"resetSync\": false,\n \"useCustomField\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b9fef24-e7ad-49b3-ae71-479488d1f2da", "name": "View AD Server Setting", "request": { "name": "View AD Server Setting", "description": { "content": "Retrieves AD server configurations.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "adserversetting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "96021c73-700f-4107-a6f3-6e4a7b156d56", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "adserversetting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ADServerSettingCollection\": {\n \"total\": 1,\n \"rows\": [\n {\n \"serverAddress\": \"192.111.22.3\",\n \"userName\": \"test\",\n \"password\": \"test1!\",\n \"userDomainName\": \"DC=test,DC=co,DC=kr\",\n \"lastSyncTime\": 1748311298580,\n \"lastSyncResult\": \"0\",\n \"lastUpdateTime\": 1748311298580,\n \"useSSL\": false,\n \"adlogin\": false,\n \"adType\": \"A\",\n \"scheduleSyncInterval\": 0,\n \"adEnable\": \"0\",\n \"syncEvtCheck\": false,\n \"resetSync\": false,\n \"targetUserIds\": []\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5267a7f-eae5-4b54-8649-f81a26824d99", "name": "View AD User Mapping List", "request": { "name": "View AD User Mapping List", "description": { "content": "Retrieves the mapping relationships between user attribute fields in BioStar X and those used in Active Directory or Entra ID.\n\nPlease note that the required mapping information differs between Entra ID and Active Directory.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "adusrmappinglist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "398348ad-2700-4f75-bf41-7ba4136faeff", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "adusrmappinglist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ADUsrMappingCollection\": {\n \"total\": 9,\n \"rows\": [\n {\n \"columnm\": \"userID\",\n \"adcolumnm\": \"none\"\n },\n {\n \"columnm\": \"userName\",\n \"adcolumnm\": \"displayName\"\n },\n {\n \"columnm\": \"email\",\n \"adcolumnm\": \"mail\"\n },\n {\n \"columnm\": \"phone\",\n \"adcolumnm\": \"businessPhones\"\n },\n {\n \"columnm\": \"expiry_datetime\",\n \"adcolumnm\": \"employeeLeaveDateTime\"\n },\n {\n \"columnm\": \"department\",\n \"adcolumnm\": \"department\"\n },\n {\n \"columnm\": \"user_title\",\n \"adcolumnm\": \"jobTitle\"\n },\n {\n \"columnm\": \"usergroup\",\n \"adcolumnm\": \"memberOf\"\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ce332d4-c7aa-4826-ae94-adcfad0025c1", "name": "View AD Column List", "request": { "name": "View AD Column List", "description": { "content": "Retrieve user property information used by Active Directory or EntraID.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "adcolumnlist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f7acc596-4151-49ba-ab47-87b20219963a", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "adcolumnlist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"List\": {\n \"total\": 286,\n \"rows\": [\n {\n \"seq\": 208,\n \"adcolumnm\": \"aboutMe\",\n \"adtype\": \"E\"\n },\n {\n \"seq\": 209,\n \"adcolumnm\": \"accountEnabled\",\n \"adtype\": \"E\"\n },\n {\n \"seq\": 1,\n \"adcolumnm\": \"accountExpires\",\n \"adtype\": \"A\"\n },\n {\n \"seq\": 2,\n \"adcolumnm\": \"accountNameHistory\",\n \"adtype\": \"A\"\n },\n {\n \"seq\": 3,\n \"adcolumnm\": \"aCSPolicyName\",\n \"adtype\": \"A\"\n },\n {\n \"seq\": 4,\n \"adcolumnm\": \"adminCount\",\n \"adtype\": \"A\"\n }\n ]\n },\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"success\",\n \"by\": \"web\"\n },\n \"ADColumnCollection\": {\n \"total\": 286,\n \"rows\": [\n {\n \"seq\": 208,\n \"adcolumnm\": \"aboutMe\",\n \"adtype\": \"E\"\n },\n {\n \"seq\": 209,\n \"adcolumnm\": \"accountEnabled\",\n \"adtype\": \"E\"\n },\n {\n \"seq\": 1,\n \"adcolumnm\": \"accountExpires\",\n \"adtype\": \"A\"\n },\n {\n \"seq\": 2,\n \"adcolumnm\": \"accountNameHistory\",\n \"adtype\": \"A\"\n },\n {\n \"seq\": 3,\n \"adcolumnm\": \"aCSPolicyName\",\n \"adtype\": \"A\"\n },\n {\n \"seq\": 4,\n \"adcolumnm\": \"adminCount\",\n \"adtype\": \"A\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c1193bde-f00e-4053-86b7-b2364114eb4a", "name": "Check EntraID SSO Login Setting", "request": { "name": "Check EntraID SSO Login Setting", "description": { "content": "Checks whether Entra ID SSO Login is enabled.\n\nIf the **\"BioStar X 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'`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "setting", "checkEntraIDSetting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d02f7abf-b6c5-49e7-bdaf-063418b711af", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "setting", "checkEntraIDSetting" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"D\",\n \"by\": \"web\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5988b4cc-84c3-4cba-b7ac-1dea67e0c30b", "name": "Email Setting", "description": { "content": "Email notification settings", "type": "text/plain" }, "item": [ { "id": "4f704ce9-ef2e-4f41-9f89-6275a30b8d74", "name": "View Email Setting", "request": { "name": "View Email Setting", "description": { "content": "This API is used to view the email template for Visual Face and BioStar X QR.", "type": "text/plain" }, "url": { "path": [ "api", "setting_email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "53d31ed5-4745-466d-accb-e683aa26ea3d", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting_email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e62b451-dcea-403c-bdc7-3bbc893e3f13", "name": "Create Email Setting (Visual Face / QR)", "request": { "name": "Create Email Setting (Visual Face / QR)", "description": { "content": "This API is used to set email template for Visual Face and BioStar X QR.", "type": "text/plain" }, "url": { "path": [ "api", "setting_email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "email_type", "value": "", "description": "1:Visual face mobile enrollment contents, 2:QR credential contents" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"company_name\": \"\",\n \"company_logo\": \"\",\n \"admin_contact\": \"\",\n \"use_setting\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b5c6b4ce-26db-4cc8-ab58-84d538b26c50", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting_email" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "email_type", "value": "1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"VisualFace\",\n \"company_name\": \"Suprema Inc.\",\n \"company_logo\": \"\",\n \"admin_contact\": \"admin@example.com\",\n \"use_setting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c1026c9-5319-40c0-8bb7-c1a7d2affa2d", "name": "Update Email Setting (Visual Face / QR)", "request": { "name": "Update Email Setting (Visual Face / QR)", "description": { "content": "This API is used to set email template for Visual Face and BioStar X QR.", "type": "text/plain" }, "url": { "path": [ "api", "setting_email" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "email_type", "value": "", "description": "1:Visual face mobile enrollment contents, 2:QR credential contents" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"company_name\": \"\",\n \"company_logo\": \"\",\n \"admin_contact\": \"\",\n \"use_setting\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0f548302-8534-42d7-b382-6eba0dc23f67", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting_email" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "email_type", "value": "1" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"VisualFace\",\n \"company_name\": \"Suprema Inc.\",\n \"company_logo\": \"\",\n \"admin_contact\": \"admin@example.com\",\n \"use_setting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12ceb572-a07f-48d9-9704-6d5805386cda", "name": "View SMTP Setting", "request": { "name": "View SMTP Setting", "description": { "content": "This API is used to view the SMTP (Simple Mail Transfer Protocol) for sending emails.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "alarm_smtps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "1b5d87ef-67b6-412d-b6d0-006988daaa1b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "alarm_smtps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ca452f8-76f6-4d15-8523-523d072793c4", "name": "Create SMTP Setting", "request": { "name": "Create SMTP Setting", "description": { "content": "This API is used to set the SMTP (Simple Mail Transfer Protocol) for sending emails.\n\n**Note:**\n\nWhen using an SMTP server with an email account that has two-factor authentication (2FA) enabled, be aware of the following:\n- Once 2FA is set up, the SMTP password is **not** the same as the email account password. Instead, it corresponds to an **app password** generated specifically for use with 2FA.\n- If you change the email account password, all existing app passwords are automatically revoked. As a result, the previously configured SMTP password will no longer work.\n- After changing the email account password, you must **generate a new app password** and **update the SMTP settings** with the new value.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "alarm_smtps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AlarmSmtp\": {\n \"name\": \"\",\n \"description\": \"\",\n \"smtp_server_addr\": \"\",\n \"smtp_server_port\": \"\",\n \"smtp_username\": \"\",\n \"smtp_password\": \"\",\n \"smtp_security\": \"\",\n \"smtp_sender\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f874d644-780e-42c7-91e2-e44964241999", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "alarm_smtps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AlarmSmtp\": {\n \"name\": \"smtp.example.com\",\n \"description\": \"Example SMTP Server\",\n \"smtp_server_addr\": \"smtp.example.com\",\n \"smtp_server_port\": \"587\",\n \"smtp_username\": \"user@example.com\",\n \"smtp_password\": \"\",\n \"smtp_security\": \"2\",\n \"smtp_sender\": \"sender@example.com\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b626aea5-a0bb-491b-80b2-17c7eb8d3670", "name": "Update SMTP Setting", "request": { "name": "Update SMTP Setting", "description": { "content": "This API is used to update the SMTP (Simple Mail Transfer Protocol) for sending emails.\n\n**Note:**\n\nWhen using an SMTP server with an email account that has two-factor authentication (2FA) enabled, be aware of the following:\n- Once 2FA is set up, the SMTP password is **not** the same as the email account password. Instead, it corresponds to an **app password** generated specifically for use with 2FA.\n \n- If you change the email account password, all existing app passwords are automatically revoked. As a result, the previously configured SMTP password will no longer work.\n \n- After changing the email account password, you must **generate a new app password** and **update the SMTP settings** with the new value.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "alarm_smtps", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the SMTP setting which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AlarmSmtp\": {\n \"name\": \"\",\n \"description\": \"\",\n \"smtp_server_addr\": \"\",\n \"smtp_server_port\": \"\",\n \"smtp_username\": \"\",\n \"smtp_password\": \"\",\n \"smtp_security\": \"\",\n \"smtp_sender\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b3da43d1-271a-463d-8e41-d267729222da", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "alarm_smtps", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the SMTP setting which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"AlarmSmtp\": {\n \"name\": \"smtp.example.com\",\n \"description\": \"Example SMTP Server\",\n \"smtp_server_addr\": \"smtp.example.com\",\n \"smtp_server_port\": \"587\",\n \"smtp_username\": \"user@example.com\",\n \"smtp_password\": \"\",\n \"smtp_security\": \"2\",\n \"smtp_sender\": \"sender@example.com\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5d9085a-fb5c-4390-aa98-44e15a447995", "name": "Test SMTP Connection", "request": { "name": "Test SMTP Connection", "description": { "content": "This API is used to test SMTP connection by sending an email to the specified address.\n\nDo note that the address input here need to be a complete email address.", "type": "text/plain" }, "url": { "path": [ "api", "test_smtp_connection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"target_email\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0cb693ea-5d40-49dc-981b-3fde44cc6fb5", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "test_smtp_connection" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target_email\": \"example@example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6b26f47a-7d7e-4278-bb20-451b30ef958f", "name": "Preference", "description": { "content": "System preferences and configuration", "type": "text/plain" }, "item": [ { "id": "64f0c716-eb29-45ab-8152-0b673bc74e41", "name": "View Preference", "request": { "name": "View Preference", "description": { "content": "This API is used to view preference information.", "type": "text/plain" }, "url": { "path": [ "api", "preferences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the user which preference will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "234b0b79-9806-4a89-8552-7bf32ef51660", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "preferences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the user which preference will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "005b0c8a-fa6f-45f2-8f56-b282053ffbfe", "name": "Update Preference", "request": { "name": "Update Preference", "description": { "content": "This API is used to update preference configuration.", "type": "text/plain" }, "url": { "path": [ "api", "preferences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Preference\": {\n \"language\": \"\",\n \"date_format\": \"\",\n \"time_format\": \"\",\n \"time_long_term_format\": \"\",\n \"time_zone\": \"\",\n \"dst1\": \"\",\n \"dst2\": \"\",\n \"depend_on_os\": \"\",\n \"user_id\": {\n \"user_id\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "106793d2-735d-4dde-8e8a-091924c065b8", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "preferences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Preference\": {\n \"language\": \"en\",\n \"date_format\": \"yyyy/MM/dd\",\n \"time_format\": \"HH:mm\",\n \"time_long_term_format\": \"HH:mm:ss\",\n \"time_zone\": \"25\",\n \"dst1\": \"0\",\n \"dst2\": \"0\",\n \"depend_on_os\": true,\n \"user_id\": {\n \"user_id\": 6\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6c524d1-f918-44ff-8768-e8e4b28aa319", "name": "Add Preference", "request": { "name": "Add Preference", "description": { "content": "This API is used to add preference configuration.", "type": "text/plain" }, "url": { "path": [ "api", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Preference\": {\n \"language\": \"\",\n \"date_format\": \"\",\n \"time_format\": \"\",\n \"time_long_term_format\": \"\",\n \"time_zone\": \"\",\n \"dst1\": \"\",\n \"dst2\": \"\",\n \"depend_on_os\": \"\",\n \"user_id\": {\n \"user_id\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1b808ec6-6248-4d1f-ac7f-83ced49b804e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "preferences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Preference\": {\n \"language\": \"en\",\n \"date_format\": \"yyyy/MM/dd\",\n \"time_format\": \"HH:mm\",\n \"time_long_term_format\": \"HH:mm:ss\",\n \"time_zone\": \"25\",\n \"dst1\": \"0\",\n \"dst2\": \"0\",\n \"depend_on_os\": true,\n \"user_id\": {\n \"user_id\": 6\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "945e019f-6d99-4fd0-8e2d-dad196cf3b9f", "name": "Virtual Device & Event Import", "description": { "content": "This feature allows external systems (e.g., mobile T&A apps) to send **punch/access events** directly to **BioStar X** **without database-level integration**.\n\nTo ensure data consistency, each event must be associated with a **Virtual Device** — a device record created inside BioStar X to represent the external source.\n\n**Notes:**\n\n- Virtual Devices are **non-functional placeholders** and **cannot be used for access control, doors, or Advanced AC features**. Their only purpose is to logically link imported events to a known device identity.\n \n- **BioStar X Event Log API** license is required for the feature.\n \n\n### Step-by-Step: How to Use\n\n#### Step 1: Create a Virtual Device\n\n- Use `POST /api/v2/virtual_devices` to create a new virtual device.\n \n- Usable ID range: **100001–999999**\n \n- Ensure it’s **not a duplicate ID or name**.\n \n- Assign it to an existing **device group**.\n \n\n---\n\n#### Step 2: Verify Virtual Device\n\n- Use `GET /api/v2/virtual_devices`\n \n\nto confirm your virtual device is registered and visible.\n\n---\n\n#### Step 3: Import Events\n\n- Prepare your event payload with the same `packet_device_id` as the virtual device ID.\n \n- Ensure all timestamps are in **UTC**.\n \n- Use `POST /api/events/import` to upload multiple events at once.\n \n\n---\n\n#### Step 4: Verify Event Import\n\n- After import, use existing endpoints such as:\n \n - `POST /api/events/search`\n \n\nto confirm the events are visible in BioStar X event logs.\n\n---\n\n#### Step 5: Troubleshooting\n\nIf an error occurs:\n\n- Check that `is_virtual_device` is `\"true\"`.\n \n- Confirm all `user_id`s exist.\n \n- Verify datetime formatting (`YYYY-MM-DDTHH:mm:ssZ`).\n \n- Ensure the event code is either `4088` or `6400`.", "type": "text/plain" }, "item": [ { "id": "aa0175a9-4724-4dc1-839a-c9fa27e42a0c", "name": "Create a New Virtual Device", "request": { "name": "Create a New Virtual Device", "description": { "content": "Registers a **virtual device** within BioStar X.\n\nEach virtual device:\n\n- Must have a unique `id` (range: 100001–999999).\n \n- Cannot duplicate existing device IDs or names.\n \n- Appears in device lists when `?virtual=true` is included in search queries.\n\n**Notes:**\n\n- Virtual devices are **non-functional** placeholders (cannot control doors or perform access).\n \n- Once created, the **device ID cannot be modified**.\n \n- Virtual devices can be listed using `GET /api/v2/devices/search?virtual=true`.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "virtual_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"VirtualDevice\": {\n \"id\": \"\",\n \"name\": \"\",\n \"device_group_id\": {\n \"id\": \"\"\n },\n \"description\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d69dca88-1b8f-44fb-9527-b9738796c0c9", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "virtual_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"VirtualDevice\": {\n \"id\": 100001,\n \"name\": \"Virtual Device 100001\",\n \"device_group_id\": {\n \"id\": 1\n },\n \"description\": \"Virtual device for mobile punch import\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"VirtualDevices\": [\n {\n \"id\": 100001,\n \"name\": \"Virtual Device 100001\",\n \"description\": \"Virtual device for mobile punch import\",\n \"device_group_id\": {\n \"id\": 1\n }\n },\n {\n \"id\": 100001,\n \"name\": \"Virtual Device 100001\",\n \"description\": \"Virtual device for mobile punch import\",\n \"device_group_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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f928567-6070-48c8-8be6-e38aee9038fb", "name": "Forbidden", "originalRequest": { "url": { "path": [ "api", "v2", "virtual_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"VirtualDevice\": {\n \"id\": 100001,\n \"name\": \"Virtual Device 100001\",\n \"device_group_id\": {\n \"id\": 1\n },\n \"description\": \"Virtual device for mobile punch import\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"331791\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"License is required.\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1a53a508-3bc1-4bcb-b578-ece6a5a6e051", "name": "Fetch Registered Virtual Devices", "request": { "name": "Fetch Registered Virtual Devices", "description": { "content": "Retrieve a list of registered virtual devices.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "virtual_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c97875a4-a8d6-49df-bf80-34bf02e12520", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "virtual_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"VirtualDevices\": [\n {\n \"id\": 100001,\n \"name\": \"Virtual Device 100001\",\n \"description\": \"Virtual device for mobile punch import\",\n \"device_group_id\": {\n \"id\": 1\n }\n },\n {\n \"id\": 100001,\n \"name\": \"Virtual Device 100001\",\n \"description\": \"Virtual device for mobile punch import\",\n \"device_group_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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce07f54c-707f-44ef-a6f8-926e04dbaaeb", "name": "Delete Virtual Device", "request": { "name": "Delete Virtual Device", "description": { "content": "Deletes one or more virtual devices based on provided IDs.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "virtual_devices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "3b979214-c7d3-42d8-a92b-e3fd49cc6196", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "virtual_devices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "100002" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Devices deleted successfully\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "998de612-5af9-44fc-a3d4-03142f1d81df", "name": "Modify Existing Virtual Device", "request": { "name": "Modify Existing Virtual Device", "description": { "content": "Modify existing virtual device details. Only updatable fields need to be included.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "virtual_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Virtual Device which will be modified." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "88af57c6-3ee9-443e-bc1e-fd4b49d07890", "name": "OK", "originalRequest": { "url": { "path": [ "api", "v2", "virtual_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Virtual Device which will be modified." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"VirtualDevice\": {\n \"device_group_id\": {\n \"id\": 1\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"VirtualDevices\": [\n {\n \"id\": 100001,\n \"name\": \"Virtual Device 100001\",\n \"description\": \"Virtual device for mobile punch import\",\n \"device_group_id\": {\n \"id\": 1\n }\n },\n {\n \"id\": 100001,\n \"name\": \"Virtual Device 100001\",\n \"description\": \"Virtual device for mobile punch import\",\n \"device_group_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 \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4e54f80-6b9c-4d6f-a1b4-a43a9351a8ab", "name": "Import Events", "request": { "name": "Import Events", "description": { "content": "Imports external access events into the system.\n\nAllows batch import of **Access Granted (4088)** and **Access Denied (6400)** events generated by a **Virtual Device**.\n\nThis is typically used when an external app generates punch logs (e.g., mobile attendance).\n\nEach imported event is stored as a normal BioStar X event, visible in event logs and reports.\n\n**Important Rules**\n\n- `packet_device_id` and every `events[].dev_id` must match.\n \n- Only **virtual devices** are allowed.\n \n- Only **event codes 4088 or 6400** are permitted.\n \n- `datetime` must be in **UTC** (convert local time accordingly).\n \n- All `user_id`s must exist in the system.\n \n- Each imported event will be logged individually (one row per event).", "type": "text/plain" }, "url": { "path": [ "api", "events", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"packet_device_id\": \"\",\n \"is_virtual_device\": \"\",\n \"events\": [\n {\n \"dev_id\": \"\",\n \"evt\": \"\",\n \"datetime\": \"\",\n \"user_id\": \"\",\n \"tna_key\": \"\"\n },\n {\n \"dev_id\": \"\",\n \"evt\": \"\",\n \"datetime\": \"\",\n \"user_id\": \"\",\n \"tna_key\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "17fb9966-2575-42d1-a80f-038f43418a90", "name": "Events imported successfully", "originalRequest": { "url": { "path": [ "api", "events", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"packet_device_id\": 100001,\n \"is_virtual_device\": true,\n \"events\": [\n {\n \"dev_id\": 100001,\n \"evt\": 6400,\n \"datetime\": \"2025-10-30T15:12:00Z\",\n \"user_id\": \"2\",\n \"tna_key\": \"1\"\n },\n {\n \"dev_id\": 100001,\n \"evt\": 6400,\n \"datetime\": \"2025-10-30T15:13:01Z\",\n \"user_id\": \"2\",\n \"tna_key\": \"1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ] }, { "id": "00ad82f3-c77b-44f0-a8f0-9f39e19a5f71", "name": "Mobile Access", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "93cce1b7-2a10-46c2-856f-10f9c59c5d73", "name": "Delete Mobile Access Card in Airfob Portal: ALL on User ID", "request": { "name": "Delete Mobile Access Card in Airfob Portal: ALL on User ID", "description": { "content": "This API is used to delete Mobile Access Card in Airfob Portal.\n\nThere are three variations in using this API:\n\n1. Using Card ID\n \n2. Using User ID\n \n3. Using ALL parameter on User ID\n\n- To delete multiple `card_id` or `user_id`, separate each value with comma (,). Ex: \\[\"1\", \"2\", \"3\"\\]\n \n- This API only remove Mobile Access Card information from Airfob Portal. To remove Mobile Access credential from the user, use `PUT /api/users/:id`", "type": "text/plain" }, "url": { "path": [ "api", "v2", "mobile", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"MobileCollection\": {\n \"mobile\": {\n \"user_id\": \"\",\n \"card_id\": [\n \"\",\n \"\"\n ],\n \"param\": {\n \"UserIDs\": \"ALL\",\n \"query\": {\n \"group_id\": 1\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "24798698-2d52-4825-9746-dba5a0b641bd", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "mobile", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MobileCollection\": {\n \"mobile\": {\n \"user_id\": \"ALL\",\n \"card_id\": [\n \"1\",\n \"2\",\n \"3\"\n ],\n \"param\": {\n \"UserIDs\": \"ALL\",\n \"query\": {\n \"group_id\": 1\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"mobileUsers\": [\n \"3\",\n \"4\"\n ],\n \"status\": 0,\n \"errorMessage\": \"\",\n \"Response\": {\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b70c7cec-66f9-4080-954b-dac949a47203", "name": "Create Mobile Access Card in Airfob Portal", "request": { "name": "Create Mobile Access Card in Airfob Portal", "description": { "content": "This API is used to create Mobile Access Card in Airfob Portal.\n\n**Note:**\n- When creating mobile access cards, Airfob portal sites are divided into regular and dynamic\n- The startDate and endDate fields are used when the sites are dynamic sites\n\n**ToM**\n- ToM uses Extend mode for personal authentication mode when creating a card\n- 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\n- In API, if you put in the cardAuthModeEx value, the server internally maps the cardAuthMode value\n\n**Card AuthMode Mapping Table:**\n\n| **cardAuthModeEx** | **cardAuthMode** |\n| --- | --- |\n| 21 - Card | 2 - Card only |\n| 22 - Card + Face | 3 - Card + Fingerprint |\n| 23 - Card + Fingerprint | 3 - Card + Fingerprint |\n| 24 - Card + PIN | 4 - Card + PIN |\n| 25 - Card + Face or Fingerprint | 5 - Card + Fingerprint or PIN |\n| 26 - Card + Face or PIN | 5 - Card + Fingerprint or PIN |\n| 27 - Card + Fingerprint or PIN | 5 - Card + Fingerprint or PIN |\n| 28 - Card + Face or Fingerprint or PIN | 5 - Card + Fingerprint or PIN |\n| 29 - Card + Face + Fingerprint | 6 - Card + Fingerprint + PIN |\n| 30 - Card + Face + PIN | 6 - Card + Fingerprint + PIN |\n| 31 - Card + Fingerprint + Face | 6 - Card + Fingerprint + PIN |\n| 32 - Card + Fingerprint + PIN | 6 - Card + Fingerprint + PIN |\n| 33 - Card + Face or Fingerprint + PIN | 6 - Card + Fingerprint + PIN |\n| 34 - Card + Face + Fingerprint or PIN | 6 - Card + Fingerprint + PIN |\n| 35 - Card + Fingerprint + Face or PIN | 6 - Card + Fingerprint + PIN |", "type": "text/plain" }, "url": { "path": [ "api", "v2", "mobile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"MobileCollection\": {\n \"mobile\": {\n \"user_id\": [\n \"\",\n \"\"\n ],\n \"email\": [\n \"\",\n \"\"\n ],\n \"card_id\": [\n \"\",\n \"\"\n ],\n \"startTime\": [\n \"\",\n \"\"\n ],\n \"endTime\": [\n \"\",\n \"\"\n ],\n \"mobileCardType\": [\n \"\",\n \"\"\n ],\n \"name\": [\n \"\",\n \"\"\n ],\n \"title\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"phone\": [\n \"\",\n \"\"\n ],\n \"portraitData\": [\n \"\",\n \"\"\n ],\n \"startDate\": [\n \"\",\n \"\"\n ],\n \"endDate\": [\n \"\",\n \"\"\n ],\n \"issueCount\": [\n \"\",\n \"\"\n ],\n \"duressMask\": [\n \"\",\n \"\"\n ],\n \"useAlphanumericID\": [\n \"\",\n \"\"\n ],\n \"cardAuthModeEx\": [\n \"\",\n \"\"\n ],\n \"pin\": [\n \"\",\n \"\"\n ],\n \"accessGroupId\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "404f8168-e2a7-4657-a5a7-45ddbf7985d2", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "mobile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"MobileCollection\": {\n \"mobile\": {\n \"user_id\": [\n \"3\"\n ],\n \"email\": [\n \"test2@suprema.com\"\n ],\n \"card_id\": [\n \"2\"\n ],\n \"startTime\": [\n 978274800000\n ],\n \"endTime\": [\n 1924959540000\n ],\n \"mobileCardType\": [\n \"4\"\n ],\n \"name\": [\n \"test2\"\n ],\n \"title\": [\n null\n ],\n \"department\": [\n null\n ],\n \"phone\": [\n null\n ],\n \"portraitData\": [\n null\n ],\n \"startDate\": [\n 1703563320000\n ],\n \"endDate\": [\n 1703649720000\n ],\n \"issueCount\": [\n 1\n ],\n \"duressMask\": [\n null\n ],\n \"useAlphanumericID\": [\n 0\n ],\n \"cardAuthModeEx\": [\n 21\n ],\n \"pin\": [\n null\n ],\n \"accessGroupId\": [\n null\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"MobileCollection\": {\n \"listMobile\": [\n {\n \"apisnddt\": \"2023-12-26T04:03:17.382Z\",\n \"userid\": 2,\n \"crdid\": 2,\n \"portalrslt\": \"\"\n },\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 \"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 \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80ecbb74-93dc-4d9c-ba07-f055a1f7e36b", "name": "View Deleted CSN Mobile", "request": { "name": "View Deleted CSN Mobile", "description": { "content": "This API is used to fetch CSN Mobile information deleted from the list.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cards", "mobile", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Limit the number of responses by n records. Remove this parameter to view all." }, { "disabled": false, "key": "offset", "value": "", "description": "Offset the response shown by n records." }, { "disabled": false, "key": "search_type", "value": "", "description": "Filter the response by card type (DELETED_CSN_MOBILE)." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e1a855b6-b2db-40d2-b68f-a42d9627dc0e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "cards", "mobile", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" }, { "key": "search_type", "value": "DELETED_CSN_MOBILE" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"CardCollection\": {\n \"rows\": [\n {\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 {\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 {\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 ],\n \"total\": 3\n },\n \"Response\": {\n \"code\": 0\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8de5a5d-7931-40c4-8d61-eae5653d584c", "name": "Delete CSN Mobile", "request": { "name": "Delete CSN Mobile", "description": { "content": "This API is used to delete CSN Mobile information.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cards", "mobile", "enable" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "", "description": "Card UID value, separate using comma (,). Use asterisk (*) to select all." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "a4a3877d-3bb3-4e38-8ca7-799193210de0", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "cards", "mobile", "enable" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "18,19,20" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "11192032-788a-4757-bef8-3df0510d4e74", "name": "Count Deleted CSN Mobile", "request": { "name": "Count Deleted CSN Mobile", "description": { "content": "This API is used to count deleted CSN Mobile information.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "cards", "mobile", "count" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"cardUids\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bae4aafc-124a-4e41-84f5-ee0fffa1b67b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "cards", "mobile", "count" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"cardUids\": \"11,12,13,16,17\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"CardCollection\": {\n \"count\": 2\n },\n \"Response\": {\n \"code\": \"0\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d8571de2-ff2a-4450-9beb-749d13e6e230", "name": "Events", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "703f1077-af3d-493c-b2b1-93264788d179", "name": "Download CSV File", "request": { "name": "Download CSV File", "description": { "content": "This API is used to download exported CSV files from BioStar X Server.\n\nSupports downloading both user-related CSV files and events-related CSV files. The system automatically detects the file type based on the filename pattern.\n\n**Supported File Types:**\n- **User CSV files**: Generated from `POST /api/users/csv_export`\n- **Events CSV files**: Generated from `POST /api/events/export`\n\n**Usage:**\n1. Export data using the appropriate API (`csv_export` for users, `export` for events)\n2. Get the filename from the export response\n3. Use the filename as the path parameter in this download API", "type": "text/plain" }, "url": { "path": [ "download", ":csv_filename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "csv_filename", "description": "(Required) Name of the CSV file to download (supports both user and events files)" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "98e099a9-7928-47c4-a275-ce4a13496607", "name": "Successful response", "originalRequest": { "url": { "path": [ "download", ":csv_filename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "csv_filename", "description": "(Required) Name of the CSV file to download (supports both user and events files)" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43334f48-cf7f-4c66-b5fd-d25ed7fc5088", "name": "Fetch Event Image", "request": { "name": "Fetch Event Image", "description": { "content": "When query events through **Search Events** (`/api/events/search`), events that contain image logs include the response fields.\nThe `image_data` value can be used to retrieve the corresponding image file.", "type": "text/plain" }, "url": { "path": [ "api", "events", "images", ":image_data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "image_data", "description": "(Required) (String, Required) – The identifier of the image, obtained from the event search response." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b90ad279-c093-4fbf-80a9-3a5965ab643b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "events", "images", ":image_data" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "image_data", "description": "(Required) (String, Required) – The identifier of the image, obtained from the event search response." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"image_id\": {\n \"image_data\": 1.7550623415478388e+24,\n \"image_type\": \"JPG\",\n \"photo\": \"false\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab787ce5-5b70-4c8d-b72c-c128955ef0e8", "name": "Search Thermal Events", "request": { "name": "Search Thermal Events", "description": { "content": "This API is used to view events with thermal data.\n\nParameters on this API is the same as Search Events.", "type": "text/plain" }, "url": { "path": [ "api", "events", "search", "thermal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "64c159ce-373e-4bd8-90c4-61f5d87f25dc", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "events", "search", "thermal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"limit\": 51,\n \"conditions\": [\n {\n \"column\": \"datetime\",\n \"operator\": 3,\n \"values\": [\n \"2021-01-27T16:00:00.000Z\",\n \"2022-01-28T15:59:59.000Z\"\n ]\n }\n ],\n \"orders\": [\n {\n \"column\": \"datetime\",\n \"descending\": false\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f757990d-814b-4840-8ad6-8d05ec7e6ad6", "name": "Export as CSV", "request": { "name": "Export as CSV", "description": { "content": "This API is used to export events as a `.csv` file. Exported `.csv` will be saved on `[BioStar X Server installation path]/nginx/html/download`. To get it from the server, use [Download Events Exported CSV API](#tag/Events/operation/downloadCsvFilename).", "type": "text/plain" }, "url": { "path": [ "api", "events", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "time_offset", "value": "", "description": "Shift time on the exported file by n minutes" }, { "disabled": false, "key": "use_centigrade", "value": "", "description": "Toggle true to set temperature as celcius, false as fahrenheit." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"columns\": [\n \"\",\n \"\"\n ],\n \"headers\": [\n \"\",\n \"\"\n ],\n \"conditions\": [\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"offset\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a05eefa8-5cbb-42ba-9f1e-4c87614c9777", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "events", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "time_offset", "value": "480" }, { "key": "use_centigrade", "value": "true" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"columns\": [\n \"\",\n \"\"\n ],\n \"headers\": [\n \"\",\n \"\"\n ],\n \"conditions\": [\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"offset\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "614a8a44-84c2-47b7-8241-99d92fb49991", "name": "List All Alerts: Filter & Sort by Date", "request": { "name": "List All Alerts: Filter & Sort by Date", "description": { "content": "This example shows how to use the parameters on this API to filter responses according to the datetime of the alert events.", "type": "text/plain" }, "url": { "path": [ "api", "alerts", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"conditions\": [\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"orders\": [\n {\n \"column\": \"\",\n \"descending\": \"\"\n },\n {\n \"column\": \"\",\n \"descending\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dd364687-cdd5-4c8f-95a6-6135ecd4271b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "alerts", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"conditions\": [\n {\n \"column\": \"event_id.datetime\",\n \"operator\": 3,\n \"values\": [\n \"2023-02-02T00:00:00.00Z\",\n \"2023-02-03T00:00:00.00Z\"\n ]\n }\n ],\n \"orders\": [\n {\n \"column\": \"event_id.datetime\",\n \"descending\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a6fb78f-41d2-4a17-a63f-aeb83f4d1b50", "name": "Update Alert History", "request": { "name": "Update Alert History", "description": { "content": "This API is used to log `alertable: true` events (`GET /api/event_types`) to Alert Collection (`POST /api/alerts/search`)", "type": "text/plain" }, "url": { "path": [ "api", "alerts", ":alert_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) Unique ID recorded on hint parameter (POST /api/events/search)" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Alert\": {\n \"event_id\": {\n \"datetime\": \"\"\n },\n \"status\": 1,\n \"ack_user_id\": {\n \"user_id\": \"1\"\n },\n \"ack_message\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8a60b551-2dc1-4242-af2d-afa42cdbbc9c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "alerts", ":alert_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "alert_id", "description": "(Required) Unique ID recorded on hint parameter (POST /api/events/search)" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Alert\": {\n \"event_id\": {\n \"datetime\": \"2022-02-02T00:00:00.00Z\"\n },\n \"status\": 1,\n \"ack_user_id\": {\n \"user_id\": \"1\"\n },\n \"ack_message\": \"test\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b322478-96ce-4f93-8e9b-d8e8730898d9", "name": "View a Muster Zone Status", "request": { "name": "View a Muster Zone Status", "description": { "content": "This API is used to view a muster zone status.", "type": "text/plain" }, "url": { "path": [ "api", "zones", ":id", "tracking" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"limit\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ce55660a-7925-4663-ad66-76f9a9cad226", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "zones", ":id", "tracking" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"limit\": 51\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "28bd524e-3e67-49d7-9139-a0d00366710c", "name": "Audit", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "08a866bc-35a9-40af-ab10-90b3cb8d54f4", "name": "Audit Search", "request": { "name": "Audit Search", "description": { "content": "This API is used to view Audit Trail logs.\n\nIt is possible to use multiple conditions in a request. Separate each condition using comma (,).\n\nExample:\n\\[ {condition 1}, {condition 2}, .. \\]", "type": "text/plain" }, "url": { "path": [ "api", "audit", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": false,\n \"conditions\": [\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "56ec34aa-8d36-45df-b500-763303a3c860", "name": "Audit logs retrieved successfully", "originalRequest": { "url": { "path": [ "api", "audit", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"offset\": 0,\n \"limit\": 5,\n \"conditions\": [\n {\n \"column\": \"DATE\",\n \"operator\": 3,\n \"values\": [\n \"2024-02-17T16:00:00.000Z\",\n \"2024-03-18T15:59:59.000Z\"\n ]\n }\n ],\n \"total\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12ae68e6-f505-4a08-b403-94c1e8c2e38d", "name": "Audit Search User", "request": { "name": "Audit Search User", "description": { "content": "This API is used to filter user by the specified input.\n\nDo note the API will only show records of user which have Audit Trail logs only.", "type": "text/plain" }, "url": { "path": [ "api", "audit", "userlist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Userlist\": {\n \"search\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1fec5def-fda8-4371-b500-7a13e751c54d", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "audit", "userlist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Userlist\": {\n \"search\": \"ag\",\n \"limit\": 201,\n \"offset\": 0\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56b3bba2-d4da-49ab-8580-247e09e3535b", "name": "Audit Search Operator Level", "request": { "name": "Audit Search Operator Level", "description": { "content": "This API is used to filter Operator Level by the specified input.\n\nDo note the API will only show records of Operator Level which have Audit Trail logs only.", "type": "text/plain" }, "url": { "path": [ "api", "audit", "permlist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Permlist\": {\n \"search\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f94b4d64-75c5-4758-a6f1-a571fe1f5d33", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "audit", "permlist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Permlist\": {\n \"search\": \"ag\",\n \"limit\": 201,\n \"offset\": 0\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8384472e-1c75-4b4c-9982-a2761aac890d", "name": "Audit Search IP List", "request": { "name": "Audit Search IP List", "description": { "content": "This API is used to filter IP records by the specified input.\n\nDo note the API will only show records which have Audit Trail logs only.", "type": "text/plain" }, "url": { "path": [ "api", "audit", "iplist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Iplist\": {\n \"search\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "30de0b88-2f32-43d1-9bdc-48104af797f0", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "audit", "iplist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Iplist\": {\n \"search\": \"ag\",\n \"limit\": 201,\n \"offset\": 0\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fec1e9fe-a005-4149-9436-a2e30ab95051", "name": "Audit Search Target List", "request": { "name": "Audit Search Target List", "description": { "content": "This API is used to filter Target records by the specified input.\n\nDo note the API will only show records which have Audit Trail logs only.", "type": "text/plain" }, "url": { "path": [ "api", "audit", "targetlist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Targetlist\": {\n \"search\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c5a0583f-8eb9-40b0-9497-dc2c6fbb7b18", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "audit", "targetlist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Targetlist\": {\n \"search\": \"ag\",\n \"limit\": 201,\n \"offset\": 0\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8dc06020-bee6-4ed1-b31c-c2911faf7c0f", "name": "Audit CSV Export", "request": { "name": "Audit CSV Export", "description": { "content": "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.", "type": "text/plain" }, "url": { "path": [ "api", "audit", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "time_offset", "value": "", "description": "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)." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"columns\": [\n \"\",\n \"\"\n ],\n \"headers\": [\n \"\",\n \"\"\n ],\n \"conditions\": [\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"offset\": \"\"\n },\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1834638f-40ca-46b9-b627-5934137d7318", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "audit", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "time_offset", "value": "480" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"offset\": 0,\n \"conditions\": [\n {\n \"column\": \"DATE\",\n \"operator\": 3,\n \"values\": [\n \"2024-02-17T16:00:00.000Z\",\n \"2024-03-18T15:59:59.000Z\"\n ]\n }\n ],\n \"columns\": [\n \"DATE\",\n \"USRID\",\n \"PERM\",\n \"IP\",\n \"MENU\",\n \"TARGET\",\n \"METHOD\",\n \"CONTENT\"\n ],\n \"headers\": [\n \"Datetime\",\n \"User\",\n \"Operator Level\",\n \"IP\",\n \"Category\",\n \"Target\",\n \"Action\",\n \"Modification\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Zones", "item": [ { "id": "92142de5-ce15-4cb5-a3e5-5ad97222f0f1", "name": "Zones", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "d91c0a7a-e534-42ea-adac-3fb80e96c269", "name": "Interlock: Create", "request": { "name": "Interlock: Create", "description": { "content": "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.\n\n- An interlock zone can be configured with up to 4 doors.\n- An interlock zone can only set the doors with the devices connected to the CoreStation.\n \n- A device set as an interlock zone cannot be set to another zone.\n- A door set as an interlock zone cannot be set to another zone other than the fire alarm zone.", "type": "text/plain" }, "url": { "path": [ "api", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Zone\": {\n \"name\": \"\",\n \"zone_type\": \"\",\n \"is_global\": \"\",\n \"enable\": \"\",\n \"inter_lock\": {\n \"doors\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"sensor_inputs\": [\n {\n \"device\": {\n \"id\": \"\"\n },\n \"input_index\": \"\",\n \"duration\": \"\",\n \"normal_open\": \"\",\n \"input_type\": \"\"\n }\n ],\n \"alarm_actions\": [\n {\n \"input_event_id\": \"\",\n \"output_type\": \"\",\n \"output_device_id\": {\n \"id\": \"\",\n \"buzzer\": \"\"\n },\n \"output_buzzer_volume\": \"\"\n },\n {\n \"input_event_id\": \"\",\n \"output_type\": \"\",\n \"output_device_id\": {\n \"id\": \"\",\n \"buzzer\": \"\"\n },\n \"output_buzzer_volume\": \"\"\n }\n ]\n },\n \"description\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "db825871-6036-4125-b563-3b9b992af1ec", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Zone\": {\n \"name\": \"IN1\",\n \"description\": \"\",\n \"zone_type\": 7,\n \"is_global\": 0,\n \"enable\": 1,\n \"inter_lock\": {\n \"doors\": [\n {\n \"id\": 2\n },\n {\n \"id\": 3\n }\n ],\n \"sensor_inputs\": [\n {\n \"device\": {\n \"id\": 546091003\n },\n \"input_index\": 0,\n \"duration\": 300,\n \"normal_open\": 0,\n \"input_type\": \"input\"\n }\n ],\n \"alarm_actions\": [\n {\n \"input_event_id\": 41472,\n \"output_type\": 3,\n \"output_device_id\": {\n \"id\": 546091003,\n \"buzzer\": true\n },\n \"output_buzzer_volume\": 1\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "89bf8ab5-ad96-4c6f-8e32-1eeeb8be6a14", "name": "View Zones", "request": { "name": "View Zones", "description": { "content": "This API is used to view zones.", "type": "text/plain" }, "url": { "path": [ "api", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "da37fc6f-0076-4f5e-891c-ea707a7ee53a", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "zones" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8867d4df-556f-4867-ae07-e37f01bdb093", "name": "APB: Clear APB", "request": { "name": "APB: Clear APB", "description": { "content": "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**\n\n**Response Codes:**\n\n- 200 OK: Request successful\n \n- 400 Bad Request (Code 671): Zone ID mismatch (zone not found)\n \n- 401 Unauthorized: Login required or invalid session token", "type": "text/plain" }, "url": { "path": [ "api", "zones", "clear_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"AntiPassBackConfig\": {\n \"Zone\": {\n \"ZoneCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"UserType\": \"\"\n },\n \"User\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1d23bd93-141b-4f12-b8c1-eb26b58abe93", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "zones", "clear_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AntiPassBackConfig\": {\n \"Zone\": {\n \"ZoneCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"UserType\": \"\"\n },\n \"User\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"0\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Success\",\n \"by\": \"web\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30e850e2-f878-4602-9631-c75c2409a726", "name": "Bad Request", "originalRequest": { "url": { "path": [ "api", "zones", "clear_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AntiPassBackConfig\": {\n \"Zone\": {\n \"ZoneCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"UserType\": \"\"\n },\n \"User\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Response\": {\n \"code\": \"671\",\n \"link\": \"https://support.supremainc.com/en/support/home\",\n \"message\": \"Zone type mismatch.\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c1852e5-f66d-4596-95e9-907c8f177d5a", "name": "Unauthorized - The API key provided was invalid or missing.", "originalRequest": { "url": { "path": [ "api", "zones", "clear_apb_ex" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"AntiPassBackConfig\": {\n \"Zone\": {\n \"ZoneCollection\": {\n \"rows\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"UserType\": \"\"\n },\n \"User\": [\n {\n \"user_id\": \"\"\n },\n {\n \"user_id\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b714d8c8-a0ef-4fc8-989b-9a85875190e9", "name": "Zones: Update", "request": { "name": "Zones: Update", "description": { "content": "This API is used to update a Zone.", "type": "text/plain" }, "url": { "path": [ "api", "zones", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Zone which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Zone\": {\n \"name\": \"\",\n \"zone_type\": \"\",\n \"is_global\": \"\",\n \"enable\": \"\",\n \"description\": \"\",\n \"status\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "efe3bb7b-5d42-41da-94f5-8d9aa6d763ea", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "zones", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Zone which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"Zone\": {\n \"name\": \"testmuster1\",\n \"zone_type\": 8,\n \"is_global\": 1,\n \"enable\": 1,\n \"status\": 64,\n \"muster\": {\n \"access_groups\": [\n {}\n ],\n \"entry_devices\": [\n {}\n ],\n \"exit_devices\": [\n {}\n ],\n \"time_limit\": \"1200\",\n \"alarm_actions\": []\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cdc4153-2f31-4442-a630-4d90ecb992ea", "name": "Zones: Delete", "request": { "name": "Zones: Delete", "description": { "content": "This API is used to delete a Zone.", "type": "text/plain" }, "url": { "path": [ "api", "zones", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the zone which will be deleted." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e5ff4dc3-07d4-4b10-adc2-ad46ef9c8e19", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "zones", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the zone which will be deleted." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7aec12ea-f361-4e53-b531-a4a6c6f12178", "name": "View a Zone Detail", "request": { "name": "View a Zone Detail", "description": { "content": "This API is used to view a zone detailed information.", "type": "text/plain" }, "url": { "path": [ "api", "zones", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the zone which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "17172fd2-dc35-4402-ad56-06f6ebd90111", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "zones", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the zone which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "412ead37-c313-4f1f-ad61-8af687bfaef9", "name": "Occupancy Limit", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "bda94d27-b453-4a5e-8f96-47a023c23450", "name": "Occupancy: Create New", "request": { "name": "Occupancy: Create New", "description": { "content": "Create and manage occupancy limit zones to control population density in specific areas and prevent overcrowding.\n\nYou can monitor occupancy status and set alerts when zones reach capacity.\n\n**Capacity:** Up to 100 occupancy limit zones can be added.\n\n**Compatible Devices:**\n- FaceStation F2 firmware version 1.1.0 or later\n- FaceStation 2 firmware version 1.5.0 or later\n\n**Important Notes:**\n- A device cannot be assigned to both entry and exit simultaneously\n- Maximum 128 entry and exit devices combined\n- Devices using Dual Authentication cannot be set as entry or exit devices\n- Auto Count Reset time is based on UTC for the zone's location\n- Alert values must be smaller than the limit value and different from each other\n- Count Bypass feature is not available when using Thermal & Mask Check Mode without authentication\n- Up to 16 bypass groups can be added", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "time_zone", "value": "26" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"is_enabled\": \"\",\n \"name\": \"\",\n \"zone_type\": \"\",\n \"status\": \"\",\n \"occupancy_detail\": {\n \"limit_count\": \"\",\n \"entry_devices\": [\n \"\",\n \"\"\n ],\n \"exit_devices\": [\n \"\",\n \"\"\n ],\n \"network_fail_action\": \"\",\n \"almost_full_alert_setting\": {\n \"level\": \"\",\n \"step_1\": \"\",\n \"step_2\": \"\"\n },\n \"auto_reset_count_time\": {\n \"is_enabled\": \"\",\n \"minute\": \"\"\n },\n \"bypass_groups\": [\n {\n \"acsgruid\": \"\"\n },\n {\n \"acsgruid\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fafebf5a-e446-414a-8312-42226f5b7cdf", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "time_zone", "value": "25" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"is_enabled\": 1,\n \"name\": \"OccupancyZone1\",\n \"zone_type\": 11,\n \"status\": 0,\n \"occupancy_detail\": {\n \"limit_count\": 100,\n \"entry_devices\": [\n \"543720368\"\n ],\n \"exit_devices\": [\n \"542353521\"\n ],\n \"network_fail_action\": 0,\n \"almost_full_alert_setting\": {\n \"level\": 1,\n \"step_1\": 95,\n \"step_2\": 0\n },\n \"auto_reset_count_time\": {\n \"is_enabled\": 1,\n \"minute\": 1439\n },\n \"bypass_groups\": [\n {\n \"acsgruid\": 1\n },\n {\n \"acsgruid\": 1\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e7efc4a-2567-4938-9ea7-888a6430ca17", "name": "Occupancy: Delete", "request": { "name": "Occupancy: Delete", "description": { "content": "This API is used to delete Occupancy Zone.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "37df3c77-5e1c-484a-b54f-6a62557adbd6", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "622d7273-4cb0-4e28-87f2-0e8c54223922", "name": "Occupancy: List All", "request": { "name": "Occupancy: List All", "description": { "content": "This API is used to list all configured Occupancy Zone.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "de3e33ae-2df0-4776-81a6-ee99ca358119", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1996e16e-f018-4947-bb79-6802544138aa", "name": "Occupancy: Update", "request": { "name": "Occupancy: Update", "description": { "content": "This API is used to update occupancy zone configuration.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "time_zone", "value": "26" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the occupancy zone which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"is_enabled\": \"\",\n \"name\": \"\",\n \"zone_type\": \"\",\n \"status\": \"\",\n \"occupancy_detail\": {\n \"limit_count\": \"\",\n \"entry_devices\": [\n \"\",\n \"\"\n ],\n \"exit_devices\": [\n \"\",\n \"\"\n ],\n \"network_fail_action\": \"\",\n \"almost_full_alert_setting\": {\n \"level\": \"\",\n \"step_1\": \"\",\n \"step_2\": \"\"\n },\n \"auto_reset_count_time\": {\n \"is_enabled\": \"\",\n \"minute\": \"\"\n },\n \"bypass_groups\": [\n {\n \"acsgruid\": \"\"\n },\n {\n \"acsgruid\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "44057481-c6d3-4445-a979-d0ac921ac507", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "time_zone", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the occupancy zone which will be updated." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"is_enabled\": 1,\n \"name\": \"OccupancyZone1\",\n \"zone_type\": 11,\n \"status\": 0,\n \"occupancy_detail\": {\n \"limit_count\": 100,\n \"entry_devices\": [\n \"543720368\"\n ],\n \"exit_devices\": [\n \"542353521\"\n ],\n \"network_fail_action\": 0,\n \"almost_full_alert_setting\": {\n \"level\": 1,\n \"step_1\": 95,\n \"step_2\": 0\n },\n \"auto_reset_count_time\": {\n \"is_enabled\": 1,\n \"minute\": 1439\n },\n \"bypass_groups\": [\n {\n \"acsgruid\": 1\n },\n {\n \"acsgruid\": 1\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94d82982-f6fb-416f-a7d1-3b45f39b8273", "name": "Occupancy: View Details", "request": { "name": "Occupancy: View Details", "description": { "content": "This API is used to view details of an Occupancy Zone.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "time_zone", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Zone which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a366317b-7138-43a8-9710-db1b56f3e8d8", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "time_zone", "value": "25" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Zone which will be viewed." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dc3128ad-76fe-4dce-b363-e54bbb62fd54", "name": "Occupancy: Search by Name", "request": { "name": "Occupancy: Search by Name", "description": { "content": "This API is used to search Occupancy Zone by name.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", "search", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Name of the Occupancy Zone which will be searched." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "37889b7d-d7a7-4f2d-b978-378e61fa68ce", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", "search", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Name of the Occupancy Zone which will be searched." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd01ea52-4132-4830-8113-69948305dcda", "name": "Occupancy: List Dual Auth. Devices", "request": { "name": "Occupancy: List Dual Auth. Devices", "description": { "content": "This API is used to get a list of dual authentication devices.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", "devices", "dual" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0076bb47-a852-498c-a690-d5a05c183f77", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", "devices", "dual" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd852a7f-fe75-470d-bd1a-5d0ce5fae8e0", "name": "Occupancy: View Assigned Devices", "request": { "name": "Occupancy: View Assigned Devices", "description": { "content": "This API is used to list assigned devices on a Occupancy Zone.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", "devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Zone" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "76d5f204-d9dc-4872-9ede-2617beddb21e", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", "devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Zone" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26104f28-0646-44c7-8e3b-40a7dfeed19a", "name": "Occupancy: Increase Count", "request": { "name": "Occupancy: Increase Count", "description": { "content": "This API is used to increase an occupancy count.\n\nCount will be higher or equal to 0 and will be lower or equal to Count Limit.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", "count", "increase", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Limit." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "198d5161-b074-4a06-91f0-32561e4eca83", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", "count", "increase", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Limit." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eea35ac0-02f6-4bd4-9c85-35a040060d61", "name": "Occupancy: Decrease Count", "request": { "name": "Occupancy: Decrease Count", "description": { "content": "This API is used to decrease an occupancy count.\n\nCount will be higher or equal to 0 and will be lower or equal to Count Limit.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", "count", "decrease", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Limit" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "30169ec6-1d9f-43cd-80de-dd528ec57a15", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", "count", "decrease", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Limit" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "128f979d-ece5-4d2b-9c08-c90566945658", "name": "Occupancy: Set Count", "request": { "name": "Occupancy: Set Count", "description": { "content": "This API is used to set and occupancy limit count.\n\nCount value will be higher or equal to 0 and will be lower or equal to Count Limit.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", "count", "set", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Limit." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"count\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c3ae2b16-2140-4e47-b2d4-8e8bf3ed59d7", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", "count", "set", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the Occupancy Limit." }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"count\": 85\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f140d56-3b6f-46d7-91d7-7c70873d6ed7", "name": "Occupancy: Reset Count", "request": { "name": "Occupancy: Reset Count", "description": { "content": "This API is used to reset current counts and bypass counts of the occupancy limit zone.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e1a40ecf-e45f-49b4-bbcf-663a47eddacd", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", "reset" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 32784\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ac1ffcd7-a2f0-4d1e-a702-ab1b237307a2", "name": "Occupancy: Disable", "request": { "name": "Occupancy: Disable", "description": { "content": "This API is used to disable Occupancy Limit Zone.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", "disable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "806c609c-6ae3-42b6-9b22-88e129acfca9", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", "disable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 32784\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce1fce2c-2553-4c09-b3cb-1425d5206aad", "name": "Occupancy: Enable", "request": { "name": "Occupancy: Enable", "description": { "content": "This API is used to enable Occupancy Limit Zone.", "type": "text/plain" }, "url": { "path": [ "api", "v2", "zones", "occupancy", "enable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a8ac7f1b-6f85-4ce5-a3a4-ebd800746628", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "v2", "zones", "occupancy", "enable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 32784\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ] }, { "name": "Step by Step", "item": [ { "id": "4b171dd3-3b0f-43c4-a1e4-fe47889d8435", "name": "Event Log", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "07a0aa48-fd8e-4f72-bc25-e2a2ba76ca10", "name": "View Event Types", "request": { "name": "View Event Types", "description": { "content": "This API is used for listing event types recorded on BioStar X.", "type": "text/plain" }, "url": { "path": [ "api", "event_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "is_break_glass", "value": "", "description": "Filter event types which is marked as break glass." }, { "disabled": false, "key": "setting_alert", "value": "", "description": "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 BioStar X." }, { "disabled": false, "key": "setting_all", "value": "", "description": "Toggle true to list all events recorded on database." } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ed39326b-036d-4932-891d-c108dcc0511a", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "event_types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "is_break_glass", "value": "false" }, { "key": "setting_alert", "value": "false" }, { "key": "setting_all", "value": "true" } ], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6b3b89b-21cc-49fa-8fe3-7f3113ba8e46", "name": "Search Events Example", "request": { "name": "Search Events Example", "description": { "content": "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.\n\nNote 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.", "type": "text/plain" }, "url": { "path": [ "api", "events", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"limit\": \"\",\n \"conditions\": [\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"column\": \"\",\n \"operator\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"orders\": [\n {\n \"column\": \"\",\n \"descending\": \"\"\n },\n {\n \"column\": \"\",\n \"descending\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4d541c7c-c44f-4c10-9fe3-91aeb728592c", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "events", "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"Query\": {\n \"limit\": 5,\n \"conditions\": [\n {\n \"column\": \"datetime\",\n \"operator\": 3,\n \"values\": [\n \"2022-05-31T16:05:00.000Z\",\n \"2022-06-30T15:58:00.000Z\"\n ]\n },\n {\n \"column\": \"device_id\",\n \"operator\": 0,\n \"values\": [\n \"543308153\"\n ]\n }\n ],\n \"orders\": [\n {\n \"column\": \"datetime\",\n \"descending\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e711d57e-80eb-47a7-8e2d-cec58faeabc5", "name": "Create User", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "13a3fde0-fef1-4457-ae22-61d3cb9727e1", "name": "02 View BioStar Settings", "request": { "name": "02 View BioStar Settings", "description": { "content": "After logged in, use this API to view the User ID setting of the BioStar X, is it AlphaNumeric or Number.\n\nIt 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.", "type": "text/plain" }, "url": { "path": [ "api", "setting", "biostar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "811408bb-09c1-4a9a-a282-0fd8acb65050", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "setting", "biostar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da9b8e62-17b3-445e-88b6-eb2d36587563", "name": "03 Find Next Available UserID", "request": { "name": "03 Find Next Available UserID", "description": { "content": "After User ID setting of BioStar X is confirmed, use this API to get the next `user_id` for new user.\n\nThis API will only shows next available ID in number format.\n\nKeep this ID for input on `user_id` parameter when creating new user.", "type": "text/plain" }, "url": { "path": [ "api", "users", "next_user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5432ed6f-754f-4757-9f49-ce6a5526b655", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "users", "next_user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "567f3959-b46d-40fb-bd6a-1274e0a4b359", "name": "04a Enroll Card Credential", "request": { "name": "04a Enroll Card Credential", "description": { "content": "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.\n\nThis API is used to enroll card credential using the specified device.\n\nKeep the card_id value on the response which shows after running this API to apply it to the user which will be created.\n\nTo view device(s) with capability to enroll a card, use **View Device(s) Based on Enrollment Type** API.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "scan_card" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be used for enrollment" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "" } }, "response": [ { "id": "ab53c437-2bdd-4de7-9d5e-d6d753519b0b", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "scan_card" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be used for enrollment" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "" } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7b05b07-3a30-48ed-afb5-33a7b2eed886", "name": "04b Enroll Face Credential", "request": { "name": "04b Enroll Face Credential", "description": { "content": "Use this API to enroll face credential from a device.\n\nSet the `pose_sensitivity` to `0` if you're doing a Visual Face scan.\n\nKeep the response of this API after running to apply it to the user which will be created.\n\nTo view device(s) with capability to enroll Face/Visual Face, use `View Device(s) Based on Enrollment Type` API.", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":id", "credentials", "face" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "pose_sensitivity", "value": "", "description": "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" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be used to enroll" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a55a0b77-5948-4da6-847e-eb55cef9b71a", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":id", "credentials", "face" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "pose_sensitivity", "value": "4" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) ID of the device which will be used to enroll" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b7cb3b7-65d0-4f18-a656-7f269f70e724", "name": "04c Enroll Fingerprint", "request": { "name": "04c Enroll Fingerprint", "description": { "content": "Use this API to scan a fingerprint.\n\nOn 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`.\n\nThe procedure to add a fingerprint as follows:\n- Scan a finger using this API\n- Use `POST /api/server_matching/identify_finger` to check if it's already exist\n- If it's not exist, then run a second scan using this API for the same finger\n- 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 \n- 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`", "type": "text/plain" }, "url": { "path": [ "api", "devices", ":dev_id", "scan_fingerprint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "dev_id", "description": "(Required) Unique identifier of the device to perform fingerprint scanning" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"ScanFingerprintOption\": {\n \"enroll_quality\": \"\",\n \"raw_image\": \"\"\n },\n \"noblockui\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6c2e551c-1368-489c-87b0-ce78fdac78f0", "name": "Successful response", "originalRequest": { "url": { "path": [ "api", "devices", ":dev_id", "scan_fingerprint" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "dev_id", "description": "(Required) Unique identifier of the device to perform fingerprint scanning" }, { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ScanFingerprintOption\": {\n \"enroll_quality\": 80,\n \"raw_image\": false\n },\n \"noblockui\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53c0dce4-b6a2-4c6b-802c-92a277c2e9a1", "name": "05 Create New User", "request": { "name": "05 Create New User", "description": { "content": "After preparing available user_id and credential(s), use this API to create a new user using the basic configuration.\n\nFor applying configuration beyond this, such as credential(s) or custom fields, refer to the subsequent example.\n\nWhen Setting > Server is set to Number, you can make use of endpoint `/api/users/next_user_id` to automatically get the next user_id.\n\n**Known validation errors:**\n- `name` is more than 48 characters\n- Using single quote on name\n- Duplicate `user_id`, `email`, or `login_id`\n- Empty required fields\n- Using non-existent user_group_id\n- Password with 3 or more subsequent letter or number\n- Start and expiry date difference is more than 30 years", "type": "text/plain" }, "url": { "path": [ "api", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"User\": {\n \"user_id\": \"\",\n \"user_group_id\": {\n \"id\": \"\"\n },\n \"start_datetime\": \"\",\n \"expiry_datetime\": \"\",\n \"name\": \"\",\n \"disabled\": \"\",\n \"email\": \"\",\n \"department\": \"\",\n \"title\": \"\",\n \"photo\": \"\",\n \"phone\": \"\",\n \"permission\": {\n \"id\": \"\"\n },\n \"access_groups\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"login_id\": \"\",\n \"password\": \"\",\n \"user_ip\": \"\",\n \"pin\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dfec7c95-ce17-429f-bc91-42c19f0087df", "name": "User created successfully", "originalRequest": { "url": { "path": [ "api", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "description": "BioStar X server hostname and port", "type": "any", "value": "{{baseurl}}", "key": "baseurl" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "bs-session-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"User\": {\n \"user_id\": \"1001\",\n \"user_group_id\": {\n \"id\": \"1\"\n },\n \"start_datetime\": \"2001-01-01T00:00:00.00Z\",\n \"expiry_datetime\": \"2030-12-31T23:59:00.00Z\",\n \"name\": \"John Doe\",\n \"disabled\": false,\n \"email\": \"john.doe@example.com\",\n \"department\": \"Engineering\",\n \"title\": \"Software Engineer\",\n \"photo\": \"\",\n \"phone\": \"+1-555-0123\",\n \"permission\": {\n \"id\": \"1\"\n },\n \"access_groups\": [\n {\n \"id\": \"1\"\n },\n {\n \"id\": \"1\"\n }\n ],\n \"login_id\": \"john.doe\",\n \"password\": \"ZxwOzbCK2VQ1dyv\",\n \"user_ip\": \"192.168.1.100\",\n \"pin\": 1234\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ] } ], "event": [], "variable": [ { "description": { "content": "BioStar X server hostname and port", "type": "text/plain" }, "type": "any", "value": "127.0.0.1:443", "key": "baseurl" }, { "type": "string", "value": "https://{{baseurl}}", "key": "baseUrl" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "bs-session-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "a7dac1f5-9712-4a1f-9955-538f052f5794", "name": "BioStar X API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## Overview\n\nSuprema BioStar X API is a JSON-based API. All requests are made to endpoints beginning with [https://server_ip|domain_name[:port]/api](https://server_ip|domain_name:port/api)\n\nThe API can be used to perform almost any operation. Following are a few examples of what can be done with Suprema BioStar X API:\n\n- Manage User data\n \n- Manage Access Group data\n \n- Manage Doors data\n \n- Assign an Access Group to one or multiple User\n \n- Assign a User with one or multiple Access Group\n \n- Manage Devices\n \n- And many more...\n \n\nAll requests must be secure (https).\n\n## General Information\n\nTo call the API, BioStar X is mainly using HTTP Methods `GET`, `POST`, `PUT`, and `DELETE`.\n\n- `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.\n \n- `POST` request is used to send data to the server to create or a resource. The data sent to the server is stored on the body of the HTTP request.\n \n- `PUT` is similar to `POST` in that it creates or s 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.\n \n- `DELETE` is used to delete resources at the specified endpoint.\n \n\nThere are four parameter location that’s being used on Suprema BioStar X API:\n\n- PATH parameter is located on the URL, usually on the end of an endpoint. For example in /items/{ItemID}, the PATH parameter is ItemID.\n \n- 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.\n \n- 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.\n \n- HEADER. Custom headers that are expected as part of the request.\n \n\nPath 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](https://127.0.0.1:4433/api/some_api/%7Bid)} \nAbove example shows that the required value will be placed on {id}\n\n\n## Import the Postman collection\nTo import the Postman collection online, follow these steps:\n1. Download the Postman collection file(bsxapi-postman-collection.json).\n2. Go to Postman and sign in.\n3. Select your workspace from the workspace selector in the top left. Or create a workspace if you don't have one.\n4. Click **Import** in the sidebar.\n5. Select downloaded file, or drag the file into the import window.\n\n \n\n6. Click **Import** to complete the process.\n\n\n## Release Notes\n**2025-09-30**\n- Initial version\n\nContact Support:\n Name: Suprema Inc.\n Email: CS@suprema.co.kr", "type": "text/plain" } } }