Notification Method


The notification method allows you to access your account notification settings.

Base Url

GET   http://www.reefware.com/api/request/v1/notification

Response

{ id: [notification_id],
token: [notification_token],
type: [notification_type],
item: [notification_item],
condition: [notification_condition],
value: [notification_value],
valueType: [notification_value_type],
sent: [notification_sent],
tank: [tank_token],
date: [date_added]
}


Data Options

id
optional

  • 'id' will return the notification id.
  • The notification id is unique for each notification set up.
  • This option will return as a number.

token
optional

  • 'token' will return the notification token that was automatically generated.
  • The notification token is unique for each notification set up.
  • This option will return as a string.

type
optional

  • 'type' will return the notification type.
  • The available types are evaporation, filter, or parameter.
  • This option will return as a string.

item
optional

  • 'item' will return the specific item that will be watched.
  • Items will range from each parameter, each filter media, or water_level.
  • This option will return as a string.

condition
optional

  • 'condition' will return the mathematical condition assigned to this notification.
  • The three response options are less, greater, or equal.
  • This option will return as a string.

value
optional

  • 'value' is the set numeric value for this notification.
  • This option will return as a number.

valueType
optional

  • 'valueType' is the unit type for the value set above.
  • Available value types are ppt, ppm, dkh, ph, degrees, or percent.
  • This option will return as a string.

sent
optional

  • 'sent' will display if a notification was sent or not.
  • This option will return a zero or one.
  • '0' means the notification has not been sent.
  • '1' means the notification has been sent.

tank
optional

  • 'tank' will return the tank token that this notification is associated with.
  • The tank token will be required to update the notification.
  • This option will return a string.

date
optional

  • 'date' will return the date the notification was created.
  • This option will return as a date timestamp.

This option can not be updated.

 

Example Request

GEThttp://www.reefware.com/api/request/v1/notification/data/token.item.date

Response

  1. [
  2. [
  3. {
  4. "token": "jdkDJSKdjskXdsj",
  5. "item": "water_level",
  6. "date": 2013-10-28 18:00:05
  7. }
  8. ]
  9. ]