Skip to content

Latest commit

 

History

History
261 lines (194 loc) · 7.26 KB

README.md

File metadata and controls

261 lines (194 loc) · 7.26 KB
Raw

ASPC API

A standardized way to access ASPC features. Currently there is only an API for the Menu.

Authentication Token

Your authentication token will be shown to you when you login and go to https://aspc.pomona.edu/api/.

Please use this authentication token to access all the endpoints below. You are limited to 1000 requests per day. Please contact digitalmedia@aspc.pomona.edu if you wish to raise the limit.

Example using cURL

Request (GET)

curl -H "Authorization: Token 83056d12c23f007d1d2ad7d2713b776d4644c21c" https://aspc.pomona.edu/api/menu/

Response 200 (application/json)

[
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Breakfast Selections\", \"Scrambled Eggs\\nCheese & Bacon Eggs\\nTurkey Bacon & Sausage Patties\\nChorizo & Cheese Quesadilla\", \"Oatmeal & Grits\\nWaffles\\nHash Browns \\nCranberry & Apple Cinnamon Muffins\", \"Make Your Own Waffle Station\"]",
        "id": 11,
        "meal": "breakfast"
    },
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Chocolate Chip Cookies\\nCinnamon Roll Cheesecake Cookies\\nPina Colada Bar\\nLemon Blueberry Pound Cake\", \"Red Velvet Cake\\nVegan Banana Cream Pie\\nMade Without Gluten Rochers\"]",
        "id": 13,
        "meal": "dessert"
    }, ...
]

Menu API

All Menus [/api/menu/]

Lists all menus

Request (GET)

+ Headers
    Authorization: Token 83456d12c23f007d1d2ad7d2713b776d4644c21c

Response 200 (application/json)

[
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Breakfast Selections\", \"Scrambled Eggs\\nCheese & Bacon Eggs\\nTurkey Bacon & Sausage Patties\\nChorizo & Cheese Quesadilla\", \"Oatmeal & Grits\\nWaffles\\nHash Browns \\nCranberry & Apple Cinnamon Muffins\", \"Make Your Own Waffle Station\"]",
        "id": 11,
        "meal": "breakfast"
    },
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Chocolate Chip Cookies\\nCinnamon Roll Cheesecake Cookies\\nPina Colada Bar\\nLemon Blueberry Pound Cake\", \"Red Velvet Cake\\nVegan Banana Cream Pie\\nMade Without Gluten Rochers\"]",
        "id": 13,
        "meal": "dessert"
    }, ...
]

Menus By Dining Hall [/api/menu/dining_hall/{dining_hall}/]

Lists all menus by a specific dining hall

Parameters

  • dining_hall (enum[string])

    Name of the dining hall

    • Members
      • frary
      • frank
      • cmc
      • mudd
      • scripps
      • oldenborg

Request (GET)

+ Headers
    Authorization: Token 83456d12c23f007d1d2ad7d2713b776d4644c21c

Response 200 (application/json)

[
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Breakfast Selections\", \"Scrambled Eggs\\nCheese & Bacon Eggs\\nTurkey Bacon & Sausage Patties\\nChorizo & Cheese Quesadilla\", \"Oatmeal & Grits\\nWaffles\\nHash Browns \\nCranberry & Apple Cinnamon Muffins\", \"Make Your Own Waffle Station\"]",
        "id": 11,
        "meal": "breakfast"
    },
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Chocolate Chip Cookies\\nCinnamon Roll Cheesecake Cookies\\nPina Colada Bar\\nLemon Blueberry Pound Cake\", \"Red Velvet Cake\\nVegan Banana Cream Pie\\nMade Without Gluten Rochers\"]",
        "id": 13,
        "meal": "dessert"
    }, ...
]

Menus By Day [/api/menu/day/{day}/]

Lists all menus by a specific day of the week

Parameters

  • day (enum[string])

    Name of the day of the week

    • Members
      • mon
      • tue
      • wed
      • thu
      • fri
      • sat
      • sun

Request (GET)

+ Headers
    Authorization: Token 83456d12c23f007d1d2ad7d2713b776d4644c21c

Response 200 (application/json)

[
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Breakfast Selections\", \"Scrambled Eggs\\nCheese & Bacon Eggs\\nTurkey Bacon & Sausage Patties\\nChorizo & Cheese Quesadilla\", \"Oatmeal & Grits\\nWaffles\\nHash Browns \\nCranberry & Apple Cinnamon Muffins\", \"Make Your Own Waffle Station\"]",
        "id": 11,
        "meal": "breakfast"
    },
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Chocolate Chip Cookies\\nCinnamon Roll Cheesecake Cookies\\nPina Colada Bar\\nLemon Blueberry Pound Cake\", \"Red Velvet Cake\\nVegan Banana Cream Pie\\nMade Without Gluten Rochers\"]",
        "id": 13,
        "meal": "dessert"
    }, ...
]

Menus By Dining Hall and Day [/api/menu/dining_hall/{dining_hall}/day/{day}/]

Lists all menus by dining hall and a specific day of the week

Parameters

  • dining_hall (enum[string])

    Name of the dining hall

    • Members
      • frary
      • frank
      • cmc
      • mudd
      • scripps
      • oldenborg

  • day (enum[string])

    Name of the day of the week

    • Members
      • mon
      • tue
      • wed
      • thu
      • fri
      • sat
      • sun

Request (GET)

+ Headers
    Authorization: Token 83456d12c23f007d1d2ad7d2713b776d4644c21c

Response 200 (application/json)

[
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Breakfast Selections\", \"Scrambled Eggs\\nCheese & Bacon Eggs\\nTurkey Bacon & Sausage Patties\\nChorizo & Cheese Quesadilla\", \"Oatmeal & Grits\\nWaffles\\nHash Browns \\nCranberry & Apple Cinnamon Muffins\", \"Make Your Own Waffle Station\"]",
        "id": 11,
        "meal": "breakfast"
    },
    {
        "day": "fri",
        "dining_hall": "cmc",
        "food_items": "[\"Chocolate Chip Cookies\\nCinnamon Roll Cheesecake Cookies\\nPina Colada Bar\\nLemon Blueberry Pound Cake\", \"Red Velvet Cake\\nVegan Banana Cream Pie\\nMade Without Gluten Rochers\"]",
        "id": 13,
        "meal": "dessert"
    }, ...
]

Menus By Dining Hall, Day, and Meal [/api/menu/dining_hall/{dining_hall}/day/{day}/meal/{meal}/]

Find a menu with a specific dining hall, specific day of the week, and meal

Parameters

  • meal (enum[string])

    Name of the dining hall

    • Members
      • breakfast
      • lunch
      • dinner

  • dining_hall (enum[string])

    Name of the dining hall

    • Members
      • frary
      • frank
      • cmc
      • mudd
      • scripps
      • oldenborg

  • day (enum[string])

    Name of the day of the week

    • Members
      • mon
      • tue
      • wed
      • thu
      • fri
      • sat
      • sun

Request (GET)

+ Headers
    Authorization: Token 83456d12c23f007d1d2ad7d2713b776d4644c21c

Response 200 (application/json)

{
    "day": "fri",
    "dining_hall": "cmc",
    "food_items": "[\"Breakfast Selections\", \"Scrambled Eggs\\nCheese & Bacon Eggs\\nTurkey Bacon & Sausage Patties\\nChorizo & Cheese Quesadilla\", \"Oatmeal & Grits\\nWaffles\\nHash Browns \\nCranberry & Apple Cinnamon Muffins\", \"Make Your Own Waffle Station\"]",
    "id": 11,
    "meal": "breakfast"
}