{"info":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","description":"

Habität is a product that makes it possible to optimize the use of office spaces and make structural and energy costs more efficient.

Habitat Esite API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs (POST, GET, PUT, PATCH, and DELETE).

Habitat Esite API is an optional module and extends Habitat Core API. The Esite module controls the sensorized spaces to obtain information on their occupation.

This API is use to manage:

Devices: PIR sensors, nodes and gateways used to monitor spaces occupation.
Spaces: Sites or rooms to monitor.
Graphical areas: Enclosed areas that cluster spaces.
Alarms: Notifications triggered from devices monitoring. For example, a notification when two persons are sitted in adjacent sites.
Subsections: Different parts of the building to organize spaces.

All Habitat resources (except for the authentication endpoints) are protected with OAuth 2.0 Bearer Tokens sent on the request as an Authorization: Bearer header. If a request doesn't include the Bearer token, Habität will answer with a 401 Unauthorized HTTP error code.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6786529","collectionId":"2de37ba2-9b92-44c5-9f63-31f311d2e488","publishedId":"TVem9oRp","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-08T12:10:19.000Z"},"item":[{"name":"(outdatedDoc)auth","item":[{"name":"Amazon Cognito","item":[{"name":"Cognito auth","event":[{"listen":"test","script":{"id":"46148686-da28-4bb4-ba28-edc787257a8c","exec":["pm.globals.set(\"token\", pm.response.json()[\"access_token\"]);"],"type":"text/javascript"}}],"id":"f1165222-4ead-4a98-8308-489fc6525d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{idp_client_id}}"},{"key":"password","value":"{{idp_client_secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{idp_scope}}","description":"

Required. Allowed scope given to the client

\n","type":"text"},{"key":"grant_type","value":"client_credentials","description":"

Required. Must be 'client_credentials'

\n","type":"text"}]},"url":"{{idp_host}}/oauth2/token","description":"

Obtains an access_token through Amazon Cognito needed to perform requests to Habitat services.
This is used to authenticate services that launch some processes without the intervention of any user.

The response could be one of:

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

200 OK	Successful authorization
400 Bad Request	Invalid parameters

","urlObject":{"path":["oauth2","token"],"host":["{{idp_host}}"],"query":[],"variable":[]}},"response":[{"id":"d2dfe26b-6c33-4760-94cd-66e0fad14912","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{idp_scope}}","description":"Required. Allowed scope given to the client","type":"text"},{"key":"grant_type","value":"client_credentials","description":"Required. Must be 'client_credentials'","type":"text"}]},"url":"{{idp_host}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 10 Jun 2022 10:24:56 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-amz-cognito-request-id","value":"f80c807e-65c4-4788-829f-4c74fc33fd67"},{"key":"X-Application-Context","value":"application:prod:8443"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Server","value":"Server"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJraWQiOiI1NWxJbzFtWWtcL3B0U1JuY1d2NEFEWkprZHpURjF3cFQ5Y2MzV0ZNVCszTT0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJwMG9pbTY2cHAxMGlqYjViM2ZjN3M2MWVrIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJoYWJpdGF0LXBvYy1hcHBcL2Z1bGxfYWNjZXNzIiwiYXV0aF90aW1lIjoxNjU0ODU2Njk2LCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAuZXUtd2VzdC0xLmFtYXpvbmF3cy5jb21cL2V1LXdlc3QtMV9Na1FCTWs4RVAiLCJleHAiOjE2NTQ4NjAyOTYsImlhdCI6MTY1NDg1NjY5NiwidmVyc2lvbiI6MiwianRpIjoiMTkzMzQxZDgtN2JkZC00NDllLTg4ZDQtYzMxMDg1ZGJiMjIxIiwiY2xpZW50X2lkIjoicDBvaW02NnBwMTBpamI1YjNmYzdzNjFlayJ9.ZR3kifieMhRDJWlI8zrBmAbw-PbOnHzY0JJvX9GNmmAz9a0pSyRS4FtWg5zEjW9xAYP6fwnyGNL85iaJJK9tIQ7Nz7BpXzLOjxE-Kc0N6s69I73gmwOVkBkyt6_71H8-xGCQJoXzMd6nUWPwhs2xOC3wR-pHDU0ZgEl9MiQgqZG8gWR3dzLlmE4YteRKfCz1ZKexONtHolDtogX83tTMjtWRM0Zm0-m7sC_-o4IQisY-lI2k5VuoMBQiIaWYaHCQ8UHT7ph-RA1z5oZ9h6xMngEZexxuPt4YY_b3OFiENah1hgnjF9r7scniX1TqXvTZGqSEeUIWbewsxA8kcaAxDg\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}"},{"id":"0773d178-bb0b-400d-97a9-ed20bb869486","name":"400 Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{idp_scope}}","description":"Required. Allowed scope given to the client","type":"text"},{"key":"grant_type","value":"oauth2_token","description":"Required. Must be 'client_credentials'","type":"text"}]},"url":"{{idp_host}}/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 10 Jun 2022 10:25:19 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-amz-cognito-request-id","value":"998fa0ee-5c33-431a-86a5-558a03d2f6dd"},{"key":"X-Application-Context","value":"application:prod:8443"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Server","value":"Server"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"unsupported_grant_type\"\n}"}],"_postman_id":"f1165222-4ead-4a98-8308-489fc6525d2c"}],"id":"8d53a6e9-8459-4d65-b4a3-7dad9f297df8","description":"

This section contains request used for:

Application (server to server communication) request of IdP access_tokens

By using Amazon Cognito IdP.

\n","_postman_id":"8d53a6e9-8459-4d65-b4a3-7dad9f297df8","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f","id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f","name":"(outdatedDoc)auth","type":"folder"}}},{"name":"Microsoft AD FS","item":[{"name":"AD FS auth","event":[{"listen":"test","script":{"id":"46148686-da28-4bb4-ba28-edc787257a8c","exec":["pm.globals.set(\"token\", pm.response.json()[\"access_token\"]);"],"type":"text/javascript"}}],"id":"e9fcff0b-21aa-4915-af3c-5bd4b150a9ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{idp_scope}}","description":"

Optional. Allowed scope given to the client

\n","type":"text","disabled":true},{"key":"grant_type","value":"client_credentials","description":"

Required. Must be 'client_credentials'

\n","type":"text"},{"key":"client_id","value":"{{idp_client_id}}","description":"

Required. Client ID of the AD FS app client

\n","type":"text"},{"key":"client_secret","value":"{{idp_client_secret}}","description":"

Required. Client secret of the AD FS app client

\n","type":"text"}]},"url":"{{idp_host}}/oauth2/token","description":"

Obtains an access_token through Microsoft AD FS needed to perform requests to Habitat services.
This is used to authenticate services that launch some processes without the intervention of any user.

The response could be one of:

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

200 OK	Successful authorization
400 Bad Request	Invalid parameters

","urlObject":{"path":["oauth2","token"],"host":["{{idp_host}}"],"query":[],"variable":[]}},"response":[{"id":"84e4cd73-2737-4c4a-8cd8-2f04ef287d8d","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{idp_scope}}","description":"Optional. Allowed scope given to the client","type":"text","disabled":true},{"key":"grant_type","value":"client_credentials","description":"Required. Must be 'client_credentials'","type":"text"},{"key":"client_id","value":"{{idp_client_id}}","description":"Required. Client ID of the AD FS app client","type":"text"},{"key":"client_secret","value":"{{idp_client_secret}}","description":"Required. Client secret of the AD FS app client","type":"text"}]},"url":"{{idp_host}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"993"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0 Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Mon, 13 Jun 2022 09:30:39 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Imwxd2hWZTRvWDYtWFB4SVgyZ2Npbnd1ck1IWSJ9.eyJhdWQiOiJtaWNyb3NvZnQ6aWRlbnRpdHlzZXJ2ZXI6YWQ5Nzk2NDQtN2M5Mi00MTY0LWE2YTYtNTUzMDhjZDRiZDRhIiwiaXNzIjoiaHR0cDovL2FkZnNwcm9kNDAuZXZlcmlzLmNvbS9hZGZzL3NlcnZpY2VzL3RydXN0IiwiaWF0IjoxNjU1MTEyNjM5LCJleHAiOjE2NTUxMTYyMzksImFwcHR5cGUiOiJDb25maWRlbnRpYWwiLCJhcHBpZCI6ImFkOTc5NjQ0LTdjOTItNDE2NC1hNmE2LTU1MzA4Y2Q0YmQ0YSIsImF1dGhtZXRob2QiOiJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvYXV0aGVudGljYXRpb25tZXRob2QvcGFzc3dvcmQiLCJhdXRoX3RpbWUiOiIyMDIyLTA2LTEzVDA5OjMwOjM5LjI3N1oiLCJ2ZXIiOiIxLjAifQ.NiIqfDuXmomSAQPXDRcCzO4aBmNw3WK7kyxbtUcfHjmMut4fNSuZ3PJ80sjIg-y4bAU9srlSc_jvyxBo8Y1DVr1S5r_W93mFasB7Q-n8mkN0xN-G7u1ufR9CrYXEN7bisK6frWXKtHZp_oHx16O4F6g5L6makV82tZG2umIVahG5QE7A2-ppvGnYYkvQamUOy1KTalBl3fKpKEbKX6R4j_uQpFw_YK4hJLrXweuRVqIx-xYV7KdIVlTH3-PRynUi2BPmR7vaqASue1ZjnyXjIFjVEt1I8bElBJ4oPMOUVjxKSgoBk4sIMNoDu7N4aPO9-NE6-VxiEmHXkl9VEZUCsg\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600\n}"},{"id":"87e03f1c-f54f-4e33-a0c2-1694ce6166ff","name":"400 Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"{{idp_scope}}","description":"Optional. Allowed scope given to the client","type":"text","disabled":true},{"key":"grant_type","value":"client_credentials","description":"Required. Must be 'client_credentials'","type":"text"},{"key":"client_id","value":"12345","description":"Required. Client ID of the AD FS app client","type":"text"},{"key":"client_secret","value":"{{idp_client_secret}}","description":"Required. Client secret of the AD FS app client","type":"text"}]},"url":"{{idp_host}}/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"173"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0 Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Mon, 13 Jun 2022 09:30:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\",\n \"error_description\": \"MSIS9607: The 'client_id' parameter in the request is invalid. No registered client is found with this identifier.\"\n}"}],"_postman_id":"e9fcff0b-21aa-4915-af3c-5bd4b150a9ef"}],"id":"f05e3fe9-a41f-43ed-9f52-66c3bf2fa09d","description":"

This section contains request used for:

Application (server to server communication) request of IdP access_tokens

By using Microsoft AD FS IdP.

\n","_postman_id":"f05e3fe9-a41f-43ed-9f52-66c3bf2fa09d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f","id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f","name":"(outdatedDoc)auth","type":"folder"}}},{"name":"Microsoft AzureAD","item":[{"name":"AzureAD auth","event":[{"listen":"test","script":{"id":"cd46d3c4-269e-4080-b1eb-26e0b7502a31","exec":["pm.globals.set(\"token\", pm.response.json()[\"access_token\"]);"],"type":"text/javascript"}}],"id":"84960972-d4f3-4377-b197-e3172f0e9101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{idp_client_id}}","description":"

Required. Application ID assigned to the Azure AD client.

\n","type":"text"},{"key":"scope","value":"{{idp_scope}}","description":"

Required. Allowed scope to generated token.

\n","type":"text"},{"key":"client_secret","value":"{{idp_client_secret}}","description":"

Required. Client secret of the Azure AD app client

\n","type":"text"},{"key":"grant_type","value":"client_credentials","description":"

Required. Must be set to client_credentials.

\n","type":"text"}]},"url":"https://login.microsoftonline.com/{{tenant}}/oauth2/v2.0/token","description":"

Obtains an access_token through Azure AD needed to perform requests to Habitat services.
This is used to authenticate services that launch some processes without the intervention of any user.

The response could be one of:

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

200 OK	Successful authorization
400 Bad Request	Invalid parameters

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f","id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f","name":"(outdatedDoc)auth","type":"folder"}},"urlObject":{"protocol":"https","path":["{{tenant}}","oauth2","v2.0","token"],"host":["login","microsoftonline","com"],"query":[],"variable":[]}},"response":[{"id":"2519cff7-8f10-4577-887d-4af599d13bdd","name":"200 OK","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{idp_client_id}}","description":"Required. Application ID assigned to the Azure AD client.","type":"text"},{"key":"scope","value":"{{idp_scope}}","description":"Required. Allowed scope to generated token.","type":"text"},{"key":"client_secret","value":"{{idp_client_secret}}","description":"Required. Client secret of the Azure AD app client","type":"text"},{"key":"grant_type","value":"client_credentials","description":"Required. Must be set to client_credentials.","type":"text"}]},"url":"https://login.microsoftonline.com/{{tenant}}/oauth2/v2.0/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"P3P","value":"CP=\"DSP CUR OTPi IND OTRi ONL FIN\""},{"key":"x-ms-request-id","value":"c53ede08-0889-410f-ab85-18b3d4553300"},{"key":"x-ms-ests-server","value":"2.1.13156.10 - NEULR2 ProdSlices"},{"key":"X-XSS-Protection","value":"0"},{"key":"Set-Cookie","value":"fpc=AtxKSxeWKINDqNsoZBcG7Ny1TIGiAQAAAB8tY9oOAAAA; expires=Sun, 14-Aug-2022 09:45:21 GMT; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"x-ms-gateway-slice=estsfd; path=/; secure; samesite=none; httponly"},{"key":"Set-Cookie","value":"stsservicecookie=estsfd; path=/; secure; samesite=none; httponly"},{"key":"Date","value":"Fri, 15 Jul 2022 09:45:20 GMT"},{"key":"Content-Length","value":"1331"}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599,\n \"ext_expires_in\": 3599,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjJaUXBKM1VwYmpBWVhZR2FYRUpsOGxWMFRPSSIsImtpZCI6IjJaUXBKM1VwYmpBWVhZR2FYRUpsOGxWMFRPSSJ9.eyJhdWQiOiJkZGNmZTUzYy04NjBiLTQ5NzctYWNmMi1lMzJmMGE0YWUzYzIiLCJpc3MiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC9mNWZkOWUxNi0xMTRmLTQ4MjAtOGRlMS02MzEyZGFmOWFlYmIvIiwiaWF0IjoxNjU3ODc4MDIxLCJuYmYiOjE2NTc4NzgwMjEsImV4cCI6MTY1Nzg4MTkyMSwiYWlvIjoiRTJaZ1lEalc2aDR1dTlkNWJrMzhET1c2K2JIM0FBPT0iLCJhcHBpZCI6ImRkY2ZlNTNjLTg2MGItNDk3Ny1hY2YyLWUzMmYwYTRhZTNjMiIsImFwcGlkYWNyIjoiMSIsImlkcCI6Imh0dHBzOi8vc3RzLndpbmRvd3MubmV0L2Y1ZmQ5ZTE2LTExNGYtNDgyMC04ZGUxLTYzMTJkYWY5YWViYi8iLCJvaWQiOiIwNTQ3NTVkNi0yZjdkLTQwMTktOGE5My04NzI2YWMzZGViNmQiLCJyaCI6IjAuQVFVQUZwNzk5VThSSUVpTjRXTVMydm11dXp6bHo5MExobmRKclBMakx3cEs0OElGQUFBLiIsInN1YiI6IjA1NDc1NWQ2LTJmN2QtNDAxOS04YTkzLTg3MjZhYzNkZWI2ZCIsInRpZCI6ImY1ZmQ5ZTE2LTExNGYtNDgyMC04ZGUxLTYzMTJkYWY5YWViYiIsInV0aSI6IkNONC14WWtJRDBHcmhSaXoxRlV6QUEiLCJ2ZXIiOiIxLjAifQ.lpP73I5k3cC5FceAnKrDQVcOXqCm5cHatu8LaGSaAWq0L45g17BY5kyvVoHey2AQII5KKW2kkRn9epruy8uRb4Mt6l6IX9xUXcv38jx3ypAT-jakgFiu401hJfRoPzV4JcI__7QtWQWlge20lML3ublN_gR8tjYLzKPiY2x_am2i9aCTtOBxFJu1AooDznPKqh4EOTEVGfm8w9puyOS4lR7Pw9cp1QGGV6RiTAB3Ta6IP5v9cDqhwUyOWpeeiN2SQyk86EQnxcbaRNmsGCybB9HFTZwYXGSRF1-baVTyVI5-pQi8DGIZoBa4rsibiRdB--n4sy5nEsobaCOiYAVeyQ\"\n}"},{"id":"257fd493-398b-44eb-a923-982ff08b2964","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{idp_client_id}}","description":"Required. Application ID assigned to the Azure AD client.","type":"text"},{"key":"scope","value":"{{idp_scope}}","description":"Required. Allowed scope to generated token.","type":"text"},{"key":"client_secret","value":"{{idp_client_secret}}","description":"Required. Client secret of the Azure AD app client","type":"text"},{"key":"grant_type","value":"access_token","description":"Required. Must be set to client_credentials.","type":"text"}]},"url":"https://login.microsoftonline.com/{{tenant}}/oauth2/v2.0/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-store, no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"P3P","value":"CP=\"DSP CUR OTPi IND OTRi ONL FIN\""},{"key":"x-ms-request-id","value":"ed37dbd2-4a7e-4435-a64a-16f681683b00"},{"key":"x-ms-ests-server","value":"2.1.13156.10 - WEULR2 ProdSlices"},{"key":"X-XSS-Protection","value":"0"},{"key":"Set-Cookie","value":"fpc=AtxKSxeWKINDqNsoZBcG7Ny1TIGiAQAAAB8tY9oOAAAA; expires=Sun, 14-Aug-2022 09:45:40 GMT; path=/; secure; HttpOnly; SameSite=None"},{"key":"Set-Cookie","value":"x-ms-gateway-slice=estsfd; path=/; secure; samesite=none; httponly"},{"key":"Set-Cookie","value":"stsservicecookie=estsfd; path=/; secure; samesite=none; httponly"},{"key":"Date","value":"Fri, 15 Jul 2022 09:45:39 GMT"},{"key":"Content-Length","value":"433"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"unsupported_grant_type\",\n \"error_description\": \"AADSTS70003: The app requested an unsupported grant type 'access_token'.\\r\\nTrace ID: ed37dbd2-4a7e-4435-a64a-16f681683b00\\r\\nCorrelation ID: 583e08d1-a7bd-4698-b99a-ac48c93bb516\\r\\nTimestamp: 2022-07-15 09:45:40Z\",\n \"error_codes\": [\n 70003\n ],\n \"timestamp\": \"2022-07-15 09:45:40Z\",\n \"trace_id\": \"ed37dbd2-4a7e-4435-a64a-16f681683b00\",\n \"correlation_id\": \"583e08d1-a7bd-4698-b99a-ac48c93bb516\"\n}"}],"_postman_id":"84960972-d4f3-4377-b197-e3172f0e9101"}],"id":"0f828377-c2c8-4619-9b38-c11410594752","description":"

This section contains a request used for:

Application (server to server communication) request of IdP access_tokens

By using Azure AD IdP.

\n","_postman_id":"0f828377-c2c8-4619-9b38-c11410594752","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f","id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f","name":"(outdatedDoc)auth","type":"folder"}}},{"name":"(deprecated) users auth","event":[{"listen":"test","script":{"id":"cd15ae3c-ad0e-4147-95e0-8b0317408500","exec":["pm.globals.set(\"token\", pm.response.json()[\"token\"]);"],"type":"text/javascript"}}],"id":"9ba4e80c-543d-4365-a9fa-f9ad1273f40d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"myuser@mydomain.com\",\n \"password\": \"P@ssw0rd\"\n}"},"url":"{{host}}/habitat/v2/auth/users","description":"

Obtain a Bearer token using user credentials.

Both name and password are strings and required fields.

The response could be one of:

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

200 OK	Successful authorization
403 Forbidden	Wrong credentials
400 Bad Request	Required parameter is missing

","urlObject":{"path":["habitat","v2","auth","users"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"3a7805de-cb81-45ff-bd81-2d5d63e4700f","name":"Ok","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Angus.Kohler@hotmail.com\",\n\t\"password\": \"f7QSS8AGN0Qe11M\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/habitat/v2/auth/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Feb 2022 16:03:59 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"216"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJoYWJpdGF0LmV2ZXJpc2lvdC5jb20iLCJleHAiOjE2NDY3NDY4NjMsInVzZXJJZCI6MX0.S5MUdj_CYNuSrODfY4-isD6LXPA2a2CvxuZubTDJk9aYjG3JzMTvwDrwG0itcwaaooOR0S-3SrF0VkwsWp88LA\"\n}"},{"id":"2c8ec75e-b4ce-48a1-b3ab-8d01bc12ca9d","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Katharina_Gorczany@yahoo.com\",\n\t\"password\": \"or9cOlIX43ZtCQs\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/habitat/v2/auth/users"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Feb 2022 16:03:59 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"216"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":""},{"id":"7150983a-f23c-4e3f-828f-6ca5a0b7f1c4","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Estevan_Kreiger@yahoo.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/habitat/v2/auth/users"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Feb 2022 16:03:59 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"216"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9ba4e80c-543d-4365-a9fa-f9ad1273f40d"},{"name":"(deprecated) servers auth","event":[{"listen":"test","script":{"id":"62197687-b1bd-4869-a77a-1ce9a5c0ced1","exec":["pm.globals.set(\"token\", pm.response.json()[\"token\"]);"],"type":"text/javascript"}}],"id":"4c5b2ae1-b94b-4b0b-a6f6-84e3ecc60c51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"key\": \"5e39366f-b703-4fe1-ad7c-9eff501f67ff\"\n}"},"url":"{{host}}/habitat/v2/auth/servers","description":"

Obtain a Bearer token using API Key credential.
This is used to authenticate services that launch some processes without the intervention of any user.

key parameter is required.

The response could be one of:

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

200 OK	Successful authorization
403 Forbidden	Wrong credentials
400 Bad Request	Required parameter is missing

