Skip to content

API Documentation

Jump to bottom
Toks Fifo edited this page Jul 24, 2016 · 1 revision

Users/Auth

Users (currently only supporting facebook auth).

Representation
{
  "_id": (String) Id of user,
  "displayName": (String, optional) Display name,
  "email": (String, optional) Email,
  "facebook": {
    "name": (String) Name from facebook,
    "id": (String) Id from facebook,
    "email": (String) Email from facebook
  },
  "createdAt": (Date) Creation date
}
Endpoints
GET /users

response: (Array) <User>
POST /users

request: <User>

response: <User>
GET /usersMapById

response: Hash mapping user IDs to <User>

Events

An event is a fig, created by a single user who is able to invite others. Events generate places that users decide between. Users perform actions on an event, resulting in a solution.

Representation
{
  "_id": (String) Id of event,
  "name": (String) Name of event,
  "location": {
    "type": (String) Type of location data. Either "address" or "coord",
    "address": (String) Address of locaton, if type is "address",
    "lat": (Number) Latitide of location, if type is "coord",
    "long": (Number) Longitude of location, if type is "coord",
    "radius": (Number, optional) Radius of requested places in miles. Defaults to 1
  },
  "users": (Array) ids (String) of users invited to event. The id of the event creator should come first in the array,
  "search" (String, optional) Additional search terms e.g. "sushi", "brunch",
  "limit": (Number, optional) Number of places considered for the solution to this event. Defaults to 6,
  "createdAt": (Date) Creation date
}
Endpoints
GET /users/:userId/invitations

response: (Array) <Event>
GET /events/:eventId

response: <Event>
POST /events

request: <Event>

response: <Event>

Places

A place is a restaurant. Several (default 6) places belong to a single event.

Representation
{
  "_id": (String) Id of place,
  "yelpId": (String) Yelp id of place,
  "event": (String) Id of event that generated this place,
  "name": (String) Name of place,
  "rating": (Number) Yelp rating. One of [1, 1.5, ... 5],
  "urls": {
    "reservation": (String, optional) Reservation URL (SeatMe),
    "delivery": (String, optional) Delivery URL (Eat24),
    "web": (String) Yelp web URL,
    "mobile": (String) Yelp mobile URL,
  },
  "phone": (String) Phone number of place,
  "location": (Object) Detailed yelp location data for address (see yelp documentation),
  "images": (Array) 6 Image links (String),
  "createdAt": (Date) Creation date
}
Endpoints
GET /events/:eventId/places

response: (Array) <Place>
GET /events/:eventId/solution

response: <Place>

Actions

Actions are performed on events. Each user performs multiple actions on an event, encompassing all their selection decisions.

Representation
{
  "_id": (String) Id of action,
  "user": (String) Id of user performing action,
  "event": (String) Id of event that action belongs to,        
  "selections": (Array) Selection info. The array should include an image item (see below) for every image shown to the user,
  "createdAt": (Date) Creation date
}

imageItem: {
  "image": (String) Image URL,
  "place": (String) Id of place that image belongs to,
  "isSelected": (Boolean) Whether user selected image
}
Endpoints
POST /events/:eventId/actions

request: <Action>

response: <Action>

Notes

  • For simplcity, one representation is used for both GET and POST requests. However, you can omit certain optional properties, such as _id when creating a new resource (since it won't exist yet). The response to the creation will be the same resource, with the newly created id included.

Clone this wiki locally