Livestock Method


The livestock method allows you to access the livestock associated with your account.

Base Url

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

Response

{ id: [livestock_id],
tank: [tank_token],
type: [livestock_type],
image: [livestock_image],
date: [date_purchased],
name: [livestok_name],
size: [livestock_size],
sizeUnits: [livestock_size_units],
observe: [observations],
token: [livestock_token],
quantity: [number_of_livestock]
}


Data Options

id
optional

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

This option can not be changed or modified.

tank
optional

  • 'tank' will return the token assigned to the tank for each livestock.
  • This option will return as a string.

type
optional

  • 'type' will return the type of livestock.
  • The available types include fish, invert, plant, and coral.
  • This option will return as a string.

image
optional

  • 'image' will return the image location for the livestock.
  • This option will return as a string.

date
optional

  • 'date' will return the date that the livestock was purchased.
  • This option will return as a date timestamp.

name
optional

  • 'name' will return the name of the livestock.
  • This option will return as a string.

size
optional

  • 'size' will return the size of the livestock.
  • This option will return as a number.

sizeUnits
optional

  • 'sizeUnits' will return the size units of the livestock.
  • The available options include in and cm.
  • This option will return as a string.

observe
optional

  • 'observe' will return the observation text for the livestock.
  • This option will return as a string.

token
optional

  • 'token' will return the public token for the livestock.
  • This option will return as a string.

This option can't be changed.

quantity
optional

  • 'quantity' will return the number of each specific livestock.
  • This option will return as a number.

 

Example Request

GEThttp://www.reefware.com/api/request/v1/livestock/data/type.image.quantity

Response

  1. [
  2. [
  3. {
  4. "type": "fish",
  5. "image": "/media/uploads/images/ehf8ejw93ke8jj4ke9f.jpg",
  6. "quantity": 5
  7. }
  8. ]
  9. ]