Movie Lists

V1

This representation is not yet finalized and is subject to change.

The Movie Lists endpoint allows creation, view, edits and deletes of Movie Lists.


Endpoints

Verb Endpoint Description
GET /v1/movie-lists Returns a collection of movie lists.
GET /v1/movie-lists?type={type} Returns a list of movie lists by type.
GET /v1/movie-lists?type={type}&start-date={start-date}&end-date={end-date} Returns a list of movie lists by type and date range.
POST /v1/movie-lists Creates a new list.
GET /v1/movie-lists/views/{typeName} Retrieves the current movie list for a specific type name.
POST /v1/movie-lists/{movie-list-id} Adds a new movie to a movie list.
PUT /v1/movie-lists/{movie-list-id} Updates the sequence of a movie in the list.
GET /v1/movie-lists/{movie-list-id} Retrieves a movie list by id.
DELETE /v1/movie-lists/{movie-list-id} Deletes a list by id.
DELETE /v1/movie-lists/{movie-list-id}/{movieId} Deletes a movie from a list by id.

Examples

Get collection of movie lists.
GET  /v1/movie-lists

Response

{
  "count": 3,
  "_embedded": {
    "movieLists": [
      {
        "id": 71,
        "name": "Advance Tickets For Summer 2016",
        "typeName": "AdvanceTickets",
        "startDate": "2016-08-06T00:00:00",
        "endDate": "2016-08-31T00:00:00",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v1/movie-lists/71",
            "templated": false
          }
        }
      },
      {
        "id": 72,
        "name": "Advance Tickets For Fall 2016",
        "typeName": "AdvanceTickets",
        "startDate": "2016-09-06T00:00:00",
        "endDate": "2016-11-06T00:00:00",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v1/movie-lists/72",
            "templated": false
          }
        }
      },
      {
        "id": 73,
        "name": "Now Playing For Summer 2016",
        "typeName": "NowPlaying",
        "startDate": "2016-06-01T00:00:00",
        "endDate": "2016-08-01T00:00:00",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v1/movie-lists/73",
            "templated": false
          }
        }
      }
    ],
    "_links": {
      "self": {
        "href": "https://api.amctheatres.com/v1/movie-lists",
        "templated": false
      }
    }
  }
}
Retrieves a list of type AdvanceTickets.
GET  /v1/movie-lists?type=AdvanceTickets

Response

{
  "count": 2,
  "movieLists": [
    {
      "_embedded": {
        "movieList": {
          "id": 71,
          "name": "Advance Tickets For Summer 2016",
          "typeName": "AdvanceTickets",
          "startDate": "2016-08-06T00:00:00",
          "endDate": "2016-08-31T00:00:00",
          "_links": {
            "self": {
              "href": "https://api.amctheatres.com/v1/movie-lists/71",
              "templated": false
            }
          }
        }
      }
    },
    {
      "_embedded": {
        "movieList": {
          "id": 72,
          "name": "Advance Tickets For Fall 2016",
          "typeName": "AdvanceTickets",
          "startDate": "2016-09-06T00:00:00",
          "endDate": "2016-11-06T00:00:00",
          "_links": {
            "self": {
              "href": "https://api.amctheatres.com/v1/movie-lists/72",
              "templated": false
            }
          }
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v1/movie-lists?type=advancetickets",
      "templated": false
    }
  }
}
Retrieves a list of type AdvanceTickets between 8-15-2016 and 8-31-2016
GET  /v1/movie-lists?type=AdvanceTickets&start-date=2016&end-date=2016

Response

{
  "count": 1,
  "movieLists": [
    {
      "_embedded": {
        "movieList": {
          "id": 71,
          "name": "Advance Tickets For Summer 2016",
          "typeName": "AdvanceTickets",
          "startDate": "2016-08-06T00:00:00",
          "endDate": "2016-08-31T00:00:00",
          "_links": {
            "self": {
              "href": "https://api.amctheatres.com/v1/movie-lists/71",
              "templated": false
            }
          }
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v1/movie-lists?type=advancetickets&&start-date=2016-08-15T00:00:00&&end-date=2016-08-31T00:00:00",
      "templated": false
    }
  }
}
Create a new list under the list type of AdvanceTickets.
POST  /v1/movie-lists

Request

{
  "name": "Advance Tickets For Summer 2016",
  "typeName": "AdvanceTickets",
  "startDate": "2016-08-06 00:00:00",
  "endDate": "2016-08-31 00:00:00"
}

Response

HTTP/1.1 201 Created
Location: https://api.amctheatres.com/v1/movie-lists/71
Gets the Current Now Playing list
GET  /v1/movie-lists/views/nowPlaying

Request

{
  "count": 1,
  "_embedded": {
    "movies": [
      {
        "sequence": 1,
        "_embedded": {
          "movie": {
            "id": 46001,
            "name": "Remaining, The"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v1/movie-lists/73",
      "templated": false
    }
  }
}

Response

HTTP/1.1 201 Created
Location: https://api.amctheatres.com/v1/movie-lists/views/nowPlaying
Add a title to the Now Playing 2016 list
POST  /v1/movie-lists/73

Request

{
  "movieId": 46001,
  "position": 1
}

Response

HTTP/1.1 201 Created
Location: https://api.amctheatres.com/v1/movie-lists/73
Updates the sequence of an existing movie in the list
PUT  /v1/movie-lists/73

Request

{
  "movieId": 46001,
  "position": 2
}

Response

HTTP/1.1 201 Created
Location: https://api.amctheatres.com/v1/movie-lists/73
Gets the Now Playing Summer 2016 list
GET  /v1/movie-lists/73

Request

{
  "count": 1,
  "_embedded": {
    "movies": [
      {
        "sequence": 1,
        "_embedded": {
          "movie": {
            "id": 46001,
            "name": "Remaining, The"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v1/movie-lists/73",
      "templated": false
    }
  }
}

Response

HTTP/1.1 201 Created
Location: https://api.amctheatres.com/v1/movie-lists/73
Deletes a list by id.
DELETE  /v1/movie-lists/10

Response

HTTP/1.1 200 OK
Deletes a movie from a list by id.
DELETE  /v1/movie-lists/10/1

Response

HTTP/1.1 200 OK