Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Latest commit

 

History

History
203 lines (172 loc) · 3.55 KB

building_acronym_vendingmachines.md

File metadata and controls

203 lines (172 loc) · 3.55 KB

Building Vending Machines

GET /buildings/{building_code}/vendingmachines.{format}

Description

This method returns list of vending machines available in a given building

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1487 Enabled Yes
Service Name buildings Service ID 257
Information Steward Food Services Data Type Direct DB Connection
Update Frequency Every request (live) Cache Time 0 seconds

Notes

  • Any value can be null

Sources

Parameters

GET /buildings/{building_code}/vendingmachines.{format}
Parameter Type Required Description
building input yes Building code
key filter yes Your API key
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /buildings/{building_code}/vendingmachines.{format}

Response

Field Name Type Value Description
building_name string Name of the Building
building_acronym string Building Acronym
vending_machines list Machines list
location string Relative machine location inside the bulding
machines number Total machines in that given location
products list List of products/machine type

Any value can be null

Output

JSON

{
  "meta":{
    "requests":796909,
    "timestamp":1452283330,
    "status":200,
    "message":"Request successful",
    "method_id":1487,
    "method":{
      
    }
  },
  "data":{
    "building_name":"Mathematics & Computer Building",
    "building_acronym":"MC",
    "vending_machines":[
      {
        "location":"2nd floor lounge",
        "machines":4,
        "products":[
          "Coca-Cola Products",
          "Dasani products",
          "Snacks"
        ]
      },
      {
        "location":"3rd floor lounge",
        "machines":6,
        "products":[
          "Energy\/Powerade",
          "Coca-Cola Products",
          "Dasani products",
          "Health and Wellness",
          "Snacks",
          "Milk to Go and Snacks"
        ]
      }
    ]
  }
}