R3play API Documentation: Global

Members

AnimeSchema

Anime Schema object

Source:

models.js, line 62

MovieSchema

Movie Schema object

Source:

models.js, line 6

TVSchema

TV series Schema object

Source:

models.js, line 33

(async) deleteAnime

API call to delete "/users/:id/:animes/:AnimeID" returning user json object with a deleted movie data (anime gets deleted from the FavoriteMovies)

Source:

index.js, line 445

(async) deleteMovie

API call to delete "/users/:id/:movies/:MovieID" returning user json object with a deleted movie data

Source:

index.js, line 422

(async) deleteTV

API call to delete "/users/:id/:tvseries/:tvID" returning user json object with a deleted movie data (tv series gets deleted from the FavoriteMovies)

Source:

index.js, line 468

(async) deleteUser

API call to delete "/users/:id" returning user json object with a deleted user data

Source:

index.js, line 534

(async) getAnimeDirector

API call to get "/animes/directors/directorName" returning json object with an anime director name and bio

Source:

index.js, line 260

(async) getAnimeGenre

API call to get "/animes/genres/animeName" returning json object with an anime genre name and description

Source:

index.js, line 202

(async) getAnimeTitle

API call to get "/animes/:animeTitle" returning json object with an anime

Source:

index.js, line 140

(async) getAnimes

API call to get all "/movies" returning JSON object (Returns all movies)

Source:

index.js, line 63

(async) getDocumentation

API call to get "/" returning documentation html file

Source:

index.js, line 110

(async) getDocumentation

API call to get "/" returning documentation html file

Source:

index.js, line 558

(async) getMovieDirector

API call to get "/movies/directors/:directorName" eturning json object with a movie director name and bio

Source:

index.js, line 240

(async) getMovieGenre

API call to get "/movies/genres/:genreName" returning json object with a movie genre name and description

Source:

index.js, line 182

(async) getMovieTitle

API call to get "/movies/movieTitle" returning json object with a movie

Source:

index.js, line 122

(async) getMovies

API call to get all "/movies" returning JSON object (Returns all movies)

Source:

index.js, line 43

(async) getTVDirector

API call to get "/tvseries/directors/directorName" returning json object with a tv series director name and bio

Source:

index.js, line 281

(async) getTVGenre

API call to get "/tvseries/genres/tvName" returning json object with a tv series genre name and description

Source:

index.js, line 221

(async) getTVSeries

API call to get all "/movies" returning JSON object (Returns all movies)

Source:

index.js, line 85

(async) getTVTitle

API call to get "/tvseries/:tvTitle" returning json object with an TV series

Source:

index.js, line 162

(async) postAnime

API call to post "/users/:id/:animes/:AnimeID" returning user json object with a favorite anime data (anime gets pushed to favoriteMovies)

Source:

index.js, line 374

(async) postMovie

API call to post "/users/:id/:movies/:MovieID" returning user json object with a favorite movie data

Source:

index.js, line 350

(async) postTV

API call to post "/users/:id/:tvseries/:tvID" returning user json object with a favorite movie data (tv series gets pushed to favoriteMovies)

Source:

index.js, line 398

(async) postUser

API call to post "/users" returning json object with a new user

Source:

index.js, line 302

(async) putUser

API call to put "/users/:id" returning user json object with an updated user data

Source:

index.js, line 491

Methods

generateToken(Generates)

Generates a JWT token

Parameters:

Name	Type	Description
`Generates`		a JWT token

Source:

auth.js, line 8

loginUserAndToken(/users/:id/, Username:, Password:)

API call to login a user with Passport Authentication and generate a token

Parameters:

Name	Type	Description
`/users/:id/`	string
`Username:`	object	string
`Password:`	object	number

Source:

auth.js, line 23