{"info":{"_postman_id":"f7343df4-8aed-46bc-b662-589773f0cbf1","name":"Integration APIs","description":"

This collection contains a set of endpoints designed to facilitate seamless integration with our platform. These APIs provide functionality to access, manage, and retrieve critical data such as event history, division details, and other essential resources, allowing for comprehensive monitoring and interaction.

To request access to this API please contact your support specialist or sales executive.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38875822","collectionId":"f7343df4-8aed-46bc-b662-589773f0cbf1","publishedId":"2sAXxPBDn7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"558BD3"},"publishDate":"2024-10-08T18:20:39.000Z"},"item":[{"name":"Schedule Achievement","id":"47e61323-dfeb-4d89-9bd4-45f3a4e6b43b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{URL}}/api/scheduleAchievement","description":"

This API retrieves schedule achievements for a given division and an optional date. It can be used to track the completion or status of scheduled tasks or goals within a division. All parameters are optional, and the API requires Bearer token authentication

The ID of the division for which schedule achievements are requested. (Optional)

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

The specific date (ISO Format) to retrieve achievements for. (Optional)

\n","type":"text/plain"},"key":"date","value":"2024-02-20"}],"variable":[]}},"response":[{"id":"7e0864af-fe2e-4ca0-939f-7a3e8adcc0ce","name":"Schedule Achievement","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://test.guarnic.com/api/scheduleAchievement?divisionId=division_id&date=2024-02-20","protocol":"https","host":["test","guarnic","com"],"path":["api","scheduleAchievement"],"query":[{"key":"divisionId","value":"division_id","description":"The ID of the division for which schedule achievements are requested. (Optional)"},{"key":"date","value":"2024-02-20","description":"The specific date (ISO Format) to retrieve achievements for. (Optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"1338"},{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Function-Execution-Id","value":"siqwv9yw48yy"},{"key":"Server","value":"Google Frontend"},{"key":"Strict-Transport-Security","value":"max-age=31556926"},{"key":"X-Cloud-Trace-Context","value":"403d420b1f6aae7db590aa4db0ed8a34;o=1"},{"key":"X-Country-Code","value":"US"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Date","value":"Tue, 08 Oct 2024 17:39:28 GMT"},{"key":"X-Served-By","value":"cache-iad-kiad7000165-IAD"},{"key":"X-Cache","value":"MISS"},{"key":"X-Cache-Hits","value":"0"},{"key":"X-Timer","value":"S1728409162.357457,VS0,VE6029"},{"key":"Vary","value":"cookie,need-authorization, x-fh-requested-host, accept-encoding"},{"key":"alt-svc","value":"h3=\":443\";ma=86400,h3-29=\":443\";ma=86400,h3-27=\":443\";ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"scheduleEfficiency\": [\n {\n \"scheduleEfficiency\": 0,\n \"divisionName\": \"Division Test 1\",\n \"queryTime\": \"2024-10-08T17:39:28.210+00:00\",\n \"reportTime\": \"2024-10-08\",\n \"scheduleEfficiencyDetail\": [\n {\n \"scheduleId\": \"schedule2\",\n \"progress\": 0,\n \"startDate\": \"2024-10-08T10:00:00.000+00:00\",\n \"endDate\": \"2024-10-08T19:00:00.000+00:00\",\n \"scheduleName\": \"Schedule Test 2\",\n \"userIds\": [\n \"user1\",\n \"user2\",\n \"user3\"\n ]\n },\n {\n \"scheduleId\": \"schedule3\",\n \"progress\": 0,\n \"startDate\": \"2024-10-08T12:00:00.000+00:00\",\n \"endDate\": \"2024-10-09T04:00:00.000+00:00\",\n \"scheduleName\": \"Schedule Test 3\",\n \"userIds\": [\n \"user1\"\n ]\n },\n {\n \"scheduleId\": \"schedule4\",\n \"progress\": 0,\n \"startDate\": \"2024-10-08T12:00:00.000+00:00\",\n \"endDate\": \"2024-10-09T02:00:00.000+00:00\",\n \"scheduleName\": \"Schedule Test 4\",\n \"userIds\": [\n \"user1\",\n \"user2\",\n \"user3\"\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"47e61323-dfeb-4d89-9bd4-45f3a4e6b43b"},{"name":"User Achievement","id":"8ce6a875-5ceb-4e7f-949a-850a598f82cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://test.guarnic.com/api/scheduleUserAchievement?uid=user_id&divisionId=division_id&date=2024-02-20","description":"

This API retrieves a user's schedule achievements for a specific division and date. It allows you to track the progress or completion status of scheduled tasks for a particular user within a division. All parameters are optional, and the API requires Bearer token authentication.

The user ID for which to retrieve schedule achievements. (Optional)

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

The division ID for which to retrieve schedule achievements. (Optional)

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

The specific date (ISO Format) for which to retrieve the achievements. (Optional)

\n","type":"text/plain"},"key":"date","value":"2024-02-20"}],"variable":[]}},"response":[{"id":"f2cd2bb2-287f-4ee5-a987-a47117c0f39e","name":"New Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://test.guarnic.com/api/scheduleUserAchievement?uid=user_id&divisionId=division_id&date=2024-02-20","protocol":"https","host":["test","guarnic","com"],"path":["api","scheduleUserAchievement"],"query":[{"key":"uid","value":"user_id","description":"Optional filter by user id"},{"key":"divisionId","value":"division_id","description":"Optional filter for specific divisions"},{"key":"date","value":"2024-02-20","description":"Optional schedule start date filter"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"523"},{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Function-Execution-Id","value":"i72a1klbee4b"},{"key":"Server","value":"Google Frontend"},{"key":"Strict-Transport-Security","value":"max-age=31556926"},{"key":"X-Cloud-Trace-Context","value":"155c15169c31421ed831524155220516;o=1"},{"key":"X-Country-Code","value":"US"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Date","value":"Tue, 08 Oct 2024 17:31:11 GMT"},{"key":"X-Served-By","value":"cache-iad-kcgs7200111-IAD"},{"key":"X-Cache","value":"MISS"},{"key":"X-Cache-Hits","value":"0"},{"key":"X-Timer","value":"S1728408668.500261,VS0,VE3982"},{"key":"Vary","value":"cookie,need-authorization, x-fh-requested-host, accept-encoding"},{"key":"alt-svc","value":"h3=\":443\";ma=86400,h3-29=\":443\";ma=86400,h3-27=\":443\";ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"userEfficiency\": [\n {\n \"userEfficiency\": 0,\n \"divisionName\": \"Division Test 1\",\n \"queryTime\": \"2024-10-08T17:31:11.351+00:00\",\n \"reportTime\": \"2024-10-08\",\n \"userEfficiencyDetail\": [\n {\n \"progress\": 0,\n \"userId\": \"user1\"\n },\n {\n \"progress\": 10,\n \"userId\": \"user2\"\n },\n {\n \"progress\": 20,\n \"userId\": \"user3\"\n }\n ]\n },\n {\n \"userEfficiency\": 0,\n \"divisionName\": \"Division Test 2\",\n \"queryTime\": \"2024-10-08T17:31:11.351+00:00\",\n \"reportTime\": \"2024-10-08\",\n \"userEfficiencyDetail\": [\n {\n \"progress\": 0,\n \"userId\": \"user1\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"8ce6a875-5ceb-4e7f-949a-850a598f82cf"},{"name":"New Events","id":"7d2306fa-0980-4da9-9f1a-a7b1f8fbd1b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://test.guarnic.com/api/newEvents","description":"

This API retrieves a list of new events that have occurred within the system. It requires a Bearer token for authentication, and there are no mandatory query parameters. The API returns recent events based on creation date and last time it was searched in the organization of the token

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{TOKEN}}"}]},"isInherited":true,"source":{"_postman_id":"f7343df4-8aed-46bc-b662-589773f0cbf1","id":"f7343df4-8aed-46bc-b662-589773f0cbf1","name":"Integration APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["api","newEvents"],"host":["test","guarnic","com"],"query":[],"variable":[]}},"response":[{"id":"30063356-71a7-40d1-80a5-40f525a3464a","name":"New Request","originalRequest":{"method":"GET","header":[],"url":"https://test.guarnic.com/api/newEvents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"193060"},{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Function-Execution-Id","value":"rzx95kk79i62"},{"key":"Server","value":"Google Frontend"},{"key":"Strict-Transport-Security","value":"max-age=31556926"},{"key":"X-Cloud-Trace-Context","value":"39421f6b26b2a74290960ace93c795fb;o=1"},{"key":"X-Country-Code","value":"US"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Date","value":"Tue, 08 Oct 2024 17:36:02 GMT"},{"key":"X-Served-By","value":"cache-iad-kcgs7200112-IAD"},{"key":"X-Cache","value":"MISS"},{"key":"X-Cache-Hits","value":"0"},{"key":"X-Timer","value":"S1728408958.720213,VS0,VE4494"},{"key":"Vary","value":"cookie,need-authorization, x-fh-requested-host, accept-encoding"},{"key":"alt-svc","value":"h3=\":443\";ma=86400,h3-29=\":443\";ma=86400,h3-27=\":443\";ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"newEvents\": [\n {\n \"eventId\": \"eventId1\",\n \"createdAt\": \"2024-07-26T21:55:37.000+00:00\",\n \"divisionId\": \"divisionId1\",\n \"divisionName\": \"Division 1\",\n \"eventTypeId\": \"eventTypeId1\",\n \"eventTypeName\": \"QRCode1\",\n \"scheduleId\": \"scheduleId1\",\n \"scheduleName\": \"Testing Schedule 1\",\n \"userId\": \"userId1\",\n \"userName\": \"User test\"\n },\n {\n \"eventId\": \"eventId2\",\n \"createdAt\": \"2024-07-26T21:55:37.000+00:00\",\n \"divisionId\": \"divisionId2\",\n \"divisionName\": \"Division 2\",\n \"eventTypeId\": \"eventTypeId2\",\n \"eventTypeName\": \"QRCode2\",\n \"scheduleId\": \"scheduleId2\",\n \"scheduleName\": \"Testing Schedule 2\",\n \"userId\": \"userId2\",\n \"userName\": \"User test 2\"\n },\n ]\n}"}],"_postman_id":"7d2306fa-0980-4da9-9f1a-a7b1f8fbd1b4"},{"name":"Events History","id":"45545a16-9236-47ba-b57d-787bbeeb4dc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{URL}}/api/eventsHistory?startDate=2025-02-20&endDate=2025-02-21&divisionId=TRTBLDrAbCsEQDdLh2ha","description":"

This API retrieves the history of events for a specified division within an optional date range. It requires a Bearer token for authentication

The start date (ISO Format) for filtering the events history. (Optional)

\n","type":"text/plain"},"key":"startDate","value":"2025-02-20"},{"description":{"content":"

The end date (ISO Format) for filtering the events history. (Optional)

\n","type":"text/plain"},"key":"endDate","value":"2025-02-21"},{"description":{"content":"

The ID of the division for which the events history is requested. (Optional)

\n","type":"text/plain"},"key":"divisionId","value":"TRTBLDrAbCsEQDdLh2ha"}],"variable":[]}},"response":[{"id":"e38eba67-0fd1-445f-90cd-a750518b1695","name":"New Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://test.guarnic.com/api/eventsHistory?divisionId=division_id&startDate=2024-02-20&endDate=2024-02-21","protocol":"https","host":["test","guarnic","com"],"path":["api","eventsHistory"],"query":[{"key":"divisionId","value":"division_id","description":"The ID of the division for which the events history is requested. (Optional)"},{"key":"startDate","value":"2024-02-20","description":"The start date (ISO Format) for filtering the events history. (Optional)"},{"key":"endDate","value":"2024-02-21","description":"The end date (ISO Format) for filtering the events history. (Optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"6958"},{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Function-Execution-Id","value":"a1yscpte4e9a"},{"key":"Server","value":"Google Frontend"},{"key":"Strict-Transport-Security","value":"max-age=31556926"},{"key":"X-Cloud-Trace-Context","value":"433a9aeb4fe155c2e74716eb485b9c56;o=1"},{"key":"X-Country-Code","value":"US"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Date","value":"Tue, 08 Oct 2024 17:41:43 GMT"},{"key":"X-Served-By","value":"cache-iad-kjyo7100057-IAD"},{"key":"X-Cache","value":"MISS"},{"key":"X-Cache-Hits","value":"0"},{"key":"X-Timer","value":"S1728409300.084471,VS0,VE3886"},{"key":"Vary","value":"cookie,need-authorization, x-fh-requested-host, accept-encoding"},{"key":"alt-svc","value":"h3=\":443\";ma=86400,h3-29=\":443\";ma=86400,h3-27=\":443\";ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"eventsHistory\": [\n {\n \"eventId\": \"event1\",\n \"createdAt\": \"2024-02-20T17:09:30.000+00:00\",\n \"divisionId\": \"division1\",\n \"divisionName\": \"Division 1\",\n \"eventTypeId\": \"eventType1\",\n \"eventTypeName\": \"EventType Test 1\",\n \"scheduleId\": \"schedule1\",\n \"scheduleName\": \"Schedule Test 1\",\n \"userId\": \"user1\",\n \"userName\": \"User 1\"\n },\n {\n \"eventId\": \"event2\",\n \"createdAt\": \"2024-02-20T17:09:30.000+00:00\",\n \"divisionId\": \"division1\",\n \"divisionName\": \"Division 1\",\n \"eventTypeId\": \"eventType1\",\n \"eventTypeName\": \"EventType Test 1\",\n \"scheduleId\": \"schedule1\",\n \"scheduleName\": \"Schedule Test 1\",\n \"userId\": \"user1\",\n \"userName\": \"User 1\"\n },\n ]\n}"}],"_postman_id":"45545a16-9236-47ba-b57d-787bbeeb4dc4"},{"name":"Event Details","id":"e3a8e4ce-1aa4-4781-a78c-a8420a198032","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{URL}}/api/events?divisionId=division_id&startDate=2024-02-20&endDate=2024-02-21&triggerId=trigger_id&formId=form_id","description":"

This API retrieves events components detail for a given division, within an optional date range, and filtered by optional trigger and form IDs. The events can include various activities such as alerts, status changes, or other significant system events. All parameters are optional, and Bearer token authentication is required

The ID of the division for which events are requested. (Optional)

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

The start date (ISO Format) for filtering events. (Optional)

\n","type":"text/plain"},"key":"startDate","value":"2024-02-20"},{"description":{"content":"

The end date (ISO Format) for filtering events.(Optional)

\n","type":"text/plain"},"key":"endDate","value":"2024-02-21"},{"description":{"content":"

The ID of the trigger associated with the event (Optional).

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

The ID of the form associated with the event (Optional).

\n","type":"text/plain"},"key":"formId","value":"form_id"}],"variable":[]}},"response":[{"id":"d3c23c9a-120d-4b33-ac4a-8d1f15286993","name":"Components Detail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://test.guarnic.com/api/events?divisionId=division_id&startDate=2024-02-20&endDate=2024-02-21&triggerId=trigger_id&formId=form_id","protocol":"https","host":["test","guarnic","com"],"path":["api","events"],"query":[{"key":"divisionId","value":"division_id","description":"The ID of the division for which events are requested. (Optional)"},{"key":"startDate","value":"2024-02-20","description":"The start date (ISO Format) for filtering events. (Optional)"},{"key":"endDate","value":"2024-02-21","description":"The end date (ISO Format) for filtering events.(Optional)"},{"key":"triggerId","value":"trigger_id","description":"The ID of the trigger associated with the event (Optional)."},{"key":"formId","value":"form_id","description":"The ID of the form associated with the event (Optional)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"14376"},{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Function-Execution-Id","value":"sop7sia52zzp"},{"key":"Server","value":"Google Frontend"},{"key":"Strict-Transport-Security","value":"max-age=31556926"},{"key":"X-Cloud-Trace-Context","value":"8861af3a93861a8087bb2c95c0b416a7;o=1"},{"key":"X-Country-Code","value":"US"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Date","value":"Tue, 08 Oct 2024 18:06:37 GMT"},{"key":"X-Served-By","value":"cache-iad-kcgs7200111-IAD"},{"key":"X-Cache","value":"MISS"},{"key":"X-Cache-Hits","value":"0"},{"key":"X-Timer","value":"S1728410795.742413,VS0,VE2506"},{"key":"Vary","value":"cookie,need-authorization, x-fh-requested-host, accept-encoding"},{"key":"alt-svc","value":"h3=\":443\";ma=86400,h3-29=\":443\";ma=86400,h3-27=\":443\";ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"componentsDetail\": [\n {\n \"eventId\": \"event1\",\n \"createdAt\": \"2024-02-20T17:09:38.000+00:00\",\n \"divisionId\": \"division1\",\n \"divisionName\": \"Division Test 1\",\n \"eventTypeId\": \"eventType1\",\n \"eventTypeName\": \"EventType Test 1\",\n \"scheduleId\": \"schedule1\",\n \"scheduleName\": \"Schedule Test 1\",\n \"formId\": \"form1\",\n \"formName\": \"Form Test 1\",\n \"userId\": \"user1\",\n \"userName\": \"User 1\",\n \"formDetail\": {\n \"Texto\": \"hola\",\n \"Foto\": [],\n \"Tags\": [],\n \"Interruptor\": false,\n \"Video\": [],\n \"Archivos\": []\n }\n }\n ]\n}"}],"_postman_id":"e3a8e4ce-1aa4-4781-a78c-a8420a198032"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{TOKEN}}"}]}},"event":[{"listen":"prerequest","script":{"id":"fb90c4e9-43c7-4635-89f1-4f8c7cc4d0fe","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"ab683af5-b069-48a8-ab43-c58249296e9a","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"value":"","type":"string","disabled":true},{"value":"","type":"string","disabled":true}]}