Evaporation Method


The evaporation method allows you to access the evaporation on a tank.

Base Url

GET   http://www.reefware.com/api/request/v1/evaporation/[tank]

Response

{ id: [evaporation_id],
tank: [taank_token],
current: [current_status],
fill: [fill_amount],
fillUnits: [fill_amount_units],
rate: [seconds_to_empty],
rateUnits: [rate_units],
updated: [date_last_updated]
}


Data Options

id
optional

  • 'id' will return the evaporation id.
  • The evaporation id is unique for each tank.
  • This option will return as a number.

This option can't be changed.

tank
optional

  • 'tank' will return the tank token.
  • This option will return as a string.

current
optional

  • 'current' will return the decimal value for the evaporation percentage.
  • This option will return as a number.

fill
optional

  • 'fill' will return the value required to top off the tank.
  • This option will return as a number.

fillUnits
optional

  • 'fillUnits' will return the unit type for the fill amount.
  • Available options include oz, pint, quart, liter, and gallon.
  • This option will return as a string.

rate
optional

  • 'rate' will return the number of seconds for the tank evaporation to reach zero.
  • This option will return as a number.

rateUnits
optional

  • 'rateUnits' will return the label for the rate value.
  • This option will return as a string.

updated
optional

  • 'updated' will return the date the evaporation was last updated.
  • This option will return as a date timestamp.

 

Example Request

GEThttp://www.reefware.com/api/request/v1/evaporation/tank/HSFhdksSH9383/data/tank.current.rate

Response

  1. [
  2. [
  3. {
  4. "tank": "HSFhdksSH9383",
  5. "current": .25,
  6. "rate": 259200
  7. }
  8. ]
  9. ]