API:Instructor 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
param: Param you can pass in place of Id (friendly id) to find instructor record
abbreviated_name: First name of the instructor with abbreviated last name
university: University name that the instructor attended
major: Major of instructor
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)
hours_taught: Float number of instructional hours taught
accepts_work: boolean indicating if instructor is accepting new assignments
tier: String description of highest level

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
subject_short_name: A string with a parameterized version of the instructor subject name ('algebra-i', 'computer-science')
subject_category_short_name: A string with a parameterized version of the instructor subject category name ('math', 'test-prep')
professional: Boolean ('true', '1' or 'false', '0') that if true, will only include 'professional' tutors in result set
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,
              "param": "jimmy",
              "abbreviated_name": "Jimmy B.",
              "university": "Chapman University",
              "major": "B.S. Art History",
              "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"
              "hours_taught": 1200,
              "accepts_work": true,
              "tier": "Distinguished"
          }
      ]
  }

API:Instructor Details

Attributes:

id: Id of the instructor record
abbreviated_name: First name of the instructor with abbreviated last name
university: University name that the instructor attended
major: Instructors major at university
bio: Full Biography of the instructor
avatar_url: Url to retrieve the headshot 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)
sat_percentile: Sat score percentile
act_percentile: Act score percentile
hours_taught: Float number of instructional hours taught
accepts_work: boolean indicating if instructor is accepting new assignments
tier: String description of highest level
subjects: An array of subject names the instructor is proficient in teaching
location: Geographical location where the instructor is based

city: Name of city
state: Name of state
zip: Postal zip code

student_reviews: Collection of 10 most recent reviews on instructors by students

student_name: Abbreviated name of student
stars: Star rating given to the instructor based on a 5 star rating
comment: Comment made by the student
reviewed_on: The date a student submitted the review

Methods:

List

URL: https://console.revolutionprep.com/api/v1/instructors/[id].[format]
Method: GET
Required Parameters:
id: This is the primary id of the instructor

JSON example

// https://console.revolutionprep.com/api/v1/instructors/1309.json

{
  "id": 1309,
  "abbreviated_name": "Jimmy B.",
  "university": "Chapman University",
  "major": "Creative Writing, Theater",
  "bio": "Jimmy has been teaching for six years.  He started out directing Shakespeare for youth theater, and now teaches English, writing, SAT/ACT prep, and improvisational comedy to students of all ages.  In over three years with Revolution Prep, he has been rated as an A/A+ teacher by 97% of his students.  Jimmy graduated from Chapman University with degrees in Creative Writing and Theater and was involved in a popular campus improv group that continues to perform in theaters all around Southern California.  In his free time Jimmy is always up for a competitive game of Ultimate Frisbee.",
  "avatar_url": "https://s3.amazonaws.com/revrails-development/profile_attachments/9688/Jimmy.Bowman.jpg",
  "awesome_rating": 98.3,
  "average_rating": 4.9,
  "reviews_count": 270,
  "type": "Standard",
  "sat_percentile": 99,
  "act_percentile": null,
  "hours_taught": 1200,
  "accepts_work": true,
  "tier": "Distinguished",
  "subjects": [
      {
        name: "10th Grade English",
        short_name: 10th-grade-english,
        category_name: "English Language and Literature",
        category_short_name: "english-language-and-literature"
      }
  ],
  "location": {
      "city": "Toluca Lake",
      "state": "CA",
      "zip_code": "91602"
  },
  student_reviews: [
    {
    student_name: "Karin L.",
    stars: 5,
    comment: "Yes, he keeps the class interactive and interesting throughout the entire three hours which is very hard to do",
    reviewed_on: "05/30/13"
    },

    ect...
  ]
}