{"docs":{"name":"Asset Score/Audit Template","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/apidoc/v2","api_url":"/api","resources":{"building_sync":{"doc_url":"/apidoc/v2/building_sync","id":"building_sync","api_url":"/api/building_sync","name":"Building sync","short_description":"BuildingSync","full_description":"\n\u003cp\u003eServices relating to BuildingSync.\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/building_sync/download","name":"download","apis":[{"api_url":"/api/v2/building_sync/download/rp/buildings/:id","http_method":"GET","short_description":"Export the building with the given ID.  Response for a successful request is a BuildingSync XML document.","deprecated":null},{"api_url":"/api/v2/building_sync/download/rp/nyc/properties/:id","http_method":"GET","short_description":"Export the NYC property with the given ID.  Response for a successful request is a BuildingSync XML document.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/building_sync/upload","name":"upload","apis":[{"api_url":"/api/v2/building_sync/upload","http_method":"POST","short_description":"Import Buildings.  Response for a successful request is an object with the assigned unique IDs for the new buildings.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"audit_file","full_name":"audit_file","description":"\n\u003cp\u003eThe BuildingSync XML document.  Validated against the BuildingSync XML schema document.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a File","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buildings":{"doc_url":"/apidoc/v2/buildings","id":"buildings","api_url":"/api/buildings","name":"Buildings","short_description":"Buildings","full_description":"\n\u003cp\u003eServices relating to buildings\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/buildings/recommendations","name":"recommendations","apis":[{"api_url":"/api/v2/buildings/:id/recommendations","http_method":"GET","short_description":"Find all measures that are applicable for the building wth the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[{"code":200,"description":"OK","is_array":true,"returns_object":[{"name":"recommendation_id","full_name":"recommendation_id","description":"\n\u003cp\u003eThe unique identifier for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"recommendation","full_name":"recommendation","description":"\n\u003cp\u003eThe description of the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"cost","full_name":"cost","description":"\n\u003cp\u003eThe qualitative cost of the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"end_use","full_name":"end_use","description":"\n\u003cp\u003eThe end use for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"end_use_subcategory","full_name":"end_use_subcategory","description":"\n\u003cp\u003eThe end use subcategory for the measure recommendation.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"energy_savings","full_name":"energy_savings","description":"\n\u003cp\u003eThe qualitative energy savings for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"upgrade_guide","full_name":"upgrade_guide","description":"\n\u003cp\u003eThe URL for the “Learn more” upgrade guide for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/envelope","name":"envelope","apis":[{"api_url":"/api/v2/buildings/:id/envelope","http_method":"GET","short_description":"Download the envelope evaluation JSON file for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_one_eio","name":"model_one_eio","apis":[{"api_url":"/api/v2/buildings/:id/model_one_eio","http_method":"GET","short_description":"Download the current/proposed Energy Plus model for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_one_html","name":"model_one_html","apis":[{"api_url":"/api/v2/buildings/:id/model_one_html","http_method":"GET","short_description":"Download the current/proposed Energy Plus model summary for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_one_idf","name":"model_one_idf","apis":[{"api_url":"/api/v2/buildings/:id/model_one_idf","http_method":"GET","short_description":"Download the current/proposed IDF file for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_one_osm","name":"model_one_osm","apis":[{"api_url":"/api/v2/buildings/:id/model_one_osm","http_method":"GET","short_description":"Download the current/proposed Open Studio model for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_one_xml","name":"model_one_xml","apis":[{"api_url":"/api/v2/buildings/:id/model_one_xml","http_method":"GET","short_description":"Download the current/proposed Open Studio model summary for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_one_zip","name":"model_one_zip","apis":[{"api_url":"/api/v2/buildings/:id/model_one_zip","http_method":"GET","short_description":"Download the ZIP archive of the current/proposed Energy Plus model for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_two_eio","name":"model_two_eio","apis":[{"api_url":"/api/v2/buildings/:id/model_two_eio","http_method":"GET","short_description":"Download the recommended/baseline Energy Plus model for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_two_html","name":"model_two_html","apis":[{"api_url":"/api/v2/buildings/:id/model_two_html","http_method":"GET","short_description":"Download the recommended/baseline Energy Plus model summary for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_two_idf","name":"model_two_idf","apis":[{"api_url":"/api/v2/buildings/:id/model_two_idf","http_method":"GET","short_description":"Download the recommended/baseline IDF file for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_two_osm","name":"model_two_osm","apis":[{"api_url":"/api/v2/buildings/:id/model_two_osm","http_method":"GET","short_description":"Download the recommended/baseline Open Studio model for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_two_xml","name":"model_two_xml","apis":[{"api_url":"/api/v2/buildings/:id/model_two_xml","http_method":"GET","short_description":"Download the recommended/baseline Open Studio model summary for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/model_two_zip","name":"model_two_zip","apis":[{"api_url":"/api/v2/buildings/:id/model_two_zip","http_method":"GET","short_description":"Download the ZIP archive of the recommended/baseline Energy Plus model for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/report","name":"report","apis":[{"api_url":"/api/v2/buildings/:id/report","http_method":"GET","short_description":"Download the PDF report for the building with the given ID (owned by the current user or shared with the current user).","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/index","name":"index","apis":[{"api_url":"/api/v2/rp/buildings","http_method":"GET","short_description":"All Buildings.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eThe number of results per page (max 100). Default: 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of the results to fetch. Default: 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_type","full_name":"report_type","description":"\n\u003cp\u003eSpecifies the audit report type for the results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eSpecifies the submission status for the results. Can be one of: “Editing”, “Submitted”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ownership","full_name":"ownership","description":"\n\u003cp\u003eSpecifies the ownership for the results you want returned. Can be one of: “Mine”, “Shared”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/show","name":"show","apis":[{"api_url":"/api/v2/rp/buildings/:id","http_method":"GET","short_description":"One Building","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/validate","name":"validate","apis":[{"api_url":"/api/v2/rp/buildings/:id/validate","http_method":"GET","short_description":"Validate One Building","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings/submit_to_city","name":"submit_to_city","apis":[{"api_url":"/api/v2/rp/buildings/:id/submit_to_city","http_method":"POST","short_description":"Submit to City","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"comment","description":"\n\u003cp\u003eAdditional comments for submission.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"buildings_offline":{"doc_url":"/apidoc/v2/buildings_offline","id":"buildings_offline","api_url":"/api/buildings_info","name":"Buildings offline","short_description":"Buildings","full_description":"\n\u003cp\u003eServices relating to buildings\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/buildings_offline/index","name":"index","apis":[{"api_url":"/api/api/v2/rp/buildings_offline","http_method":"GET","short_description":"All Buildings.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eThe number of results per page (max 100). Default: 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of the results to fetch. Default: 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_type","full_name":"report_type","description":"\n\u003cp\u003eSpecifies the audit report type for the results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eSpecifies the submission status for the results. Can be one of: “Editing”, “Submitted”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ownership","full_name":"ownership","description":"\n\u003cp\u003eSpecifies the ownership for the results you want returned. Can be one of: “Mine”, “Shared”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"recent_updates","full_name":"recent_updates","description":"\n\u003cp\u003eSpecifies the number of recently updated buildings to fetch.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings_offline/facilities","name":"facilities","apis":[{"api_url":"/api/api/v2/rp/buildings_offline/:id/facilities","http_method":"GET","short_description":"Get all facilities for a building","deprecated":null},{"api_url":"/api/api/v2/rp/buildings_offline/:id/facilities","http_method":"PATCH","short_description":"Add or edit a facility","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"heating_plants","full_name":"heating_plants","description":"\n\u003cp\u003eHeating plant attributes (see model for full list)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of Hash","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"cooling_plants","full_name":"cooling_plants","description":"\n\u003cp\u003eCooling plant attributes (see model for full list)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of Hash","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"condenser_plants","full_name":"condenser_plants","description":"\n\u003cp\u003eCondenser plant attributes (see model for full list)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of Hash","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hvac_systems","full_name":"hvac_systems","description":"\n\u003cp\u003eHVAC system attributes (see model for full list)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of Hash","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"pump_systems","full_name":"pump_systems","description":"\n\u003cp\u003ePump system attributes (see model for full list)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of Hash","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/buildings_offline/show","name":"show","apis":[{"api_url":"/api/v2/rp/buildings_offline/:id","http_method":"GET","short_description":"One Building","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"cities":{"doc_url":"/apidoc/v2/cities","id":"cities","api_url":"/api/cities","name":"Cities","short_description":"Cities","full_description":"\n\u003cp\u003eServices relating to cities\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/cities/create_user","name":"create_user","apis":[{"api_url":"/api/v2/rp/cities/:id/users","http_method":"POST","short_description":"Register a user account.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"\n\u003cp\u003eThe new user.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"first_name","full_name":"user[first_name]","description":"\n\u003cp\u003eThe new user\u0026#39;s first name.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"user[last_name]","description":"\n\u003cp\u003eThe new user\u0026#39;s last name.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"user[email]","description":"\n\u003cp\u003eThe new user\u0026#39;s email address.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eThe new user\u0026#39;s password.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/cities/set_user_organization","name":"set_user_organization","apis":[{"api_url":"/api/v2/rp/cities/:id/users/assign","http_method":"POST","short_description":"Assign a user to the city's organization.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"\n\u003cp\u003eThe user.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"email","full_name":"user[email]","description":"\n\u003cp\u003eThe user\u0026#39;s email address.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/cities/index","name":"index","apis":[{"api_url":"/api/v2/rp/cities","http_method":"GET","short_description":"All cities","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eThe number of results per page (max 100). Default: 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of the results to fetch. Default: 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/cities/show","name":"show","apis":[{"api_url":"/api/v2/rp/cities/:id","http_method":"GET","short_description":"All submissions for city.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eThe number of results per page (max 100). Default: 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of the results to fetch. Default: 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_type","full_name":"report_type","description":"\n\u003cp\u003eSpecifies the audit report type for the results.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eSpecifies the submission status for the results. Can be one of: “Received”, “Pending”, “Rejected”, “Complies”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003eSpecifies the minimum date of submissions for the results. Must be an ISO 8601 date (YYYY-MM-DD).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/^[0-9]{4}-(?:1[0-2]|0[1-9])-(?:3[0-1]|2[0-9]|1[0-9]|0[1-9]){2}$/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"cities_reports":{"doc_url":"/apidoc/v2/cities_reports","id":"cities_reports","api_url":"/api/cities/:city_id/reports","name":"Cities reports","short_description":"Reports","full_description":"\n\u003cp\u003eServices relating to reports\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/cities_reports/index","name":"index","apis":[{"api_url":"/api/v2/rp/cities/:city_id/reports","http_method":"GET","short_description":"All reports","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eThe number of results per page (max 100). Default: 50\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of the results to fetch. Default: 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/cities_reports/show","name":"show","apis":[{"api_url":"/api/v2/rp/cities/:city_id/reports/:id","http_method":"GET","short_description":"One report.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"submission_attachments":{"doc_url":"/apidoc/v2/submission_attachments","id":"submission_attachments","api_url":"/api/buildings/:building_id/attachments","name":"Submission attachments","short_description":"Submission Attachments","full_description":"\n\u003cp\u003eServices relating to submission attachments\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/submission_attachments/references","name":"references","apis":[{"api_url":"/api/v2/rp/buildings/:rp_building_id/attachments/references","http_method":"GET","short_description":"Submission attachment available references.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/submission_attachments/download","name":"download","apis":[{"api_url":"/api/v2/rp/buildings/:rp_building_id/attachments/:id/download","http_method":"GET","short_description":"Download submission attachment file.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/submission_attachments/index","name":"index","apis":[{"api_url":"/api/v2/rp/buildings/:rp_building_id/attachments","http_method":"GET","short_description":"All submission attachments.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/submission_attachments/show","name":"show","apis":[{"api_url":"/api/v2/rp/buildings/:rp_building_id/attachments/:id","http_method":"GET","short_description":"One submission attachment.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/submission_attachments/create","name":"create","apis":[{"api_url":"/api/v2/rp/buildings/:rp_building_id/attachments","http_method":"POST","short_description":"New Submission Attachment.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rp_submission_attachment","full_name":"rp_submission_attachment","description":"\n\u003cp\u003eThe submission attachment.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"attachment","full_name":"rp_submission_attachment[attachment]","description":"\n\u003cp\u003eThe uploaded file.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a File","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attachment_description","full_name":"rp_submission_attachment[attachment_description]","description":"\n\u003cp\u003eThe description.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attachment_other","full_name":"rp_submission_attachment[attachment_other]","description":"\n\u003cp\u003eThe “Other (Please Specify)” description.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attachment_reference_id","full_name":"rp_submission_attachment[attachment_reference_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attachment_reference_type","full_name":"rp_submission_attachment[attachment_reference_type]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/submission_attachments/destroy","name":"destroy","apis":[{"api_url":"/api/v2/rp/buildings/:rp_building_id/attachments/:id","http_method":"DELETE","short_description":"Delete one submission attachment.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The specified parameters MUST be valid for each service call.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"submissions":{"doc_url":"/apidoc/v2/submissions","id":"submissions","api_url":"/api/submissions","name":"Submissions","short_description":"Submissions","full_description":"\n\u003cp\u003eServices relating to submissions\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/submissions/show","name":"show","apis":[{"api_url":"/api/v2/rp/submissions/:id","http_method":"GET","short_description":"One submission.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/submissions/mark_as_compliant","name":"mark_as_compliant","apis":[{"api_url":"/api/v2/rp/submissions/:id/mark_as_compliant","http_method":"POST","short_description":"Mark submission as compliant.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/submissions/mark_as_pending","name":"mark_as_pending","apis":[{"api_url":"/api/v2/rp/submissions/:id/mark_as_pending","http_method":"POST","short_description":"Mark submission as pending.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/submissions/mark_as_received","name":"mark_as_received","apis":[{"api_url":"/api/v2/rp/submissions/:id/mark_as_received","http_method":"POST","short_description":"Mark submission as received.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/submissions/mark_as_rejected","name":"mark_as_rejected","apis":[{"api_url":"/api/v2/rp/submissions/:id/mark_as_rejected","http_method":"POST","short_description":"Mark submission as rejected.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"simple_buildings":{"doc_url":"/apidoc/v2/simple_buildings","id":"simple_buildings","api_url":"/api/simple_buildings","name":"Simple buildings","short_description":"Simple Buildings","full_description":"\n\u003cp\u003eServices relating to Quick Building Assessment Tool (QBAT) buildings.\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/simple_buildings/create","name":"create","apis":[{"api_url":"/api/v2/simple_buildings","http_method":"POST","short_description":"Create a new Quick Building Assessment Tool (QBAT) building. The response for a successful request is the assigned unique ID of the new building.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call.","metadata":null},{"code":422,"description":"Unprocessable Entity - The form data contains errors.","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"simple_building","full_name":"simple_building","description":"\n\u003cp\u003eThe form data for the new simple building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"address","full_name":"simple_building[address]","description":"\n\u003cp\u003eStreet\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"simple_building[city]","description":"\n\u003cp\u003eCity\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"simple_building[name]","description":"\n\u003cp\u003eBuilding Name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"notes","full_name":"simple_building[notes]","description":"\n\u003cp\u003eAdd notes about this building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_of_floors","full_name":"simple_building[number_of_floors]","description":"\n\u003cp\u003eNumber of Above Grade Floors\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"predominant_hvac_system_type_name","full_name":"simple_building[predominant_hvac_system_type_name]","description":"\n\u003cp\u003ePredominant HVAC System Type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eFour Pipe Fan Coil Unit\u003c/code\u003e, \u003ccode\u003ePackaged Terminal Air Conditioner\u003c/code\u003e, \u003ccode\u003ePackaged Terminal Heat Pump\u003c/code\u003e, \u003ccode\u003ePackaged VAV with Electric Reheat\u003c/code\u003e, \u003ccode\u003ePackaged VAV with Hot Water Reheat\u003c/code\u003e, \u003ccode\u003eRooftop Air Conditioner and Gas Furnace\u003c/code\u003e, \u003ccode\u003eRooftop Air Source Heat Pump\u003c/code\u003e, \u003ccode\u003eVAV with Electric Reheat\u003c/code\u003e, \u003ccode\u003eVAV with Hot Water Reheat\u003c/code\u003e, \u003ccode\u003eVRF\u003c/code\u003e, \u003ccode\u003eWarm Air Furnace\u003c/code\u003e, \u003ccode\u003eWater Loop Heat Pump\u003c/code\u003e, \u003ccode\u003eWindow AC + Baseboard\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_floor_area","full_name":"simple_building[reported_floor_area]","description":"\n\u003cp\u003eTotal Floor Area\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"shape_name","full_name":"simple_building[shape_name]","description":"\n\u003cp\u003eBuilding Shape\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eH-shape\u003c/code\u003e, \u003ccode\u003eL-shape\u003c/code\u003e, \u003ccode\u003eRectangle\u003c/code\u003e, \u003ccode\u003eU-shape\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state","full_name":"simple_building[state]","description":"\n\u003cp\u003eState\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eAK\u003c/code\u003e, \u003ccode\u003eAL\u003c/code\u003e, \u003ccode\u003eAR\u003c/code\u003e, \u003ccode\u003eAZ\u003c/code\u003e, \u003ccode\u003eCA\u003c/code\u003e, \u003ccode\u003eCO\u003c/code\u003e, \u003ccode\u003eCT\u003c/code\u003e, \u003ccode\u003eDC\u003c/code\u003e, \u003ccode\u003eDE\u003c/code\u003e, \u003ccode\u003eFL\u003c/code\u003e, \u003ccode\u003eGA\u003c/code\u003e, \u003ccode\u003eHI\u003c/code\u003e, \u003ccode\u003eIA\u003c/code\u003e, \u003ccode\u003eID\u003c/code\u003e, \u003ccode\u003eIL\u003c/code\u003e, \u003ccode\u003eIN\u003c/code\u003e, \u003ccode\u003eKS\u003c/code\u003e, \u003ccode\u003eKY\u003c/code\u003e, \u003ccode\u003eLA\u003c/code\u003e, \u003ccode\u003eMA\u003c/code\u003e, \u003ccode\u003eMD\u003c/code\u003e, \u003ccode\u003eME\u003c/code\u003e, \u003ccode\u003eMI\u003c/code\u003e, \u003ccode\u003eMN\u003c/code\u003e, \u003ccode\u003eMO\u003c/code\u003e, \u003ccode\u003eMS\u003c/code\u003e, \u003ccode\u003eMT\u003c/code\u003e, \u003ccode\u003eNC\u003c/code\u003e, \u003ccode\u003eND\u003c/code\u003e, \u003ccode\u003eNE\u003c/code\u003e, \u003ccode\u003eNH\u003c/code\u003e, \u003ccode\u003eNJ\u003c/code\u003e, \u003ccode\u003eNM\u003c/code\u003e, \u003ccode\u003eNV\u003c/code\u003e, \u003ccode\u003eNY\u003c/code\u003e, \u003ccode\u003eOH\u003c/code\u003e, \u003ccode\u003eOK\u003c/code\u003e, \u003ccode\u003eOR\u003c/code\u003e, \u003ccode\u003ePA\u003c/code\u003e, \u003ccode\u003eRI\u003c/code\u003e, \u003ccode\u003eSC\u003c/code\u003e, \u003ccode\u003eSD\u003c/code\u003e, \u003ccode\u003eTN\u003c/code\u003e, \u003ccode\u003eTX\u003c/code\u003e, \u003ccode\u003eUT\u003c/code\u003e, \u003ccode\u003eVA\u003c/code\u003e, \u003ccode\u003eVT\u003c/code\u003e, \u003ccode\u003eWA\u003c/code\u003e, \u003ccode\u003eWI\u003c/code\u003e, \u003ccode\u003eWV\u003c/code\u003e, \u003ccode\u003eWY\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_type_name","full_name":"simple_building[use_type_name]","description":"\n\u003cp\u003ePredominant Use Type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eEducation\u003c/code\u003e, \u003ccode\u003eMulti-family (4 floors or greater)\u003c/code\u003e, \u003ccode\u003eMulti-family (fewer than 4 floors)\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"year_of_construction","full_name":"simple_building[year_of_construction]","description":"\n\u003cp\u003eYear Completed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"zip_code","full_name":"simple_building[zip_code]","description":"\n\u003cp\u003eZip Code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[{"code":200,"description":"OK","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe ID of the building.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eThe name of the building.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"owner","full_name":"owner","description":"\n\u003cp\u003eThe user that owns the building.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"params":[{"name":"id","full_name":"owner[id]","description":"\n\u003cp\u003eThe ID of the user that owns the building.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"owner[email]","description":"\n\u003cp\u003eThe email address of the user that owns the building.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"first_name","full_name":"owner[first_name]","description":"\n\u003cp\u003eThe first name of the user that owns the building.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"owner[last_name]","description":"\n\u003cp\u003eThe last name of the user that owns the building.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"owner[organization]","description":"\n\u003cp\u003eThe organization to which the user that owns the building is assigned.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"owner[organization][id]","description":"\n\u003cp\u003eThe ID of the organization to which the user that owns the building is assigned.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"owner[organization][name]","description":"\n\u003cp\u003eThe name of the organization to which the user that owns the building is assigned.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"site_admin","full_name":"owner[site_admin]","description":"\n\u003cp\u003eSet to “true” if the user that owns the building is a site administrator.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"owner[type]","description":"\n\u003cp\u003eThe type of the user. Always: “User”\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eThe status of the building.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eEditing\u003c/code\u003e, \u003ccode\u003eRunning\u003c/code\u003e, \u003ccode\u003eRated\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003eThe timestamp for when the building was created.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003eThe timestamp for when the building was last modified.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true},{"name":"html_url","full_name":"html_url","description":"\n\u003cp\u003eThe URL for the building in the Asset Score tool.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"address","full_name":"address","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"city","full_name":"city","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"notes","full_name":"notes","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"number_of_floors","full_name":"number_of_floors","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"predominant_hvac_system_type_name","full_name":"predominant_hvac_system_type_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"reported_floor_area","full_name":"reported_floor_area","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"shape_name","full_name":"shape_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"state","full_name":"state","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"use_type_name","full_name":"use_type_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"year_of_construction","full_name":"year_of_construction","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"zip_code","full_name":"zip_code","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"simulations":{"doc_url":"/apidoc/v2/simulations","id":"simulations","api_url":"/api/buildings/:building_id/simulations","name":"Simulations","short_description":"Energy Asset - Simulations","full_description":"\n\u003cp\u003eSimulations relating to building simulation runs.\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/simulations/index","name":"index","apis":[{"api_url":"/api/v2/buildings/:building_id/simulations(:.format)","http_method":"GET","short_description":"Retrieve all simulation runs belonging to the building.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call. The user MUST be the owner of the building or the building MUST be shared with the user.","metadata":null},{"code":404,"description":"Not Found - The specified building is not available.","metadata":null},{"code":422,"description":"Unprocessable Entity - The form data contains errors.","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"OK","is_array":true,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe ID for the simulation run.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"rating","full_name":"rating","description":"\n\u003cp\u003eThe rating for the simulation run.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true},{"name":"simulation_started_at","full_name":"simulation_started_at","description":"\n\u003cp\u003eThe timestamp for when the simulation run was started.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true},{"name":"simulation_completed_at","full_name":"simulation_completed_at","description":"\n\u003cp\u003eThe timestamp for when the simulation run was completed.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true},{"name":"simulation_completion_type","full_name":"simulation_completion_type","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efailure because a full building simulation is not allowed\u003c/code\u003e, \u003ccode\u003efailure due to error\u003c/code\u003e, \u003ccode\u003efailure due to invalid building\u003c/code\u003e, \u003ccode\u003esuccess\u003c/code\u003e, \u003ccode\u003esuccess with alternate calculation method\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true},{"name":"measures","full_name":"measures","description":"\n\u003cp\u003eThe measure recommendations for the simulation run.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"recommendation_id","full_name":"measures[recommendation_id]","description":"\n\u003cp\u003eThe unique identifier for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recommendation","full_name":"measures[recommendation]","description":"\n\u003cp\u003eThe description of the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cost","full_name":"measures[cost]","description":"\n\u003cp\u003eThe qualitative cost of the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_use","full_name":"measures[end_use]","description":"\n\u003cp\u003eThe end use for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_use_subcategory","full_name":"measures[end_use_subcategory]","description":"\n\u003cp\u003eThe end use subcategory for the measure recommendation.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"energy_savings","full_name":"measures[energy_savings]","description":"\n\u003cp\u003eThe qualitative energy savings for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upgrade_guide","full_name":"measures[upgrade_guide]","description":"\n\u003cp\u003eThe URL for the “Learn more” upgrade guide for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/simulations/show","name":"show","apis":[{"api_url":"/api/v2/buildings/:building_id/simulations/:id(:.format)","http_method":"GET","short_description":"Retrieve one simulation run that belongs to the building.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call. The user MUST be the owner of the building or the building MUST be shared with the user.","metadata":null},{"code":404,"description":"Not Found - The specified building is not available.","metadata":null},{"code":422,"description":"Unprocessable Entity - The form data contains errors.","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"OK","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe ID for the simulation run.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"rating","full_name":"rating","description":"\n\u003cp\u003eThe rating for the simulation run.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true},{"name":"simulation_started_at","full_name":"simulation_started_at","description":"\n\u003cp\u003eThe timestamp for when the simulation run was started.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true},{"name":"simulation_completed_at","full_name":"simulation_completed_at","description":"\n\u003cp\u003eThe timestamp for when the simulation run was completed.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true},{"name":"simulation_completion_type","full_name":"simulation_completion_type","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efailure because a full building simulation is not allowed\u003c/code\u003e, \u003ccode\u003efailure due to error\u003c/code\u003e, \u003ccode\u003efailure due to invalid building\u003c/code\u003e, \u003ccode\u003esuccess\u003c/code\u003e, \u003ccode\u003esuccess with alternate calculation method\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true},{"name":"measures","full_name":"measures","description":"\n\u003cp\u003eThe measure recommendations for the simulation run.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"recommendation_id","full_name":"measures[recommendation_id]","description":"\n\u003cp\u003eThe unique identifier for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recommendation","full_name":"measures[recommendation]","description":"\n\u003cp\u003eThe description of the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cost","full_name":"measures[cost]","description":"\n\u003cp\u003eThe qualitative cost of the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_use","full_name":"measures[end_use]","description":"\n\u003cp\u003eThe end use for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_use_subcategory","full_name":"measures[end_use_subcategory]","description":"\n\u003cp\u003eThe end use subcategory for the measure recommendation.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"energy_savings","full_name":"measures[energy_savings]","description":"\n\u003cp\u003eThe qualitative energy savings for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upgrade_guide","full_name":"measures[upgrade_guide]","description":"\n\u003cp\u003eThe URL for the “Learn more” upgrade guide for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/simulations/create","name":"create","apis":[{"api_url":"/api/v2/buildings/:building_id/simulations(:.format)","http_method":"POST","short_description":"Enqueue one simulation run that belongs to the building.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - The \"token\" parameter MUST be provided for each service call. The user MUST be the owner of the building or the building MUST be shared with the user.","metadata":null},{"code":404,"description":"Not Found - The specified building is not available.","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recommendation_ids","full_name":"recommendation_ids","description":"\n\u003cp\u003eThe unique IDs for the recommendations to be applied to the building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"OK","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eThe ID for the simulation run.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"rating","full_name":"rating","description":"\n\u003cp\u003eThe rating for the simulation run.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true},{"name":"simulation_started_at","full_name":"simulation_started_at","description":"\n\u003cp\u003eThe timestamp for when the simulation run was started.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true},{"name":"simulation_completed_at","full_name":"simulation_completed_at","description":"\n\u003cp\u003eThe timestamp for when the simulation run was completed.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true},{"name":"simulation_completion_type","full_name":"simulation_completion_type","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efailure because a full building simulation is not allowed\u003c/code\u003e, \u003ccode\u003efailure due to error\u003c/code\u003e, \u003ccode\u003efailure due to invalid building\u003c/code\u003e, \u003ccode\u003esuccess\u003c/code\u003e, \u003ccode\u003esuccess with alternate calculation method\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true},{"name":"measures","full_name":"measures","description":"\n\u003cp\u003eThe measure recommendations for the simulation run.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"params":[{"name":"recommendation_id","full_name":"measures[recommendation_id]","description":"\n\u003cp\u003eThe unique identifier for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recommendation","full_name":"measures[recommendation]","description":"\n\u003cp\u003eThe description of the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cost","full_name":"measures[cost]","description":"\n\u003cp\u003eThe qualitative cost of the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_use","full_name":"measures[end_use]","description":"\n\u003cp\u003eThe end use for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_use_subcategory","full_name":"measures[end_use_subcategory]","description":"\n\u003cp\u003eThe end use subcategory for the measure recommendation.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"energy_savings","full_name":"measures[energy_savings]","description":"\n\u003cp\u003eThe qualitative energy savings for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upgrade_guide","full_name":"measures[upgrade_guide]","description":"\n\u003cp\u003eThe URL for the “Learn more” upgrade guide for the measure recommendation.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"additional_properties":false},{"code":422,"description":"Unprocessable Entity","is_array":false,"returns_object":[{"name":"building_id","full_name":"building_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true},{"name":"recommendation_ids","full_name":"recommendation_ids","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"table_downloads":{"doc_url":"/apidoc/v2/table_downloads","id":"table_downloads","api_url":"/api/table/exports","name":"Table downloads","short_description":"Table Exports","full_description":"\n\u003cp\u003eServices relating to table exports\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/table_downloads/index","name":"index","apis":[{"api_url":"/api/v2/table/exports","http_method":"GET","short_description":"All Table Exports.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"Not Found - The table export MUST be available to the current user.","metadata":null},{"code":422,"description":"Unprocessable Entity - The form data contains errors.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_downloads/show","name":"show","apis":[{"api_url":"/api/v2/table/exports/:id","http_method":"GET","short_description":"One Table Export.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The form data contains errors.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_downloads/download","name":"download","apis":[{"api_url":"/api/v2/table/exports/:id/download","http_method":"GET","short_description":"Download File for Table Export.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The form data contains errors.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_downloads/create","name":"create","apis":[{"api_url":"/api/v2/table/exports","http_method":"POST","short_description":"New Table Export.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"Not Found - The table export MUST be available to the current user.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rp_table_download","full_name":"rp_table_download","description":"\n\u003cp\u003eThe table export.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"rp_cities_report_id","full_name":"rp_table_download[rp_cities_report_id]","description":"\n\u003cp\u003eThe unique ID for the Audit Report.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_table_writer_format","full_name":"rp_table_download[rp_table_writer_format]","description":"\n\u003cp\u003eThe file format.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003exlsx\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rp_table_download_buildings_attributes","full_name":"rp_table_download[rp_table_download_buildings_attributes]","description":"\n\u003cp\u003eThe table export buildings.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"rp_building_id","full_name":"rp_table_download[rp_table_download_buildings_attributes][rp_building_id]","description":"\n\u003cp\u003eThe unique ID for the Audit Template building.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"rp_annual_summary_entries_count","full_name":"rp_table_download[rp_annual_summary_entries_count]","description":"\n\u003cp\u003eThe number of Annual Summaries per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_condenser_plants_count","full_name":"rp_table_download[rp_condenser_plants_count]","description":"\n\u003cp\u003eThe number of Condenser Plants per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_control_system_digitals_count","full_name":"rp_table_download[rp_control_system_digitals_count]","description":"\n\u003cp\u003eThe number of Control Systems (Digital) per Control System Package.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_control_system_packages_count","full_name":"rp_table_download[rp_control_system_packages_count]","description":"\n\u003cp\u003eThe number of Control System Packages per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_cooking_systems_count","full_name":"rp_table_download[rp_cooking_systems_count]","description":"\n\u003cp\u003eThe number of Cooking Systems per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_cooling_plants_count","full_name":"rp_table_download[rp_cooling_plants_count]","description":"\n\u003cp\u003eThe number of Cooling Plants per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_dishwasher_systems_count","full_name":"rp_table_download[rp_dishwasher_systems_count]","description":"\n\u003cp\u003eThe number of Dishwasher Systems per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_elevators_count","full_name":"rp_table_download[rp_elevators_count]","description":"\n\u003cp\u003eThe number of Elevators per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_energy_deliveries_count","full_name":"rp_table_download[rp_energy_deliveries_count]","description":"\n\u003cp\u003eThe number of Energy Deliveries per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_energy_meter_readings_count","full_name":"rp_table_download[rp_energy_meter_readings_count]","description":"\n\u003cp\u003eThe number of Energy Meter Readings per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_energy_savings_measures_count","full_name":"rp_table_download[rp_energy_savings_measures_count]","description":"\n\u003cp\u003eThe number of Energy Savings Measures per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_energy_savings_package_measures_count","full_name":"rp_table_download[rp_energy_savings_package_measures_count]","description":"\n\u003cp\u003eThe number of Energy Savings Measures per Energy Savings Package.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_energy_savings_packages_count","full_name":"rp_table_download[rp_energy_savings_packages_count]","description":"\n\u003cp\u003eThe number of Energy Savings Packages per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_energy_supply_sources_count","full_name":"rp_table_download[rp_energy_supply_sources_count]","description":"\n\u003cp\u003eThe number of Energy Supply Sources per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_energy_uses_count","full_name":"rp_table_download[rp_energy_uses_count]","description":"\n\u003cp\u003eThe number of Energy Uses per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_exterior_floors_count","full_name":"rp_table_download[rp_exterior_floors_count]","description":"\n\u003cp\u003eThe number of Exterior Floors per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_fan_systems_count","full_name":"rp_table_download[rp_fan_systems_count]","description":"\n\u003cp\u003eThe number of Fan Systems per HVAC System.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_fixtures_count","full_name":"rp_table_download[rp_fixtures_count]","description":"\n\u003cp\u003eThe number of Lighting Fixtures per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_fixtures_space_functions_count","full_name":"rp_table_download[rp_fixtures_space_functions_count]","description":"\n\u003cp\u003eThe number of Space Functions per Lighting Fixture.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_foundations_count","full_name":"rp_table_download[rp_foundations_count]","description":"\n\u003cp\u003eThe number of Foundations per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_heating_plants_count","full_name":"rp_table_download[rp_heating_plants_count]","description":"\n\u003cp\u003eThe number of Heating Plants per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_hot_water_systems_count","full_name":"rp_table_download[rp_hot_water_systems_count]","description":"\n\u003cp\u003eThe number of Hot Water Systems per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_hot_water_systems_space_functions_count","full_name":"rp_table_download[rp_hot_water_systems_space_functions_count]","description":"\n\u003cp\u003eThe number of Space Functions per Hot Water System.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_hvac_systems_count","full_name":"rp_table_download[rp_hvac_systems_count]","description":"\n\u003cp\u003eThe number of HVAC Systems per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_hvac_systems_space_functions_count","full_name":"rp_table_download[rp_hvac_systems_space_functions_count]","description":"\n\u003cp\u003eThe number of Space Functions per HVAC System.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_laundry_systems_count","full_name":"rp_table_download[rp_laundry_systems_count]","description":"\n\u003cp\u003eThe number of Laundry Systems per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_measure_savings_count","full_name":"rp_table_download[rp_measure_savings_count]","description":"\n\u003cp\u003eThe number of Energy Savings per Energy Savings Measure.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_operations_count","full_name":"rp_table_download[rp_operations_count]","description":"\n\u003cp\u003eThe number of Operations per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_package_measure_savings_count","full_name":"rp_table_download[rp_package_measure_savings_count]","description":"\n\u003cp\u003eThe number of Energy Savings per Energy Savings Measure per Energy Savings Package.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_package_savings_count","full_name":"rp_table_download[rp_package_savings_count]","description":"\n\u003cp\u003eThe number of Energy Savings per Energy Savings Package.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_pump_systems_count","full_name":"rp_table_download[rp_pump_systems_count]","description":"\n\u003cp\u003eThe number of Pump Systems per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_refrigeration_systems_count","full_name":"rp_table_download[rp_refrigeration_systems_count]","description":"\n\u003cp\u003eThe number of Refrigeration Systems per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_roofs_count","full_name":"rp_table_download[rp_roofs_count]","description":"\n\u003cp\u003eThe number of Roofs per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_shared_system_annual_summary_entries_count","full_name":"rp_table_download[rp_shared_system_annual_summary_entries_count]","description":"\n\u003cp\u003eThe number of Shared System Annual Summaries per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_shared_system_energy_uses_count","full_name":"rp_table_download[rp_shared_system_energy_uses_count]","description":"\n\u003cp\u003eThe number of Shared System Energy Uses per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_skylights_count","full_name":"rp_table_download[rp_skylights_count]","description":"\n\u003cp\u003eThe number of Skylights per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_space_functions_count","full_name":"rp_table_download[rp_space_functions_count]","description":"\n\u003cp\u003eThe number of Space Functions per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_wall_elements_count","full_name":"rp_table_download[rp_wall_elements_count]","description":"\n\u003cp\u003eThe number of Wall Elements per Wall.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_walls_count","full_name":"rp_table_download[rp_walls_count]","description":"\n\u003cp\u003eThe number of Walls per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"rp_windows_count","full_name":"rp_table_download[rp_windows_count]","description":"\n\u003cp\u003eThe number of Windows per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_clothes_washers_count","full_name":"rp_table_download[wa_clothes_washers_count]","description":"\n\u003cp\u003eThe number of Facility Clothes Washers per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_cooling_towers_count","full_name":"rp_table_download[wa_cooling_towers_count]","description":"\n\u003cp\u003eThe number of Facility Cooling Towers per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_faucets_count","full_name":"rp_table_download[wa_faucets_count]","description":"\n\u003cp\u003eThe number of Facility Faucets per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_irrigation_controllers_count","full_name":"rp_table_download[wa_irrigation_controllers_count]","description":"\n\u003cp\u003eThe number of Facility Landscape Irrigation Controllers per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_irrigation_stations_count","full_name":"rp_table_download[wa_irrigation_stations_count]","description":"\n\u003cp\u003eThe number of Stations per Facility Landscape Irrigation Controller.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_showerheads_count","full_name":"rp_table_download[wa_showerheads_count]","description":"\n\u003cp\u003eThe number of Facility Showerheads per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_toilets_count","full_name":"rp_table_download[wa_toilets_count]","description":"\n\u003cp\u003eThe number of Facility Toilets per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_urinals_count","full_name":"rp_table_download[wa_urinals_count]","description":"\n\u003cp\u003eThe number of Facility Urinals per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_water_features_count","full_name":"rp_table_download[wa_water_features_count]","description":"\n\u003cp\u003eThe number of Facility Water Features per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_water_savings_count","full_name":"rp_table_download[wa_water_savings_count]","description":"\n\u003cp\u003eThe number of Facility Water Savings per Water Savings Package per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"wa_water_savings_packages_count","full_name":"rp_table_download[wa_water_savings_packages_count]","description":"\n\u003cp\u003eThe number of Facility Water Savings Packages per Building.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"table_uploads":{"doc_url":"/apidoc/v2/table_uploads","id":"table_uploads","api_url":"/api/table/imports","name":"Table uploads","short_description":"Table Imports","full_description":"\n\u003cp\u003eServices relating to table imports\u003c/p\u003e\n","version":"v2","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/table_uploads/index","name":"index","apis":[{"api_url":"/api/v2/table/imports","http_method":"GET","short_description":"All Table Imports.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"Not Found - The table import MUST be available to the current user.","metadata":null},{"code":422,"description":"Unprocessable Entity - The form data contains errors.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_uploads/show","name":"show","apis":[{"api_url":"/api/v2/table/imports/:id","http_method":"GET","short_description":"One Table Import.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The form data contains errors.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_uploads/download","name":"download","apis":[{"api_url":"/api/v2/table/imports/:id/download","http_method":"GET","short_description":"Download File for Table Import.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":422,"description":"Unprocessable Entity - The form data contains errors.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/table_uploads/create","name":"create","apis":[{"api_url":"/api/v2/table/imports","http_method":"POST","short_description":"New Table Import.","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"Not Found - The table import MUST be available to the current user.","metadata":null},{"code":401,"description":"Unauthorized","metadata":null},{"code":422,"description":"Unprocessable Entity","metadata":null}],"params":[{"name":"token","full_name":"token","description":"\n\u003cp\u003eThe token for user authentication.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rp_table_upload","full_name":"rp_table_upload","description":"\n\u003cp\u003eThe table import.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"attachment","full_name":"rp_table_upload[attachment]","description":"\n\u003cp\u003eThe uploaded file.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a File","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rp_cities_report_id","full_name":"rp_table_upload[rp_cities_report_id]","description":"\n\u003cp\u003eThe unique ID for the Audit Report.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"scope_rp_nyc_properties","full_name":"rp_table_upload[scope_rp_nyc_properties]","description":"\n\u003cp\u003eScope the NYC properties to the uploaded file?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"users":{"doc_url":"/apidoc/v2/users","id":"users","api_url":"/api/users","name":"Users","short_description":"Energy Asset - Users","full_description":"\n\u003cp\u003eServices relating to users of the Energy Asset Tool.  “\\\u003c/p\u003e\n\n\u003cpre\u003e\u0026quot;NOTE: Use appropriate content-type header -- application/xml or application/json\u003c/pre\u003e\n","version":"v2","formats":["json","xml"],"metadata":null,"methods":[{"doc_url":"/apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/v2/users","http_method":"GET","short_description":"Retrieve a list of users.  NOTE: Users are only allowed to view their own account.This call always returns a 404.","deprecated":null}],"formats":["json","xml"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - ensure token is being passed with each service call.","metadata":null},{"code":500,"description":"Unspecified error on server.","metadata":null},{"code":404,"description":"Listing all users is not supported.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/authenticate","name":"authenticate","apis":[{"api_url":"/api/v2/users/authenticate","http_method":"POST","short_description":"Authenticate user to get API token. Response for a successful request will be an object including a token to be used with future API requests.","deprecated":null}],"formats":["json","xml"],"full_description":"\n\u003cp\u003eAuthenticate to the Energy Asset Score application to receive a token for use in future API requests.  In order to authenticate a user account and organization token are also required.  Contact asset.score@pnnl.gov to request an organization token.  Use the organization token to create a user account.  Follow the API documentation for user accounts: :///apidoc/v2/users.html\u003c/p\u003e\n","errors":[{"code":404,"description":"Unsupported operation","metadata":null},{"code":500,"description":"Unspecified error on server.","metadata":null},{"code":401,"description":"Request must contain username, password and organization token","metadata":null},{"code":401,"description":"Invalid email or password.","metadata":null},{"code":401,"description":"Invalid username, password or organization token","metadata":null}],"params":[{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail address of the existing user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword for the existing account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_token","full_name":"organization_token","description":"\n\u003cp\u003eUnique token required to generate a user token for future API calls.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["(json) POST ://buildingenergyscore.energy.gov/api/v2/users/authenticate?email=test@test.org\u0026password=passw0rd\u0026organization_token=1234TokenGoesHere","(json) Response:  {\"user_id\": 30, \"token\":\"xzysuLdC2hiJfRGgMkAv\"}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/v2/users/:id","http_method":"GET","short_description":"Retrieve the user with the given ID.  NOTE: Users are only allowed to view their own account.","deprecated":null}],"formats":["json","xml"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - ensure token is being passed with each service call.","metadata":null},{"code":404,"description":"Unsupported operation","metadata":null},{"code":500,"description":"Unspecified error on server.","metadata":null}],"params":[],"returns":[],"examples":["{\"created_at\":\"2013-07-26T16:51:25Z\",\"email\":\"user1@nowhere.com\",\"id\":12,\"organization_token\":\"test0rg\",\"role_id\":1,\"updated_at\":\"2013-07-26T16:51:25Z\"}","\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003cuser\u003e\n  \u003ccreated-at type=\"datetime\"\u003e2014-01-31T06:17:22Z\u003c/created-at\u003e\n  \u003cemail\u003euser1@nowhere.com\u003c/email\u003e\n  \u003cid type=\"integer\"\u003e14\u003c/id\u003e\n  \u003corganization-id type=\"integer\"\u003e1\u003c/organization-id\u003e\n  \u003crole-id type=\"integer\"\u003e1\u003c/role-id\u003e\n  \u003cupdated-at type=\"datetime\"\u003e2014-01-31T06:17:22Z\u003c/updated-at\u003e\n\u003c/user\u003e"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/v2/users","http_method":"POST","short_description":"Create a new user account.  Response for a successful request is a complete User object with the assigned unique ID of the new user.Password must contain uppercase, lowercase, digit and a special character.","deprecated":null}],"formats":["json","xml"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - ensure token is being passed with each service call.","metadata":null},{"code":404,"description":"Unsupported operation","metadata":null},{"code":500,"description":"Unspecified error on server.","metadata":null}],"params":[{"name":"organization_token","full_name":"organization_token","description":"\n\u003cp\u003eUnique organization token required to generate a user token for future API calls.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail address of the new user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword for the new user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password_confirmation","full_name":"password_confirmation","description":"\n\u003cp\u003ePassword again to ensure user didn\u0026#39;t make a mistake\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"first_name","full_name":"first_name","description":"\n\u003cp\u003eFirst name.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\n\u003cp\u003eLast name.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["(json) POST {\"first_name\":\"Somefirstname\",\"last_name\":\"Somelastname\",\"email\":\"test@test.org\",\"password\":\"passw0rd\",\"password_confirmation\":\"passw0rd\",\"organization_token\":\"1234TokenGoesHere\"}","(json) POST ://buildingenergyscore.energy.gov/api/v2/users?first_name=Somefirstname\u0026last_name=Somelastname\u0026email=test@test.org\u0026password=passw0rd\u0026password_confirmation=passw0rd\u0026organization_token=1234TokenGoesHere","(json) Response: {\"created_at\":\"2013-07-31T22:53:44Z\",\"email\":\"newuser@nowhere.com\",\"id\":15,\"organization_id\":1,\"role_id\":1,\"updated_at\":\"2013-07-31T22:53:44Z\"}","(xml) POST ://buildingenergyscore.energy.gov/api/v2/users.xml?first_name=Somefirstname\u0026last_name=Somelastname\u0026email=test@test.org\u0026password=passw0rd\u0026password_confirmation=passw0rd\u0026organization_token=1234TokenGoesHere","(xml) Response:\n\u003cuser\u003e\n  \u003ccreated-at type=\"datetime\"\u003e2014-01-30T23:28:08Z\u003c/created-at\u003e\n  \u003cemail\u003etest@test.org\u003c/email\u003e\n  \u003cid type=\"integer\"\u003e30\u003c/id\u003e\n  \u003corganization-id type=\"integer\"\u003e1\u003c/organization-id\u003e\n  \u003crole-id type=\"integer\"\u003e1\u003c/role-id\u003e\n  \u003cupdated-at type=\"datetime\"\u003e2014-01-30T23:28:08Z\u003c/updated-at\u003e\n\u003c/user\u003e"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/v2/users/:id","http_method":"PUT","short_description":"Update user account with given ID.  Nothing is returned.  NOTE:  Users can only update their own account.  Users NOT allowed to change role or organization.","deprecated":null}],"formats":["json","xml"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - ensure token is being passed with each service call.","metadata":null},{"code":404,"description":"Unsupported operation","metadata":null},{"code":500,"description":"Unspecified error on server.","metadata":null},{"code":422,"description":"password and password_confirmation do NOT match","metadata":null}],"params":[{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail address of the new user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword for the new user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password_confirmation","full_name":"password_confirmation","description":"\n\u003cp\u003ePassword again to ensure user didn\u0026#39;t make a mistake\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"first_name","full_name":"first_name","description":"\n\u003cp\u003eFirst name.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"\n\u003cp\u003eLast name.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["(json) Update email: PUT {\"email\": \"test2@test.org\"}","(xml) Update email and password:\n\u003cuser\u003e\n  \u003cemail\u003etest3@test.org\u003c/email\u003e\n  \u003cpassword\u003etestchange\u003c/password\u003e\n  \u003cpassword_confirmation\u003etestchange\u003c/password_confirmation\u003e\n\u003c/user\u003e"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}