Bouquets

List a bouquet's streams, movies or TV shows

GET/management/bouquets/{id}/content/

read Read: looks, changes nothing. Scopes

One kind at a time, a page at a time, with in_bouquet on each row. With membership=out, what you could add to it.

Path parameters

  • idstring (uuid)required

    A UUID string identifying this Bouquet.

Query parameters

  • categorystring (uuid)

    Only this category.

  • kindstringrequired

    series: TV shows.

    One of: "movies" "series" "streams"

  • membershipstring

    in: what it holds; out: what you could add; all (default): both.

    One of: "all" "in" "out"

  • orderingstring

    name, category_name, is_active, in_bouquet, and status, is_on_demand (streams) or year; - first for descending.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Matches the name.

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idstring (uuid)required
    • namestringrequired
    • category_namestringrequiredcan be null
    • is_activebooleanrequired
    • in_bouquetbooleanrequired

      Whether the bouquet holds it.

    • statusstring

      Streams only.

    • is_on_demandboolean

      Streams only: starts when someone watches.

    • yearintegercan be null

      Movies and TV shows only.

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 404 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means