{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"76b69baa-2171-4425-81b3-6082a3147354","name":"Amatis Public API","description":"### Introduction\n\nWelcome to the Amatis Controls API documentation! This guide is your resource for understanding and interacting with the powerful Amatis Controls system. Whether you’re looking to control devices, manage scenes, or retrieve detailed information about your site’s architecture, this API is designed to provide you with the tools and flexibility needed to optimize your operations.\n\n---\n\n### **Understanding the Amatis Controls Site Architecture**\n\nThe Amatis Controls system is built on a hierarchical structure to ensure seamless organization and control. At the top level, you’ll find the **site**, which serves as the primary container for all locations. Within a site, you can have **locations**, which may represent floors, rooms, or other organizational units. Locations can further be divided into **sub-locations** (sometimes utilized as **zones**).\n\n#### **IDs and Parent IDs**\n\nEach location has a unique **ID** and a **parent ID** (except for the main site, which only has an ID). These IDs are used throughout the API to manage and query locations effectively.\n\n#### **Example Architectures**\n\n##### **Simple School Setup**\n\n- **Site:** School (id: site_001)\n    \n    - **Location:** Floor 1 (id: loc_001, parent_id: site_001)\n        \n        - **Sub-location:** Classroom 101 (id: sub_001, parent_id: loc_001)\n            \n        - **Sub-locatios:** Classroom 101 (id: sub_002, parent_id: loc_001)\n            \n\nEach classroom is treated as a single sub-location (zone), with all devices grouped together under one control point. Since the classroom lighting is intended to operate as a whole, there is no need to further subdivide the devices into additional zones or sub-locations.\n\n##### **Complex Medical Office**\n\n- **Site:** Medical Center (id: site_001)\n    \n    - **Location:** Floor 1 (id: loc_001, parent_id: site_001)\n        \n        - **Sub-location:** Exam Room 101 (id: sub_001, parent_id: loc_001)\n            \n            - **Sub-location (zone):** Exam Lights (id: sub_002, parent_id: sub_001)\n                \n            - **Sub-location (zone):** Room Lights (id: sub_003, parent_id: sub_001)\n                \n        - **Sub-location:** Exam Room 102 (id: sub_004, parent_id: loc_001)\n            \n            - **Sub-location (zone):** Exam Lights (id: sub_005, parent_id: sub_004)\n                \n            - **Sub-location (zone):** Room Lights (id: sub_006, parent_id: sub_004)\n                \n\nIn this example, the exam rooms each have two distinct lighting sub-locations (zones) for “Exam Lights” and “Room Lights,” allowing for discrete control of these areas. Despite this separation, these zones behave just like any other sub-location within the hierarchy. Additionally, scenes can be programmed into higher-level locations, such as “Exam Room 101.” These scenes can control the lights in both of its sub-locations, “Exam Lights” and “Room Lights,” simultaneously. This flexibility allows for streamlined control of multiple lighting zones while maintaining the ability for individual adjustments when needed.\n\nWith this structure, you can organize devices and scenes across a wide variety of use cases, from simple configurations to complex setups with nested sub-locations. The architecture ensures that higher-level locations can manage or influence the sub-locations beneath them, enabling centralized or distributed control as needed.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"63727","team":11092,"collectionId":"76b69baa-2171-4425-81b3-6082a3147354","publishedId":"2sAYJ1jMuh","public":true,"publicUrl":"https://ambr-api.amatiscontrols.com","privateUrl":"https://go.postman.co/documentation/63727-76b69baa-2171-4425-81b3-6082a3147354","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Luum/Amatis Cloud API"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-12-20T14:55:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Luum/Amatis Cloud API","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Amatis API Public Environment","id":"dd2a74a3-cb77-4d0d-8c11-2a35beccaf67","owner":"17259446","values":[{"key":"AUTH-TOKEN","value":"","enabled":true,"type":"default"},{"key":"LOCATIONID","value":"","enabled":true,"type":"default"},{"key":"SERVER","value":"https://api.amatiscontrols.com","enabled":true,"type":"default"},{"key":"SITEID","value":"c45","enabled":true,"type":"default"},{"key":"HEADER-AUTH-TOKEN","value":"","enabled":true,"type":"any"},{"key":"LINK-ID","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8693b654c3eaf53edf2982adb9bd0d737f25af4241027f6b1f4b2d7e6cbb9afd","favicon":"https://res.cloudinary.com/postman/image/upload/v1581079907/team/hwlqowna9x7jatjyebhj.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Amatis API Public Environment","value":"17259446-dd2a74a3-cb77-4d0d-8c11-2a35beccaf67"}],"canonicalUrl":"https://ambr-api.amatiscontrols.com/view/metadata/2sAYJ1jMuh"}