jazziesf / trip_api

Resource: API for retrieving Trips™ and making reservations, used for the project Trek (https://github.com/AdaGold/trek/)

Trip API™

Trip API™

Retrieve Data

• Retrieve list of all Trips:

  • get https://trektravel.herokuapp.com/trips

• Retrieve list of all trips by continent:

  • get https://trektravel.herokuapp.com/trips/continent?query=Asia

• Retrieve list of all trips by max amount of weeks:

  • get https://trektravel.herokuapp.com/trips/weeks?query=3

• Retrieve list of all trips by max budget:

  • get https://trektravel.herokuapp.com/trips/budget?query=5000
  • budget is in dollar amount, above represents $5,000

• Retrieve Data on Single Trip From ID:

  • get https://trektravel.herokuapp.com/trips/1

• Retrieve all reservations of a Trip:

  • get https://trektravel.herokuapp.com/trips/1/reservations

Send Data

• Reserve a Spot on a Trip:

  • POST https://trektravel.herokuapp.com/trips/1/reservations
  • accepted params:
    • name (string) required
    • age (integer)
    • email (string) required

• Add a New Trip:

  • POST https://trektravel.herokuapp.com/trips
  • accepted params:
    • name (string) required
    • continent (string) required
    • about (string)
    • category (string) required
    • weeks (integer) required
    • cost (float) required