Tank Method
The tank method allows you to access the tanks associated with your account.
Base Url
GET http://www.reefware.com/api/request/v1/tank
Response
{
id: [tank_id],
name: [tank_name],
size: [tank_size],
sizeUnits: [tank_size_units],
start: [date_started],
length: [tank_length],
lengthUnits: [tank_length_units],
width: [tank_width],
widthUnits: [tank_width_units],
height: [tank_height],
heightUnits: [tank_height_units],
type: [water_type],
material: [tank_material],
updated: [date_last_updated],
public: [public_token],
token: [private_token],
priority: [tank_priority]
}
Data Options
id
optional
- 'id' will return the tank id.
- The tank id is unique.
- This option will return as a number.
name
optional
- 'name' will return the tank name.
- This option will return as a string.
size
optional
- 'size' will return the size of the tank.
- This option will return as a number.
sizeUnits
optional
- 'sizeUnits' will return the size units of the tank.
- The available options are gallons and liters.
- This option will return as a string.
start
optional
- 'start' will return the date that the aquarium was started.
- This option will return as a date timestamp.
length
optional
- 'length' will return the length of the tank.
- This option will return as a number.
lengthUnits
optional
- 'lengthUnits' will return the length units of the tank.
- The available options are in and cm.
- This option will return as a string.
width
optional
- 'width' will return the width of the tank.
- This option will return as a number.
widthUnits
optional
- 'widthUnits' will return the width units of the tank.
- The available options are in and cm.
- This option will return as a string.
height
optional
- 'height' will return the height of the tank.
- This option will return as a number.
heightUnits
optional
- 'heightUnits' will return the height units of the tank.
- The available options are in and cm.
- This option will return as a string.
type
optional
- 'type' will return the type of aquarium water.
- The available options are salt and fresh.
- This option will return as a string.
material
optional
- 'material' will return the type of material the aquarium is made of.
- The available options are glass and acrylic.
- This option will return as a string.
updated
optional
- 'updated' will return the date the tank was last changed.
- This option will return as a date timestamp.
public
optional
- 'public' will return the token assigned to the tank that can be shared.
- This option will return as a string.
This option can not be changed.
token
optional
- 'token' will return the token assigned to the tank that is private.
- This option will return as a string.
This option can not be changed.
priority
optional
- 'priority' will return the priority number for the aquarium.
- Changing the priority will arrange how the aquariums appear in your account
- This option will return as a number.
Example Request
GEThttp://www.reefware.com/api/request/v1/tank/data/name.size.type
Response
- [
- [
- {
- "name": "Reefware Aquarium",
- "size": 150,
- "type": "saltwater"
- }
- ]
- ]