Skip to content
Jared Johnson edited this page Aug 17, 2016 · 30 revisions

Welcome to the GroceryGroove wiki!

API v1.0 Goals

Users

  • Create User
    • By Email
    • By DeviceID
  • Secure Login
    • By Email & Password
    • By DeviceID
  • Get Households that User is part of
  • Invite New User to Household
  • Convert User from DeviceID Account to Full Account (Email)

Grocery Lists

  • Create Grocery List
  • Get Grocery List (singular)
  • Get Grocery Lists (plural)
  • Add Item to Grocery List
  • Update Item in Grocery List
  • Get Items on Grocery List and Relevant Info
    • Item Name
    • Category
    • Qty
    • Qty Type
    • Who Added
    • Checked
  • Check Grocery List Item
  • Remove Grocery List Item

Items

  • Add Item
    • And Categorize It
  • Suggested Item Name Autocomplete

Categories

  • Get Category Names
  • Get Category Infos
  • Add Categories

Quantity Types

  • Get Quantity Types
  • Add Quantity Types

Households

  • Get Household Info
  • Get Users Within Household
  • Set Household Administrator
  • Remove User from Household
  • Existing User Create New Household

Client/API Goals

  • Real time synchronization

Client v1.0 Goals

Users

  • Create User
  • Secure Login
  • Invite New User to Household

Grocery Lists

  • Create Grocery List
  • View Grocery Lists (plural)
  • View Grocery List (singular)

Items

  • Add Item to Grocery List (Item Name, Category, Quantity Type, Quantity)
  • Check Item
  • Remove Item from list
  • Suggested Item Autocomplete
  • Display who added item (maybe colors? or just name)
  • View more info about item on list (who added, when added, etc.)

Categories

  • Get Categories to populate ComboBox

Quantity Types

  • Get Quantity Types to populate ComboBox

Household

  • Get Household Name to Display in Lists header bar

Client/API Goals

  • Real time synchronization