","urlObject":{"path":["habitat","v2","auth","servers"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"9aca117a-4bc6-4e00-afd9-fbc659893bf2","name":"Ok","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"key\": \"414a955f-ed18-4546-ad49-2993d21d4b99\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/habitat/v2/auth/servers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Mar 2022 13:48:31 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"214"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJoYWJpdGF0LmV2ZXJpc2lvdC5jb20iLCJrZXlJZCI6MSwiZXhwIjoxNjQ2NzQ3MzExfQ.nY3bray3lUkCBzzexW_pb2I-66F2yv7geGcL_5faxV3wdZuu33yfY4z3_uIpnf0oAv3swKKworWfH1JOuWTo7g\"\n}"},{"id":"84ad290d-63f5-45a4-a5f6-93fa32344c25","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/habitat/v2/auth/servers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 07 Mar 2022 13:46:27 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"375"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":""},{"id":"24470929-c550-4d00-8adc-dd76ec13bb7e","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"key\": \"dd0b0667-2aa2-4565-9c4e-823a85fbe22c\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/habitat/v2/auth/servers"},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 07 Mar 2022 13:47:00 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4c5b2ae1-b94b-4b0b-a6f6-84e3ecc60c51"}],"id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f","description":"

Before using the Habitat Esite API, you’ll need to obtain an Authorization Token. All Habitat resources are protected with OAuth 2.0 Bearer Tokens sent on the request as an Authorization: Bearer header.

There are two different authorization endpoints:

users auth: Authorization is performed by Habität users credentials (name and password).
servers auth: Authorization is performed via API Key. This is though to be used to secure communication between Habität modules and also for server-side applications which runs processes without the need of interaction by any user.

By default, tokens issued by Habität expire in a day.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6e60da0c-160d-4a43-9936-14e7b4aa5148","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7205f5dc-ca36-438b-9069-a3f703f5ea4c","type":"text/javascript","exec":[""]}}],"_postman_id":"5d1bd252-ae6e-45d7-ba71-1ca1b38e0f2f"},{"name":"alarms","item":[{"name":"sensor","item":[{"name":"get sensor alarms","id":"bbc4d902-40f9-4e98-94d9-0082dbd56d7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/alarms/sensor","description":"

Gets the sensor alarms that has been triggered and filtered by several optional parameters.

AlarmsRead permission is required.

The results can be paginated with page and perPage parameters. By default, is no pagination parameters are provided, the request returns the first 50 results.

The response could be one of:

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

200 OK
403 Forbidden	User without AlarmsRead permission
401 Unauthorized	Missing Bearer token

Filter sensors alarms by type

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

Filter sensors by read status

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

Filter by device substring

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

Page index

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

Number of items per page

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

Order the results (only insertDate supported)

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

Order direction (asc or desc)

