Movie Mash

Version: 1.0.0

Methods

[ Jump to Models ]

Table of Contents

Movielist

User

Movielist

Up 
post /v1/createList
Create a list of movies (createMovieList)

Request body

body CreateList (required)
Body Parameter — Created user object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

405

Invalid input

500

500 Internal server issue
Up 
delete /v1/deleteList
Delete all movies from user's list (deleteMovieEntry)
This can only be done by the logged in user.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

200 OK

500

500 Internal server issue
Up 
delete /v1/removeMovie
Delete one movie from user's list (deleteMovieList)

Request body

body RemoveMovie (required)
Body Parameter — Created user object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

200 OK

500

500 Internal server issue
Up 
get /v1/profile
Get username for profile (featuredMovie)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

200 OK

500

500 Internal server issue
Up 
put /v1/profile
Change username (featuredMovie2)

Request body

body Profile (required)
Body Parameter — Created user object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

200 OK

500

500 Internal server issue
Up 
get /v1/compare/:id
Compare list with other user (otherUserList)

Query parameters

id (required)
Query Parameter — The username of the other user

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

200 OK

405

Invalid input

500

500 Internal server issue
Up 
put /v1/updateMovie
Change the rating of a movie on your list (updateRating)

Request body

body UpdateMovie (required)
Body Parameter — Created user object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

200 OK

400

400 Bad Request

500

500 Internal server issue
Up 
get /v1/createList
Get list of movies user can add to list (userMovielist)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

successful operation
Up 
get /v1/getUsers
Get a list of other users (v1GetUsersGet)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

200 OK

500

500 Internal server issue
Up 
get /v1/listMovies
List movies that the user has added to their list (v1ListMoviesGet)

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

200 OK

500

500 Internal server issue

User

Up 
post /v1/register
Create user (createUser)
Create an account.

Request body

body User (required)
Body Parameter — Created user object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

201 Created

400

400 Bad Request

409

409 Conflict

500

500 Internal server issue
Up 
post /v1/login
Logs user into the system (loginUser)

Request body

body Login (required)
Body Parameter — Created user object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid username/password supplied

401

401 Unauthorized

500

500 Internal server issue

Models

[ Jump to Methods ]

Table of Contents

  1. CreateList -
  2. Login -
  3. Profile -
  4. RemoveMovie -
  5. UpdateMovie -
  6. User -

CreateList - Up

user (optional)
String
title (optional)
String
score (optional)
Integer

Login - Up

email (optional)
String
password (optional)
String

Profile - Up

name (optional)
String

RemoveMovie - Up

user (optional)
String
title (optional)
String

UpdateMovie - Up

rating (optional)
Integer
title (optional)
String

User - Up

username (optional)
String
email (optional)
String
password (optional)
String