Supported Formats

json, xml

Errors

Code Description
401 Unauthorized - ensure token is being passed with each service call.
404 Unsupported operation
500 Unspecified error on server.

Params

Param name Description
misc_electric_load
optional

Miscellaneous electric load (Watts per square foot).

Validations:

  • Must be a Float

misc_gas_load
optional

Miscellaneous gas load.

Validations:

  • Must be a Float

total_occupants
optional

Total occupants.

Validations:

  • Must be a Integer

setpoint_heating
optional

Setpoint heating.

Validations:

  • Must be a Integer

setpoint_cooling
optional

Setpoint cooling.

Validations:

  • Must be a Integer

elevator_id
optional

ID of elevator to link to operations.

Validations:

  • Must be a Integer

weekdays_open
optional

True if open on weekdays, false if closed.

Validations:

  • Must be one of: true, false.

weekdays_open_time
optional

Time that building opens during weekday (e.g. 5:00am).

Validations:

  • Must be a String

weekdays_close_time
optional

Time that building closes during weekday (e.g. 6:00pm).

Validations:

  • Must be a String

saturday_open
optional

True if open on Saturdays, false if closed.

Validations:

  • Must be one of: true, false.

saturday_open_time
optional

Time that building opens during Saturdays (e.g. 5:00am).

Validations:

  • Must be a String

saturday_close_time
optional

Time that building closes during Saturdays (e.g. 6:00pm).

Validations:

  • Must be a String

sunday_open
optional

True if open on Sundays, false if closed.

Validations:

  • Must be one of: true, false.

sunday_open_time
optional

Time that building opens during Sundays (e.g. 5:00am).

Validations:

  • Must be a String

sunday_close_time
optional

Time that building closes during Sundays (e.g. 6:00pm).

Validations:

  • Must be a String