{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d28a505c-8e84-450a-85e2-9f1de8012e0f","name":"ENSIMS Web API","description":"ENSIMS Web Service API collection\n\nVersion 1.1, © 2020, 2024 [Energy Simulation Solutions Ltd](https://www.ensims.com/)\n\n## Overview\n\n<img src=\"https://www.jeplus.org/wiki/lib/exe/fetch.php?media=docs:jea:webservice.jpg\">\n\nThe ENSIMS Web Service platform is accessible using a RESTful API, which is detailed in the corresponding sections.\n\n- [Users API](https://go.postman.co/workspace/ENSIMS-JESS%2FJEA%2FJBODY-Web-API~80053da7-d320-413f-8616-29d4adb8db5e/documentation/1290610-d28a505c-8e84-450a-85e2-9f1de8012e0f?entity=folder-0dcb474f-7712-43bd-ab0f-f0e1166f3664) - Authentication, account management, file upload/download\n    \n- [JESS API ](https://go.postman.co/workspace/ENSIMS-JESS%252FJEA%252FJBODY-Web-API~80053da7-d320-413f-8616-29d4adb8db5e/documentation/1290610-d28a505c-8e84-450a-85e2-9f1de8012e0f?entity=folder-07b4a406-3f93-4233-9fbb-b2591e1bd711) \\- Online simulation service for EnergyPlus, jEPlus and Radiance/Daysim\n    \n- [JEA API](https://go.postman.co/workspace/ENSIMS-JESS%252FJEA%252FJBODY-Web-API~80053da7-d320-413f-8616-29d4adb8db5e/documentation/1290610-d28a505c-8e84-450a-85e2-9f1de8012e0f?entity=folder-98513fb9-3838-4775-9b08-8d61e985f1e2) - Parametric, sensitivity analysis, optimisation engine\n    \n- [JBODY API](https://go.postman.co/workspace/ENSIMS-JESS%252FJEA%252FJBODY-Web-API~80053da7-d320-413f-8616-29d4adb8db5e/documentation/1290610-d28a505c-8e84-450a-85e2-9f1de8012e0f?entity=folder-11cf7311-d71d-4fea-800c-c98a34920b31) - Web-based interface for the Fiala human thermoregulatory model\n    \n\n## **Getting started guide**\n\nTo start using the ENSIMS Web API, you need to -\n\n- Create an account on the [ENSIMS Web Portal](https://app.ensims.com).\n    \n- To access the JESS API, you also need to request a new, or link an existing, JESS account to your ENSIMS account.\n    \n- The API only responds to HTTPS-secured communications.\n    \n- The API returns most of the request responses in JSON format. When an API request returns an error, the JSON response's 'ok' field will be false, and the 'status' field may provide further information.\n    \n\n## Authentication\n\nThe ENSIMS Web API uses JWT session_token in cookies for authentication. You start with the \"auth\" operation to obtain a new session_token with your credentials; and then send the token along (as a cookie) in all further requests. A token has a life span of approximately 24 hours. You can refresh the token with a \"checkin\" request.\n\n### Authentication error response\n\nIf a session _token is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.\n\n### 503 response\n\nAn HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/).\n\n### **Need some help?**\n\n\\[In case you have questions, go through our tutorials ((link to your video or help documentation here)). Or visit our FAQ page ((link to the relevant page)).\n\nOr you can check out our community forum, there’s a good chance our community has an answer for you. Visit our developer forum ((link to developer forum)) to review topics, ask questions, and learn from others.\\]","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1290610","collectionId":"d28a505c-8e84-450a-85e2-9f1de8012e0f","publishedId":"2sA3kYhKCW","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1290610/2sA3kYhKCW","privateUrl":"https://go.postman.co/documentation/1290610-d28a505c-8e84-450a-85e2-9f1de8012e0f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Building performance simulation, optimisation, parametric analysis, sensitivity analysis, uncertainty analysis, EnergyPlus, Radiance, DaySim, jEPlus, Fiala model, digital mannequin, online service, accelerated simulation, REST API, and example code snippets."},{"name":"title","value":"API Documentation of Energy Simulation Solutions (ENSIMS) JESS, JEA and JBODY services"}],"appearance":{"default":"light","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-07-25T13:01:28.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"API Documentation of Energy Simulation Solutions (ENSIMS) JESS, JEA and JBODY services","description":"Building performance simulation, optimisation, parametric analysis, sensitivity analysis, uncertainty analysis, EnergyPlus, Radiance, DaySim, jEPlus, Fiala model, digital mannequin, online service, accelerated simulation, REST API, and example code snippets."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"JESS Web Public","id":"8177a3cc-7b91-4345-8af9-d5d3f08b2e36","owner":"1290610","values":[{"key":"api_key","value":"AAAA","enabled":true,"type":"secret"},{"key":"session_key","value":"user@email.com","enabled":true,"type":"secret"},{"key":"root_url","value":"https://api.ensims.com","enabled":true,"type":"default"},{"key":"admin_user","value":"user@email.com","enabled":true,"type":"secret"},{"key":"admin_pwd","value":"AAAA","enabled":true,"type":"secret"},{"key":"test_user","value":"","enabled":false,"type":"default"},{"key":"test_pwd","value":"","enabled":false,"type":"default"},{"key":"session_token","value":"eyJraWQiOiIxNTAxNjg3OTIzMDE4IiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJqZXNzLmVuc2ltcy5jb20iLCJhdWQiOiJKRVNTIEFQSSBjbGllbnRzIiwiZXhwIjoxNzE5NDg1OTQwLCJqdGkiOiJYaTBmMWlua0tWdi1NVEtxU3VIRDR3IiwiaWF0IjoxNzE5Mzk4NTMzLCJuYmYiOjE3MTkzOTg0MTMsInN1YiI6IllpIiwiZW1haWwiOiJ5aUBqZXBsdXMub3JnIiwibGlmZXNwYW4iOiIxNDQwIn0.RznoM7ZywN513zS2xQ1gTPY3vqdRgnsloEmcnnqn9EqxGkBgMrPBzwUCHNxTP4sWfVE9J4gHa2s_lJ3moDy8P7x8A1liUipL5BxwqqBN4BemPH7wX2HpTjfTEUUa625qDbZsfTgfFnMsaEP-i0fVT_6xDOH1_UJWEJX4XVxaHWzkhVv0o_lXFZrqsp4HEPe3H3R3wKDQx1pVjneSTqABe3q6plwyzZFvgOFZThSWtGD3VBj9394MJXZLV73lqzpI75YpdavhbowXoqjTDbj6AGmF1gKYbJ4ARz-TE58SQIlCR8m_0vNwKqBIyh4GDvtGnOlM5XHLiWnw1vD0FZB0hw","enabled":true,"type":"secret"},{"key":"jess_user","value":"BBBB","enabled":true,"type":"secret"},{"key":"jess_pwd","value":"XXXX","enabled":true,"type":"secret"}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"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":"JESS Web Public","value":"1290610-8177a3cc-7b91-4345-8af9-d5d3f08b2e36"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3kYhKCW"}