API:Testimonial Search

Attributes:

  • current_page: Current page # of results
  • total_entries: Total number of results for the given query
  • total_pages: Total number of pages of results
  • instructors: List of instructors
    • id: Id of the instructor record
    • abbreviated_name: First name of the instructor with abbreviated last name
    • university: University name that the instructor attended
    • bio: Truncated Biography of the instructor
    • avatar_url: Url to retrieve the headshot of the instructor
    • profile_url: Url to retrieve the details of the instructor
    • awesome_rating: This is a overall performance rating based on numerous factors
    • average_rating: Average rating based on submitted reviews
    • reviews_count: Number of submitted reviews for this instructor
    • type: Type of instructor (Standard or GPA Protection)

Methods:

List

URL: https://revolutionprep.com/api/v1/instructors.[format]
Method: GET
Optional Parameters:
query: This could be any combination of words separated by spaces
zip: A US zip code which returns results sorted by zip code nearest to furthest
account_id: Instructors must have been reviewed with a 4+ star rating by a student associated with that account_id
page: an integer value which specifies which page of results to fetch, starting at 1. Fetching successively higher page numbers will return additional results, until there are no results to return (in which case an empty result set will be returned). Defaults to 1 page and 25 records per page

JSON example

// https://console.revolutionprep.com/api/v1/instructors.json?query=Jimmy

  {
      "current_page": 1,
      "total_entries": 1,
      "total_pages": 1,
      "instructors": [
          {
              "id": 1309,
              "abbreviated_name": "Jimmy B.",
              "university": "Chapman University",
              "bio": "Jimmy has been teaching for six years.  He started out directing Shakespeare for youth theater, a...",
              "avatar_url": "https://s3.amazonaws.com/revrails-development/profile_attachments/9688/Jimmy.Bowman.jpg",
              "profile_url": "http://http://localhost:3333/api/v1/instructors/1309.json",
              "awesome_rating": 98.3,
              "average_rating": 4.9,
              "reviews_count": 270,
              "type": "Standard Tutor"
          }
      ]
  }