\n","type":"text/plain"},"key":"order","value":"asc"}],"variable":[]}},"response":[{"id":"25ccd84a-89e6-4e88-9b41-72d1384ee042","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/sensor","host":["{{host}}"],"path":["v2","alarms","sensor"],"query":[{"key":"type","value":"SensorDisconnectedByHardware","description":"Filter sensors alarms by type","type":"text","disabled":true},{"key":"read","value":"false","description":"Filter sensors by read status","type":"text","disabled":true},{"key":"device","value":"F3851","description":"Filter by device substring","disabled":true},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"insertDate","description":"Order the results (only insertDate supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Feb 2022 16:05:20 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"type\": \"SensorDisconnectedByHardware\",\n \"device\": \"00124B00197F3851\",\n \"port\": 1,\n \"read\": true,\n \"insertDate\": \"2020-11-16T11:22:14\"\n },\n {\n \"id\": 2,\n \"type\": \"SensorDisconnectedTimer\",\n \"device\": \"00124B00197F6783\",\n \"port\": 0,\n \"read\": true,\n \"insertDate\": \"2020-11-25T22:41:29\"\n },\n {\n \"id\": 3,\n \"type\": \"SensorDisconnectedTimer\",\n \"device\": \"00124B00197F3C5D\",\n \"port\": 0,\n \"read\": true,\n \"insertDate\": \"2020-11-25T22:41:30\"\n },\n {\n \"id\": 4,\n \"type\": \"SensorDisconnectedTimer\",\n \"device\": \"00124B00197F3C5D\",\n \"port\": 0,\n \"read\": false,\n \"insertDate\": \"2020-11-27T20:51:15\"\n },\n {\n \"id\": 5,\n \"type\": \"SensorDisconnectedTimer\",\n \"device\": \"00124B00197F6783\",\n \"port\": 0,\n \"read\": true,\n \"insertDate\": \"2020-11-27T20:51:27\"\n }\n]"},{"id":"b48c0059-64d0-4b0b-915b-e2ebac64aa80","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/sensor","host":["{{host}}"],"path":["v2","alarms","sensor"],"query":[{"key":"type","value":"SensorDisconnectedByHardware","description":"Filter sensors alarms by type","type":"text","disabled":true},{"key":"read","value":"false","description":"Filter sensors by read status","type":"text","disabled":true},{"key":"device","value":"F3851","description":"Filter by device substring","disabled":true},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"insertDate","description":"Order the results (only insertDate supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:33:43 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"f9bdb080-db5b-42d4-add9-9a4fa685b688","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/sensor","host":["{{host}}"],"path":["v2","alarms","sensor"],"query":[{"key":"type","value":"SensorDisconnectedByHardware","description":"Filter sensors alarms by type","type":"text","disabled":true},{"key":"read","value":"false","description":"Filter sensors by read status","type":"text","disabled":true},{"key":"device","value":"F3851","description":"Filter by device substring","disabled":true},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"insertDate","description":"Order the results (only insertDate supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:19:03 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"bbc4d902-40f9-4e98-94d9-0082dbd56d7e"},{"name":"get sensor alarm","id":"40038f3a-1284-4204-b34d-201bb7da4664","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/alarms/sensor/:alarmId","description":"

Gets a sensor alarm by its id.

AlarmsRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without AlarmsRead permission
404 Not Found	Alarm id not found
401 Unauthorized	Missing Bearer token

Id of the alarm to be retrieved

\n","type":"text/plain"},"type":"string","value":"1","key":"alarmId"}]}},"response":[{"id":"92a9353d-839a-40ea-8459-b1985903f02a","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/sensor/:alarmId","host":["{{host}}"],"path":["v2","alarms","sensor",":alarmId"],"variable":[{"key":"alarmId","value":"84","type":"string","description":"Id of the alarm to be retrieved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Feb 2022 16:14:35 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 84,\n \"type\": \"SensorDisconnectedByHardware\",\n \"device\": \"00124B00197F3851\",\n \"port\": 1,\n \"read\": true,\n \"insertDate\": \"2020-11-16T11:22:14\"\n}"},{"id":"c75910cb-e05f-4944-88bf-977c8f827a7a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/sensor/:alarmId","host":["{{host}}"],"path":["v2","alarms","sensor",":alarmId"],"variable":[{"key":"alarmId","value":"367","type":"string","description":"Id of the alarm to be retrieved"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:33:57 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"2532389b-51b7-490a-a456-9f18c5d710bf","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/sensor/:alarmId","host":["{{host}}"],"path":["v2","alarms","sensor",":alarmId"],"variable":[{"key":"alarmId","value":"25","type":"string","description":"Id of the alarm to be retrieved"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Feb 2022 16:15:07 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Sensor alarm 25 not found\"\n}"},{"id":"d0a5d3e1-1f74-4beb-9cba-bbb2b3bda9d7","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/sensor/:alarmId","host":["{{host}}"],"path":["v2","alarms","sensor",":alarmId"],"variable":[{"key":"alarmId","value":"803","type":"string","description":"Id of the alarm to be retrieved"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:19:34 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"40038f3a-1284-4204-b34d-201bb7da4664"},{"name":"set as read","id":"db5a911c-79dc-49e7-900e-9fb8c4543e2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"read\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/alarms/sensor/:alarmId","description":"

Modify the read flag of an alarm.

AlarmsWrite permission is required.

Body field:

read: Required. Boolean. Sets the read status of the alarm.

The response could be one of:

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

200 OK
403 Forbidden	User without AlarmsWrite permission
404 Not Found	Alarm id not found
401 Unauthorized	Missing Bearer token

Id of the sensor alarm to modify

\n","type":"text/plain"},"type":"string","value":"1","key":"alarmId"}]}},"response":[{"id":"679d55d6-1e60-4d41-b501-fd65c5f92a50","name":"Ok","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"read\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/alarms/sensor/:alarmId","host":["{{host}}"],"path":["v2","alarms","sensor",":alarmId"],"variable":[{"key":"alarmId","value":"78","type":"string","description":"Id of the sensor alarm to modify"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Feb 2022 16:14:47 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 78,\n \"type\": \"SensorDisconnectedByHardware\",\n \"device\": \"00124B00197F3851\",\n \"port\": 1,\n \"read\": true,\n \"insertDate\": \"2020-11-16T11:22:14\"\n}"},{"id":"1bbf66d0-6f80-4121-99bb-47a5ce95c59b","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"read\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/alarms/sensor/:alarmId","host":["{{host}}"],"path":["v2","alarms","sensor",":alarmId"],"variable":[{"key":"alarmId","value":"366","type":"string","description":"Id of the sensor alarm to modify"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:34:05 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"667e7590-692d-4943-b2b5-fe1e2f4b94e4","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"read\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/alarms/sensor/:alarmId","host":["{{host}}"],"path":["v2","alarms","sensor",":alarmId"],"variable":[{"key":"alarmId","value":"902","type":"string","description":"Id of the sensor alarm to modify"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:19:44 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"d9f30cb0-cb3d-4dc6-969b-a2d43a535cf9","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"read\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/alarms/sensor/:alarmId","host":["{{host}}"],"path":["v2","alarms","sensor",":alarmId"],"variable":[{"key":"alarmId","value":"12","type":"string","description":"Id of the sensor alarm to modify"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Mar 2022 15:17:10 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Sensor alarm 12 not found\"\n}"}],"_postman_id":"db5a911c-79dc-49e7-900e-9fb8c4543e2a"}],"id":"4104b6e2-3b36-4e2c-859b-5ae0ee58b237","description":"

Requests related to sensor alarms.

The sensor alarms can be queried and marked as readed when the issue of the sensor has been reviewed.

\n","event":[{"listen":"prerequest","script":{"id":"a0d6e55b-337e-4eb7-a762-315410961c58","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2af0567a-ece1-43d6-9cb3-25e86fdbcf26","type":"text/javascript","exec":[""]}}],"_postman_id":"4104b6e2-3b36-4e2c-859b-5ae0ee58b237","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"system","item":[{"name":"TEST","item":[{"name":"get system alarms Copy","id":"a2e80828-8167-4f7b-b94d-29a1767d9585","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/alarms/system","description":"

Gets the system alarms stored and the total system alarms. The request accept several filters and pagination over results.

AlarmsRead permission is required.

Currently only proximity alarms are retrieved.

The result can be filtered by start and end date time. This filters are in format YYYY-MM-ddTHH:mm.

If star nor end parameters are provided, the request will return the system alarms that has been triggered in the last day.

The results can be paginated with page and perPage parameters. If pagination parameters are not provided, the first 50 results will be retrieved.

The response could be one of:

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

200 OK
403 Forbidden	User without AlarmsRead permission
401 Unauthorized	Missing Bearer token

Start date to filter in format YYYY-MM-ddTHH:mm

\n","type":"text/plain"},"key":"start","value":"2019-11-30T05:00"},{"disabled":true,"description":{"content":"

End date to filter in format YYYY-MM-ddTHH:mm

\n","type":"text/plain"},"key":"end","value":"2020-11-30T08:00"},{"disabled":true,"description":{"content":"

Page index

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

Number of items per page

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

Order the results (only date supported)

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

Order direction (asc or desc)

\n","type":"text/plain"},"key":"order","value":"asc"}],"variable":[]}},"response":[{"id":"f39be3c5-eb4a-423b-bd61-c21b7a09dfe6","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/system?start=2019-11-30T05:00&end=2021-11-30T08:00","host":["{{host}}"],"path":["v2","alarms","system"],"query":[{"key":"start","value":"2019-11-30T05:00","description":"Start date to filter in format YYYY-MM-ddTHH:mm"},{"key":"end","value":"2021-11-30T08:00","description":"End date to filter in format YYYY-MM-ddTHH:mm"},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"date","description":"Order the results (only date supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:11:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 7,\n \"alarms\": [\n {\n \"id\": 589,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T08:49:55\"\n },\n {\n \"id\": 590,\n \"space1\": 12833,\n \"space2\": 12834,\n \"date\": \"2022-04-11T08:53:31\"\n },\n {\n \"id\": 591,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T08:59:43\"\n },\n {\n \"id\": 592,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T10:11:27\"\n },\n {\n \"id\": 593,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T10:26:16\"\n },\n {\n \"id\": 594,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T10:36:36\"\n },\n {\n \"id\": 595,\n \"space1\": 12833,\n \"space2\": 12834,\n \"date\": \"2022-04-11T10:51:49\"\n }\n ]\n}"},{"id":"c7b9cf3e-450f-46e0-9a85-674831c27b31","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/system","host":["{{host}}"],"path":["v2","alarms","system"],"query":[{"key":"start","value":"2019-11-30T05:00","description":"Start date to filter in format YYYY-MM-ddTHH:mm","disabled":true},{"key":"end","value":"2020-11-30T08:00","description":"End date to filter in format YYYY-MM-ddTHH:mm","disabled":true},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"date","description":"Order the results (only date supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","type":"text","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:36:36 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"7ef1fdbf-8ff9-44f7-af16-04a38cb438d2","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/system?start=2019-11-30T05:00&end=2021-11-30T08:00","host":["{{host}}"],"path":["v2","alarms","system"],"query":[{"key":"start","value":"2019-11-30T05:00","description":"Start date to filter in format YYYY-MM-ddTHH:mm"},{"key":"end","value":"2021-11-30T08:00","description":"End date to filter in format YYYY-MM-ddTHH:mm"},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"date","description":"Order the results (only date supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","type":"text","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:24:29 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"a2e80828-8167-4f7b-b94d-29a1767d9585"},{"name":"get system alarms \"NEW\"","id":"15a37be5-7206-46be-b0eb-d9952c289fe5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/alarms/system/new","description":"

Gets the system alarms stored and the total system alarms. The request accept several filters and pagination over results.

AlarmsRead permission is required.

Currently only proximity alarms are retrieved.

The result can be filtered by start and end date time. This filters are in format YYYY-MM-ddTHH:mm.

If star nor end parameters are provided, the request will return the system alarms that has been triggered in the last day.

The results can be paginated with page and perPage parameters. If pagination parameters are not provided, the first 50 results will be retrieved.

The response could be one of:

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

200 OK
403 Forbidden	User without AlarmsRead permission
401 Unauthorized	Missing Bearer token

Start date to filter in format YYYY-MM-ddTHH:mm

\n","type":"text/plain"},"key":"start","value":"2019-11-30T05:00"},{"disabled":true,"description":{"content":"

End date to filter in format YYYY-MM-ddTHH:mm

\n","type":"text/plain"},"key":"end","value":"2020-11-30T08:00"},{"disabled":true,"description":{"content":"

Page index

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

Number of items per page

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

Order the results (only date supported)

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

Order direction (asc or desc)

\n","type":"text/plain"},"key":"order","value":"asc"}],"variable":[]}},"response":[{"id":"acf23eda-276f-4ced-aa8e-0cb30a0e3529","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/system?start=2019-11-30T05:00&end=2021-11-30T08:00","host":["{{host}}"],"path":["v2","alarms","system"],"query":[{"key":"start","value":"2019-11-30T05:00","description":"Start date to filter in format YYYY-MM-ddTHH:mm"},{"key":"end","value":"2021-11-30T08:00","description":"End date to filter in format YYYY-MM-ddTHH:mm"},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"date","description":"Order the results (only date supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:11:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 7,\n \"alarms\": [\n {\n \"id\": 589,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T08:49:55\"\n },\n {\n \"id\": 590,\n \"space1\": 12833,\n \"space2\": 12834,\n \"date\": \"2022-04-11T08:53:31\"\n },\n {\n \"id\": 591,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T08:59:43\"\n },\n {\n \"id\": 592,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T10:11:27\"\n },\n {\n \"id\": 593,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T10:26:16\"\n },\n {\n \"id\": 594,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T10:36:36\"\n },\n {\n \"id\": 595,\n \"space1\": 12833,\n \"space2\": 12834,\n \"date\": \"2022-04-11T10:51:49\"\n }\n ]\n}"},{"id":"3e03fb8d-bc0d-444a-955c-596dbafcafc9","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/system","host":["{{host}}"],"path":["v2","alarms","system"],"query":[{"key":"start","value":"2019-11-30T05:00","description":"Start date to filter in format YYYY-MM-ddTHH:mm","disabled":true},{"key":"end","value":"2020-11-30T08:00","description":"End date to filter in format YYYY-MM-ddTHH:mm","disabled":true},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"date","description":"Order the results (only date supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","type":"text","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:36:36 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"77e30fab-ee21-4a78-a447-760c97b95fb9","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/system?start=2019-11-30T05:00&end=2021-11-30T08:00","host":["{{host}}"],"path":["v2","alarms","system"],"query":[{"key":"start","value":"2019-11-30T05:00","description":"Start date to filter in format YYYY-MM-ddTHH:mm"},{"key":"end","value":"2021-11-30T08:00","description":"End date to filter in format YYYY-MM-ddTHH:mm"},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"date","description":"Order the results (only date supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","type":"text","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:24:29 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"15a37be5-7206-46be-b0eb-d9952c289fe5"}],"id":"dad6e853-3e3e-4465-a7ae-a625bf8a86e8","_postman_id":"dad6e853-3e3e-4465-a7ae-a625bf8a86e8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"get system alarms","id":"91669a91-7572-4bbf-8171-876b945879bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/alarms/system","description":"

Gets the system alarms stored and the total system alarms. The request accept several filters and pagination over results.

AlarmsRead permission is required.

Currently only proximity alarms are retrieved.

The result can be filtered by start and end date time. This filters are in format YYYY-MM-ddTHH:mm.

If star nor end parameters are provided, the request will return the system alarms that has been triggered in the last day.

The results can be paginated with page and perPage parameters. If pagination parameters are not provided, the first 50 results will be retrieved.

The response could be one of:

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

200 OK
403 Forbidden	User without AlarmsRead permission
401 Unauthorized	Missing Bearer token

Start date to filter in format YYYY-MM-ddTHH:mm

\n","type":"text/plain"},"key":"start","value":"2019-11-30T05:00"},{"disabled":true,"description":{"content":"

End date to filter in format YYYY-MM-ddTHH:mm

\n","type":"text/plain"},"key":"end","value":"2020-11-30T08:00"},{"disabled":true,"description":{"content":"

Page index

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

Number of items per page

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

Order the results (only date supported)

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

Order direction (asc or desc)

\n","type":"text/plain"},"key":"order","value":"asc"}],"variable":[]}},"response":[{"id":"887a441f-1c7e-4d4b-a392-393baf52d009","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/system?start=2019-11-30T05:00&end=2021-11-30T08:00","host":["{{host}}"],"path":["v2","alarms","system"],"query":[{"key":"start","value":"2019-11-30T05:00","description":"Start date to filter in format YYYY-MM-ddTHH:mm"},{"key":"end","value":"2021-11-30T08:00","description":"End date to filter in format YYYY-MM-ddTHH:mm"},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"date","description":"Order the results (only date supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:11:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"total\": 7,\n \"alarms\": [\n {\n \"id\": 589,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T08:49:55\"\n },\n {\n \"id\": 590,\n \"space1\": 12833,\n \"space2\": 12834,\n \"date\": \"2022-04-11T08:53:31\"\n },\n {\n \"id\": 591,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T08:59:43\"\n },\n {\n \"id\": 592,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T10:11:27\"\n },\n {\n \"id\": 593,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T10:26:16\"\n },\n {\n \"id\": 594,\n \"space1\": 12834,\n \"space2\": 12833,\n \"date\": \"2022-04-11T10:36:36\"\n },\n {\n \"id\": 595,\n \"space1\": 12833,\n \"space2\": 12834,\n \"date\": \"2022-04-11T10:51:49\"\n }\n ]\n}"},{"id":"abd70c18-8b17-4ae5-8ea3-7956cc50d9cd","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/system","host":["{{host}}"],"path":["v2","alarms","system"],"query":[{"key":"start","value":"2019-11-30T05:00","description":"Start date to filter in format YYYY-MM-ddTHH:mm","disabled":true},{"key":"end","value":"2020-11-30T08:00","description":"End date to filter in format YYYY-MM-ddTHH:mm","disabled":true},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"date","description":"Order the results (only date supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","type":"text","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:36:36 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"37009d4c-8ed6-4f58-bbe7-5aad91fcf32f","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/alarms/system?start=2019-11-30T05:00&end=2021-11-30T08:00","host":["{{host}}"],"path":["v2","alarms","system"],"query":[{"key":"start","value":"2019-11-30T05:00","description":"Start date to filter in format YYYY-MM-ddTHH:mm"},{"key":"end","value":"2021-11-30T08:00","description":"End date to filter in format YYYY-MM-ddTHH:mm"},{"key":"page","value":"1","description":"Page index","disabled":true},{"key":"perPage","value":"50","description":"Number of items per page","disabled":true},{"key":"orderBy","value":"date","description":"Order the results (only date supported)","disabled":true},{"key":"order","value":"asc","description":"Order direction (asc or desc)","type":"text","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:24:29 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"91669a91-7572-4bbf-8171-876b945879bd"}],"id":"2445522b-3119-495e-8a80-dbdcf70f9525","description":"

Requests related to system alarms.

Currently only proximity alarms, which are triggered by occupation of adjacent sensors, are supported

\n","event":[{"listen":"prerequest","script":{"id":"6b52a13c-3f4b-4999-af64-2182ad742330","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"24b4036d-6dc6-42ee-adea-b086b70602f7","type":"text/javascript","exec":[""]}}],"_postman_id":"2445522b-3119-495e-8a80-dbdcf70f9525","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}}],"id":"db5b1e3b-79ee-4a48-8ab3-aebfa89d1476","description":"

Requests related to alarms.

Habitat defines two type of alarms:

Sensor alarms: Alarms related to a malfunction or issue in the sensor installed in a site or room.
System alarms: Processed information about occupation, like proximity alarms, triggered when two adjacent sensors detect occupation.

\n","event":[{"listen":"prerequest","script":{"id":"326de707-b21c-4e39-8072-98b38fb3e21f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4d36056a-bc1b-4347-9896-544dd6404ab2","type":"text/javascript","exec":[""]}}],"_postman_id":"db5b1e3b-79ee-4a48-8ab3-aebfa89d1476","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"devices","item":[{"name":"associations","item":[{"name":"get associations","event":[{"listen":"test","script":{"id":"32691105-6ab7-4d77-a238-d0a523113f90","exec":[""],"type":"text/javascript"}}],"id":"58c3f793-8398-4c8b-923e-7bda4c1eb435","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/devices/:device/associations","description":"

Returns all the associations of the device

DevicesRead permission is required

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesRead permission
404 Not Found	MAC Address not found on database
401 Unauthorized	Missing Bearer token

MAC Address of the device to return associations

\n","type":"text/plain"},"type":"string","value":"12345FGH2","key":"device"}]}},"response":[{"id":"22911b27-44b0-4a21-a806-5f699c506e60","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"00124B00197F3FCA","type":"string","description":"MAC Address of the device to return associations"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 16:43:34 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"device\": \"00124B00197F3FCA\",\n \"port\": 1,\n \"space\": 3751,\n \"sensorType\": \"Pir\",\n \"sensorCoverType\": null,\n \"sensorDelay\": 120\n },\n {\n \"device\": \"00124B00197F3FCA\",\n \"port\": 2,\n \"space\": 3756,\n \"sensorType\": \"Pir\",\n \"sensorCoverType\": null,\n \"sensorDelay\": 120\n },\n {\n \"device\": \"00124B00197F3FCA\",\n \"port\": 3,\n \"space\": 3752,\n \"sensorType\": \"Pir\",\n \"sensorCoverType\": null,\n \"sensorDelay\": 120\n }\n]"},{"id":"faf10f47-1efe-4db1-906a-588ce557e0a8","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"03:a3:dc:d1:64:59","type":"string","description":"MAC Address of the device to return associations"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:36:56 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"b3565508-4fbc-409b-b1e5-f070d50d14d1","name":"403 Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"82:7d:e4:42:0f:cc","type":"string","description":"MAC Address of the device to return associations"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 08 Mar 2022 09:17:47 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"72f3300f-1f9d-4e50-b34b-9d43316e757e","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"d1:e0:32:e3:b1:6e","type":"string","description":"MAC Address of the device to return associations"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 08 Mar 2022 09:17:47 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"58c3f793-8398-4c8b-923e-7bda4c1eb435"},{"name":"get association at port","id":"778323be-2180-498f-8ebc-c369356def5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/devices/:device/associations/:port","description":"

Returns the association of the device at the selected port

DevicesRead permission is required

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesRead permission
404 Not Found	MAC Address not found on database
401 Unauthorized	Missing Bearer token

MAC Address of the device to return association

\n","type":"text/plain"},"type":"string","value":"12345FGH2","key":"device"},{"description":{"content":"

Port number

\n","type":"text/plain"},"type":"string","value":"1","key":"port"}]}},"response":[{"id":"5fea08aa-c416-4bd9-aca8-d8733f9e0bc2","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations/:port","host":["{{host}}"],"path":["v2","devices",":device","associations",":port"],"variable":[{"key":"device","value":"00124B00197F3FCA","type":"string","description":"MAC Address of the device to return associations"},{"key":"port","value":"1","type":"string","description":"Port number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 16:43:45 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"device\": \"00124B00197F3FCA\",\n \"port\": 1,\n \"space\": 3751,\n \"sensorType\": \"Pir\",\n \"sensorCoverType\": null,\n \"sensorDelay\": 120\n}"},{"id":"f9928e74-d4a8-4f7b-91af-19aec1751cfa","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations/:port","host":["{{host}}"],"path":["v2","devices",":device","associations",":port"],"variable":[{"key":"device","value":"ef:36:6d:44:44:95","type":"string","description":"MAC Address of the device to return associations"},{"key":"port","value":"41","type":"string","description":"Port number"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:37:44 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"01059212-b385-4289-8eed-c34f025c40de","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations/:port","host":["{{host}}"],"path":["v2","devices",":device","associations",":port"],"variable":[{"key":"device","value":"de:6b:7e:c3:cc:85","type":"string","description":"MAC Address of the device to return association"},{"key":"port","value":"946","type":"string","description":"Port number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 08 Mar 2022 09:26:00 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"c80ba138-a372-4afd-a725-37ead2f6adee","name":"403 Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations/:port","host":["{{host}}"],"path":["v2","devices",":device","associations",":port"],"variable":[{"key":"device","value":"de:7b:e3:45:68:66","type":"string","description":"MAC Address of the device to return associations"},{"key":"port","value":"229","type":"string","description":"Port number"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:37:44 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"778323be-2180-498f-8ebc-c369356def5c"},{"name":"delete all associations of the device","id":"acd68e8f-47a6-4965-b93d-b91c8e444245","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{host}}/v2/devices/:device/associations","description":"

Delete all associations of the device

DevicesWrite permission is required

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesWrite permission
401 Unauthorized	Missing Bearer token
404 Not Found	MAC Address missing in database

MAC Address of the device to delete associatons from

\n","type":"text/plain"},"type":"string","value":"12345FGH2","key":"device"}]}},"response":[{"id":"1c640041-7665-48ea-96a1-f2355fa2f2a7","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"a2:9c:7c:76:16:c8","type":"string","description":"MAC Address of the device to delete associatons from"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 16 Feb 2022 16:44:37 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"7710d0f9-e366-49ca-a5e3-1c8fa9b6b5b4","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"ed:11:c0:bb:e6:dd","type":"string","description":"MAC Address of the device to delete associatons from"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:37:55 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"b6070a74-a8da-40c4-8701-b078978dafcb","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"68:eb:ba:14:cd:e5","type":"string","description":"MAC Address of the device to delete associatons from"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:37:55 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"b7655981-a90f-4eb3-a01c-9e91a94d807f","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"d3:0d:f2:30:c8:e5","type":"string","description":"MAC Address of the device to delete associatons from"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:37:55 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"acd68e8f-47a6-4965-b93d-b91c8e444245"},{"name":"delete association at port","id":"75c18c5d-6326-4ec2-8913-b0a494969d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{host}}/v2/devices/:device/associations/:port","description":"

Delete association of the device at the selected port

DevicesWrite permission is required

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesWrite permission
401 Unauthorized	Missing Bearer token
404 Not Found	MAC Address missing in database

MAC Address of the device to delete associaton from

\n","type":"text/plain"},"type":"string","value":"12345FGH2","key":"device"},{"description":{"content":"

Port number

\n","type":"text/plain"},"type":"string","value":"2","key":"port"}]}},"response":[{"id":"91511728-1895-4e67-98c2-34f96f5c4877","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations/:port","host":["{{host}}"],"path":["v2","devices",":device","associations",":port"],"variable":[{"key":"device","value":"5f:f7:51:24:03:98","type":"string","description":"MAC Address of the device to delete associaton from"},{"key":"port","value":"93","type":"string","description":"Port number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 16 Feb 2022 16:44:26 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"5c60dfda-137d-4eaa-a8fb-0eee2d73094e","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations/:port","host":["{{host}}"],"path":["v2","devices",":device","associations",":port"],"variable":[{"key":"device","value":"8d:cb:d0:54:00:48","type":"string","description":"MAC Address of the device to delete associaton from"},{"key":"port","value":"894","type":"string","description":"Port number"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:07 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"7a0542ac-ffc9-4985-a572-44d6aae25dc1","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations/:port","host":["{{host}}"],"path":["v2","devices",":device","associations",":port"],"variable":[{"key":"device","value":"d0:a9:63:2d:99:94","type":"string","description":"MAC Address of the device to delete associaton from"},{"key":"port","value":"254","type":"string","description":"Port number"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:07 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"58026422-de96-49fa-928e-1422a417eb2d","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device/associations/:port","host":["{{host}}"],"path":["v2","devices",":device","associations",":port"],"variable":[{"key":"device","value":"bc:8c:34:fa:48:9e","type":"string","description":"MAC Address of the device to delete associaton from"},{"key":"port","value":"724","type":"string","description":"Port number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 08 Mar 2022 09:38:29 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"75c18c5d-6326-4ec2-8913-b0a494969d2c"},{"name":"create or modify association","id":"262d8f2b-b657-43ce-8b5c-add17e4ce40e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"device\": \"00124B00159AF12A\",\n \"port\": 2,\n \"space\": 3568,\n \"sensorType\": \"Dali\",\n \"sensorCoverType\": \"CircularWide\",\n \"sensorDelay\": 2000\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/devices/:device/associations","description":"

Creates a new association at the selected port.

DevicesWrite permission is required

If there is already one, it will be overwrited.

Body fields:

device: Required. String. MAC of the device
port: Required. Int. Port number in which modify association at.
space: Required. Int. Id of the space to associate
sensorType: Required. String. Type of sensor associated. Enumerated value (Dali, Pir, Room)
sensorCoverType: Optional. String. Sensor cover type. Enumerated value (CircularWide, CircularMedium, CircularSmall).
sensorDelay: Required. Int. Sensor delay in milliseconds

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesWrite permission
401 Unauthorized	Missing Bearer token
404 Not Found	MAC Address missing in database
400 Bad Request	Invalid or missing required parameters

","urlObject":{"path":["v2","devices",":device","associations"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"

MAC Address of the device to modify or create association from

\n","type":"text/plain"},"type":"string","value":"00124B00159AF12A","key":"device"}]}},"response":[{"id":"3a28110b-441b-4eb3-ae04-8606f0aad26c","name":"Ok","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"device\": \"00124B00197F3FCA\",\n \"port\": 2,\n \"space\": 3568,\n \"sensorType\": \"Dali\",\n \"sensorDelay\": 2000\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"00124B00197F3FCA","type":"string","description":"MAC Address of the device to modify or create association from"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 16:44:07 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"device\": \"00124B00197F3FCA\",\n \"port\": 2,\n \"space\": 3568,\n \"sensorType\": \"Dali\",\n \"sensorCoverType\": null,\n \"sensorDelay\": 2000\n}"},{"id":"e6c9d3bf-fcf0-4f27-a37c-348774680d40","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"device\": \"00124B00197F3FCB\",\n \"port\": 2,\n \"space\": 3568,\n \"sensorType\": \"Pir\",\n \"sensorCoverType\": \"CircularWide\",\n \"sensorDelay\": 2000\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"00124B00197F3FCB","type":"string","description":"MAC Address of the device to modify or create association from"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"921abf42-1801-4ce5-a771-674463fbc50b","name":"404 Not Found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"device\": \"00124B00197F3FC\",\n \"port\": 2,\n \"space\": 3568,\n \"sensorType\": \"Pir\",\n \"sensorCoverType\": \"CircularWide\",\n \"sensorDelay\": 2000\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"00124B00197F3FC","type":"string","description":"MAC Address of the device to modify or create association from"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"16cca201-0089-4627-bc44-a9ab7550bff4","name":"400 Bad Request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"device\": \"00124B00197F3FCB\",\n \"port\": 2\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"00124B00197F3FCB","type":"string","description":"MAC Address of the device to modify or create association from"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"32543435-3841-4461-ae56-fd06fab6e265","name":"403 Forbidden","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"device\": \"00124B00197F3FCB\",\n \"port\": 2,\n \"space\": 3568,\n \"sensorType\": \"Pir\",\n \"sensorCoverType\": \"CircularWide\",\n \"sensorDelay\": 2000\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device/associations","host":["{{host}}"],"path":["v2","devices",":device","associations"],"variable":[{"key":"device","value":"00124B00197F3FCB","type":"string","description":"MAC Address of the device to modify or create association from"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"262d8f2b-b657-43ce-8b5c-add17e4ce40e"}],"id":"b6bbccb4-ae5b-48e1-81e4-ba6984df1e92","description":"

Requests related with the associations (connections) between devices.

\n","_postman_id":"b6bbccb4-ae5b-48e1-81e4-ba6984df1e92","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"get devices","id":"19ba5188-a943-482e-b230-5eec94b73101","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/devices","description":"

Gets the devices installed in this instance. Accepts different filter and pagination parameters.

DevicesRead permission is required.

The results can be paginated with page and perPage parameters. If no pagination parameters are provided, request will return the first 50 results.

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesRead permission
401 Unauthorized	Missing Bearer token

Filter by device type (Node, gateway)

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

Filter by floor

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

Page index

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

Items per page

\n","type":"text/plain"},"key":"perPage","value":"50"}],"variable":[]}},"response":[{"id":"255d2cce-37d8-44c0-801b-cfd5be981268","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices","host":["{{host}}"],"path":["v2","devices"],"query":[{"key":"type","value":"Node","description":"Filter by device type (Node, gateway)","type":"text","disabled":true},{"key":"floor","value":"28","description":"Filter by floor","disabled":true},{"key":"page","value":"1","description":"Page index","type":"text","disabled":true},{"key":"perPage","value":"50","description":"Items per page","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 10:00:39 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 291,\n \"physicalCode\": \"00124B00197F3C56\",\n \"installationDate\": \"2020-01-21T20:50:07\",\n \"x\": 149.885,\n \"y\": 60.3584,\n \"floor\": 30,\n \"registerDate\": null,\n \"unregisterDate\": \"2022-01-27T12:31:49.81\",\n \"type\": \"Gateway\"\n },\n {\n \"id\": 354,\n \"physicalCode\": \"00124B00197F3C2B\",\n \"installationDate\": \"2020-09-30T14:57:01.506\",\n \"x\": 119.938,\n \"y\": 47.2692,\n \"floor\": 30,\n \"registerDate\": null,\n \"unregisterDate\": \"2022-01-27T12:31:50.052\",\n \"type\": \"Node\"\n },\n {\n \"id\": 356,\n \"physicalCode\": \"00124B00197F3C67\",\n \"installationDate\": \"2020-01-23T23:59:59\",\n \"x\": 140.498,\n \"y\": 59.153,\n \"floor\": 30,\n \"registerDate\": null,\n \"unregisterDate\": \"2020-10-28T14:17:00\",\n \"type\": \"Node\"\n },\n {\n \"id\": 357,\n \"physicalCode\": \"00124B00197F3C1B\",\n \"installationDate\": \"2020-01-22T20:24:17\",\n \"x\": 105.017,\n \"y\": 27.7287,\n \"floor\": 30,\n \"registerDate\": null,\n \"unregisterDate\": \"2022-01-27T12:31:50.097\",\n \"type\": \"Node\"\n }\n]"},{"id":"87181ed6-4769-47d1-8b9c-6f487e617343","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices","host":["{{host}}"],"path":["v2","devices"],"query":[{"key":"type","value":"Node","description":"Filter by device type (Node, gateway)","type":"text","disabled":true},{"key":"floor","value":"28","description":"Filter by floor","disabled":true},{"key":"page","value":"1","description":"Page index","type":"text","disabled":true},{"key":"perPage","value":"50","description":"Items per page","type":"text","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:31 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"6fd57801-fcbc-403a-a28d-954e76e2ddec","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices","host":["{{host}}"],"path":["v2","devices"],"query":[{"key":"type","value":"Node","description":"Filter by device type (Node, gateway)","type":"text","disabled":true},{"key":"floor","value":"28","description":"Filter by floor","disabled":true},{"key":"page","value":"1","description":"Page index","type":"text","disabled":true},{"key":"perPage","value":"50","description":"Items per page","type":"text","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:10:00 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"19ba5188-a943-482e-b230-5eec94b73101"},{"name":"get device","id":"a76ea52c-305d-49e8-b16f-c193bc1e4302","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/devices/:device","description":"

Gets the info of a device by its MAC Address.

DevicesRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesRead permission
404 Not Found	MAC Address not found
401 Unauthorized	Missing Bearer token

MAC address of the device to retrieve

\n","type":"text/plain"},"type":"string","value":"12345FGH2","key":"device"}]}},"response":[{"id":"e1973d96-43fb-48c0-b7c3-16479b27de43","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"00124B00197F3C76","type":"string","description":"MAC address of the device to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 10:07:14 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 269,\n \"physicalCode\": \"00124B00197F3C76\",\n \"installationDate\": \"2020-01-20T22:47:38\",\n \"x\": 109.11,\n \"y\": 58.0677,\n \"floor\": 30,\n \"registerDate\": null,\n \"unregisterDate\": \"2022-01-27T12:31:49.778\",\n \"type\": \"Gateway\"\n}"},{"id":"009c3f21-4f91-48bf-9bde-9d1c1b45e78f","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"ff:6a:ac:4a:f1:40","type":"string","description":"MAC address of the device to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:41 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"c74e58f7-886e-4e23-a999-5d404f46e0af","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"dc:96:5d:ae:06:c7","type":"string","description":"MAC address of the device to retrieve"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:10:12 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"bb26d408-731a-48d0-b375-246480319965","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"7b:7f:1f:33:34:e9","type":"string","description":"MAC address of the device to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 10:56:05 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Device not found\"\n}"}],"_postman_id":"a76ea52c-305d-49e8-b16f-c193bc1e4302"},{"name":"delete device","id":"dbf914a6-9fa9-4348-b663-10df6bad62c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{host}}/v2/devices/:device","description":"

Delete a device by its MAC Address.

DevicesWrite permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesWrite permission
401 Unauthorized	Missing Bearer token
404 Not Found	MAC Address Not Found in database

MAC address of the device to delete

\n","type":"text/plain"},"type":"string","value":"12345FGH2","key":"device"}]}},"response":[{"id":"6e5d0078-0fbd-4805-9d4f-68497e84ca46","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"7f:b0:69:6b:44:c2","type":"string","description":"MAC address of the device to delete"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 10:56:56 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"6fe68f9e-e400-421b-b80b-b675ee667dd7","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"1c:fc:69:ab:36:38","type":"string","description":"MAC address of the device to delete"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:49 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"84e7a9b9-eeee-4e86-84d4-9190393ac825","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"9d:12:49:38:a1:3c","type":"string","description":"MAC address of the device to delete"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:10:18 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"dbf914a6-9fa9-4348-b663-10df6bad62c8"},{"name":"create device","id":"d3faa526-d193-491b-8966-e4ba71e81581","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"physicalCode\": \"12345FGH2\",\n \"x\": 10.0,\n \"y\": 20.0,\n \"floor\": 1,\n \"type\": \"Node\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/devices","description":"

Creates a new device in the instance.

Requirements:

You need to have created a Floor previously (See \"create Floor\" from Habitat Core API).
DevicesWrite permission

Fields:

physicalCode: Required. String. MAC Address of the device to create.
x: Required. Float. Position in the X axis of the device (See Habitat Core API for more information about floor's plans and coordinates)
y: Required. Float. Position in the Y axis of the device (See Habitat Core API for more information about floor's plans and coordinates)
floor: Required. Int. Id of the floor where the device is installed in.
type: Required. String. Type of the device. Enumerated value (Node, Gateway)

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesWrite permission
401 Unauthorized	Missing Bearer token
400 Bad Request	Floor id not found in database, already a device with the provided MAC Address or invalid request parameters

","urlObject":{"path":["v2","devices"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8474b91a-25db-47e6-89b1-d6f41f8d280f","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"physicalCode\": \"00124B00197F3C76\",\n \"x\": 10.0,\n \"y\": 20.0,\n \"floor\": 30,\n \"type\": \"Gateway\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/devices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:05:18 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3917,\n \"physicalCode\": \"00124B00197F3C76\",\n \"installationDate\": \"2022-02-15T11:05:18.3\",\n \"x\": 10,\n \"y\": 20,\n \"floor\": 30,\n \"registerDate\": null,\n \"unregisterDate\": null,\n \"type\": \"Gateway\"\n}"},{"id":"9ff6cd23-0d11-45cf-9fd7-b9357aa805b9","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"physicalCode\": \"71:5f:d0:36:55:de\",\n \"x\": 10.3,\n \"y\": 20.0,\n \"floor\": 528,\n \"type\": \"Node\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/devices"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:38:55 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"7c79ef28-34e9-4a45-9cbe-c4387f6116db","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"physicalCode\": \"69:f9:d5:8c:18:10\",\n \"x\": 10.3,\n \"y\": 20.0,\n \"floor\": 783,\n \"type\": \"Gateway\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/devices"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:10:54 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"a3de2ae2-e9ab-4a98-9255-d2d69bb3a7fa","name":"400 Bad Request (duplicate physical code)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"physicalCode\": \"d4:2c:8d:d6:3d:68\",\n \"x\": 10.3,\n \"y\": 20.0,\n \"floor\": 742,\n \"type\": \"Node\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/devices"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:26:55 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d3faa526-d193-491b-8966-e4ba71e81581"},{"name":"modify device","id":"1e07ac2b-6eb0-4ce4-9c08-54a55fcd7933","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"x\": 100.0,\n \"y\": 200.0,\n \"floor\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/devices/:device","description":"

Modify data of an installed device.

DevicesWrite permission is required.

Currently you can modify the parameters

x
y
floor

being the type of device (Node, Gateway) and their MAC Address parameters that can't be modified.

The response could be one of:

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

200 OK
403 Forbidden	User without DevicesWrite permission
404 Not Found	Device MAC Address not found in database
400 Bad Request	Invalid parameters
401 Unauthorized	Missing Bearer token

MAC address of the device to modify

\n","type":"text/plain"},"type":"string","value":"12345FGH2","key":"device"}]}},"response":[{"id":"4eef470a-a3ec-48a6-9f08-9e6aa0955402","name":"Ok","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"y\": 58.0677,\n \"x\": 109.11,\n \"floor\": 30\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"00124B00197F3C76","type":"string","description":"MAC address of the device to modify"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:07:04 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3917,\n \"physicalCode\": \"00124B00197F3C76\",\n \"installationDate\": \"2022-02-15T11:05:18.3\",\n \"x\": 109.11,\n \"y\": 58.0677,\n \"floor\": 30,\n \"registerDate\": null,\n \"unregisterDate\": null,\n \"type\": \"Gateway\"\n}"},{"id":"0bf10df5-8f8e-4153-808b-c7d8c67b95ae","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"x\": 100.0,\n \"y\": 200.0,\n \"floor\": 606\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"33:cf:0b:68:dd:6c","type":"string","description":"MAC address of the device to modify"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:39:04 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"5fee9e2f-63c7-49b5-8c28-f4bab1f72587","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"y\": 58.0677,\n \"x\": 109.11,\n \"floor\": 540\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"b7:88:aa:ad:68:85","type":"string","description":"MAC address of the device to modify"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:11:04 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"f079e76c-5068-4929-b40d-bcda6f6bba79","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"y\": 58.0677,\n \"x\": 109.11,\n \"floor\": 258\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"be:ea:9b:29:1d:55","type":"string","description":"MAC address of the device to modify"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:11:29 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"f1c8bce3-22f6-4437-a0fe-26b9988ea462","name":"400 Bad Request","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"MACAddress\": \"62:a7:44:6a:36:25\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/devices/:device","host":["{{host}}"],"path":["v2","devices",":device"],"variable":[{"key":"device","value":"90:49:91:f7:24:75","type":"string","description":"MAC address of the device to modify"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:11:29 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1e07ac2b-6eb0-4ce4-9c08-54a55fcd7933"}],"id":"eaa6ae1c-b325-4773-ae36-361e216336d1","description":"

Requests for manadgement of devices

Listing
Modification
Creation
Deletion

Also, manages the associations between devices. Associations are the connection between devices. For example, a Node can have up to 4 different PIRs sensors connected to its ports.

\n","event":[{"listen":"prerequest","script":{"id":"16ccb6a4-fec6-4202-a8b6-2f2aeef5e76e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ced60016-69a7-4b17-bd81-b6483ba54516","type":"text/javascript","exec":[""]}}],"_postman_id":"eaa6ae1c-b325-4773-ae36-361e216336d1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"graphical areas","item":[{"name":"get graphical areas","id":"e903205a-86d5-41a0-99d7-16dc07a346f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/graphicalAreas","description":"

Returns information about all the graphical areas created on the esite module.

GraphicalAreasRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without GraphicalAreasRead permission
401 Unauthorized	Missing Bearer token

Filter by floor

\n","type":"text/plain"},"key":"floor","value":"1"}],"variable":[]}},"response":[{"id":"28cda2a3-f327-459f-b279-83a4f878679f","name":"Ok","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v2/graphicalAreas"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Aug 2021 11:42:48 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"2607"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 129,\n \"name\": \"R2NN P0 TA\",\n \"path\": \"43.599035356150125,-33.214555692284534 38.87816253518645,-40.809003273834804 10.826599396126891,-40.672166380473534 11.237110076210689,-31.16200229186554 20.952529504860582,-25.004342090608564 29.641672233300984,-25.209597430650465 39.90443923539594,-27.056895491027557\",\n \"floor\": 26,\n \"numSpaces\": 78\n },\n {\n \"id\": 130,\n \"name\": \"IT Local\",\n \"path\": \"30.599530486829845,-22.88337024350894 30.599530486829845,-17.273057615697027 43.12010426591008,-17.409894509058294 42.846430479187546,-22.67811490346704\",\n \"floor\": 26,\n \"numSpaces\": 18\n },\n {\n \"id\": 131,\n \"name\": \"Reprografía\",\n \"path\": \"43.66745183935514,-22.336022670063876 43.59903339267451,-16.999383828974498 49.14092757380578,-17.409894509058294 49.414601360528316,-22.814951796828307\",\n \"floor\": 26,\n \"numSpaces\": 4\n }\n]"},{"id":"9f241af5-7ee3-4067-86ae-8c0de2a14254","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v2/graphicalAreas"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:43:33 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"13fc651c-1c5e-4674-bdd6-191cbd5b809b","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v2/graphicalAreas"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:35:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"e903205a-86d5-41a0-99d7-16dc07a346f2"},{"name":"get graphical area","id":"79a16c04-8931-469e-9302-19816029b702","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/graphicalAreas/:graphicalArea","description":"

Returns a graphical area by its id.

GraphicalAreasRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without GraphicalAreasRead permission
404 Not Found	Graphical Area Id not found on database
401 Unauthorized	Missing Bearer token

Id of the graphical area to retrieve

\n","type":"text/plain"},"type":"string","value":"60","key":"graphicalArea"}]}},"response":[{"id":"cdb35536-0821-4ef1-ab0b-e6172143a126","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea"],"variable":[{"key":"graphicalArea","value":"60","type":"string","description":"Id of the graphical area to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:31:23 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 60,\n \"name\": \"IT Local\",\n \"path\": \"30.83912166770876,-26.23614143841061 30.460613483305416,-17.114094194289994 42.87568193173513,-17.227646649610996 43.32989175301914,-26.9931578072173\",\n \"floor\": 26,\n \"numSpaces\": 18\n}"},{"id":"5ae52f16-cc80-4e28-aaca-00e0ef237ff2","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea"],"variable":[{"key":"graphicalArea","value":"370","type":"string","description":"Id of the graphical area to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:43:55 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"ab9a05f6-6a53-4617-878e-28b2c15da247","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea"],"variable":[{"key":"graphicalArea","value":"83","type":"string","description":"Id of the graphical area to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:31:37 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Graphical area not found\"\n}"},{"id":"0fd99239-c550-4fb3-a262-862374c178a0","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea"],"variable":[{"key":"graphicalArea","value":"129","type":"string","description":"Id of the graphical area to retrieve"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:35:24 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"79a16c04-8931-469e-9302-19816029b702"},{"name":"create graphical area","id":"67113a63-718a-41c7-801b-ddde84618aa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-audit-functionality","value":"30","description":"

Identifier of the funcionality. CreateGraphicalArea

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"A1\",\n \"path\": \"0,0 100,0 100,100 0,100\",\n \"floor\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/graphicalAreas","description":"

Creates a new graphical area.

Requeriments:

You need to have created previously a Floor (See \"create Floor\" from Habitat Core API).
GraphicalAreasWrite permission.

Body fields:

name: Required. String. Name of the graphical area
path: Required. String. Path coordinates of the enclosed polygon of the graphical area. List of vertex coordinates on the X and Y axis, separated by commas. For example, in order to create a square of size 3 at the origin on coordiantes, the path could be: \"0,0 0,3 3,3 3, 0\", which is translated as: \"First vertex at X=0,Y=0. Second vertex at X=0,Y=3. Third vertex at X=3,Y=3. Fourth vetex at X=3,Y=0\"
floor: Required. Int. Id of the floor in which the graphical area is located

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 30 (CreateGraphicalArea)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
403 Forbidden	User without GraphicalAreasWrite permission
401 Unauthorized	Missing Bearer token
400 Bad Request	Invalid or missing required parameters

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}},"urlObject":{"path":["v2","graphicalAreas"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"edd6cd27-30d8-46a5-85fc-727003e8d398","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"A1\",\n \"path\": \"0,0 100,0 100,100 0,100\",\n \"floor\": 26\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/graphicalAreas"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:35:22 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 339,\n \"name\": \"A1\",\n \"path\": \"0,0 100,0 100,100 0,100\",\n \"floor\": 26,\n \"numSpaces\": 8\n}"},{"id":"86235685-2993-4597-a847-74bada60ca3e","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"A1\",\n \"path\": \"0,0 100,0 100,100 0,100\",\n \"floor\": 238\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/graphicalAreas"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:44:03 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"df503046-3950-4be4-8726-46dd4521f86b","name":"403 Forbidden","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"A1\",\n \"path\": \"0,0 100,0 100,100 0,100\",\n \"floor\": 659\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/graphicalAreas"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:41:40 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Floor not allowed for user\"\n}"},{"id":"0c798865-d85b-4da0-847a-ad83f066eb0c","name":"400 Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"a1\",\n \"path\": \"0,0 100,0 100,100 0,100\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/graphicalAreas"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:47:47 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"67113a63-718a-41c7-801b-ddde84618aa4"},{"name":"get spaces from graphical area","id":"d461ebcb-958b-4b6b-ae68-29e021f05b33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/graphicalAreas/:graphicalArea/spaces","description":"

Returns the spaces that lay inside the provided graphical area.

GraphicalAreasRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without GraphicalAreasRead permission
404 Not Found	Graphical Area Id not found on database
401 Unauthorized	Missing Bearer token

Id of the graphical area to retrieve spaces from

\n","type":"text/plain"},"type":"string","value":"129","key":"graphicalArea"}]}},"response":[{"id":"b2c30313-4ac1-4596-a511-8dd36fe4dc51","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea/spaces","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea","spaces"],"variable":[{"key":"graphicalArea","value":"698","type":"string","description":"Id of the graphical area to retrieve spaces from"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Aug 2021 11:43:45 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"18159"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 3568,\n \"code\": \"MN0AAg001\",\n \"type\": 23,\n \"description\": \"Mesa ágil 200x140a80x105h cm\",\n \"entryDate\": \"2019-10-09T10:58:00\",\n \"x\": 12.4091,\n \"y\": 32.2797,\n \"floor\": 26,\n \"availabilityType\": \"Available\",\n \"availabilityDate\": \"2021-08-25T08:10:21.129\"\n },\n {\n \"id\": 3570,\n \"code\": \"MN0AS002\",\n \"type\": 31,\n \"description\": \"Mesa sala 140x140 electrificación lateral\",\n \"entryDate\": \"2019-10-09T10:58:01\",\n \"x\": 20.6597,\n \"y\": 39.8302,\n \"floor\": 26,\n \"availabilityType\": \"Absent\",\n \"availabilityDate\": \"2021-08-25T11:21:52.652\"\n },\n {\n \"id\": 3571,\n \"code\": \"MN0AS003\",\n \"type\": 31,\n \"description\": \"Mesa sala 140x140 electrificación lateral\",\n \"entryDate\": \"2019-10-09T10:58:01\",\n \"x\": 17.4203,\n \"y\": 39.8796,\n \"floor\": 26,\n \"availabilityType\": \"Absent\",\n \"availabilityDate\": \"2021-08-25T11:21:57.481\"\n },\n {\n \"id\": 3572,\n \"code\": \"MN0AS004\",\n \"type\": 31,\n \"description\": \"Mesa sala 140x140 electrificación lateral\",\n \"entryDate\": \"2019-10-09T10:58:01\",\n \"x\": 12.7666,\n \"y\": 38.1965,\n \"floor\": 26,\n \"availabilityType\": \"Available\",\n \"availabilityDate\": \"2021-08-25T10:47:40.149\"\n },\n {\n \"id\": 3573,\n \"code\": \"MN0AS005\",\n \"type\": 31,\n \"description\": \"Mesa sala 140x140 electrificación lateral\",\n \"entryDate\": \"2019-10-09T10:58:01\",\n \"x\": 12.7172,\n \"y\": 34.9571,\n \"floor\": 26,\n \"availabilityType\": \"Absent\",\n \"availabilityDate\": \"2021-08-25T11:18:43.945\"\n }\n]"},{"id":"c78a1afe-5dcd-4a92-b8c9-e13f3209f551","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea/spaces","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea","spaces"],"variable":[{"key":"graphicalArea","value":"343","type":"string","description":"Id of the graphical area to retrieve spaces from"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:44:11 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"e8c55d9d-a576-46f8-bba9-697837b2f818","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea/spaces","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea","spaces"],"variable":[{"key":"graphicalArea","value":"283","type":"string","description":"Id of the graphical area to retrieve spaces from"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:46:14 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"e780e055-e18f-4e00-a032-c47f89a29936","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea/spaces","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea","spaces"],"variable":[{"key":"graphicalArea","value":"876","type":"string","description":"Id of the graphical area to retrieve spaces from"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:35:41 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"d461ebcb-958b-4b6b-ae68-29e021f05b33"},{"name":"delete graphical area","id":"591105c8-5be2-4213-95ef-12e285c6414f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-audit-functionality","value":"32","description":"

Identifier of the funcionality. DeleteGraphicalArea

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"url":"{{host}}/v2/graphicalAreas/:graphicalArea","description":"

Deletes a graphical area by its id.

GraphicalAreasWrite permission is required.

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 32 (DeleteGraphicalArea)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
403 Forbidden	User without GraphicalAreasWrite permission
401 Unauthorized	Missing Bearer token
404 Not Found	Graphical Area Id Not Found in database

Id of the graphical area to be deleted

\n","type":"text/plain"},"type":"string","value":"60","key":"graphicalArea"}]}},"response":[{"id":"8b71ad9a-879a-41d4-9761-1c9af902e13b","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea"],"variable":[{"key":"graphicalArea","value":"127","type":"string","description":"Id of the graphical area to be deleted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:41:26 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"c58b1bfc-6004-4785-8d3d-6a70f62747e7","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea"],"variable":[{"key":"graphicalArea","value":"199","type":"string","description":"Id of the graphical area to be deleted"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:44:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"582ac80a-b92f-4786-b6f7-18a671991bb5","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea"],"variable":[{"key":"graphicalArea","value":"176","type":"string","description":"Id of the graphical area to be deleted"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 11:50:45 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"889fe014-3320-4057-981d-f8463d7937e3","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalArea","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalArea"],"variable":[{"key":"graphicalArea","value":"838","type":"string","description":"Id of the graphical area to be deleted"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:35:49 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"591105c8-5be2-4213-95ef-12e285c6414f"},{"name":"modify graphical area","id":"0a130103-3581-48c1-937a-6be53727bd2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-audit-functionality","value":"31","description":"

Identifier of the funcionality. ModifyGraphicalArea

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"NewName\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/graphicalAreas/:graphicalAreaId","description":"

Modifies a graphical area.

GraphicalAreasWrite permission is required.

Only the graphical area's name can be modified

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 31 (ModifyGraphicalArea)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
403 Forbidden	User without GraphicalAreasWrite permission
404 Not Found	Graphical Area Id not found in database
400 Bad Request	Invalid or missing parameters
401 Unauthorized	Missing Bearer token

Id of the graphical area to modify

\n","type":"text/plain"},"type":"string","value":"1","key":"graphicalAreaId"}]}},"response":[{"id":"ef54745f-c246-43e8-b70c-683ab98b4d7e","name":"Ok","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"NewName\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalAreaId","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalAreaId"],"variable":[{"key":"graphicalAreaId","value":"849","type":"string","description":"Id of the graphical area to modify"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:37:02 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"7a96be45-c750-424b-a64c-0d0df8fcc7eb","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"NewName\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalAreaId","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalAreaId"],"variable":[{"key":"graphicalAreaId","value":"825","type":"string","description":"Id of the graphical area to modify"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:44:24 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"08d8e77b-1710-4a97-a582-5bf675456b91","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"NewName\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalAreaId","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalAreaId"],"variable":[{"key":"graphicalAreaId","value":"962","type":"string","description":"Id of the graphical area to modify"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:35:59 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"514cede5-3929-4e1f-b034-a6909864ed07","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"NewName\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/graphicalAreas/:graphicalAreaId","host":["{{host}}"],"path":["v2","graphicalAreas",":graphicalAreaId"],"variable":[{"key":"graphicalAreaId","value":"272","type":"string","description":"Id of the graphical area to modify"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:37:22 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0a130103-3581-48c1-937a-6be53727bd2a"}],"id":"07328022-32a7-4171-9d4d-8f8525858417","description":"

Requests related to graphical areas, enclosed areas that help to cluster spaces from the same floor.

This section provides REST endpoints to list, create, modify and delete this areas.

\n","event":[{"listen":"prerequest","script":{"id":"cc43aae4-411c-47f2-a249-9bc93941c3ed","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dc8cb832-e83a-4970-acbd-e40578bd09f4","type":"text/javascript","exec":[""]}}],"_postman_id":"07328022-32a7-4171-9d4d-8f8525858417","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"historic","item":[{"name":"get availabity status of spaces grouped by day","id":"467bdcfb-1dba-4991-aa5a-ca2b7a06bfbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"startDay\": \"2020-09-01\",\n \"endDay\": \"2020-09-07\",\n \"spaces\": [5001, 5002],\n \"timeout\": 10000\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/historic/availabilityStatusOfSpacesGroupedByDay","description":"

Gets the duration in each availability type (Available, NoSensor, Unavailable...) of a list of spaces in a range of days.

HistoricRead permission is required.

In the body you must indicate:

startDay: Required. String. The start date of the search range, in format \"yyyy-MM-dd\"
endDay: Required. String. The end date of the search range, in format \"yyyy-MM-dd\" (inclusive)
spaces: Required. Array of Int. An array of spaces ids for which recover historical data about occupancy.
timeout: Option. Int. An optional timeout of the operation in milliseconds. The default value is 10000ms

The response could be one of:

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

200 OK
403 Forbidden	User without HistoricRead permission
400 Bad Request	Request has timed out or invalid parameters
401 Unauthorized	Missing Bearer token

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}},"urlObject":{"path":["v2","historic","availabilityStatusOfSpacesGroupedByDay"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"51f540c2-d6b0-41a9-ac96-b1eadc99d95f","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"startDay\": \"2020-09-01\",\n \"endDay\": \"2020-09-07\",\n \"spaces\": [5001, 5002],\n \"timeout\": 10000\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/historic/availabilityStatusOfSpacesGroupedByDay"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Nov 2020 07:48:12 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"710"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":"{\n \"5001\": {\n \"2020-09-07\": {\n \"Available\": 86400000\n },\n \"2020-09-06\": {\n \"Available\": 86400000\n },\n \"2020-09-05\": {\n \"Available\": 86400000\n },\n \"2020-09-04\": {\n \"Available\": 86389330,\n \"NoSensor\": 10670\n },\n \"2020-09-03\": {\n \"Available\": 86400000\n },\n \"2020-09-02\": {\n \"Available\": 70137050,\n \"NoSensor\": 16262950\n },\n \"2020-09-01\": {\n \"Available\": 56308131,\n \"NoSensor\": 30091869\n }\n },\n \"5002\": {\n \"2020-09-07\": {\n \"Available\": 86118720,\n \"NoSensor\": 281280\n },\n \"2020-09-06\": {\n \"Available\": 85322356,\n \"NoSensor\": 1077644\n },\n \"2020-09-05\": {\n \"Available\": 86038333,\n \"NoSensor\": 361667\n },\n \"2020-09-04\": {\n \"Available\": 76277291,\n \"NoSensor\": 10122709\n },\n \"2020-09-03\": {\n \"Available\": 86393919,\n \"NoSensor\": 6081\n },\n \"2020-09-02\": {\n \"Available\": 75822430,\n \"NoSensor\": 10577570\n },\n \"2020-09-01\": {\n \"Available\": 77864736,\n \"NoSensor\": 8535264\n }\n }\n}"},{"id":"b2d14464-f48c-4fcc-9250-07e2e5a63039","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"startDay\": \"2020-09-01\",\n \"endDay\": \"2020-09-07\",\n \"spaces\": [5001, 5002]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/historic/availabilityStatusOfSpacesGroupedByDay"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:44:42 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"c7c064ac-d168-45fe-b8ef-390ea06b9fb9","name":"403 Forbidden","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"startDay\": \"2020-09-01\",\n \"endDay\": \"2020-09-07\",\n \"spaces\": [5001, 5002]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/historic/availabilityStatusOfSpacesGroupedByDay"},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:44:42 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"dfcd8ec8-01f7-491f-93ff-0916003e8e2a","name":"400 Bad Request (timed out)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"startDay\": \"2020-09-01\",\n \"endDay\": \"2020-09-07\",\n \"spaces\": [5001, 5002],\n \"timeout\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/historic/availabilityStatusOfSpacesGroupedByDay"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Mar 2022 10:52:15 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Timed out waiting for 2 ms\"\n}"},{"id":"fc312bbf-7914-4469-96d9-e9d55d2b7bb5","name":"400 Bad Request (invalid parameters)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"startDay\": \"2020-09-01\",\n \"endDay\": \"2020-09-07\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/historic/availabilityStatusOfSpacesGroupedByDay"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Mar 2022 10:52:15 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"467bdcfb-1dba-4991-aa5a-ca2b7a06bfbd"}],"id":"a18b29c6-5104-416e-be32-8e8251c8b92d","description":"

Request related with historical data, information stored in database about previous changes in occupation collected by sensors.

This information is useful to analize occupancy results over a period of time.

\n","_postman_id":"a18b29c6-5104-416e-be32-8e8251c8b92d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"resources","item":[{"name":"get resources","id":"02fdb0ee-8c53-450d-86ca-a0b59fad4049","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/resources","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}},"urlObject":{"path":["v2","resources"],"host":["{{host}}"],"query":[{"disabled":true,"key":"resourceTypes","value":null},{"disabled":true,"key":"resourceTypeCodes","value":null},{"disabled":true,"key":"format","value":null}],"variable":[]}},"response":[],"_postman_id":"02fdb0ee-8c53-450d-86ca-a0b59fad4049"}],"id":"a2d2e8ee-ed87-4193-8422-86b6d7a5b280","_postman_id":"a2d2e8ee-ed87-4193-8422-86b6d7a5b280","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"space types","item":[{"name":"get space types","id":"0436ed1b-4ec5-474a-b534-d8c858428655","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/spaceTypes","description":"

Gets all the spaces types created on Habität instance.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token

Get an space type by its id

The response could be one of:

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

200 OK
404 Not Found	Space Type Id not found on database
401 Unauthorized	Missing Bearer token

Id of the space type to retrieve

\n","type":"text/plain"},"type":"string","value":"1","key":"spaceType"}]}},"response":[{"id":"200c6069-4753-49a4-a291-1e66258a499b","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaceTypes/:spaceType","host":["{{host}}"],"path":["v2","spaceTypes",":spaceType"],"variable":[{"key":"spaceType","value":"22","type":"string","description":"Id of the space type to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 Jul 2021 06:35:57 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Origin"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 22,\n \"code\": \"A\",\n \"name\": \"Alcoba\",\n \"sensorNumber\": 1,\n \"useType\": \"Desk\"\n}"},{"id":"837808db-8cf0-47a6-91e2-2b06873f8570","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaceTypes/:spaceType","host":["{{host}}"],"path":["v2","spaceTypes",":spaceType"],"variable":[{"key":"spaceType","value":"910","type":"string","description":"Id of the space type to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:43:40 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"0d087e6e-7f46-4988-be34-037bc2f0c2e8","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaceTypes/:spaceType","host":["{{host}}"],"path":["v2","spaceTypes",":spaceType"],"variable":[{"key":"spaceType","value":"24","type":"string","description":"Id of the space type to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 15:17:50 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Space type 24 not found\"\n}"}],"_postman_id":"3fc3f956-25c2-4a6f-aa1a-e2c43f508f1d"},{"name":"create space type","id":"63d2f418-afe2-4baf-bc04-556960a139e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": \"ST2\",\n \"name\": \"ST2\",\n \"sensorNumber\": 1,\n \"useType\": \"Desk\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/spaceTypes","description":"

Creates a new space type.

code must be unique.

Fields:

code: Required. String code of the space type
name: Required. String. Name of the space type
sensorNumber: Required. Int. Number of sensors of this space type
useType: Required. String. Use type (purpose) of the space type. Enumerated value (Room, Desk, Parking)

The response could be one of:

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

200 OK
400 Bad Request	Invalid parameters or duplicate code
401 Unauthorized	Missing Bearer token

Modify an existent Space Type.

The id of the space type to be modified must be referenced in the body. It is important to note that all body properties are required, even if you want to modify only one of the resource properties.

Body fields:

id: Required. Int. Space type Id to be modified
code: Required. String code of the space type
name: Required. String. Name of the space type
sensorNumber: Required. Int. Number of sensors of this space type
useType: Required. String. Use type (purpose) of the space type. Enumerated value (Room, Desk, Parking)

The response could be one of:

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

200 OK
400 Bad Request	Invalid parameters or missing required parameters
404 Not Found	Space Type Id not found on database
401 Unauthorized	Missing Bearer token

Deletes an space type by its id

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
404 Not Found	Space Type Id Not Found in database

Id of the space type to be deleted

\n","type":"text/plain"},"type":"string","value":"1","key":"spaceType"}]}},"response":[{"id":"45608ec8-f771-4a9d-aeeb-90e1f2f0928b","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaceTypes/:spaceType","host":["{{host}}"],"path":["v2","spaceTypes",":spaceType"],"variable":[{"key":"spaceType","value":"259","type":"string","description":"Id of the space type to be deleted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 15:30:08 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"df8e0421-37cb-411a-9e4f-93ef426b669b","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaceTypes/:spaceType","host":["{{host}}"],"path":["v2","spaceTypes",":spaceType"],"variable":[{"key":"spaceType","value":"672","type":"string","description":"Id of the space type to be deleted"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:44:05 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"ebf92e54-3d21-4a8b-97d4-35200c3aa9ed","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaceTypes/:spaceType","host":["{{host}}"],"path":["v2","spaceTypes",":spaceType"],"variable":[{"key":"spaceType","value":"661","type":"string","description":"Id of the space type to be deleted"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 15:30:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d3423866-7946-4c8e-aabf-50e7756ded99"}],"id":"a13d2a58-62aa-4da4-a729-7254681a13e0","description":"

Requests related to space types management

A space type is used to group spaces with the same functionality or purpose. For example, an individual room, or a conference room. Each space type can have a different number of sensors to monitorize its occupancy.

\n","event":[{"listen":"prerequest","script":{"id":"f2b5808a-17f4-48f1-a57e-0eae9485ce88","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0b8b8b4b-1e14-4cd4-841d-36ae026111ae","type":"text/javascript","exec":[""]}}],"_postman_id":"a13d2a58-62aa-4da4-a729-7254681a13e0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"spaces","item":[{"name":"associations","item":[{"name":"get associations from space","id":"7e5b2abd-cfe4-42e9-8824-4c2fb351f863","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/spaces/:space/associations","description":"

Get the devices associated to the space referenced by its Id.

SpacesRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesRead permission
404 Not Found	Space Id not found on database
401 Unauthorized	Missing Bearer token

Id of the space for which retrieve associations

\n","type":"text/plain"},"type":"any","value":"1","key":"space"}]}},"response":[{"id":"cd642de5-8ab5-441d-9821-cecc42c75a42","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/associations","host":["{{host}}"],"path":["v2","spaces",":space","associations"],"variable":[{"key":"space","value":"6949","description":"Id of the space for which retrieve associations"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 12:05:32 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"device\": \"c1:ce:26:5a:cb:0d\",\n \"port\": 2,\n \"space\": 6949,\n \"sensorType\": \"Dali\",\n \"sensorCoverType\": null,\n \"sensorDelay\": 60\n }\n]"},{"id":"ee5866c4-0857-4f03-ae37-994081cc26eb","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/associations","host":["{{host}}"],"path":["v2","spaces",":space","associations"],"variable":[{"key":"space","value":"614","description":"Id of the space for which retrieve associations"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:45:33 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"6311ff8f-286c-451d-adde-ae33cfadccc2","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/associations","host":["{{host}}"],"path":["v2","spaces",":space","associations"],"variable":[{"key":"space","value":"144","description":"Id of the space for which retrieve associations"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 12:05:53 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"6c49bfaa-f769-49b2-a296-cef505089ad4","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/associations","host":["{{host}}"],"path":["v2","spaces",":space","associations"],"variable":[{"key":"space","value":"248","description":"Id of the space for which retrieve associations"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:33:24 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"7e5b2abd-cfe4-42e9-8824-4c2fb351f863"}],"id":"99a2dec2-9ea3-455d-9fd3-1f7fa80eba36","description":"

Requests that manage the associations between spaces and physical devices, like PIR sensors.

\n","_postman_id":"99a2dec2-9ea3-455d-9fd3-1f7fa80eba36","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"subsections","item":[{"name":"get subsections from space","id":"ccdbe2a0-2c98-43b0-add5-45b6bf12d1f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/spaces/:space/subsections","description":"

Returns the subsections of an space.

SpacesRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesRead permission
404 Not Found	Space Id not found on database
401 Unauthorized	Missing Bearer token

Id of the space for which retrieve subsections

\n","type":"text/plain"},"type":"string","value":"1","key":"space"}]}},"response":[{"id":"feb41f4f-5c86-4fdf-9b90-57e36c700f54","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections","host":["{{host}}"],"path":["v2","spaces",":space","subsections"],"variable":[{"key":"space","value":"348","type":"string","description":"Id of the space for which retrieve subsections"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"keep-alive"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 4,\n \"name\": \"AB\",\n \"type\": 2\n },\n {\n \"id\": 5,\n \"name\": \"Barajas\",\n \"type\": 3\n }\n]"},{"id":"a62a8256-7916-44a8-98f7-0fae26279477","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections","host":["{{host}}"],"path":["v2","spaces",":space","subsections"],"variable":[{"key":"space","value":"624","type":"string","description":"Id of the space for which retrieve subsections"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:45:43 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"f456ff3b-8da9-4925-8f21-cd7ca1d0be95","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections","host":["{{host}}"],"path":["v2","spaces",":space","subsections"],"variable":[{"key":"space","value":"654","type":"string","description":"Id of the space for which retrieve subsections"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 12:09:28 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"1d32aaea-68b4-42ac-acf0-005a20f26427","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections","host":["{{host}}"],"path":["v2","spaces",":space","subsections"],"variable":[{"key":"space","value":"154","type":"string","description":"Id of the space for which retrieve subsections"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:33:35 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"ccdbe2a0-2c98-43b0-add5-45b6bf12d1f4"},{"name":"add subsection to space","id":"cc6a7064-f665-4626-a994-6c80ae406b55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-audit-functionality","value":"17","description":"

Identifier of the funcionality. AddInvidivualSubsectionToSpace

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"url":"{{host}}/v2/spaces/:space/subsections/:subsection","description":"

Adds the space to a given subsection. If the space was previously linked to a subsection with the same subsection type, that link will be overwritten.

SpacesWrite permission is required.

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 17 (AddIndividualSubsectionToSpace)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesRead permission
404 Not Found	Space Id or Subsection Id not found on database
401 Unauthorized	Missing Bearer token
409 Conflict	The subsection with maxFloors 1 is already in another floor

Id of the space to link with the subsection

\n","type":"text/plain"},"type":"string","value":"3465","key":"space"},{"description":{"content":"

Id of the subsection to link the space with

\n","type":"text/plain"},"type":"string","value":"51","key":"subsection"}]}},"response":[{"id":"e21e7072-a9ba-4353-8a75-06e143654380","name":"Ok","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections/:subsection","host":["{{host}}"],"path":["v2","spaces",":space","subsections",":subsection"],"variable":[{"key":"space","value":"718","type":"string","description":"Id of the space to link with the subsection"},{"key":"subsection","value":"99","type":"string","description":"Id of the subsection to link the space with"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 12:16:21 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"5664336f-95fe-405e-a8cd-72f7cdec7e2a","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections/:subsection","host":["{{host}}"],"path":["v2","spaces",":space","subsections",":subsection"],"variable":[{"key":"space","value":"700","type":"string","description":"Id of the space to link with the subsection"},{"key":"subsection","value":"811","type":"string","description":"Id of the subsection to link the space with"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:46:10 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"74832848-8e54-4290-a127-16640947f9db","name":"404 Not Found","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections/:subsection","host":["{{host}}"],"path":["v2","spaces",":space","subsections",":subsection"],"variable":[{"key":"space","value":"181","type":"string","description":"Id of the space to link with the subsection"},{"key":"subsection","value":"385","type":"string","description":"Id of the subsection to link the space with"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 12:27:09 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"a4e6ad1b-122b-4db2-ab53-d028d9be6bd7","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections/:subsection","host":["{{host}}"],"path":["v2","spaces",":space","subsections",":subsection"],"variable":[{"key":"space","value":"662","type":"string","description":"Id of the space to link with the subsection"},{"key":"subsection","value":"801","type":"string","description":"Id of the subsection to link the space with"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:33:43 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"5c90b95b-4896-45a3-8f65-5bd6223cbeac","name":"409 Conflict","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections/:subsection","host":["{{host}}"],"path":["v2","spaces",":space","subsections",":subsection"],"variable":[{"key":"space","value":"6008","type":"string","description":"Id of the space to link with the subsection"},{"key":"subsection","value":"1216","type":"string","description":"Id of the subsection to link the space with"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 31 May 2022 06:53:29 GMT"},{"key":"Server","value":"esite-api/2.2.1"},{"key":"X-Implementation-Version","value":"2.2.1"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"The subsection with type 1 is already in another floor\"\n}"}],"_postman_id":"cc6a7064-f665-4626-a994-6c80ae406b55"},{"name":"remove all subsections","id":"32c70cf8-fe7b-4051-a45b-81521b893176","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{host}}/v2/spaces/:space/subsections","description":"

Remove all subsections of the provided space.

SpacesWrite permission is required.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
403 Forbidden	User without SpacesWrite permission
404 Not Found	Space Id Not Found in database

Id of the space for which remove subsections

\n","type":"text/plain"},"type":"string","value":"1","key":"space"}]}},"response":[{"id":"46dd5eb4-f756-4f31-8dbd-2016cbab4d46","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections","host":["{{host}}"],"path":["v2","spaces",":space","subsections"],"variable":[{"key":"space","value":"87","type":"string","description":"Id of the space for which remove subsections"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 12:27:29 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"300490bc-9486-4c23-965a-d7873604f525","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections","host":["{{host}}"],"path":["v2","spaces",":space","subsections"],"variable":[{"key":"space","value":"866","type":"string","description":"Id of the space for which remove subsections"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:46:36 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"70e69cd5-8a03-43b3-8b0d-ba7d474d7492","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections","host":["{{host}}"],"path":["v2","spaces",":space","subsections"],"variable":[{"key":"space","value":"600","type":"string","description":"Id of the space for which remove subsections"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 12:35:56 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"f53e6b5b-e7d2-4371-8498-6d880d48a89b","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections","host":["{{host}}"],"path":["v2","spaces",":space","subsections"],"variable":[{"key":"space","value":"715","type":"string","description":"Id of the space for which remove subsections"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:33:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"32c70cf8-fe7b-4051-a45b-81521b893176"},{"name":"remove subsection","id":"6b2f56f0-2118-4448-b06c-55b5e677d885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-audit-functionality","value":"19","description":"

Identifier of the funcionality. DeleteIndividualSubsectionFromSpace

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"url":"{{host}}/v2/spaces/:space/subsections/:subsection","description":"

Removes a subsection of the provided space.

SpacesWrite permission is required.

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 19 (DeleteIndividualSubsectionFromSpace)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
403 Forbidden	User without SpacesWrite permission
404 Not Found	Space Id/Subsection Id Not Found in database or provided space does not belongs to the subsection

Id of the space for which remove subsection

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

Id of the subsection to be removed from space

\n","type":"text/plain"},"type":"string","value":"2","key":"subsection"}]}},"response":[{"id":"63587c7b-3a8d-4165-88ae-e304af1d2010","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections/:subsection","host":["{{host}}"],"path":["v2","spaces",":space","subsections",":subsection"],"variable":[{"key":"space","value":"685","type":"string","description":"Id of the space for which remove subsection"},{"key":"subsection","value":"415","type":"string","description":"Id of the subsection to be removed from space"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 12:35:31 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"8356978c-9ab1-418f-ab86-18b2b517ff32","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections/:subsection","host":["{{host}}"],"path":["v2","spaces",":space","subsections",":subsection"],"variable":[{"key":"space","value":"548","type":"string","description":"Id of the space for which remove subsection"},{"key":"subsection","value":"364","type":"string","description":"Id of the subsection to be removed from space"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:46:44 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"11fd585a-cc65-4331-b1c5-8426f8e894db","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections/:subsection","host":["{{host}}"],"path":["v2","spaces",":space","subsections",":subsection"],"variable":[{"key":"space","value":"648","type":"string","description":"Id of the space for which remove subsection"},{"key":"subsection","value":"873","type":"string","description":"Id of the subsection to be removed from space"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 12:35:44 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"96062687-ae49-4bfd-888c-9b1e4efcdc02","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/subsections/:subsection","host":["{{host}}"],"path":["v2","spaces",":space","subsections",":subsection"],"variable":[{"key":"space","value":"565","type":"string","description":"Id of the space for which remove subsection"},{"key":"subsection","value":"959","type":"string","description":"Id of the subsection to be removed from space"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:33:58 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"6b2f56f0-2118-4448-b06c-55b5e677d885"}],"id":"92e6786a-e4ac-4789-ad26-c063491cd31c","description":"

Requests related to subsections of spaces.

A subsection is a reference for clustering spaces, similar to graphical areas. Unlike Graphical Areas, subsections does not have a representation on the floor's plan, meaning that sites or rooms from different floors or opposite sides of the same floor can have the same subsection.

An example of subsection coud be \"Tower A\", meaning \"all sites on the west side of the building, indepently on their floor\", for example.

\n","_postman_id":"92e6786a-e4ac-4789-ad26-c063491cd31c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"tags","item":[{"name":"get tags from space","id":"fe0fd7bb-e16c-4bcc-bf15-14016fd7487c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/spaces/:space/tags","description":"

Gets the list of tags associated with this space.

SpacesRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesRead permission
404 Not Found	Space Id not found on database
401 Unauthorized	Missing Bearer token

Id of the space for which retrieve tags

\n","type":"text/plain"},"type":"any","value":"1","key":"space"}]}},"response":[{"id":"1268e210-c5fe-45a6-9e8c-5a87af5bac10","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags","host":["{{host}}"],"path":["v2","spaces",":space","tags"],"variable":[{"key":"space","value":"363","description":"Id of the space for which retrieve tags"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"keep-alive"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 5,\n \"name\": \"Projector\",\n \"type\": 5\n },\n {\n \"id\": 7,\n \"name\": \"Coffee machine\",\n \"type\": 4\n },\n {\n \"id\": 14,\n \"name\": \"Wheelchair accesible\",\n \"type\": 7\n }\n]"},{"id":"6b6c225b-1052-45d0-9ab1-12563b629c76","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags","host":["{{host}}"],"path":["v2","spaces",":space","tags"],"variable":[{"key":"space","value":"579","description":"Id of the space for which retrieve tags"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:47:16 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"d5a619fd-ad3d-4f60-888e-55d856a8ab30","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags","host":["{{host}}"],"path":["v2","spaces",":space","tags"],"variable":[{"key":"space","value":"877","description":"Id of the space for which retrieve tags"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:25:45 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"a303b539-6239-4a9d-9290-7153541e7a43","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags","host":["{{host}}"],"path":["v2","spaces",":space","tags"],"variable":[{"key":"space","value":"848","description":"Id of the space for which retrieve tags"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:32:35 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"fe0fd7bb-e16c-4bcc-bf15-14016fd7487c"},{"name":"add tag to space","id":"87bd71d0-01bc-4dd6-a7b5-a4db50b48b06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{host}}/v2/spaces/:space/tags/:tag","description":"

Adds a new tag to this space.

SpacesWrite permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesWrite permission
404 Not Found	Space Id or Tag Id not found on database
401 Unauthorized	Missing Bearer token

Id of the space for which the tag is added

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

Id of the tag to be added

\n","type":"text/plain"},"type":"any","value":"14","key":"tag"}]}},"response":[{"id":"f8d655e0-0046-4946-a533-97a65d105f10","name":"Ok","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags/:tag","host":["{{host}}"],"path":["v2","spaces",":space","tags",":tag"],"variable":[{"key":"space","value":"830","description":"Id of the space for which the tag is added"},{"key":"tag","value":"351","description":"Id of the tag to be added"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:21:32 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"94b79eb8-1efc-46e3-be1c-9c94ff1a4fcf","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags/:tag","host":["{{host}}"],"path":["v2","spaces",":space","tags",":tag"],"variable":[{"key":"space","value":"121","description":"Id of the space for which the tag is added"},{"key":"tag","value":"298","description":"Id of the tag to be added"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:50:40 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"7f71ffce-8ffd-4924-bf6f-0b1f42c1ea48","name":"404 Not Found","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags/:tag","host":["{{host}}"],"path":["v2","spaces",":space","tags",":tag"],"variable":[{"key":"space","value":"667","description":"Id of the space for which the tag is added"},{"key":"tag","value":"494","description":"Id of the tag to be added"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:23:45 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Tag not found\"\n}"},{"id":"2c325445-7f66-41c0-a21f-3a11575bba4c","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"PUT","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags/:tag","host":["{{host}}"],"path":["v2","spaces",":space","tags",":tag"],"variable":[{"key":"space","value":"622","description":"Id of the space for which the tag is added"},{"key":"tag","value":"525","description":"Id of the tag to be added"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:31:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to write\"\n}"}],"_postman_id":"87bd71d0-01bc-4dd6-a7b5-a4db50b48b06"},{"name":"remove tag from space","id":"df8bc275-6904-4997-bb41-76c6595a0ad2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{host}}/v2/spaces/:space/tags/:tag","description":"

Removes a tag from an space.

SpacesWrite permission is required.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
403 Forbidden	User without SpacesWrite permission
404 Not Found	Space Id/Tag Id Not Found in database or provided tag is not attached to the space

Id of the space for which remove tag

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

Id of the tag to be removed

\n","type":"text/plain"},"type":"any","value":"1","key":"tag"}]}},"response":[{"id":"53f575b8-da7f-4533-8538-32a63a323281","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags/:tag","host":["{{host}}"],"path":["v2","spaces",":space","tags",":tag"],"variable":[{"key":"space","value":"832","description":"Id of the space for which remove tag"},{"key":"tag","value":"473","description":"Id of the tag to be removed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:27:13 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"f395a025-be75-4f80-b7e5-0bc18645ae5a","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags/:tag","host":["{{host}}"],"path":["v2","spaces",":space","tags",":tag"],"variable":[{"key":"space","value":"952","description":"Id of the space for which remove tag"},{"key":"tag","value":"258","description":"Id of the tag to be removed"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:50:51 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"e72d050b-5814-44d5-81fe-1af6c61cc602","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags/:tag","host":["{{host}}"],"path":["v2","spaces",":space","tags",":tag"],"variable":[{"key":"space","value":"399","description":"Id of the space for which remove tag"},{"key":"tag","value":"605","description":"Id of the tag to be removed"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:26:56 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"2f54a7ee-04a4-4584-8944-5e1aad63034b","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags/:tag","host":["{{host}}"],"path":["v2","spaces",":space","tags",":tag"],"variable":[{"key":"space","value":"125","description":"Id of the space for which remove tag"},{"key":"tag","value":"414","description":"Id of the tag to be removed"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:33:03 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"df8bc275-6904-4997-bb41-76c6595a0ad2"},{"name":"remove all tags from space","id":"3788726f-c5d3-4c5d-9b87-1a7d70591903","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{host}}/v2/spaces/:space/tags","description":"

Removes all tags from space.

SpacesWrite permission is required.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
403 Forbidden	User without SpacesWrite permission
404 Not Found	Space Id Not Found in database

Id of the space from which remove all tags

\n","type":"text/plain"},"type":"any","value":"1","key":"space"}]}},"response":[{"id":"9bfb886d-bed0-4717-87cc-2d45494b5808","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags","host":["{{host}}"],"path":["v2","spaces",":space","tags"],"variable":[{"key":"space","value":"650","description":"Id of the space from which remove all tags"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:28:26 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"9cb0916c-ebad-4e58-85b5-a270a1fbd2e0","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags","host":["{{host}}"],"path":["v2","spaces",":space","tags"],"variable":[{"key":"space","value":"751","description":"Id of the space from which remove all tags"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:51:04 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"079b4347-b2da-44b7-9934-7990c4674470","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags","host":["{{host}}"],"path":["v2","spaces",":space","tags"],"variable":[{"key":"space","value":"875","description":"Id of the space from which remove all tags"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:30:32 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"50a34668-440e-43ae-a3c5-7e88ac8a21b0","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/tags","host":["{{host}}"],"path":["v2","spaces",":space","tags"],"variable":[{"key":"space","value":"283","description":"Id of the space from which remove all tags"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:33:10 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"3788726f-c5d3-4c5d-9b87-1a7d70591903"}],"id":"e2a96d64-b638-48da-9777-3af701c36fbf","description":"

Requests related to tags of a space.

Tags are customizable labels that API users can add to spaces.

You can list, add and remove tags from any space.

\n","_postman_id":"e2a96d64-b638-48da-9777-3af701c36fbf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"get spaces","id":"07ea9184-65c2-4c27-8853-4f3c8fd267c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/spaces?useType=Desk","description":"

Returns the spaces of Habität.

SpacesRead permission is required.

Results can be filtered by several filters like floor and code, ordered and paginated with page and perPage parameters.

By default, if no pagination parameters are provided, it returns the first 50 spaces.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesRead permission
401 Unauthorized	Missing Bearer token

Filter by floor id

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

Filter by code substring

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

Filter by space type

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

Filter by use type (Desk, Room, Parking)

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

Filter by subsection

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

Filer by miminum capacity

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

Filter by tag list

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

Order the results by this field (code, id)

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

Order direction (asc or desc)

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

Page index

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

Items per page

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

Id of the area to filter by

\n","type":"text/plain"},"key":"area","value":"6"},{"disabled":true,"key":"building","value":"1"},{"disabled":true,"description":{"content":"

//Nuevo en multisede

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

//Eliminado

\n","type":"text/plain"},"key":"city","value":"1"},{"disabled":true,"key":"groupCode","value":"12345"},{"disabled":true,"key":"resources","value":null},{"disabled":true,"key":"resourceCodes","value":null},{"disabled":true,"key":"resourceTypes","value":null},{"disabled":true,"key":"resourceTypeCodes","value":null}],"variable":[]}},"response":[{"id":"c0ba1d27-4a04-4005-b4ef-610dedad8fae","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces?floor=26&useType=Desk","host":["{{host}}"],"path":["v2","spaces"],"query":[{"key":"floor","value":"26","description":"Filter by floor id"},{"key":"code","value":"Ag","description":"Filter by code substring","disabled":true},{"key":"useType","value":"Desk","description":"Filter by use type (Desk, Room, Parking)"},{"key":"subsection","value":"20","description":"Filter by subsection","type":"text","disabled":true},{"key":"capacity","value":"1","description":"Filer by miminum capacity","disabled":true},{"key":"orderBy","value":"code","description":"Order the results by this field (code, id)","disabled":true},{"key":"order","value":"desc","description":"Order direction (asc or desc)","disabled":true},{"key":"page","value":"1","description":"Page index","type":"text","disabled":true},{"key":"perPage","value":"10000","description":"Items per page","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 09 Jul 2021 11:43:38 GMT"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Origin"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 3628,\n \"code\": \"MN3BAg006\",\n \"type\": 23,\n \"name\": \"\",\n \"description\": \"Mesa ágil 200x140a80x105h cm\",\n \"entryDate\": \"2020-01-02T17:00:10\",\n \"x\": 148.19,\n \"y\": 45.6626,\n \"floor\": 26,\n \"capacity\": 1,\n \"availabilityType\": \"NoSensor\",\n \"availabilityDate\": \"2020-10-28T14:15:00\"\n },\n {\n \"id\": 3629,\n \"code\": \"MN3BAg004\",\n \"type\": 23,\n \"name\": \"\",\n \"description\": \"Mesa ágil 200x140a80x105h cm\",\n \"entryDate\": \"2020-01-02T17:00:10\",\n \"x\": 135.751,\n \"y\": 56.0325,\n \"floor\": 26,\n \"capacity\": 1,\n \"availabilityType\": \"NoSensor\",\n \"availabilityDate\": \"2020-10-28T14:15:00\"\n },\n {\n \"id\": 3630,\n \"code\": \"MN3BAg003\",\n \"type\": 23,\n \"name\": \"\",\n \"description\": \"Mesa ágil 200x140a80x105h cm\",\n \"entryDate\": \"2020-01-02T17:00:10\",\n \"x\": 135.951,\n \"y\": 26.332,\n \"floor\": 26,\n \"capacity\": 1,\n \"availabilityType\": \"NotAvailable\",\n \"availabilityDate\": \"2020-11-04T08:07:24.601\"\n }\n]"},{"id":"eeaa2dbd-aad9-4933-b1c4-dd4a51b2d7a2","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces?code=Ag&subsection=20","host":["{{host}}"],"path":["v2","spaces"],"query":[{"key":"floor","value":"1","description":"Filter by floor id","disabled":true},{"key":"code","value":"Ag","description":"Filter by code substring"},{"key":"type","value":"25","description":"Filter by space type","type":"text","disabled":true},{"key":"useType","value":"Desk","description":"Filter by use type (Desk, Room, Parking)","disabled":true},{"key":"subsection","value":"20","description":"Filter by subsection","type":"text"},{"key":"capacity","value":"1","description":"Filer by miminum capacity","disabled":true},{"key":"tags","value":"1","description":"Filter by tag list","type":"text","disabled":true},{"key":"orderBy","value":"code","description":"Order the results by this field (code, id)","disabled":true},{"key":"order","value":"desc","description":"Order direction (asc or desc)","disabled":true},{"key":"page","value":"1","description":"Page index","type":"text","disabled":true},{"key":"perPage","value":"50","description":"Items per page","type":"text","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:51:14 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"9ece1f94-5455-4d3e-9045-d030a43b151d","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces?capacity=3&orderBy=code","host":["{{host}}"],"path":["v2","spaces"],"query":[{"key":"floor","value":"1","description":"Filter by floor id","disabled":true},{"key":"code","value":"Ag","description":"Filter by code substring","disabled":true},{"key":"type","value":"25","description":"Filter by space type","type":"text","disabled":true},{"key":"useType","value":"Desk","description":"Filter by use type (Desk, Room, Parking)","disabled":true},{"key":"subsection","value":"20","description":"Filter by subsection","type":"text","disabled":true},{"key":"capacity","value":"3","description":"Filer by miminum capacity"},{"key":"tags","value":"1","description":"Filter by tag list","type":"text","disabled":true},{"key":"orderBy","value":"code","description":"Order the results by this field (code, id)"},{"key":"order","value":"desc","description":"Order direction (asc or desc)","disabled":true},{"key":"page","value":"1","description":"Page index","type":"text","disabled":true},{"key":"perPage","value":"50","description":"Items per page","type":"text","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:34:09 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"07ea9184-65c2-4c27-8853-4f3c8fd267c1"},{"name":"get spaces full","id":"2185aaf9-8c65-4e6c-859d-c69e2dbea8a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/spaces/full?page=1&perPage=20&groupCode=123456","description":"

Returns the spaces of Habität. The main difference to the previous request is that not only are the spaces returned, but also their subsections.

SpacesRead permission is required.

Results can be filtered by several filters like floor and code, ordered and paginated with page and perPage parameters.

By default, if no pagination parameters are provided, it returns the first 50 spaces.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesRead permission
401 Unauthorized	Missing Bearer token

Filter by use type (Desk, Room, Parking)

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

Filter by code substring

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

Filter by space type

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

Filer by miminum capacity

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

Filter by tag list

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

Order the results by this field (code, id)

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

Order direction (asc or desc)

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

Page index

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

Items per page

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

Filter by subsection name

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

Filter by floor id

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

Filter by subsection

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

Id of the area to filter by

\n","type":"text/plain"},"key":"area","value":"6"},{"disabled":true,"key":"building","value":"1"},{"disabled":true,"description":{"content":"

//Nuevo en multisede

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

//Eliminado

\n","type":"text/plain"},"key":"city","value":"1"},{"key":"groupCode","value":"123456"},{"disabled":true,"key":"resources","value":null},{"disabled":true,"key":"resourceCodes","value":null},{"disabled":true,"key":"resourceTypes","value":null},{"disabled":true,"key":"resourceTypeCodes","value":null}],"variable":[]}},"response":[{"id":"ae897675-5841-413c-b1c7-4266e47329fd","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/full?useType=Desk","host":["{{host}}"],"path":["v2","spaces","full"],"query":[{"key":"useType","value":"Desk","description":"Filter by use type (Desk, Room, Parking)"},{"key":"floor","value":"1","description":"Filter by floor id","type":"text","disabled":true},{"key":"code","value":"Ag","description":"Filter by code substring","type":"text","disabled":true},{"key":"type","value":"25","description":"Filter by space type","type":"text","disabled":true},{"key":"subsection","value":"20","description":"Filter by subsection","type":"text","disabled":true},{"key":"capacity","value":"1","description":"Filer by miminum capacity","type":"text","disabled":true},{"key":"tags","value":"1","description":"Filter by tag list","type":"text","disabled":true},{"key":"orderBy","value":"code","description":"Order the results by this field (code, id)","type":"text","disabled":true},{"key":"order","value":"desc","description":"Order direction (asc or desc)","type":"text","disabled":true},{"key":"page","value":"1","description":"Page index","type":"text","disabled":true},{"key":"perPage","value":"50","description":"Items per page","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Mar 2022 11:08:07 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 15748,\n \"code\": \"MN5AA007\",\n \"type\": 22,\n \"name\": \"MN5AA007\",\n \"description\": \"Cell reunion 120\",\n \"entryDate\": \"2021-07-29T10:16:50\",\n \"x\": 73.3068,\n \"y\": 33.358,\n \"floor\": 31,\n \"capacity\": 1,\n \"availabilityType\": \"NoSensor\",\n \"availabilityDate\": \"2021-07-29T10:16:50\",\n \"subsections\": [\n {\n \"name\": \"CD\",\n \"type\": \"Módulo\"\n },\n {\n \"name\": \"Matadero\",\n \"type\": \"Barrio\"\n }\n ]\n },\n {\n \"id\": 15749,\n \"code\": \"MN5AA008\",\n \"type\": 22,\n \"name\": \"MN5AA008\",\n \"description\": \"Cell reunion 120\",\n \"entryDate\": \"2021-07-29T10:16:50\",\n \"x\": 73.2824,\n \"y\": 45.1614,\n \"floor\": 31,\n \"capacity\": 1,\n \"availabilityType\": \"NoSensor\",\n \"availabilityDate\": \"2021-07-29T10:16:50\",\n \"subsections\": [\n {\n \"name\": \"A\",\n \"type\": \"Torre\"\n },\n {\n \"name\": \"CD\",\n \"type\": \"Módulo\"\n },\n {\n \"name\": \"Matadero\",\n \"type\": \"Barrio\"\n }\n ]\n },\n {\n \"id\": 16595,\n \"code\": \"MN5AA001\",\n \"type\": 22,\n \"name\": \"MN5AA001\",\n \"description\": \"Cell reunion 120\",\n \"entryDate\": \"2021-08-16T06:34:30\",\n \"x\": 32.0413,\n \"y\": 60.5271,\n \"floor\": 149,\n \"capacity\": 1,\n \"availabilityType\": \"NoSensor\",\n \"availabilityDate\": \"2021-08-16T06:34:30\",\n \"subsections\": null\n }\n]"},{"id":"bdf18104-470d-40e0-8d3b-490a4c3f3093","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/full?useType=Desk&subsection=20","host":["{{host}}"],"path":["v2","spaces","full"],"query":[{"key":"useType","value":"Desk","description":"Filter by use type (Desk, Room, Parking)"},{"key":"floor","value":"1","description":"Filter by floor id","type":"text","disabled":true},{"key":"code","value":"Ag","description":"Filter by code substring","type":"text","disabled":true},{"key":"type","value":"25","description":"Filter by space type","type":"text","disabled":true},{"key":"subsection","value":"20","description":"Filter by subsection","type":"text"},{"key":"capacity","value":"1","description":"Filer by miminum capacity","type":"text","disabled":true},{"key":"tags","value":"1","description":"Filter by tag list","type":"text","disabled":true},{"key":"orderBy","value":"code","description":"Order the results by this field (code, id)","type":"text","disabled":true},{"key":"order","value":"desc","description":"Order direction (asc or desc)","type":"text","disabled":true},{"key":"page","value":"1","description":"Page index","type":"text","disabled":true},{"key":"perPage","value":"50","description":"Items per page","type":"text","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:09:31 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"8df3d0f8-40a5-4167-9389-690cd2862a55","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/full?floor=721&code=Ag&type=25","host":["{{host}}"],"path":["v2","spaces","full"],"query":[{"key":"useType","value":"Desk","description":"Filter by use type (Desk, Room, Parking)","disabled":true},{"key":"floor","value":"984","description":"Filter by floor id"},{"key":"code","value":"Ag","description":"Filter by code substring"},{"key":"type","value":"25","description":"Filter by space type"},{"key":"subsection","value":"20","description":"Filter by subsection","type":"text","disabled":true},{"key":"capacity","value":"1","description":"Filer by miminum capacity","type":"text","disabled":true},{"key":"tags","value":"1","description":"Filter by tag list","type":"text","disabled":true},{"key":"orderBy","value":"code","description":"Order the results by this field (code, id)","type":"text","disabled":true},{"key":"order","value":"desc","description":"Order direction (asc or desc)","type":"text","disabled":true},{"key":"page","value":"1","description":"Page index","type":"text","disabled":true},{"key":"perPage","value":"50","description":"Items per page","type":"text","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:35:06 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"}],"_postman_id":"2185aaf9-8c65-4e6c-859d-c69e2dbea8a4"},{"name":"get space","id":"23f87702-9161-48ae-b07f-9f331db22bfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/v2/spaces/:space","description":"

Returns a space by its id.

SpacesRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesRead permission
404 Not Found	Space Id not found on database
401 Unauthorized	Missing Bearer token

","urlObject":{"path":["v2","spaces",":space"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"

Id of the space to retrieve

\n","type":"text/plain"},"type":"string","value":"660","key":"space"}]}},"response":[{"id":"08db7aa0-0250-4dae-8cc6-d37d3f7f97c5","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"27266","type":"string","description":"Id of the space to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:45:54 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 27266,\n \"code\": \"CE\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Cell elevable\",\n \"entryDate\": \"2022-02-03T09:18:58\",\n \"x\": 69.1631,\n \"y\": 89.2466,\n \"floor\": 199,\n \"capacity\": 1,\n \"availabilityType\": \"NoSensor\",\n \"availabilityDate\": \"2022-02-03T09:18:58\"\n}"},{"id":"a4129bac-55e5-405c-96cc-1a6d72b4fc22","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"251","type":"string","description":"Id of the space to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 14:51:24 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"9a7957ae-c44d-4639-8a99-67df517d5bd1","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"579","type":"string","description":"Id of the space to retrieve"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:34:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"f9b8f540-cebb-491c-bafb-5196647aa306","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"65","type":"string","description":"Id of the space to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:42:03 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Space not found\"\n}"}],"_postman_id":"23f87702-9161-48ae-b07f-9f331db22bfd"},{"name":"get space full","id":"a48be9d5-fbd7-42e5-a7d1-31dba669feea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/spaces/:space/full","description":"

Returns a space by its id.

SpacesRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesRead permission
404 Not Found	Space Id not found on database
401 Unauthorized	Missing Bearer token

Id of the space to retrieve

\n","type":"text/plain"},"type":"string","value":"660","key":"space"}]}},"response":[{"id":"2387b284-ee54-4e13-a66b-0a7a02b80439","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/full","host":["{{host}}"],"path":["v2","spaces",":space","full"],"variable":[{"id":"4f43c4e0-e160-4c4d-81c3-c34ea29bf939","key":"space","value":"660","type":"string","description":"Id of the space to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 31 May 2023 09:15:58 GMT"},{"key":"X-Implementation-Version","value":"1.6.7"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Server","value":"ktor-server-core/1.6.7"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"keep-alive"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 660,\n \"code\": \"MN2BCe001\",\n \"type\": 3,\n \"useType\": \"Desk\",\n \"name\": \"MN2BCe001\",\n \"description\": \"Puesto de trabajo 120cm de flor elevable\",\n \"entryDate\": \"2022-03-03T14:19:50\",\n \"x\": 98.7208,\n \"y\": 63.1388,\n \"floor\": 2,\n \"capacity\": 1,\n \"availabilityType\": \"NoSensor\",\n \"availabilityDate\": \"2022-03-03T14:19:50\",\n \"subsections\": [\n {\n \"subsectionId\": 10,\n \"name\": \"EF\",\n \"type\": \"Módulo\",\n \"subsectionTypeId\": 2\n },\n {\n \"subsectionId\": 11,\n \"name\": \"Puerta de Alcalá\",\n \"type\": \"Barrio\",\n \"subsectionTypeId\": 3\n }\n ]\n}"}],"_postman_id":"a48be9d5-fbd7-42e5-a7d1-31dba669feea"},{"name":"get space graphical area","id":"c1d95ce8-9d98-4706-8c55-6e55e52d80d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/spaces/:space/graphicalArea","description":"

Returns the graphical area that includes the provided space, if any.

GraphicalAreasRead permission is required.

The response could be one of:

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

200 OK
403 Forbidden	User without GraphicalAreasRead permission
404 Not Found	Space Id not found on database
401 Unauthorized	Missing Bearer token

Id of the space for which retrieve graphical area

\n","type":"text/plain"},"type":"string","value":"1","key":"space"}]}},"response":[{"id":"cdc67070-601b-4df6-97d7-61e705854c0d","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/graphicalArea","host":["{{host}}"],"path":["v2","spaces",":space","graphicalArea"],"variable":[{"key":"space","value":"1000","description":"Id of the space for which retrieve graphical area"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"keep-alive"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 108,\n \"name\": \"Area 3B3\",\n \"path\": \"96.68876681857893,-16.628848676568857 126.78870924015233,-16.628848676568857 126.96473229524925,-23.72844523214465 122.50548156612727,-24.608560507629253 121.80138934573958,-28.53974207146048 115.3472106588525,-28.481067719761505 112.4721674256028,-24.315188749134386 97.15816163217072,-25.195304024618988\",\n \"floor\": 30,\n \"numSpaces\": 62\n}"},{"id":"7912450e-748b-4ea2-ad2f-9ec377f22312","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/graphicalArea","host":["{{host}}"],"path":["v2","spaces",":space","graphicalArea"],"variable":[{"key":"space","value":"745","type":"string","description":"Id of the space for which retrieve graphical area"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:34:26 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"0a81001f-461e-460b-b8c7-f41297936a9a","name":"403 Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/graphicalArea","host":["{{host}}"],"path":["v2","spaces",":space","graphicalArea"],"variable":[{"key":"space","value":"584","type":"string","description":"Id of the space for which retrieve graphical area"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:34:26 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"7ff3b2a4-e0ba-4274-a81f-875b9c26cba1","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/spaces/:space/graphicalArea","host":["{{host}}"],"path":["v2","spaces",":space","graphicalArea"],"variable":[{"key":"space","value":"218","type":"string","description":"Id of the space for which retrieve graphical area"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:34:26 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c1d95ce8-9d98-4706-8c55-6e55e52d80d8"},{"name":"create space","id":"24fa997f-5809-498e-a601-357a9e25345d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"x-audit-functionality","value":"1","description":"

Identifier of the funcionality. CreateIndividualSpace

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"MNP50000\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"x\": 0.0,\n \"y\": 1.0,\n \"floor\": 1,\n \"capacity\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/spaces","description":"

Creates a new space.

Requirements:

You need to have created previously a Floor (See \"create Floor\" from Habitat Core API).
You need to have created previously a space type (See \"space type\" section).
SpacesWrite permission.

If a space with the same code already exists, a 409 HTTP error code is returned.

Fields:

code: Required. String code of the space
type: Required. Int. Id of the space type
name: Required. String. Display name of this space.
description: Required. String. Short description of the space
x: Required. Float. Position on the X axis where the space is placed on the floor's plan. See Habitat Core API documentation for a guide about resource placement on the floor's plan.
y: Required. Float. Position on the Y axis where the space is placed on the floor's plan. See Habitat Core API documentation for a guide about resource placement on the floor's plan.
floor: Required. Int. Floor where the space is located
capacity: Optional. Int. Capacity of the space. If not specified, default is one

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 1 (CreateIndividualSpace)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
403 Forbidden	User without SpacesWrite permission or Floor not available for user
401 Unauthorized	Missing Bearer token
409 Conflict	There is already an space created with the provided code
400 Bad Request	Invalid or missing required parameters

","urlObject":{"path":["v2","spaces"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"3b26e647-9a82-49ee-acbc-9cf83573f161","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": \"MNP5001\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"x\": 0.0,\n \"y\": 1.0,\n \"floor\": 26,\n \"capacity\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/spaces"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:59:46 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2734,\n \"code\": \"MNP5001\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"entryDate\": \"2022-02-15T14:59:46\",\n \"x\": 0,\n \"y\": 1,\n \"floor\": 26,\n \"capacity\": 1,\n \"availabilityType\": \"NoSensor\",\n \"availabilityDate\": \"2022-02-15T14:59:46\"\n}"},{"id":"2326c315-987e-4729-9ffd-a1b28a8049d4","name":"400 Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": \"MNP5001\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"x\": 0.0,\n \"capacity\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/spaces"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:05:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"72701a4e-37d2-4ad6-9d05-d3a1086f3156","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": \"MNP5001\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"x\": 0.0,\n \"y\": 1.0,\n \"floor\": 26,\n \"capacity\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/spaces"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:05:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"9cf1ff5a-0192-415b-a4fd-92570244082e","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": \"MNP5001\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"x\": 0.0,\n \"y\": 1.0,\n \"floor\": 26,\n \"capacity\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/spaces"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:34:36 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"eafe9f0e-c8d1-496e-b94c-f49a509acbba","name":"409 Conflict (The space code is in use)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"code\": \"MNP5001\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"x\": 0.0,\n \"y\": 1.0,\n \"floor\": 26,\n \"capacity\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/spaces"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 15:00:39 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"The space code is in use\"\n}"}],"_postman_id":"24fa997f-5809-498e-a601-357a9e25345d"},{"name":"modify space","id":"dcadf87d-32da-4852-9411-c854d506d5af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-audit-functionality","value":"3","description":"

Identifier of the functionality. ModifyIndividualSpace

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"MNP5001\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"x\": 0.0,\n \"y\": 1.0,\n \"floor\": 1,\n \"capacity\": 1\n}\n","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/spaces/:space","description":"

Modifies data of the space.

SpacesWrite permission is required.

One or more of this fields can be modified:

code
type
description
x
y
floor
capacity

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 3 (ModifyIndividualSpace)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
400 Bad Request	Invalid parameters
403 Forbidden	User without SpacesWrite permission or Floor not available for user
404 Not Found	Space Id not found on database
401 Unauthorized	Missing Bearer token

Id of the space to be modified

\n","type":"text/plain"},"type":"string","value":"1","key":"space"}]}},"response":[{"id":"ce2389a8-2f86-4e3e-906c-8aef4d38978d","name":"Ok","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"x\": 50,\n \"y\": 51\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"27375","type":"string","description":"Id of the space to be modified"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 15:04:38 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 27375,\n \"code\": \"MNP5001\",\n \"type\": 22,\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"entryDate\": \"2022-02-15T15:04:14\",\n \"x\": 50,\n \"y\": 51,\n \"floor\": 26,\n \"capacity\": 1,\n \"availabilityType\": \"NoSensor\",\n \"availabilityDate\": \"2022-02-15T15:04:14\"\n}"},{"id":"ad3bc477-c622-40d3-9a08-a7cd7edf944a","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"code\": \"MNP5001\",\n \"type\": 22\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"483","type":"string","description":"Id of the space to be modified"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:09:12 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"6789047c-5c65-42f9-ac65-803d6fe4c03c","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"floor\": 569,\n \"capacity\": 3\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"743","type":"string","description":"Id of the space to be modified"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:34:47 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"a4b2a32b-f309-4540-ae08-e48d573a082d","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"MNP5001\",\n \"description\": \"Individual Pull\",\n \"x\": 0.0,\n \"y\": 1.0\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"80","type":"string","description":"Id of the space to be modified"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 15:11:32 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"dcadf87d-32da-4852-9411-c854d506d5af"},{"name":"delete space","id":"87658f98-3805-49e3-9849-442cd4af054e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-audit-functionality","value":"5","description":"

Identifier of the funcionality. DeleteSpace

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"url":"{{host}}/v2/spaces/:space","description":"

Delete space referenced by its id.

SpacesWrite permission is required.

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 5 (DeleteSpace)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
403 Forbidden	User without SpacesWrite permission
404 Not Found	Space Id Not Found in database

Id of the space to be deleted

\n","type":"text/plain"},"type":"any","value":"1","key":"space"}]}},"response":[{"id":"944f1020-24a3-4275-b975-96cbcc729936","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"796","description":"Id of the space to be deleted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 15:03:55 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"0940b8f2-be1e-4403-9917-8c9fbc9c0948","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"33","description":"Id of the space to be deleted"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:09:23 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"561c5056-5d5d-4c15-9620-170ae349a304","name":"403 Forbidden (User without specific permission)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"905","description":"Id of the space to be deleted"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 14:34:59 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Not allowed to read\"\n}"},{"id":"1383e43a-e6e0-4d38-aa4e-fb10dae92b08","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/spaces/:space","host":["{{host}}"],"path":["v2","spaces",":space"],"variable":[{"key":"space","value":"192","description":"Id of the space to be deleted"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 15:11:57 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"87658f98-3805-49e3-9849-442cd4af054e"}],"id":"bc7e75a3-8a27-4d81-a990-e9d674daa155","description":"

Requests for manadgement of spaces, the sites or rooms to monitor

\n","_postman_id":"bc7e75a3-8a27-4d81-a990-e9d674daa155","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"subsection types","item":[{"name":"get subsection types","id":"331189d2-46ea-4f54-b269-cd94f5a69d39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/subsectionTypes?maxFloors=1","description":"

Get subsection types created on the esite module

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token

Filter by maxFloors

\n","type":"text/plain"},"key":"maxFloors","value":"1"}],"variable":[]}},"response":[{"id":"4ee800f2-9eb5-472a-bb51-18163a59df94","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v2/subsectionTypes"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:54:31 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"cf07443e-2221-43a4-a1d4-33b8b9e2ebb4","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/subsectionTypes","host":["{{host}}"],"path":["v2","subsectionTypes"],"query":[{"key":"maxFloors","value":"1","description":"Filter by maxFloors","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jun 2022 16:46:22 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Implementation-Version","value":"3.3.0-test16"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Server","value":"esite-api/3.3.0-test16"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 40,\n \"name\": \"Aserejé\",\n \"maxFloors\": 999\n },\n {\n \"id\": 3,\n \"name\": \"Barrio\",\n \"maxFloors\": 999\n },\n {\n \"id\": 2,\n \"name\": \"Módulo\",\n \"maxFloors\": 999\n },\n {\n \"id\": 19,\n \"name\": \"PruebasDiego\",\n \"maxFloors\": 999\n },\n {\n \"id\": 14,\n \"name\": \"Subseccion1\",\n \"maxFloors\": 1\n },\n {\n \"id\": 15,\n \"name\": \"Subseccion2\",\n \"maxFloors\": 999\n },\n {\n \"id\": 6,\n \"name\": \"Subseccion3\",\n \"maxFloors\": 0\n },\n {\n \"id\": 21,\n \"name\": \"testborrar\",\n \"maxFloors\": 1\n },\n {\n \"id\": 1,\n \"name\": \"testborrar1\",\n \"maxFloors\": 999\n },\n {\n \"id\": 13,\n \"name\": \"TipoSubPf3\",\n \"maxFloors\": 999\n },\n {\n \"id\": 7,\n \"name\": \"TipoSubTestPf1\",\n \"maxFloors\": 1\n },\n {\n \"id\": 20,\n \"name\": \"TipoSubTestPf2\",\n \"maxFloors\": 999\n }\n]"}],"_postman_id":"331189d2-46ea-4f54-b269-cd94f5a69d39"},{"name":"get subsection type","id":"58b9be28-4129-43c1-a1f0-ec3332d1de4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/subsectionTypes/:subsectionType","description":"

Returns a subsection type by its id

The response could be one of:

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

200 OK
404 Not Found	Subsection Type Id not found on database
401 Unauthorized	Missing Bearer token

Id of the subsection type

\n","type":"text/plain"},"type":"string","value":"1","key":"subsectionType"}]}},"response":[{"id":"a6efc359-95ac-4847-854e-4dd0634bd917","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/subsectionTypes/:subsectionType","host":["{{host}}"],"path":["v2","subsectionTypes",":subsectionType"],"variable":[{"id":"7d657b9d-acb2-4e0b-83c0-3725e4f94d70","key":"subsectionType","value":"1","type":"string","description":"Id of the subsection type"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:56:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"36064348-a1e3-4e8c-867d-74351e2225b5","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/subsectionTypes/:subsectionType","host":["{{host}}"],"path":["v2","subsectionTypes",":subsectionType"],"variable":[{"key":"subsectionType","value":"40","type":"string","description":"Id of the subsection type"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:10:14 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Subsection type 40 not found\"\n}"},{"id":"787ed04c-3528-4382-90c8-3335ef75672b","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/subsectionTypes/:subsectionType","host":["{{host}}"],"path":["v2","subsectionTypes",":subsectionType"],"variable":[{"key":"subsectionType","value":"3","type":"string","description":"Id of the subsection type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jun 2022 16:47:33 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Implementation-Version","value":"3.3.0-test16"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Server","value":"esite-api/3.3.0-test16"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3,\n \"name\": \"Barrio\",\n \"maxFloors\": 999\n}"}],"_postman_id":"58b9be28-4129-43c1-a1f0-ec3332d1de4f"},{"name":"create subsection type","id":"584b94e1-934b-4ed9-a98e-91e83391006b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-audit-functionality","value":"13","description":"

Identifier of the funcionality. CreateSubsectionType

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Tower\",\n \"maxFloors\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsectionTypes","description":"

Creates a new subsection type.

Body fields:

name: Required. String. Name of the subsection type

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 13 (CreateSubsectionType)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
409 Conflict	There is already an space created with the provided code
400 Bad Request	Duplicate subsection type with provided name or missing required parameters

Identifier of the funcionality. ModifySubsectionType

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 11,\n \"name\": \"SubseccionPedroTipo999\",\n \"maxFloors\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsectionTypes","description":"

Modifies a subsection type.

The id of the subsection type to be modified must be referenced in the body

Body fields:

id: Required. Int. Id of the subsection type to modify
name: Required. String. New name going to be set to subsection type.
maxFloors: Required. Int. New maxFloors value going to be set to subsection type.

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 22 (ModifySubsectionType)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
404 Not Found	Subsection Type Id not found on database
400 Bad Request	Invalid parameters or duplicate subsection type name
401 Unauthorized	Missing Bearer token
409 Conflict	The subsection maxFloors field cannot be modified to 1 because there is a least one subsection for this type with spaces at more than one floor

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}},"urlObject":{"path":["v2","subsectionTypes"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"709e3be9-7d2d-4f35-bb51-ccbff3768fad","name":"Ok","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 4,\n \"name\": \"Module\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsectionTypes"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:10:59 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"99fb9156-149e-41a8-9186-40c1d7162417","name":"400 Bad Request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 25\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsectionTypes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:11:41 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"a3b92558-0528-4c60-897b-a296bfb2ece3","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 4,\n \"name\": \"Tower\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsectionTypes"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:57:12 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"034ed6a3-f9b3-4ab0-a2d7-4138a7b68dd6","name":"404 Not Found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 302,\n \"name\": \"Module\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsectionTypes"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:11:41 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"c6f4580f-cd60-4673-a437-779d72c4c090","name":"409 Conflict","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 3,\n \"name\": \"Barrio\",\n \"maxFloors\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsectionTypes"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jun 2022 11:06:25 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Implementation-Version","value":"3.3.0-test15"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Server","value":"esite-api/3.3.0-test15"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"The subsection maxFloors field cannot be modified to 1 because there is a least one subsection for this type with spaces at more than one floor\"\n}"}],"_postman_id":"3358b042-0f25-456e-b99c-0c65150f33f4"},{"name":"delete subsection type","id":"e4c79124-b212-4c8e-ba85-3040c6ac2c65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-audit-functionality","value":"20","description":"

Identifier of the funcionality. DeleteSubsectionType

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"url":"{{host}}/v2/subsectionTypes/:subsectionType","description":"

Deletes a subsection type by its id

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 20 (DeleteSubsectionType)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
404 Not Found	Subsection Type Id Not Found in database

Id of the subsection type to be deleted

\n","type":"text/plain"},"type":"string","value":"70","key":"subsectionType"}]}},"response":[{"id":"b4b19a31-18ac-4da6-8f99-1df22f604f58","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/subsectionTypes/:subsectionType","host":["{{host}}"],"path":["v2","subsectionTypes",":subsectionType"],"variable":[{"key":"subsectionType","value":"21","type":"string","description":"Id of the subsection type to be deleted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:11:16 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"2960da4d-792a-4ab8-96ad-452b1f90bea9","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/subsectionTypes/:subsectionType","host":["{{host}}"],"path":["v2","subsectionTypes",":subsectionType"],"variable":[{"key":"subsectionType","value":"545","type":"string","description":"Id of the subsection type to be deleted"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:57:21 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"67a1b3a6-637b-4ab4-a6b5-01c31e387695","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/subsectionTypes/:subsectionType","host":["{{host}}"],"path":["v2","subsectionTypes",":subsectionType"],"variable":[{"key":"subsectionType","value":"67","type":"string","description":"Id of the subsection type to be deleted"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:11:56 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e4c79124-b212-4c8e-ba85-3040c6ac2c65"}],"id":"b7ab342a-cd29-4fdf-ae87-e6d3e109b7ff","description":"

Requests related to subsection types.

Subsection types are thought to be used for clustering subsections. For example, a subsection type could be \"Tower\" while its subsection values could be \"east\" or \"west\" (for a building of two towers)

Depending on the value of maxFloors the relationship between the floors changes:

maxFloors - 0: No physical location.
maxFloors - 1: Located on a single floor.
maxFloors - 999: Located on several floors.

\n","event":[{"listen":"prerequest","script":{"id":"94eee750-8119-4053-9f9b-b34bf509671a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1d75de19-74c5-4d41-8cdc-914a425ba0bc","type":"text/javascript","exec":[""]}}],"_postman_id":"b7ab342a-cd29-4fdf-ae87-e6d3e109b7ff","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"subsections","item":[{"name":"get subsections","id":"92be6325-1e8c-4738-907d-40df3e12d4aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/subsections","description":"

Returns the subsections with the floors assigned to it created on esite module

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token

Filter by subsection type

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

Filter by floor

\n","type":"text/plain"},"key":"floor","value":"19"}],"variable":[]}},"response":[{"id":"023997eb-9151-4285-b98e-c6ad854a2d43","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/subsections","host":["{{host}}"],"path":["v2","subsections"],"query":[{"key":"type","value":"2","description":"Filter by subsection type","type":"text","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:44:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"82a4767e-a1ce-472e-8ca6-87f9de6cda60","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/subsections","host":["{{host}}"],"path":["v2","subsections"],"query":[{"key":"type","value":"7","description":"Filter by subsection type","type":"text","disabled":true},{"key":"floor","value":"19","description":"Filter by floor","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jun 2022 17:11:10 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Implementation-Version","value":"3.3.0-test16"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Server","value":"esite-api/3.3.0-test16"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"B\",\n \"type\": 1,\n \"floors\": [\n 1,\n 2,\n 7,\n 15\n ]\n },\n {\n \"id\": 2,\n \"name\": \"A\",\n \"type\": 2,\n \"floors\": [\n 1,\n 2,\n 7,\n 15,\n 4,\n 18\n ]\n },\n {\n \"id\": 3,\n \"name\": \"B,A,C\",\n \"type\": 2,\n \"floors\": [\n 18\n ]\n },\n {\n \"id\": 5,\n \"name\": \"F,G\",\n \"type\": 3,\n \"floors\": [\n null\n ]\n },\n {\n \"id\": 6,\n \"name\": \"AB\",\n \"type\": 2,\n \"floors\": [\n 2,\n 7,\n 15,\n 18,\n 17\n ]\n },\n {\n \"id\": 7,\n \"name\": \"Serrano\",\n \"type\": 2,\n \"floors\": [\n 2,\n 7,\n 15,\n 18,\n 22\n ]\n },\n {\n \"id\": 8,\n \"name\": \"CD\",\n \"type\": 2,\n \"floors\": [\n 2,\n 7,\n 15,\n 18,\n 22\n ]\n },\n {\n \"id\": 9,\n \"name\": \"Palacio de Cibeles\",\n \"type\": 3,\n \"floors\": [\n 2,\n 7,\n 15,\n 18,\n 22\n ]\n },\n {\n \"id\": 10,\n \"name\": \"EF\",\n \"type\": 2,\n \"floors\": [\n 2,\n 7,\n 15,\n 18\n ]\n },\n {\n \"id\": 11,\n \"name\": \"Puerta de Alcalá\",\n \"type\": 3,\n \"floors\": [\n 2,\n 7,\n 15,\n 18\n ]\n },\n {\n \"id\": 12,\n \"name\": \"GH\",\n \"type\": 2,\n \"floors\": [\n 2,\n 7,\n 15,\n 18\n ]\n },\n {\n \"id\": 13,\n \"name\": \"Museo del Prado\",\n \"type\": 3,\n \"floors\": [\n 2,\n 7,\n 15,\n 18\n ]\n },\n {\n \"id\": 14,\n \"name\": \"DE\",\n \"type\": 2,\n \"floors\": [\n null\n ]\n },\n {\n \"id\": 15,\n \"name\": \"FREE-CITY\",\n \"type\": 3,\n \"floors\": [\n 5,\n 13,\n 14\n ]\n },\n {\n \"id\": 16,\n \"name\": \"BSA-CITY\",\n \"type\": 3,\n \"floors\": [\n 5\n ]\n },\n {\n \"id\": 17,\n \"name\": \"BSA-SEA\",\n \"type\": 3,\n \"floors\": [\n 5\n ]\n },\n {\n \"id\": 18,\n \"name\": \"FREE-SEA\",\n \"type\": 3,\n \"floors\": [\n 5\n ]\n },\n {\n \"id\": 19,\n \"name\": \"PRODUCTION-SEA\",\n \"type\": 3,\n \"floors\": [\n 5\n ]\n },\n {\n \"id\": 20,\n \"name\": \"SALA IT\",\n \"type\": 3,\n \"floors\": [\n 5\n ]\n },\n {\n \"id\": 27,\n \"name\": \"IM-CITY\",\n \"type\": 3,\n \"floors\": [\n 8,\n 9\n ]\n },\n {\n \"id\": 28,\n \"name\": \"IM-SEA\",\n \"type\": 2,\n \"floors\": [\n 8,\n 9\n ]\n },\n {\n \"id\": 29,\n \"name\": \"TAS-CITY\",\n \"type\": 3,\n \"floors\": [\n 10\n ]\n },\n {\n \"id\": 30,\n \"name\": \"TAS-SEA\",\n \"type\": 3,\n \"floors\": [\n 10\n ]\n },\n {\n \"id\": 31,\n \"name\": \"INDUSTRY-CITY\",\n \"type\": 3,\n \"floors\": [\n 11\n ]\n },\n {\n \"id\": 32,\n \"name\": \"INDUSTRY-SEA\",\n \"type\": 3,\n \"floors\": [\n 11\n ]\n },\n {\n \"id\": 33,\n \"name\": \"BANKING-CITY\",\n \"type\": 3,\n \"floors\": [\n 12\n ]\n },\n {\n \"id\": 34,\n \"name\": \"BANKING-SEA\",\n \"type\": 3,\n \"floors\": [\n 12,\n 4\n ]\n },\n {\n \"id\": 35,\n \"name\": \"BUSINESS-SEA\",\n \"type\": 3,\n \"floors\": [\n 12\n ]\n },\n {\n \"id\": 36,\n \"name\": \"BUSINESS-CITY\",\n \"type\": 3,\n \"floors\": [\n 12\n ]\n },\n {\n \"id\": 42,\n \"name\": \"Sub1SinPlanta\",\n \"type\": 2,\n \"floors\": [\n null\n ]\n },\n {\n \"id\": 47,\n \"name\": \"SubPf3\",\n \"type\": 13,\n \"floors\": [\n null\n ]\n },\n {\n \"id\": 51,\n \"name\": \"SubTestPf1\",\n \"type\": 7,\n \"floors\": [\n 16\n ]\n },\n {\n \"id\": 56,\n \"name\": \"PruebasDiego1\",\n \"type\": 3,\n \"floors\": [\n 4,\n 18\n ]\n },\n {\n \"id\": 57,\n \"name\": \"SubTestPf2\",\n \"type\": 20,\n \"floors\": [\n 16\n ]\n },\n {\n \"id\": 58,\n \"name\": \"testborrar\",\n \"type\": 20,\n \"floors\": [\n null\n ]\n },\n {\n \"id\": 65,\n \"name\": \"TipoSubPf3\",\n \"type\": 20,\n \"floors\": [\n 17\n ]\n },\n {\n \"id\": 84,\n \"name\": \"subpf12\",\n \"type\": 7,\n \"floors\": [\n null\n ]\n },\n {\n \"id\": 91,\n \"name\": \"Ja\",\n \"type\": 40,\n \"floors\": [\n 4,\n 18\n ]\n },\n {\n \"id\": 92,\n \"name\": \"deJé\",\n \"type\": 40,\n \"floors\": [\n 4\n ]\n },\n {\n \"id\": 93,\n \"name\": \"dejebe\",\n \"type\": 40,\n \"floors\": [\n null\n ]\n }\n]"}],"_postman_id":"92be6325-1e8c-4738-907d-40df3e12d4aa"},{"name":"get subsection","id":"d648191a-4264-4d56-beee-7a56789a59c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/subsections/:subsection","description":"

Returns a subsection by its id

The response could be one of:

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

200 OK
404 Not Found	Subsection Id not found on database
401 Unauthorized	Missing Bearer token

Id of the subsection to retrieve

\n","type":"text/plain"},"type":"string","value":"1","key":"subsection"}]}},"response":[{"id":"c5d9f455-3c71-4a01-9988-ff3ce2cdc602","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/subsections/:subsection","host":["{{host}}"],"path":["v2","subsections",":subsection"],"variable":[{"key":"subsection","value":"946","type":"string","description":"Id of the subsection to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:51:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"d3666ca2-b458-4c25-8a57-0b10ace79a71","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/subsections/:subsection","host":["{{host}}"],"path":["v2","subsections",":subsection"],"variable":[{"key":"subsection","value":"11244","type":"string","description":"Id of the subsection to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:02:18 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"Subsection 11244 not found\"\n}"},{"id":"71b46e5c-3152-4b3f-be24-415c42ed9d9c","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/subsections/:subsection","host":["{{host}}"],"path":["v2","subsections",":subsection"],"variable":[{"key":"subsection","value":"7","type":"string","description":"Id of the subsection to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 31 May 2022 06:48:54 GMT"},{"key":"Server","value":"esite-api/2.2.1"},{"key":"X-Implementation-Version","value":"2.2.1"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 7,\n \"name\": \"EF\",\n \"type\": 2,\n \"floors\": [\n 30,\n 31,\n 157,\n 158,\n 161,\n 162,\n 169,\n 176,\n 32,\n 199,\n 200,\n 201,\n 204,\n 203,\n 202,\n 148,\n 217,\n 218,\n 28,\n 27\n ]\n }\n]"}],"_postman_id":"d648191a-4264-4d56-beee-7a56789a59c3"},{"name":"create subsection","id":"8fc356ec-68d1-44d0-9f71-0b5a757ff0c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-audit-functionality","value":"14","description":"

Identifier of the funcionality. CreateIndividualSubsection

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"East\",\n \"type\": 3\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsections","description":"

Creates a new subsection.

Requirements:

You need to create previously a subsection type (See \"create subsectionType\" ).

Body fields:

name: Required. String. Name of the subsection
type: Required. Int. Subsection type

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 14 (CreateIndividualSubsection)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
400 Bad Request	Duplicate subsection name missing required parameters

Identifier of the funcionality. ModifySubsection

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 7,\n \"name\": \"Serrano\",\n \"type\": 3\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsections","description":"

Modifies a subsection.

The id of the subsection to be modified must be referenced in the body

Body fields:

id: Required. Int. Id of the subsection to modify
name: Required. String. New name going to be set to subsection.
type: Required. Int. Subsection type which contains this subsection

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 23 (ModifySubsection)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
404 Not Found	Subsection Id not found on database
400 Bad Request	Invalid parameters or duplicate subsection name
401 Unauthorized	Missing Bearer token
409 Conflict	The subsection type cannot be modified because the subsection has spaces at more than one floor

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}},"urlObject":{"path":["v2","subsections"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"4ffb0811-3899-4c61-9b92-2860a124050d","name":"Ok","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 205,\n \"name\": \"West\",\n \"type\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsections"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:00:53 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"61dccb3e-0070-4ee2-a44e-6712425128d9","name":"400 Bad Request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"West\",\n \"type\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsections"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:52:08 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"c8171bf7-b884-49ea-be1a-6b254c2c77b8","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 957,\n \"name\": \"West\",\n \"type\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsections"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:52:08 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"9ab61701-d3fb-41ce-b95a-6eb6b1b6518e","name":"404 Not Found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 326,\n \"name\": \"West\",\n \"type\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsections"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:02:01 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"2384db3d-0e87-415f-93f5-8224615c48c4","name":"409 Conflict","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 28,\n \"name\": \"IM-SEA\",\n \"type\": 14\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/subsections"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Jun 2022 11:07:59 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Implementation-Version","value":"3.3.0-test15"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Server","value":"esite-api/3.3.0-test15"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"The subsection type cannot be modified because the subsection has spaces at more than one floor\"\n}"}],"_postman_id":"c4101041-76cc-470f-8a15-182d464ccdfb"},{"name":"delete subsection","id":"f69b5ff1-94f0-46d9-8378-777a02155674","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-audit-functionality","value":"21","description":"

Identifier of the funcionality. DeleteSubsection

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"url":"{{host}}/v2/subsections/:subsection","description":"

Deletes a subsection by its id

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 21 (DeleteSubsection)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
404 Not Found	Subsection Id Not Found in database

Id of the subsection to be deleted

\n","type":"text/plain"},"type":"string","value":"1","key":"subsection"}]}},"response":[{"id":"06db3e2f-ef86-43ad-b293-1e1ac55fa3f1","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/subsections/:subsection","host":["{{host}}"],"path":["v2","subsections",":subsection"],"variable":[{"key":"subsection","value":"785","type":"string","description":"Id of the subsection to be deleted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:01:05 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"36ada6b9-e0c4-4748-9bb3-454683ef6add","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/subsections/:subsection","host":["{{host}}"],"path":["v2","subsections",":subsection"],"variable":[{"key":"subsection","value":"200","type":"string","description":"Id of the subsection to be deleted"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:52:14 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"32c32ff7-c689-4f38-b479-aa20da3c1efd","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/subsections/:subsection","host":["{{host}}"],"path":["v2","subsections",":subsection"],"variable":[{"key":"subsection","value":"384","type":"string","description":"Id of the subsection to be deleted"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:01:44 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=99"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f69b5ff1-94f0-46d9-8378-777a02155674"}],"id":"2c8a1f47-a1d7-407e-bb95-97cb94043508","description":"

Request related to subsections

Subsections are thought to be used for clustering spaces, without the needing of them being in the same physical area or floor.

\n","event":[{"listen":"prerequest","script":{"id":"ab934299-5a98-4e2d-9ec1-b3d13f843cf2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"72b6d647-4cdc-4278-86fd-db762b0fcbd0","type":"text/javascript","exec":[""]}}],"_postman_id":"2c8a1f47-a1d7-407e-bb95-97cb94043508","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"user","item":[{"name":"configured system alarms","item":[{"name":"get configured system alarms for user","id":"cc2a29fd-52ec-4bf1-9587-b249a5dfe750","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/user/configuredSystemAlarms","description":"

Returns the configured system alarms for the user.

Alarms can be filtered by type, but currently, only Proximty Alarms are supported.

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token

Configure a system alarm for the user.

Body fields:

alarmType: Required. String. Type of the alarm. Currently only \"Proximity\" is supported

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
400 Bad Request	Missing required parameters
409 Conflict	User already has a configured alarm of the provided type

","urlObject":{"path":["v2","user","configuredSystemAlarms"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"ad66f358-1b48-4183-9e48-06b45ecd7bf7","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"alarmType\": \"Proximity\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/user/configuredSystemAlarms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 07:18:39 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 132,\n \"alarmType\": \"Proximity\",\n \"user\": 69,\n \"creationDate\": \"2022-02-16T07:18:39.519\",\n \"lastReadDate\": null\n}"},{"id":"05fa3492-8361-42a8-9ffd-e9adb18178fe","name":"400 Bad Request( wrong alarm type)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"alarmType\": \"Proximiti\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/user/configuredSystemAlarms"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 07:24:00 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":""},{"id":"6c8f705a-8cb2-4dcc-852f-fc33198d582b","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"alarmType\": \"Proximity\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/user/configuredSystemAlarms"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:59:17 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"22366617-339a-4637-a243-ef409bafc3dc","name":"409 Conflict","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"alarmType\": \"Proximity\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/user/configuredSystemAlarms"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 16:29:24 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"reason\": \"User already has systems alarms of type Proximity configured\"\n}"}],"_postman_id":"8b13a99d-30a7-43ca-aa32-aafb205d2b1f"},{"name":"modify last read date of configured system alarm","id":"8e73e9e1-0232-44b1-82b8-9c0f8efd8682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"lastReadDate\": \"2021-12-10T00:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/user/configuredSystemAlarms/:configuredId","description":"

Modify the last read date of the configured system alarm

Body fields:

lastReadDate: Required. Date in format yyyy-MM-dd-HH:mm:ss. Last read date to be set for the alarm

The response could be one of:

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

200 OK
404 Not Found	System Alarm Id not found on database
400 Bad Request	Invalid parameters or missing required parameters
401 Unauthorized	Missing Bearer token

Id of the configured alarm to modify

\n","type":"text/plain"},"type":"string","value":"30","key":"configuredId"}]}},"response":[{"id":"c856eaa6-1437-46ad-9a64-27d15f60e714","name":"Ok","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"lastReadDate\": \"2022-01-16T00:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/user/configuredSystemAlarms/:configuredId","host":["{{host}}"],"path":["v2","user","configuredSystemAlarms",":configuredId"],"variable":[{"key":"configuredId","value":"132","type":"string","description":"Id of the configured alarm to modify"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 07:19:09 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 132,\n \"alarmType\": \"Proximity\",\n \"user\": 69,\n \"creationDate\": \"2022-01-10T07:18:39.519\",\n \"lastReadDate\": \"2022-01-16T00:00:00\"\n}"},{"id":"3565619e-4caa-4659-b08f-a407106c3e3f","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"lastReadDate\": \"2021-12-10T00:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/user/configuredSystemAlarms/:configuredId","host":["{{host}}"],"path":["v2","user","configuredSystemAlarms",":configuredId"],"variable":[{"key":"configuredId","value":"506","type":"string","description":"Id of the configured alarm to modify"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:59:26 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"abaaefb2-f263-481c-9b06-52c52e17b7dd","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"lastReadDate\": \"2021-12-10T00:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/user/configuredSystemAlarms/:configuredId","host":["{{host}}"],"path":["v2","user","configuredSystemAlarms",":configuredId"],"variable":[{"key":"configuredId","value":"400","type":"string","description":"Id of the configured alarm to modify"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 16 Feb 2022 07:20:32 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8e73e9e1-0232-44b1-82b8-9c0f8efd8682"},{"name":"delete system alarm configuration for user","id":"e08f8ad7-69e7-40d8-8534-bb361fe4efb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{host}}/v2/user/configuredSystemAlarms/:configuredId","description":"

Removes a configued system alarm for the user

The response could be one of:

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

200 OK
401 Unauthorized	Missing Bearer token
404 Not Found	System Alarm Id Not Found in database

","urlObject":{"path":["v2","user","configuredSystemAlarms",":configuredId"],"host":["{{host}}"],"query":[],"variable":[{"description":{"content":"

Id of the configured alarm to be deleted

\n","type":"text/plain"},"type":"string","value":"15","key":"configuredId"}]}},"response":[{"id":"e9bcad18-3748-4699-a940-2b7c66d1b4d4","name":"Ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/user/configuredSystemAlarms/:configuredId","host":["{{host}}"],"path":["v2","user","configuredSystemAlarms",":configuredId"],"variable":[{"key":"configuredId","value":"614","type":"string","description":"Id of the configured alarm to be deleted"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 16 Feb 2022 07:18:24 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"a8da09b6-9dab-4ef0-9919-2f0230831f05","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/user/configuredSystemAlarms/:configuredId","host":["{{host}}"],"path":["v2","user","configuredSystemAlarms",":configuredId"],"variable":[{"key":"configuredId","value":"716","type":"string","description":"Id of the configured alarm to be deleted"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:59:34 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"781081a1-7827-41d9-b512-b311588249f0","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{host}}/v2/user/configuredSystemAlarms/:configuredId","host":["{{host}}"],"path":["v2","user","configuredSystemAlarms",":configuredId"],"variable":[{"key":"configuredId","value":"292","type":"string","description":"Id of the configured alarm to be deleted"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:59:34 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e08f8ad7-69e7-40d8-8534-bb361fe4efb7"}],"id":"0b439a75-07f8-4d20-97a0-7f51394bdc61","description":"

Requests related to manadgement of the configured system alarms for the current authenticated user in the API

\n","event":[{"listen":"prerequest","script":{"id":"57f7c74d-f168-4e7f-81c0-2c3e12eecfbc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"17c375b8-d554-4cfa-9c7e-5c36799fd66e","type":"text/javascript","exec":[""]}}],"_postman_id":"0b439a75-07f8-4d20-97a0-7f51394bdc61","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}}],"id":"f89f2625-62db-4b22-ab4f-1c8ca155a6d7","description":"

Requests related to the current authenticated user in the module

\n","event":[{"listen":"prerequest","script":{"id":"18e6f005-aeb2-4a41-9150-4a246c9ad3de","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"131cd154-ff16-4905-82da-7ba1883422b2","type":"text/javascript","exec":[""]}}],"_postman_id":"f89f2625-62db-4b22-ab4f-1c8ca155a6d7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"users","item":[{"name":"get user module permissions","id":"4ec758ac-42ab-47d4-be74-604b28d345fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/users/:user/permissions","description":"

Gets the module permissions of the user.

UsersAdmin (Core module) permission is required

The result is an array of String with values:

AlarmsRead: Read permissions on alarms collection
AlarmsWrite: Write permissions on alarms collection
DevicesRead: Read permissions on alarms collection
DevicesWrite: Write permissions on devices collection
GraphicalAreasRead: Read permissions on graphical areas collection
GraphicalAreasWrite: Write permissions on graphical areas collection
SpacesRead: Read permissions on spaces, space types, subsections, and subsection types collections
SpacesWrite: Write permissions on spaces, space types, subsections, and subsection types collections
HistoricRead: Read permissions for historic requests

The response could be one of:

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

200 OK
403 Forbidden	UsersAdmin permission is required
400 Bad Request	User id not found in database
401 Unauthorized	Missing Bearer token

Id of the user to retrieve esite permissions

\n","type":"text/plain"},"type":"string","value":"21","key":"user"}]}},"response":[{"id":"03073c3e-ad7a-4fc8-b133-087b18e9a725","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/users/:user/permissions","host":["{{host}}"],"path":["v2","users",":user","permissions"],"variable":[{"key":"user","value":"773","type":"string","description":"Id of the user to retrieve esite permissions"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 07:25:43 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n \"AlarmsRead\",\n \"DevicesRead\",\n \"GraphicalAreasRead\",\n \"SpacesRead\",\n \"HistoricRead\"\n]"},{"id":"6ec1951a-b0d8-4ae0-805e-47a310c6776b","name":"400 Bad Request (user not found)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/users/:user/permissions","host":["{{host}}"],"path":["v2","users",":user","permissions"],"variable":[{"key":"user","value":"1","type":"string","description":"Id of the user to retrieve esite permissions"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:15:16 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":""},{"id":"15a33492-fc29-4935-b470-707f13d413cc","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/users/:user/permissions","host":["{{host}}"],"path":["v2","users",":user","permissions"],"variable":[{"key":"user","value":"337","type":"string","description":"Id of the user to retrieve esite permissions"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:59:45 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"ce9cf7b9-2165-4111-9984-065879d60bfe","name":"403 Forbidden","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v2/users/:user/permissions","host":["{{host}}"],"path":["v2","users",":user","permissions"],"variable":[{"key":"user","value":"399","type":"string","description":"Id of the user to retrieve esite permissions"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:59:45 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4ec758ac-42ab-47d4-be74-604b28d345fe"},{"name":"set user module permissions","id":"3916fb6f-2e8a-45e0-b29e-2d205bf029dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-audit-functionality","value":"35","description":"

Identifier of the funcionality. ModifyUserEsitePermits

\n","type":"text"},{"key":"x-audit-timestamp","value":"1775889872","description":"

Timestamp of the action

\n","type":"text"}],"body":{"mode":"raw","raw":"[\n \"AlarmsRead\",\n \"AlarmsWrite\",\n \"DevicesRead\",\n \"DevicesWrite\",\n \"GraphicalAreasRead\",\n \"GraphicalAreasWrite\",\n \"SpacesRead\",\n \"SpacesWrite\",\n \"HistoricRead\"\n]","options":{"raw":{"language":"json"}}},"url":"{{host}}/v2/users/:user/permissions","description":"

Change the esite module permissions for the user.

UsersAdmin (Core module) permission is required

The body is an array of permissions.

AlarmsRead: Read permissions on alarms collection
AlarmsWrite: Write permissions on alarms collection
DevicesRead: Read permissions on alarms collection
DevicesWrite: Write permissions on devices collection
GraphicalAreasRead: Read permissions on graphical areas collection
GraphicalAreasWrite: Write permissions on graphical areas collection
SpacesRead: Read permissions on spaces, space types, subsections, and subsection types collections
SpacesWrite: Write permissions on spaces, space types, subsections, and subsection types collections
HistoricRead: Read permissions for historic requests

The headers needed to audit this functionality are shown below:

x-audit-functionality: Identifier of the functionality permormed. In this case: 35 (ModifyUserEsitePermits)
x-audit-user: Identifier of the user that has permormed the functionality.
x-audit-timestamp: Timestamp of the performed functionality.

The response could be one of:

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

200 OK
403 Forbidden	UsersAdmin permission is required
401 Unauthorized	Missing Bearer token

Id of the user for whom modify permission

\n","type":"text/plain"},"type":"string","value":"1","key":"user"}]}},"response":[{"id":"3e65fe9d-8bea-417c-b209-f7dec8000291","name":"Ok","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\n \"AlarmsRead\",\n \"AlarmsWrite\",\n \"GraphicalAreasRead\",\n \"GraphicalAreasWrite\",\n \"HistoricRead\"\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/users/:user/permissions","host":["{{host}}"],"path":["v2","users",":user","permissions"],"variable":[{"key":"user","value":"301","type":"string","description":"Id of the user for whom modify permission"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Feb 2022 09:18:37 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n \"AlarmsRead\",\n \"AlarmsWrite\",\n \"GraphicalAreasRead\",\n \"GraphicalAreasWrite\",\n \"HistoricRead\"\n]"},{"id":"f0663682-2769-437a-8363-fd04f4696bcb","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\n \"AlarmsRead\",\n \"AlarmsWrite\",\n \"DevicesRead\",\n \"DevicesWrite\",\n \"GraphicalAreasRead\",\n \"GraphicalAreasWrite\",\n \"SpacesRead\",\n \"SpacesWrite\",\n \"HistoricRead\"\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/users/:user/permissions","host":["{{host}}"],"path":["v2","users",":user","permissions"],"variable":[{"key":"user","value":"618","type":"string","description":"Id of the user for whom modify permission"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:59:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null},{"id":"c2e71d0b-5ab7-46d0-8171-be420036edbc","name":"403 Forbidden","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\n \"AlarmsRead\",\n \"AlarmsWrite\",\n \"DevicesRead\",\n \"DevicesWrite\",\n \"GraphicalAreasRead\",\n \"GraphicalAreasWrite\",\n \"SpacesRead\",\n \"SpacesWrite\",\n \"HistoricRead\"\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v2/users/:user/permissions","host":["{{host}}"],"path":["v2","users",":user","permissions"],"variable":[{"key":"user","value":"567","type":"string","description":"Id of the user for whom modify permission"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 15:59:52 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3916fb6f-2e8a-45e0-b29e-2d205bf029dd"}],"id":"c72bd457-6b6d-49e2-a0c8-88a01a0a18d8","description":"

Requests for manadgement of the different user permissions on the esite module.

Set permissions
List permissions

\n","event":[{"listen":"prerequest","script":{"id":"43c49c61-eb9d-46b9-b083-9e197bd17124","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7e66148f-7ce4-418e-b8f8-b606f0746342","type":"text/javascript","exec":[""]}}],"_postman_id":"c72bd457-6b6d-49e2-a0c8-88a01a0a18d8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"central","item":[{"name":"get devices","id":"08c1522c-ad92-4e00-af56-d66128d9bc43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/central/v1/devices","description":"

THIS IS AN EXAMPLE REQUEST OF CENTRAL API

Central API documentation is covered in another document.

Returns devices from central associated to this instance

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}},"urlObject":{"path":["central","v1","devices"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"942fd52f-50a5-41fb-8ea1-99e297c2ab02","name":"Ok","originalRequest":{"method":"GET","header":[],"url":"{{host}}/central/v1/devices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 07:25:59 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 26,\n \"physicalCode\": \"c9:7a:3f:69:74:a0\",\n \"hardwareVersion\": 4,\n \"firmwareVersion\": 4,\n \"entryDate\": \"2019-10-30T11:45:00\",\n \"optigaId\": \"000000000000000000000000000000000000000000000000000000\",\n \"pendingOta\": false,\n \"instance\": 1,\n \"type\": \"Node\",\n \"parent\": null,\n \"rssi\": null\n },\n {\n \"id\": 56,\n \"physicalCode\": \"93:27:15:5e:d0:2f\",\n \"hardwareVersion\": 3,\n \"firmwareVersion\": 3,\n \"entryDate\": \"2019-10-31T16:36:02\",\n \"optigaId\": \"000000000000000000000000000000000000000000000000000000\",\n \"pendingOta\": false,\n \"instance\": 1,\n \"type\": \"Gateway\",\n \"parent\": null,\n \"rssi\": null\n },\n {\n \"id\": 269,\n \"physicalCode\": \"e6:f2:3b:5b:28:70\",\n \"hardwareVersion\": 3,\n \"firmwareVersion\": 26,\n \"entryDate\": \"2019-12-13T07:31:12\",\n \"optigaId\": \"CD16336B01001C000100000A0852550011002D0046801010711118\",\n \"pendingOta\": false,\n \"instance\": 1,\n \"type\": \"Gateway\",\n \"parent\": null,\n \"rssi\": null\n }\n]"},{"id":"4c87693d-d292-4d75-aab5-0f9c440e5238","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"{{host}}/central/v1/devices"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 16:00:01 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"08c1522c-ad92-4e00-af56-d66128d9bc43"},{"name":"get device","id":"a7202bd7-4b95-48fd-8409-52a730f76442","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/central/v1/devices/:mac","description":"

THIS IS AN EXAMPLE REQUEST OF CENTRAL API

Central API documentation is covered in another document.

Returns device info from central

MAC Address of the device

\n","type":"text/plain"},"type":"string","value":"00124B0015868D15","key":"mac"}]}},"response":[{"id":"c1986a0f-7522-4dc5-ab8a-36ef6b299e4a","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/central/v1/devices/:mac","host":["{{host}}"],"path":["central","v1","devices",":mac"],"variable":[{"key":"mac","value":"00124B0015868D15","type":"string","description":"MAC Address of the device"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Feb 2022 07:26:45 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 26,\n \"physicalCode\": \"00124B0015868D15\",\n \"hardwareVersion\": 4,\n \"firmwareVersion\": 4,\n \"entryDate\": \"2019-10-30T11:45:00\",\n \"optigaId\": \"000000000000000000000000000000000000000000000000000000\",\n \"pendingOta\": false,\n \"instance\": 1,\n \"type\": \"Node\",\n \"parent\": null,\n \"rssi\": null\n}"},{"id":"36087b5a-a6b9-4c8e-98b8-84c7e3907f37","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/central/v1/devices/:mac","host":["{{host}}"],"path":["central","v1","devices",":mac"],"variable":[{"key":"mac","value":"77:24:e6:9e:4f:a7","type":"string","description":"MAC Address of the device"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 14 Feb 2022 16:00:09 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"0"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a7202bd7-4b95-48fd-8409-52a730f76442"}],"id":"21026dca-bde5-4f0f-9c69-135932de9038","description":"

Requests in this folder are forwarded to central server via central proxy.

Central is the esite submodule focused on manadgement and installment of the space's sensors. Central has its own separate API endpoints.

\n","_postman_id":"21026dca-bde5-4f0f-9c69-135932de9038","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"health","item":[{"name":"get health","id":"50799a53-ad27-48c9-a426-bb320bd72a64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/v2/health","description":"

Checks if Habität eSite module is running normally. If the response has a status code of 200 OK the service is correctly working. Elsewhere, there is some issue with the service that needs to be addressed.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"98bb8b3f-6917-4fa5-807e-9af66dfc1956","id":"98bb8b3f-6917-4fa5-807e-9af66dfc1956","name":"health","type":"folder"}},"urlObject":{"path":["v2","health"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"080fc526-cf9c-4d78-9098-39b0ac08c26d","name":"Ok","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v2/health"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 16 Feb 2022 07:27:02 GMT"},{"key":"Server","value":"esite-api/2.2.0"},{"key":"X-Implementation-Version","value":"2.2.0"},{"key":"Access-Control-Expose-Headers","value":"X-Implementation-Version"},{"key":"Content-Length","value":"2"},{"key":"Content-Type","value":"text/plain; charset=UTF-8"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"50799a53-ad27-48c9-a426-bb320bd72a64"}],"id":"98bb8b3f-6917-4fa5-807e-9af66dfc1956","description":"

Requests that allow to monitorize the status of the service.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"2f5cdba8-cd32-4544-a918-9c3aa8cf5dac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7aec4c2d-f20a-46f8-a075-5809fd62dd6b","type":"text/javascript","exec":[""]}}],"_postman_id":"98bb8b3f-6917-4fa5-807e-9af66dfc1956"},{"name":"zones","item":[],"id":"7b522529-8163-4566-a8d8-098f70967ccc","_postman_id":"7b522529-8163-4566-a8d8-098f70967ccc","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}}},{"name":"Update URI","id":"b387f405-033d-4175-a4d4-dbe2711d35c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"value\":\"coap://52.17.230.33:5684/eSite/tiny-bad-crc.bin\"}","options":{"raw":{"language":"json"}}},"url":"https://habitatworkspace.com/habitat/esite/central/api/v1/devices/:mac/lwm2m/firmwareVersion","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","id":"2de37ba2-9b92-44c5-9f63-31f311d2e488","name":"Esite Api","type":"collection"}},"urlObject":{"protocol":"https","path":["habitat","esite","central","api","v1","devices",":mac","lwm2m","firmwareVersion"],"host":["habitatworkspace","com"],"query":[],"variable":[{"description":{"content":"

00124B001597B6DB / 00124B001597CC5D

\n","type":"text/plain"},"type":"any","value":"00124B001597CC5D","key":"mac"}]}},"response":[],"_postman_id":"b387f405-033d-4175-a4d4-dbe2711d35c8"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"f1a746c3-4914-41b6-afbf-e901814d1f91","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bfc763f-7949-489b-876c-2e05f46c771c","type":"text/javascript","exec":[""]}}],"variable":[{"key":"user","value":"myuser@mydomain.com"},{"key":"password","value":"P@ssw0rd"},{"key":"api-key","value":"123456"},{"key":"device","value":"12345FGH2"},{"key":"floor","value":"1"},{"key":"space","value":"1"}]}