retrieve_inputs

Returns a full set of the building inputs.

Parameters

NameDescriptionTypeLengthRequiredOptions
user_keyAPI key for accessstring32Yes
building_idID of building to validateint
Yes

Response

NameDescription
resultOK
messageBuilding #### inputs retrieved
aboutInputs about the building in general
zoneInputs about the building envelope
systemsInputs about the building systems

Notes
  • The method returns a complete set of the current building inputs in the same structure as the submit_inputs method. 
  • Empty inputs are returned as Null.


Errors

Error TextMeaning
 API key is not authorized You need to submit a valid API key
 No building found for building_id ##### You need to submit a valid building_id