Created
April 2, 2022 06:20
-
-
Save dubpirate/034363c1a5da012501e4e686b0e96f58 to your computer and use it in GitHub Desktop.
Get to da Java!
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<article id="definitions" class="content"> | |
<h1>Definitions</h1> | |
<section class="summary" data-class-title="AbstractActivity"> | |
<h1 class="api-title"><a name="/definitions/AbstractActivity"></a>AbstractActivity </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
<span class="type">Discriminator</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> | |
enum[] | |
<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/DiaryEntryActivity">DiaryEntryActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/FilmLikeActivity">FilmLikeActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/FilmRatingActivity">FilmRatingActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/FilmWatchActivity">FilmWatchActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/FollowActivity">FollowActivity</a></span>, <span | |
class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/InvitationAcceptedActivity">InvitationAcceptedActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ListActivity">ListActivity</a></span>, <span | |
class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ListCommentActivity">ListCommentActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ListLikeActivity">ListLikeActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/RegistrationActivity">RegistrationActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ReviewActivity">ReviewActivity</a></span>, <span | |
class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ReviewCommentActivity">ReviewCommentActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ReviewLikeActivity">ReviewLikeActivity</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/StoryActivity">StoryActivity</a></span>, <span | |
class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/WatchlistActivity">WatchlistActivity</a></span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AbstractComment"> | |
<h1 class="api-title"><a name="/definitions/AbstractComment"></a>AbstractComment </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
<span class="type">Discriminator</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> | |
enum[] | |
<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ListComment">ListComment</a></span>, <span | |
class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ReviewComment">ReviewComment</a></span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of comment.</p> | |
</td> | |
</tr> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the comment/reply.</p> | |
</td> | |
</tr> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member who posted the comment.</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="whenUpdated"> | |
<td class="name"> | |
whenUpdated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="commentLbml"> | |
<td class="name"> | |
commentLbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The message portion of the comment in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="removedByAdmin"> | |
<td class="name"> | |
removedByAdmin | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If Letterboxd moderators have removed the comment from the site, | |
<code>removedByAdmin</code> will be true and <code>comment</code> will not be included. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="removedByContentOwner"> | |
<td class="name"> | |
removedByContentOwner | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the content owner has removed the comment from the site, | |
<code>removedByContentOwner</code> will be true and <code>comment</code> will not be | |
included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="deleted"> | |
<td class="name"> | |
deleted | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the comment owner has removed the comment from the site, <code>deleted</code> will be | |
true and <code>comment</code> will not be included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="blocked"> | |
<td class="name"> | |
blocked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the authenticated member has blocked the commenter, <code>blocked</code> will be true | |
and <code>comment</code> will not be included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="blockedByOwner"> | |
<td class="name"> | |
blockedByOwner | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the content owner has blocked the commenter, <code>blockedByOwner</code> will be true | |
and <code>comment</code> will not be included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="editableWindowExpiresIn"> | |
<td class="name"> | |
editableWindowExpiresIn | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If | |
the authenticated member posted this comment, and the comment is still | |
editable, this value shows the number of seconds remaining until the | |
editing window closes.</p> | |
</td> | |
</tr> | |
<tr data-property-name="comment"> | |
<td class="name"> | |
comment | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The message portion of the comment formatted as HTML.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AbstractSearchItem"> | |
<h1 class="api-title"><a name="/definitions/AbstractSearchItem"></a>AbstractSearchItem </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
<span class="type">Discriminator</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> | |
enum[] | |
<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ContributorSearchItem">ContributorSearchItem</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/FilmSearchItem">FilmSearchItem</a></span>, <span | |
class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ListSearchItem">ListSearchItem</a></span>, <span | |
class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/MemberSearchItem">MemberSearchItem</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ReviewSearchItem">ReviewSearchItem</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/TagSearchItem">TagSearchItem</a></span>, <span | |
class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/StorySearchItem">StorySearchItem</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/ArticleSearchItem">ArticleSearchItem</a></span>, | |
<span class="json-property-enum-item"><a class="json-schema-ref" | |
href="#/definitions/PodcastSearchItem">PodcastSearchItem</a></span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of the search result.</p> | |
</td> | |
</tr> | |
<tr data-property-name="score"> | |
<td class="name"> | |
score | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AccessToken"> | |
<h1 class="api-title"><a name="/definitions/AccessToken"></a>AccessToken </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="access_token"> | |
<td class="name"> | |
access_token | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The access token that grants the member access. Combine this with the | |
<code>token_type</code> to form the <code>Authorization</code> header.</p> | |
</td> | |
</tr> | |
<tr data-property-name="token_type"> | |
<td class="name"> | |
token_type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of the access token. Use value: <code>bearer</code></p> | |
</td> | |
</tr> | |
<tr data-property-name="refresh_token"> | |
<td class="name"> | |
refresh_token | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
refresh token is used to obtain a new access token, after the access | |
token expires, without needing to prompt the member for their | |
credentials again. The refresh token only expires if it is explicitly | |
invalidated by Letterboxd, in which case the member should be prompted | |
for their credentials (or stored credentials used).</p> | |
</td> | |
</tr> | |
<tr data-property-name="expires_in"> | |
<td class="name"> | |
expires_in | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of seconds before the access token expires.</p> | |
</td> | |
</tr> | |
<tr data-property-name="issuer"> | |
<td class="name"> | |
issuer | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ActivityResponse"> | |
<h1 class="api-title"><a name="/definitions/ActivityResponse"></a>ActivityResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/AbstractActivity">AbstractActivity</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of activity items.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AListAddition"> | |
<h1 class="api-title"><a name="/definitions/AListAddition"></a>AListAddition </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="list"> | |
<td class="name"> | |
list | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/ListIdentifier">ListIdentifier</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="additions"> | |
<td class="name"> | |
additions | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films added to the list.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AListEntryOccurrence"> | |
<h1 class="api-title"><a name="/definitions/AListEntryOccurrence"></a>AListEntryOccurrence </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="rank"> | |
<td class="name"> | |
rank | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the list is ranked, this is the entry’s rank in the list, numbered from 1.</p> | |
</td> | |
</tr> | |
<tr data-property-name="filmId"> | |
<td class="name"> | |
filmId | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film LID for this entry.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AListTopic"> | |
<h1 class="api-title"><a name="/definitions/AListTopic"></a>AListTopic </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The topic name.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListSummary">ListSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of featured lists for the topic.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AppleIAPSubscription"> | |
<h1 class="api-title"><a name="/definitions/AppleIAPSubscription"></a>AppleIAPSubscription </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="subscriptionDaysRemaining"> | |
<td class="name"> | |
subscriptionDaysRemaining | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
number of days until the subscription ends. Only included if the | |
subscription is current. May be 0, in which case the subscription is | |
current but will end today.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AppleIAPSubscriptionMessage"> | |
<h1 class="api-title"><a name="/definitions/AppleIAPSubscriptionMessage"></a>AppleIAPSubscriptionMessage </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">SubscriptionAlreadyExpired, </span><span | |
class="json-property-enum-item">SubscriptionBelongsToAnotherMember, </span><span | |
class="json-property-enum-item">UnexpectedError</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AppleIAPSubscriptionRequest"> | |
<h1 class="api-title"><a name="/definitions/AppleIAPSubscriptionRequest"></a>AppleIAPSubscriptionRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="receiptToken"> | |
<td class="name"> | |
receiptToken | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The receipt token (Base-64 encoded).</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="AppleIAPSubscriptionResponse"> | |
<h1 class="api-title"><a name="/definitions/AppleIAPSubscriptionResponse"></a>AppleIAPSubscriptionResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/AppleIAPSubscription">AppleIAPSubscription</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/AppleIAPSubscriptionMessage">AppleIAPSubscriptionMessage</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ArticleSearchItem"> | |
<h1 class="api-title"><a name="/definitions/ArticleSearchItem"></a>ArticleSearchItem <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractSearchItem">AbstractSearchItem</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="score"> | |
<td class="name"> | |
score <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="article"> | |
<td class="name"> | |
article | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/NewsItem">NewsItem</a></span> | |
</td> | |
<td class="desc"> | |
<p>The article.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="CommentCreationRequest"> | |
<h1 class="api-title"><a name="/definitions/CommentCreationRequest"></a>CommentCreationRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="comment"> | |
<td class="name"> | |
comment | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The message portion of the comment in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>. This field has a maximum size of 100,000 characters. | |
</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="CommentUpdateMessage"> | |
<h1 class="api-title"><a name="/definitions/CommentUpdateMessage"></a>CommentUpdateMessage </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">MissingComment, </span><span | |
class="json-property-enum-item">CommentOnContentYouBlocked, </span><span | |
class="json-property-enum-item">CommentOnBlockedContent, </span><span | |
class="json-property-enum-item">CommentBan, </span><span | |
class="json-property-enum-item">CommentEditWindowExpired, </span><span | |
class="json-property-enum-item">CommentTooLong</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="CommentUpdateRequest"> | |
<h1 class="api-title"><a name="/definitions/CommentUpdateRequest"></a>CommentUpdateRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="comment"> | |
<td class="name"> | |
comment | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The message portion of the comment in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>. This field has a maximum size of 100,000 characters. | |
</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="CommentUpdateResponse"> | |
<h1 class="api-title"><a name="/definitions/CommentUpdateResponse"></a>CommentUpdateResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/AbstractComment">AbstractComment</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/CommentUpdateMessage">CommentUpdateMessage</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ContributionStatistics"> | |
<h1 class="api-title"><a name="/definitions/ContributionStatistics"></a>ContributionStatistics </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Director, </span><span | |
class="json-property-enum-item">CoDirector, </span><span | |
class="json-property-enum-item">Actor, </span><span | |
class="json-property-enum-item">Producer, </span><span | |
class="json-property-enum-item">Writer, </span><span | |
class="json-property-enum-item">Editor, </span><span | |
class="json-property-enum-item">Cinematography, </span><span | |
class="json-property-enum-item">ProductionDesign, </span><span | |
class="json-property-enum-item">ArtDirection, </span><span | |
class="json-property-enum-item">SetDecoration, </span><span | |
class="json-property-enum-item">VisualEffects, </span><span | |
class="json-property-enum-item">Composer, </span><span | |
class="json-property-enum-item">Sound, </span><span | |
class="json-property-enum-item">Costumes, </span><span | |
class="json-property-enum-item">MakeUp, </span><span | |
class="json-property-enum-item">Studio</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of contribution.</p> | |
</td> | |
</tr> | |
<tr data-property-name="filmCount"> | |
<td class="name"> | |
filmCount | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films for this contribution type.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Contributor"> | |
<h1 class="api-title"><a name="/definitions/Contributor"></a>Contributor </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the contributor.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the contributor.</p> | |
</td> | |
</tr> | |
<tr data-property-name="tmdbid"> | |
<td class="name"> | |
tmdbid | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The ID of the contributor on TMDB, if known</p> | |
</td> | |
</tr> | |
<tr data-property-name="statistics"> | |
<td class="name"> | |
statistics | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ContributorStatistics">ContributorStatistics</a></span> | |
</td> | |
<td class="desc"> | |
<p>An array of the types of contributions made, with a count of films for each contribution | |
type.</p> | |
</td> | |
</tr> | |
<tr data-property-name="links"> | |
<td class="name"> | |
links | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Link">Link</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of relevant URLs for this entity, on Letterboxd and external sites.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ContributorSearchItem"> | |
<h1 class="api-title"><a name="/definitions/ContributorSearchItem"></a>ContributorSearchItem <span | |
class="type">< <a class="json-schema-ref" | |
href="#/definitions/AbstractSearchItem">AbstractSearchItem</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="score"> | |
<td class="name"> | |
score <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="contributor"> | |
<td class="name"> | |
contributor | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/Contributor">Contributor</a></span> | |
</td> | |
<td class="desc"> | |
<p>Details of the contributor.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ContributorStatistics"> | |
<h1 class="api-title"><a name="/definitions/ContributorStatistics"></a>ContributorStatistics </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="contributions"> | |
<td class="name"> | |
contributions | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ContributionStatistics">ContributionStatistics</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The statistics for each contribution type.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ContributorSummary"> | |
<h1 class="api-title"><a name="/definitions/ContributorSummary"></a>ContributorSummary </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the contributor.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the contributor.</p> | |
</td> | |
</tr> | |
<tr data-property-name="characterName"> | |
<td class="name"> | |
characterName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The character name if available (only if the contribution is as an <code>Actor</code>; | |
see the <code>type</code> field in <a | |
href="#/definitions/FilmContributions">FilmContributions</a>).</p> | |
</td> | |
</tr> | |
<tr data-property-name="tmdbid"> | |
<td class="name"> | |
tmdbid | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The ID of the contributor on TMDB, if known</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="CountriesResponse"> | |
<h1 class="api-title"><a name="/definitions/CountriesResponse"></a>CountriesResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Country">Country</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of countries.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Country"> | |
<h1 class="api-title"><a name="/definitions/Country"></a>Country </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The ISO 3166-1 defined code of the country.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the country.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Cursor"> | |
<h1 class="api-title"><a name="/definitions/Cursor"></a>Cursor </h1> | |
<section class="json-schema-description"> | |
<p>A cursor is a string value provided by the API. It should be treated as an opaque value — don’t change | |
it.</p> | |
</section> | |
</section> | |
<section class="summary" data-class-title="DeregisterPushNotificationsRequest"> | |
<h1 class="api-title"><a | |
name="/definitions/DeregisterPushNotificationsRequest"></a>DeregisterPushNotificationsRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="deviceId"> | |
<td class="name"> | |
deviceId | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The device ID.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="DiaryDetails"> | |
<h1 class="api-title"><a name="/definitions/DiaryDetails"></a>DiaryDetails </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="diaryDate"> | |
<td class="name"> | |
diaryDate | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The date the film was watched, if specified, in ISO 8601 format, i.e. | |
<code>YYYY-MM-DD</code></p> | |
</td> | |
</tr> | |
<tr data-property-name="rewatch"> | |
<td class="name"> | |
rewatch | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member has indicated (or it can be otherwise determined) | |
that the member has seen the film prior to this date.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="DiaryEntryActivity"> | |
<h1 class="api-title"><a name="/definitions/DiaryEntryActivity"></a>DiaryEntryActivity <span class="type">< | |
<a class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="diaryEntry"> | |
<td class="name"> | |
diaryEntry | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/LogEntry">LogEntry</a></span> | |
</td> | |
<td class="desc"> | |
<p>The log entry associated with this activity</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="DisableAccountRequest"> | |
<h1 class="api-title"><a name="/definitions/DisableAccountRequest"></a>DisableAccountRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="currentPassword"> | |
<td class="name"> | |
currentPassword | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s current password.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Film"> | |
<h1 class="api-title"><a name="/definitions/Film"></a>Film </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The title of the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="originalName"> | |
<td class="name"> | |
originalName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The original title of the film, if it was first released with a non-English title.</p> | |
</td> | |
</tr> | |
<tr data-property-name="alternativeNames"> | |
<td class="name"> | |
alternativeNames | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The other names by which the film is known (including alternative titles and/or foreign | |
translations).</p> | |
</td> | |
</tr> | |
<tr data-property-name="releaseYear"> | |
<td class="name"> | |
releaseYear | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The year in which the film was first released.</p> | |
</td> | |
</tr> | |
<tr data-property-name="directors"> | |
<td class="name"> | |
directors | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ContributorSummary">ContributorSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of directors for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="poster"> | |
<td class="name"> | |
poster | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film’s poster image (2:3 aspect ratio in multiple sizes). Will contain only a single | |
obfuscated image if the <code>adult</code> flag is <code>true</code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="adultPoster"> | |
<td class="name"> | |
adultPoster | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film’s unobfuscated poster image (2:3 aspect ratio in multiple sizes), only populated | |
if the <code>adult</code> flag is <code>true</code>, may contain adult content.</p> | |
</td> | |
</tr> | |
<tr data-property-name="top250Position"> | |
<td class="name"> | |
top250Position | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film’s position in the official Letterboxd Top 250 list of narrative feature films, | |
<code>null</code> if the film is not in the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="adult"> | |
<td class="name"> | |
adult | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p><code>true</code> if the film is in TMDb’s ‘Adult’ category.</p> | |
</td> | |
</tr> | |
<tr data-property-name="filmCollectionId"> | |
<td class="name"> | |
filmCollectionId | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the collection containing this film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="links"> | |
<td class="name"> | |
links | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Link">Link</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of relevant URLs for this entity, on Letterboxd and external sites.</p> | |
</td> | |
</tr> | |
<tr data-property-name="relationships"> | |
<td class="name"> | |
relationships | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/MemberFilmRelationship">MemberFilmRelationship</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Relationships to the film for the authenticated member (if any) and other members where | |
relevant.</p> | |
</td> | |
</tr> | |
<tr data-property-name="genres"> | |
<td class="name"> | |
genres | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Genre">Genre</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film’s genres.</p> | |
</td> | |
</tr> | |
<tr data-property-name="tagline"> | |
<td class="name"> | |
tagline | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tagline for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="description"> | |
<td class="name"> | |
description | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A synopsis of the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="runTime"> | |
<td class="name"> | |
runTime | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film’s duration (in minutes).</p> | |
</td> | |
</tr> | |
<tr data-property-name="backdrop"> | |
<td class="name"> | |
backdrop | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film’s backdrop image (16:9 ratio in multiple sizes).</p> | |
</td> | |
</tr> | |
<tr data-property-name="backdropFocalPoint"> | |
<td class="name"> | |
backdropFocalPoint | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The backdrop’s vertical focal point, expressed as a proportion of the image’s height, | |
using values between <code>0.0</code> and <code>1.0</code>. Use when cropping the image | |
into a shorter space, such as in the page for a film on the Letterboxd site.</p> | |
</td> | |
</tr> | |
<tr data-property-name="trailer"> | |
<td class="name"> | |
trailer | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/FilmTrailer">FilmTrailer</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film’s trailer.</p> | |
</td> | |
</tr> | |
<tr data-property-name="countries"> | |
<td class="name"> | |
countries | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Country">Country</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film’s production countries.</p> | |
</td> | |
</tr> | |
<tr data-property-name="languages"> | |
<td class="name"> | |
languages | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Language">Language</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film’s spoken languages.</p> | |
</td> | |
</tr> | |
<tr data-property-name="contributions"> | |
<td class="name"> | |
contributions | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmContributions">FilmContributions</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film’s contributors (director, cast and crew) grouped by discipline.</p> | |
</td> | |
</tr> | |
<tr data-property-name="news"> | |
<td class="name"> | |
news | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/NewsItem">NewsItem</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The related news items for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="recentStories"> | |
<td class="name"> | |
recentStories | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Story">Story</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The related recent stories for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="similarTo"> | |
<td class="name"> | |
similarTo | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p><strong class="firstparty-label">FIRST PARTY</strong> The other films most similar | |
to the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="themes"> | |
<td class="name"> | |
themes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Theme">Theme</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p><strong class="firstparty-label">FIRST PARTY</strong> The film’s themes.</p> | |
</td> | |
</tr> | |
<tr data-property-name="minigenres"> | |
<td class="name"> | |
minigenres | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Minigenre">Minigenre</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p><strong class="firstparty-label">FIRST PARTY</strong> The film’s minigenres.</p> | |
</td> | |
</tr> | |
<tr data-property-name="nanogenres"> | |
<td class="name"> | |
nanogenres | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Nanogenre">Nanogenre</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p><strong class="firstparty-label">FIRST PARTY</strong> The film’s nanogenres.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmAvailability"> | |
<h1 class="api-title"><a name="/definitions/FilmAvailability"></a>FilmAvailability </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="service"> | |
<td class="name"> | |
service | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Amazon, </span><span | |
class="json-property-enum-item">AmazonVideo, </span><span | |
class="json-property-enum-item">AmazonPrime, </span><span | |
class="json-property-enum-item">iTunes, </span><span | |
class="json-property-enum-item">Netflix</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p><strong class="deprecated-label">DEPRECATED</strong> Use <code>displayName</code> | |
instead.</p> | |
</td> | |
</tr> | |
<tr data-property-name="displayName"> | |
<td class="name"> | |
displayName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the service.</p> | |
</td> | |
</tr> | |
<tr data-property-name="icon"> | |
<td class="name"> | |
icon | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The URL of the thumbnail image for the service.</p> | |
</td> | |
</tr> | |
<tr data-property-name="country"> | |
<td class="name"> | |
country | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">AIA, </span><span | |
class="json-property-enum-item">ARE, </span><span | |
class="json-property-enum-item">ARG, </span><span | |
class="json-property-enum-item">ARM, </span><span | |
class="json-property-enum-item">ATG, </span><span | |
class="json-property-enum-item">AUS, </span><span | |
class="json-property-enum-item">AUT, </span><span | |
class="json-property-enum-item">AZE, </span><span | |
class="json-property-enum-item">BEL, </span><span | |
class="json-property-enum-item">BFA, </span><span | |
class="json-property-enum-item">BGR, </span><span | |
class="json-property-enum-item">BHR, </span><span | |
class="json-property-enum-item">BHS, </span><span | |
class="json-property-enum-item">BLR, </span><span | |
class="json-property-enum-item">BLZ, </span><span | |
class="json-property-enum-item">BMU, </span><span | |
class="json-property-enum-item">BOL, </span><span | |
class="json-property-enum-item">BRA, </span><span | |
class="json-property-enum-item">BRB, </span><span | |
class="json-property-enum-item">BRN, </span><span | |
class="json-property-enum-item">BWA, </span><span | |
class="json-property-enum-item">CAN, </span><span | |
class="json-property-enum-item">CHE, </span><span | |
class="json-property-enum-item">CHL, </span><span | |
class="json-property-enum-item">CHN, </span><span | |
class="json-property-enum-item">COL, </span><span | |
class="json-property-enum-item">CPV, </span><span | |
class="json-property-enum-item">CRI, </span><span | |
class="json-property-enum-item">CYM, </span><span | |
class="json-property-enum-item">CYP, </span><span | |
class="json-property-enum-item">CZE, </span><span | |
class="json-property-enum-item">DEU, </span><span | |
class="json-property-enum-item">DMA, </span><span | |
class="json-property-enum-item">DNK, </span><span | |
class="json-property-enum-item">DOM, </span><span | |
class="json-property-enum-item">ECU, </span><span | |
class="json-property-enum-item">EGY, </span><span | |
class="json-property-enum-item">ESP, </span><span | |
class="json-property-enum-item">EST, </span><span | |
class="json-property-enum-item">FIN, </span><span | |
class="json-property-enum-item">FJI, </span><span | |
class="json-property-enum-item">FRA, </span><span | |
class="json-property-enum-item">FSM, </span><span | |
class="json-property-enum-item">GBR, </span><span | |
class="json-property-enum-item">GHA, </span><span | |
class="json-property-enum-item">GMB, </span><span | |
class="json-property-enum-item">GNB, </span><span | |
class="json-property-enum-item">GRC, </span><span | |
class="json-property-enum-item">GRD, </span><span | |
class="json-property-enum-item">GTM, </span><span | |
class="json-property-enum-item">HKG, </span><span | |
class="json-property-enum-item">HND, </span><span | |
class="json-property-enum-item">HRV, </span><span | |
class="json-property-enum-item">HUN, </span><span | |
class="json-property-enum-item">IDN, </span><span | |
class="json-property-enum-item">IND, </span><span | |
class="json-property-enum-item">IRL, </span><span | |
class="json-property-enum-item">ISR, </span><span | |
class="json-property-enum-item">ITA, </span><span | |
class="json-property-enum-item">ISL, </span><span | |
class="json-property-enum-item">JOR, </span><span | |
class="json-property-enum-item">JPN, </span><span | |
class="json-property-enum-item">KAZ, </span><span | |
class="json-property-enum-item">KEN, </span><span | |
class="json-property-enum-item">KGZ, </span><span | |
class="json-property-enum-item">KHM, </span><span | |
class="json-property-enum-item">KNA, </span><span | |
class="json-property-enum-item">KOR, </span><span | |
class="json-property-enum-item">LAO, </span><span | |
class="json-property-enum-item">LBN, </span><span | |
class="json-property-enum-item">LKA, </span><span | |
class="json-property-enum-item">LTU, </span><span | |
class="json-property-enum-item">LUX, </span><span | |
class="json-property-enum-item">LVA, </span><span | |
class="json-property-enum-item">MAC, </span><span | |
class="json-property-enum-item">MDA, </span><span | |
class="json-property-enum-item">MEX, </span><span | |
class="json-property-enum-item">MLT, </span><span | |
class="json-property-enum-item">MNG, </span><span | |
class="json-property-enum-item">MOZ, </span><span | |
class="json-property-enum-item">MUS, </span><span | |
class="json-property-enum-item">MYS, </span><span | |
class="json-property-enum-item">NAM, </span><span | |
class="json-property-enum-item">NER, </span><span | |
class="json-property-enum-item">NGA, </span><span | |
class="json-property-enum-item">NIC, </span><span | |
class="json-property-enum-item">NLD, </span><span | |
class="json-property-enum-item">NOR, </span><span | |
class="json-property-enum-item">NPL, </span><span | |
class="json-property-enum-item">NZL, </span><span | |
class="json-property-enum-item">OMN, </span><span | |
class="json-property-enum-item">PAN, </span><span | |
class="json-property-enum-item">PER, </span><span | |
class="json-property-enum-item">PHL, </span><span | |
class="json-property-enum-item">PNG, </span><span | |
class="json-property-enum-item">POL, </span><span | |
class="json-property-enum-item">PRT, </span><span | |
class="json-property-enum-item">PRY, </span><span | |
class="json-property-enum-item">QAT, </span><span | |
class="json-property-enum-item">ROU, </span><span | |
class="json-property-enum-item">RUS, </span><span | |
class="json-property-enum-item">SAU, </span><span | |
class="json-property-enum-item">SGP, </span><span | |
class="json-property-enum-item">SLV, </span><span | |
class="json-property-enum-item">SVK, </span><span | |
class="json-property-enum-item">SVN, </span><span | |
class="json-property-enum-item">SWE, </span><span | |
class="json-property-enum-item">SWZ, </span><span | |
class="json-property-enum-item">THA, </span><span | |
class="json-property-enum-item">TJK, </span><span | |
class="json-property-enum-item">TKM, </span><span | |
class="json-property-enum-item">TTO, </span><span | |
class="json-property-enum-item">TUR, </span><span | |
class="json-property-enum-item">TWN, </span><span | |
class="json-property-enum-item">UGA, </span><span | |
class="json-property-enum-item">UKR, </span><span | |
class="json-property-enum-item">USA, </span><span | |
class="json-property-enum-item">UZB, </span><span | |
class="json-property-enum-item">VEN, </span><span | |
class="json-property-enum-item">VGB, </span><span | |
class="json-property-enum-item">VNM, </span><span | |
class="json-property-enum-item">ZAF, </span><span | |
class="json-property-enum-item">ZWE, </span><span | |
class="json-property-enum-item">GUF, </span><span | |
class="json-property-enum-item">YEM, </span><span | |
class="json-property-enum-item">KWT, </span><span | |
class="json-property-enum-item">LBY, </span><span | |
class="json-property-enum-item">MAR, </span><span | |
class="json-property-enum-item">DZA, </span><span | |
class="json-property-enum-item">TUN, </span><span | |
class="json-property-enum-item">GIB, </span><span | |
class="json-property-enum-item">SMR, </span><span | |
class="json-property-enum-item">MCO, </span><span | |
class="json-property-enum-item">LIE, </span><span | |
class="json-property-enum-item">URY, </span><span | |
class="json-property-enum-item">JAM</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The regional store for the service. Not all countries are supported on all services.</p> | |
</td> | |
</tr> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The unique ID (if any) for the film on this service.</p> | |
</td> | |
</tr> | |
<tr data-property-name="url"> | |
<td class="name"> | |
url | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The URL for the film on this service.</p> | |
</td> | |
</tr> | |
<tr data-property-name="types"> | |
<td class="name"> | |
types | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The types of the availability, possible options included buy, rent and stream</p> | |
</td> | |
</tr> | |
<tr data-property-name="serviceCode"> | |
<td class="name"> | |
serviceCode | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The code for the service.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmAvailabilityResponse"> | |
<h1 class="api-title"><a name="/definitions/FilmAvailabilityResponse"></a>FilmAvailabilityResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmAvailability">FilmAvailability</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
list of stores where the film is available for streaming or purchasing, | |
in order of preference. If the member has not specified their preferred | |
stores for a service, the USA store will be assumed.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmCollection"> | |
<h1 class="api-title"><a name="/definitions/FilmCollection"></a>FilmCollection </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the film collection.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the collection.</p> | |
</td> | |
</tr> | |
<tr data-property-name="films"> | |
<td class="name"> | |
films | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of films in the collection.</p> | |
</td> | |
</tr> | |
<tr data-property-name="links"> | |
<td class="name"> | |
links | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Link">Link</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of relevant URLs for this entity, on Letterboxd and external sites.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmContribution"> | |
<h1 class="api-title"><a name="/definitions/FilmContribution"></a>FilmContribution </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Director, </span><span | |
class="json-property-enum-item">CoDirector, </span><span | |
class="json-property-enum-item">Actor, </span><span | |
class="json-property-enum-item">Producer, </span><span | |
class="json-property-enum-item">Writer, </span><span | |
class="json-property-enum-item">Editor, </span><span | |
class="json-property-enum-item">Cinematography, </span><span | |
class="json-property-enum-item">ProductionDesign, </span><span | |
class="json-property-enum-item">ArtDirection, </span><span | |
class="json-property-enum-item">SetDecoration, </span><span | |
class="json-property-enum-item">VisualEffects, </span><span | |
class="json-property-enum-item">Composer, </span><span | |
class="json-property-enum-item">Sound, </span><span | |
class="json-property-enum-item">Costumes, </span><span | |
class="json-property-enum-item">MakeUp, </span><span | |
class="json-property-enum-item">Studio</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of contribution.</p> | |
</td> | |
</tr> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/FilmSummary">FilmSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="characterName"> | |
<td class="name"> | |
characterName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the character (only when <code>type</code> is <code>Actor</code>).</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmContributions"> | |
<h1 class="api-title"><a name="/definitions/FilmContributions"></a>FilmContributions </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Director, </span><span | |
class="json-property-enum-item">CoDirector, </span><span | |
class="json-property-enum-item">Actor, </span><span | |
class="json-property-enum-item">Producer, </span><span | |
class="json-property-enum-item">Writer, </span><span | |
class="json-property-enum-item">Editor, </span><span | |
class="json-property-enum-item">Cinematography, </span><span | |
class="json-property-enum-item">ProductionDesign, </span><span | |
class="json-property-enum-item">ArtDirection, </span><span | |
class="json-property-enum-item">SetDecoration, </span><span | |
class="json-property-enum-item">VisualEffects, </span><span | |
class="json-property-enum-item">Composer, </span><span | |
class="json-property-enum-item">Sound, </span><span | |
class="json-property-enum-item">Costumes, </span><span | |
class="json-property-enum-item">MakeUp, </span><span | |
class="json-property-enum-item">Studio</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of contribution.</p> | |
</td> | |
</tr> | |
<tr data-property-name="contributors"> | |
<td class="name"> | |
contributors | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ContributorSummary">ContributorSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of contributors of the specified type for the film.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmContributionsCollection"> | |
<h1 class="api-title"><a name="/definitions/FilmContributionsCollection"></a>FilmContributionsCollection </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="contributions"> | |
<td class="name"> | |
contributions | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmContributions">FilmContributions</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film’s contributors (director, cast and crew) grouped by discipline.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmContributionsResponse"> | |
<h1 class="api-title"><a name="/definitions/FilmContributionsResponse"></a>FilmContributionsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmContribution">FilmContribution</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of contributions.</p> | |
</td> | |
</tr> | |
<tr data-property-name="metadata"> | |
<td class="name"> | |
metadata | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmContributorMetadata">FilmContributorMetadata</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Metadata about the contributor’s contributions.</p> | |
</td> | |
</tr> | |
<tr data-property-name="relationships"> | |
<td class="name"> | |
relationships | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmContributorMemberRelationship">FilmContributorMemberRelationship</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The relationships to the contributor for the members referenced in the request.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmContributorMemberRelationship"> | |
<h1 class="api-title"><a | |
name="/definitions/FilmContributorMemberRelationship"></a>FilmContributorMemberRelationship </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="relationships"> | |
<td class="name"> | |
relationships | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmContributorRelationship">FilmContributorRelationship</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The relationship details.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmContributorMetadata"> | |
<h1 class="api-title"><a name="/definitions/FilmContributorMetadata"></a>FilmContributorMetadata </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Director, </span><span | |
class="json-property-enum-item">CoDirector, </span><span | |
class="json-property-enum-item">Actor, </span><span | |
class="json-property-enum-item">Producer, </span><span | |
class="json-property-enum-item">Writer, </span><span | |
class="json-property-enum-item">Editor, </span><span | |
class="json-property-enum-item">Cinematography, </span><span | |
class="json-property-enum-item">ProductionDesign, </span><span | |
class="json-property-enum-item">ArtDirection, </span><span | |
class="json-property-enum-item">SetDecoration, </span><span | |
class="json-property-enum-item">VisualEffects, </span><span | |
class="json-property-enum-item">Composer, </span><span | |
class="json-property-enum-item">Sound, </span><span | |
class="json-property-enum-item">Costumes, </span><span | |
class="json-property-enum-item">MakeUp, </span><span | |
class="json-property-enum-item">Studio</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of contribution.</p> | |
</td> | |
</tr> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/FilmsMetadata">FilmsMetadata</a></span> | |
</td> | |
<td class="desc"> | |
<p>The details for this contribution type.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmContributorRelationship"> | |
<h1 class="api-title"><a name="/definitions/FilmContributorRelationship"></a>FilmContributorRelationship </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Director, </span><span | |
class="json-property-enum-item">CoDirector, </span><span | |
class="json-property-enum-item">Actor, </span><span | |
class="json-property-enum-item">Producer, </span><span | |
class="json-property-enum-item">Writer, </span><span | |
class="json-property-enum-item">Editor, </span><span | |
class="json-property-enum-item">Cinematography, </span><span | |
class="json-property-enum-item">ProductionDesign, </span><span | |
class="json-property-enum-item">ArtDirection, </span><span | |
class="json-property-enum-item">SetDecoration, </span><span | |
class="json-property-enum-item">VisualEffects, </span><span | |
class="json-property-enum-item">Composer, </span><span | |
class="json-property-enum-item">Sound, </span><span | |
class="json-property-enum-item">Costumes, </span><span | |
class="json-property-enum-item">MakeUp, </span><span | |
class="json-property-enum-item">Studio</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of contribution.</p> | |
</td> | |
</tr> | |
<tr data-property-name="relationship"> | |
<td class="name"> | |
relationship | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmsRelationship">FilmsRelationship</a></span> | |
</td> | |
<td class="desc"> | |
<p>The relationship the member has with the (filtered) films.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmIdentifier"> | |
<h1 class="api-title"><a name="/definitions/FilmIdentifier"></a>FilmIdentifier </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the film.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmLikeActivity"> | |
<h1 class="api-title"><a name="/definitions/FilmLikeActivity"></a>FilmLikeActivity <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film associated with the activity. Includes a | |
<code>MemberFilmRelationship</code> for the member who added the activity.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="FilmRatingActivity"> | |
<h1 class="api-title"><a name="/definitions/FilmRatingActivity"></a>FilmRatingActivity <span class="type">< | |
<a class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film associated with the activity. Includes a | |
<code>MemberFilmRelationship</code> for the member who added the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="rating"> | |
<td class="name"> | |
rating | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s rating for the film. Allowable values are between <code>0.5</code> | |
and <code>5.0</code>, with increments of <code>0.5</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="FilmRelationship"> | |
<h1 class="api-title"><a name="/definitions/FilmRelationship"></a>FilmRelationship </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="watched"> | |
<td class="name"> | |
watched | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member has indicated they’ve seen the film (via the | |
‘eye’ icon) or has a log entry for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenWatched"> | |
<td class="name"> | |
whenWatched | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If <code>watched=true</code>, <code>whenWatched</code> will contain the time when the | |
member marked the film as watched. ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
</td> | |
</tr> | |
<tr data-property-name="liked"> | |
<td class="name"> | |
liked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member likes the film (via the ‘heart’ icon).</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenLiked"> | |
<td class="name"> | |
whenLiked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If <code>liked=true</code>, <code>whenLiked</code> will contain the time when the member | |
marked the film as liked. ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
</td> | |
</tr> | |
<tr data-property-name="favorited"> | |
<td class="name"> | |
favorited | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member listed the film as one of their four favorites. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="inWatchlist"> | |
<td class="name"> | |
inWatchlist | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the film is in the member’s watchlist.</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenAddedToWatchlist"> | |
<td class="name"> | |
whenAddedToWatchlist | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If <code>inWatchlist=true</code>, <code>whenAddedToWatchlist</code> will contain the time | |
when the member added the film to their watchlist. ISO 8601 format with UTC timezone, | |
i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
</td> | |
</tr> | |
<tr data-property-name="whenCompletedInWatchlist"> | |
<td class="name"> | |
whenCompletedInWatchlist | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the member used to have the film in their watchlist, and subsequently watched the | |
film, <code>whenCompletedInWatchlist</code> will contain the time when the member marked | |
the film as watched. ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
</td> | |
</tr> | |
<tr data-property-name="rating"> | |
<td class="name"> | |
rating | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s rating for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="reviews"> | |
<td class="name"> | |
reviews | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of LIDs for reviews the member has written for the film in the order they were | |
added, with most recent reviews first.</p> | |
</td> | |
</tr> | |
<tr data-property-name="diaryEntries"> | |
<td class="name"> | |
diaryEntries | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of LIDs for log entries the member has added for the film in diary order, with | |
most recent entries first.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmRelationshipUpdateMessage"> | |
<h1 class="api-title"><a name="/definitions/FilmRelationshipUpdateMessage"></a>FilmRelationshipUpdateMessage | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">InvalidRatingValue, </span><span | |
class="json-property-enum-item">UnableToRemoveWatch</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmRelationshipUpdateRequest"> | |
<h1 class="api-title"><a name="/definitions/FilmRelationshipUpdateRequest"></a>FilmRelationshipUpdateRequest | |
</h1> | |
<section class="json-schema-description"> | |
<p>When <code>PATCH</code>ing a | |
film relationship, you may send all of the current property values, or | |
just those you wish to change. Properties that violate business rules | |
(see <code>watched</code> below) or contain invalid values will be ignored.</p> | |
</section> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="watched"> | |
<td class="name"> | |
watched | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> to change the film’s status for the authenticated member to | |
‘watched’ or <code>false</code> | |
for ‘not watched’. If the status is changed to ‘watched’ and the film | |
is in the member’s watchlist, it will be removed as part of this action. | |
You may not change the status of a film to ‘not watched’ if there is | |
existing activity (a rating, review or diary entry) for the | |
authenticated member—check the messages returned from this endpoint to | |
ensure no such business rules have been violated.</p> | |
</td> | |
</tr> | |
<tr data-property-name="liked"> | |
<td class="name"> | |
liked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> to change the film’s status for the authenticated member to | |
‘liked’ or <code>false</code> for ‘not liked’.</p> | |
</td> | |
</tr> | |
<tr data-property-name="inWatchlist"> | |
<td class="name"> | |
inWatchlist | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> to add the film to the authenticated member’s watchlist, or | |
<code>false</code> to remove it.</p> | |
</td> | |
</tr> | |
<tr data-property-name="rating"> | |
<td class="name"> | |
rating | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Accepts values between <code>0.5</code> and <code>5.0</code>, with increments of | |
<code>0.5</code>, or <code>null</code> (to remove the rating). If set, | |
<code>watched</code> is assumed to be <code>true</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmRelationshipUpdateResponse"> | |
<h1 class="api-title"><a name="/definitions/FilmRelationshipUpdateResponse"></a>FilmRelationshipUpdateResponse | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmRelationship">FilmRelationship</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmRelationshipUpdateMessage">FilmRelationshipUpdateMessage</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmsAutocompleteResponse"> | |
<h1 class="api-title"><a name="/definitions/FilmsAutocompleteResponse"></a>FilmsAutocompleteResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of films.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmSearchItem"> | |
<h1 class="api-title"><a name="/definitions/FilmSearchItem"></a>FilmSearchItem <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractSearchItem">AbstractSearchItem</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="score"> | |
<td class="name"> | |
score <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film returned by the search.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="FilmServicesResponse"> | |
<h1 class="api-title"><a name="/definitions/FilmServicesResponse"></a>FilmServicesResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Service">Service</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of film services.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmsMemberRelationship"> | |
<h1 class="api-title"><a name="/definitions/FilmsMemberRelationship"></a>FilmsMemberRelationship </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="relationship"> | |
<td class="name"> | |
relationship | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmsRelationship">FilmsRelationship</a></span> | |
</td> | |
<td class="desc"> | |
<p>The relationship details.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmsMetadata"> | |
<h1 class="api-title"><a name="/definitions/FilmsMetadata"></a>FilmsMetadata </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="totalFilmCount"> | |
<td class="name"> | |
totalFilmCount | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The total number of films.</p> | |
</td> | |
</tr> | |
<tr data-property-name="filteredFilmCount"> | |
<td class="name"> | |
filteredFilmCount | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films that match the filter for this request.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmsRelationship"> | |
<h1 class="api-title"><a name="/definitions/FilmsRelationship"></a>FilmsRelationship </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="counts"> | |
<td class="name"> | |
counts | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmsRelationshipCounts">FilmsRelationshipCounts</a></span> | |
</td> | |
<td class="desc"> | |
<p>The number of watches and likes for the films.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmsRelationshipCounts"> | |
<h1 class="api-title"><a name="/definitions/FilmsRelationshipCounts"></a>FilmsRelationshipCounts </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="watches"> | |
<td class="name"> | |
watches | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films the member has indicated they’ve seen (via the ‘eye’ icon) or has a | |
log entry for.</p> | |
</td> | |
</tr> | |
<tr data-property-name="likes"> | |
<td class="name"> | |
likes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films the member has indicated they liked.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmsResponse"> | |
<h1 class="api-title"><a name="/definitions/FilmsResponse"></a>FilmsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of films.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmStatistics"> | |
<h1 class="api-title"><a name="/definitions/FilmStatistics"></a>FilmStatistics </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/FilmIdentifier">FilmIdentifier</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film for which statistics were requested.</p> | |
</td> | |
</tr> | |
<tr data-property-name="counts"> | |
<td class="name"> | |
counts | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmStatisticsCounts">FilmStatisticsCounts</a></span> | |
</td> | |
<td class="desc"> | |
<p>The number of watches, ratings, likes, etc. for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="rating"> | |
<td class="name"> | |
rating | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The weighted average rating of the film between <code>0.5</code> and <code>5.0</code>. | |
Will not be present if the film has not received sufficient ratings.</p> | |
</td> | |
</tr> | |
<tr data-property-name="ratingsHistogram"> | |
<td class="name"> | |
ratingsHistogram | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/RatingsHistogramBar">RatingsHistogramBar</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A summary of the number of ratings at each increment between <code>0.5</code> and | |
<code>5.0</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmStatisticsCounts"> | |
<h1 class="api-title"><a name="/definitions/FilmStatisticsCounts"></a>FilmStatisticsCounts </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="watches"> | |
<td class="name"> | |
watches | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of members who have watched the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="likes"> | |
<td class="name"> | |
likes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of members who have liked the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="ratings"> | |
<td class="name"> | |
ratings | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of members who have rated the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="fans"> | |
<td class="name"> | |
fans | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of members who have the film as one of their four favorites.</p> | |
</td> | |
</tr> | |
<tr data-property-name="lists"> | |
<td class="name"> | |
lists | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of lists in which the film appears.</p> | |
</td> | |
</tr> | |
<tr data-property-name="reviews"> | |
<td class="name"> | |
reviews | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of reviews for the film.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmSummary"> | |
<h1 class="api-title"><a name="/definitions/FilmSummary"></a>FilmSummary </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The title of the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="originalName"> | |
<td class="name"> | |
originalName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The original title of the film, if it was first released with a non-English title.</p> | |
</td> | |
</tr> | |
<tr data-property-name="alternativeNames"> | |
<td class="name"> | |
alternativeNames | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The other names by which the film is known (including alternative titles and/or foreign | |
translations).</p> | |
</td> | |
</tr> | |
<tr data-property-name="releaseYear"> | |
<td class="name"> | |
releaseYear | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The year in which the film was first released.</p> | |
</td> | |
</tr> | |
<tr data-property-name="directors"> | |
<td class="name"> | |
directors | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ContributorSummary">ContributorSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of directors for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="poster"> | |
<td class="name"> | |
poster | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film’s poster image (2:3 aspect ratio in multiple sizes). Will contain only a single | |
obfuscated image if the <code>adult</code> flag is <code>true</code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="adultPoster"> | |
<td class="name"> | |
adultPoster | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film’s unobfuscated poster image (2:3 aspect ratio in multiple sizes), only populated | |
if the <code>adult</code> flag is <code>true</code>, may contain adult content.</p> | |
</td> | |
</tr> | |
<tr data-property-name="top250Position"> | |
<td class="name"> | |
top250Position | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film’s position in the official Letterboxd Top 250 list of narrative feature films, | |
<code>null</code> if the film is not in the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="adult"> | |
<td class="name"> | |
adult | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p><code>true</code> if the film is in TMDb’s ‘Adult’ category.</p> | |
</td> | |
</tr> | |
<tr data-property-name="filmCollectionId"> | |
<td class="name"> | |
filmCollectionId | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the collection containing this film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="links"> | |
<td class="name"> | |
links | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Link">Link</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of relevant URLs for this entity, on Letterboxd and external sites.</p> | |
</td> | |
</tr> | |
<tr data-property-name="relationships"> | |
<td class="name"> | |
relationships | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/MemberFilmRelationship">MemberFilmRelationship</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Relationships to the film for the authenticated member (if any) and other members where | |
relevant.</p> | |
</td> | |
</tr> | |
<tr data-property-name="genres"> | |
<td class="name"> | |
genres | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Genre">Genre</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film’s genres.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmTrailer"> | |
<h1 class="api-title"><a name="/definitions/FilmTrailer"></a>FilmTrailer </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The YouTube ID of the trailer.</p> | |
<section class="json-schema-example"> | |
<pre>"ICp4g9p_rgo"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="url"> | |
<td class="name"> | |
url | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The YouTube URL for the trailer.</p> | |
<section class="json-schema-example"> | |
<pre>"https://www.youtube.com/watch?v=ICp4g9p_rgo"</pre> | |
</section> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FilmWatchActivity"> | |
<h1 class="api-title"><a name="/definitions/FilmWatchActivity"></a>FilmWatchActivity <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film associated with the activity. Includes a | |
<code>MemberFilmRelationship</code> for the member who added the activity.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="FollowActivity"> | |
<h1 class="api-title"><a name="/definitions/FollowActivity"></a>FollowActivity <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="followed"> | |
<td class="name"> | |
followed | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>A summary of the member that was followed.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ForgottenPasswordRequest"> | |
<h1 class="api-title"><a name="/definitions/ForgottenPasswordRequest"></a>ForgottenPasswordRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="emailAddress"> | |
<td class="name"> | |
emailAddress | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="FriendFilmRelationshipsResponse"> | |
<h1 class="api-title"><a name="/definitions/FriendFilmRelationshipsResponse"></a>FriendFilmRelationshipsResponse | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/MemberFilmViewingRelationship">MemberFilmViewingRelationship</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of film relationships for members.</p> | |
</td> | |
</tr> | |
<tr data-property-name="watchCount"> | |
<td class="name"> | |
watchCount | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of friends who have watched the film</p> | |
</td> | |
</tr> | |
<tr data-property-name="watchListCount"> | |
<td class="name"> | |
watchListCount | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of friends who want to watch the film</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Genre"> | |
<h1 class="api-title"><a name="/definitions/Genre"></a>Genre </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the genre.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the genre.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="GenresResponse"> | |
<h1 class="api-title"><a name="/definitions/GenresResponse"></a>GenresResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Genre">Genre</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of genres.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Image"> | |
<h1 class="api-title"><a name="/definitions/Image"></a>Image </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="sizes"> | |
<td class="name"> | |
sizes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ImageSize">ImageSize</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The available sizes for the image.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ImageSize"> | |
<h1 class="api-title"><a name="/definitions/ImageSize"></a>ImageSize </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="width"> | |
<td class="name"> | |
width | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The image width in pixels.</p> | |
</td> | |
</tr> | |
<tr data-property-name="height"> | |
<td class="name"> | |
height | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The image height in pixels.</p> | |
</td> | |
</tr> | |
<tr data-property-name="url"> | |
<td class="name"> | |
url | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The URL to the image file.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="InvitationAcceptedActivity"> | |
<h1 class="api-title"><a name="/definitions/InvitationAcceptedActivity"></a>InvitationAcceptedActivity <span | |
class="type">< <a class="json-schema-ref" | |
href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<span class="json-property-enum" | |
title="Constant">InvitationAcceptedActivity</span> | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
<tr data-property-name="invitor"> | |
<td class="name"> | |
invitor | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="Language"> | |
<h1 class="api-title"><a name="/definitions/Language"></a>Language </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The ISO 639-1 defined code of the language.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the language.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LanguagesResponse"> | |
<h1 class="api-title"><a name="/definitions/LanguagesResponse"></a>LanguagesResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Language">Language</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of languages.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Link"> | |
<h1 class="api-title"><a name="/definitions/Link"></a>Link </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">letterboxd, </span><span | |
class="json-property-enum-item">tmdb, </span><span | |
class="json-property-enum-item">imdb, </span><span | |
class="json-property-enum-item">gwi, </span><span | |
class="json-property-enum-item">justwatch, </span><span | |
class="json-property-enum-item">facebook, </span><span | |
class="json-property-enum-item">instagram, </span><span | |
class="json-property-enum-item">twitter, </span><span | |
class="json-property-enum-item">youtube</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Denotes which site the link is for.</p> | |
</td> | |
</tr> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The object ID for the linked entity on the destination site.</p> | |
</td> | |
</tr> | |
<tr data-property-name="url"> | |
<td class="name"> | |
url | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The fully qualified URL on the destination site.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Links"> | |
<h1 class="api-title"><a name="/definitions/Links"></a>Links </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="links"> | |
<td class="name"> | |
links | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Link">Link</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of relevant URLs for this entity, on Letterboxd and external sites.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="List"> | |
<h1 class="api-title"><a name="/definitions/List"></a>List </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="filmCount"> | |
<td class="name"> | |
filmCount | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films in the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="published"> | |
<td class="name"> | |
published | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the owner has elected to publish the list for other members | |
to see.</p> | |
</td> | |
</tr> | |
<tr data-property-name="ranked"> | |
<td class="name"> | |
ranked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the owner has elected to make this a ranked list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="hasEntriesWithNotes"> | |
<td class="name"> | |
hasEntriesWithNotes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the owner has added notes to any entries.</p> | |
</td> | |
</tr> | |
<tr data-property-name="descriptionLbml"> | |
<td class="name"> | |
descriptionLbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list description in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="tags"> | |
<td class="name"> | |
tags | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p><strong class="deprecated-label">DEPRECATED</strong> Use <code>tags2</code> instead.</p> | |
</td> | |
</tr> | |
<tr data-property-name="tags2"> | |
<td class="name"> | |
tags2 | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Tag">Tag</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tags for the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="canShareOn"> | |
<td class="name"> | |
canShareOn | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
third-party service or services to which this list can be shared. Only | |
included if the authenticated member is the list’s owner.<span class="p"><strong | |
class="deprecated-label">DEPRECATED</strong> No longer supported by | |
Facebook.</span></p> | |
</td> | |
</tr> | |
<tr data-property-name="sharedOn"> | |
<td class="name"> | |
sharedOn | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
third-party service or services to which this list has been shared. | |
Only included if the authenticated member is the list’s owner.<span class="p"><strong | |
class="deprecated-label">DEPRECATED</strong> No longer supported by | |
Facebook.</span></p> | |
</td> | |
</tr> | |
<tr data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="whenPublished"> | |
<td class="name"> | |
whenPublished | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Anyone, </span><span | |
class="json-property-enum-item">Friends, </span><span | |
class="json-property-enum-item">You</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The policy determining who can post comments to the list. <code>You</code> in this | |
context refers to the content owner. Use the <code>commentThreadState</code> property of | |
the <code>ListRelationship</code> to determine the signed-in member’s ability to comment | |
(or not).</p> | |
</td> | |
</tr> | |
<tr data-property-name="owner"> | |
<td class="name"> | |
owner | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member who owns the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="clonedFrom"> | |
<td class="name"> | |
clonedFrom | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/ListIdentifier">ListIdentifier</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list this was cloned from, if applicable.</p> | |
</td> | |
</tr> | |
<tr data-property-name="previewEntries"> | |
<td class="name"> | |
previewEntries | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListEntrySummary">ListEntrySummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The first 12 entries in the list. To fetch more than 12 entries, and to fetch the entry | |
notes, use the <code>/list/{id}/entries</code> endpoint.</p> | |
</td> | |
</tr> | |
<tr data-property-name="links"> | |
<td class="name"> | |
links | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Link">Link</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of relevant URLs for this entity, on Letterboxd and external sites.</p> | |
</td> | |
</tr> | |
<tr data-property-name="backdrop"> | |
<td class="name"> | |
backdrop | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list’s backdrop image at multiple sizes, sourced from the first film in the list, if | |
available. Only returned for <a href="https://letterboxd.com/patrons/">Patron</a> | |
members.</p> | |
</td> | |
</tr> | |
<tr data-property-name="backdropFocalPoint"> | |
<td class="name"> | |
backdropFocalPoint | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
vertical focal point of the list’s backdrop image, if available. | |
Expressed as a proportion of the image’s height, using values between <code>0.0</code> | |
and <code>1.0</code>. Use when cropping the image into a shorter space, such as in the | |
page for a film on the Letterboxd site.</p> | |
</td> | |
</tr> | |
<tr data-property-name="description"> | |
<td class="name"> | |
description | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list description formatted as HTML.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListActivity"> | |
<h1 class="api-title"><a name="/definitions/ListActivity"></a>ListActivity <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="list"> | |
<td class="name"> | |
list | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ListSummary">ListSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="clonedFrom"> | |
<td class="name"> | |
clonedFrom | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ListSummary">ListSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list that was cloned, if applicable</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ListAdditionRequest"> | |
<h1 class="api-title"><a name="/definitions/ListAdditionRequest"></a>ListAdditionRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="lists"> | |
<td class="name"> | |
lists | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Specify the LIDs of lists to be added to.</p> | |
</td> | |
</tr> | |
<tr data-property-name="films"> | |
<td class="name"> | |
films | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Specify the LIDs of films to be added to each of the specified lists.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListAdditionResponse"> | |
<h1 class="api-title"><a name="/definitions/ListAdditionResponse"></a>ListAdditionResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/AListAddition">AListAddition</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of additions to each list.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListComment"> | |
<h1 class="api-title"><a name="/definitions/ListComment"></a>ListComment </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the comment/reply.</p> | |
</td> | |
</tr> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member who posted the comment.</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="whenUpdated"> | |
<td class="name"> | |
whenUpdated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="commentLbml"> | |
<td class="name"> | |
commentLbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The message portion of the comment in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="removedByAdmin"> | |
<td class="name"> | |
removedByAdmin | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If Letterboxd moderators have removed the comment from the site, | |
<code>removedByAdmin</code> will be true and <code>comment</code> will not be included. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="removedByContentOwner"> | |
<td class="name"> | |
removedByContentOwner | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the content owner has removed the comment from the site, | |
<code>removedByContentOwner</code> will be true and <code>comment</code> will not be | |
included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="deleted"> | |
<td class="name"> | |
deleted | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the comment owner has removed the comment from the site, <code>deleted</code> will be | |
true and <code>comment</code> will not be included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="blocked"> | |
<td class="name"> | |
blocked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the authenticated member has blocked the commenter, <code>blocked</code> will be true | |
and <code>comment</code> will not be included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="blockedByOwner"> | |
<td class="name"> | |
blockedByOwner | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the list owner has blocked the commenter, <code>blockedByOwner</code> will be true and | |
<code>comment</code> will not be included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="editableWindowExpiresIn"> | |
<td class="name"> | |
editableWindowExpiresIn | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If | |
the authenticated member posted this comment, and the comment is still | |
editable, this value shows the number of seconds remaining until the | |
editing window closes.</p> | |
</td> | |
</tr> | |
<tr data-property-name="list"> | |
<td class="name"> | |
list | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/ListIdentifier">ListIdentifier</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list on which the comment was posted.</p> | |
</td> | |
</tr> | |
<tr data-property-name="comment"> | |
<td class="name"> | |
comment | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The message portion of the comment formatted as HTML.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListCommentActivity"> | |
<h1 class="api-title"><a name="/definitions/ListCommentActivity"></a>ListCommentActivity <span class="type">< | |
<a class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="list"> | |
<td class="name"> | |
list | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ListSummary">ListSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="comment"> | |
<td class="name"> | |
comment | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ListComment">ListComment</a></span> | |
</td> | |
<td class="desc"> | |
<p>The comment associated with the activity.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ListCommentsResponse"> | |
<h1 class="api-title"><a name="/definitions/ListCommentsResponse"></a>ListCommentsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListComment">ListComment</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of comments.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListCreateEntry"> | |
<h1 class="api-title"><a name="/definitions/ListCreateEntry"></a>ListCreateEntry </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="rank"> | |
<td class="name"> | |
rank | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If | |
the list is ranked, this is the entry’s rank in the list, numbered from | |
1. If not set, the entry will be appended to the end of the list. | |
Sending two or more <code>ListCreateEntry</code>s with the same rank will return an | |
error.</p> | |
</td> | |
</tr> | |
<tr data-property-name="notes"> | |
<td class="name"> | |
notes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The notes for the list entry in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="containsSpoilers"> | |
<td class="name"> | |
containsSpoilers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member has indicated that the <code>notes</code> field | |
contains plot spoilers for the film.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListCreateMessage"> | |
<h1 class="api-title"><a name="/definitions/ListCreateMessage"></a>ListCreateMessage </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">ListNameIsBlank, </span><span | |
class="json-property-enum-item">UnknownFilmCode, </span><span | |
class="json-property-enum-item">InvalidRatingValue, </span><span | |
class="json-property-enum-item">DuplicateRank, </span><span | |
class="json-property-enum-item">EmptyPublicList, </span><span | |
class="json-property-enum-item">CloneSourceNotFound, </span><span | |
class="json-property-enum-item">SharingServiceNotAuthorized, </span><span | |
class="json-property-enum-item">CannotSharePrivateList, </span><span | |
class="json-property-enum-item">ListDescriptionIsTooLong, </span><span | |
class="json-property-enum-item">ListEntryNotesTooLong</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListCreateResponse"> | |
<h1 class="api-title"><a name="/definitions/ListCreateResponse"></a>ListCreateResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/List">List</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListCreateMessage">ListCreateMessage</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListCreationRequest"> | |
<h1 class="api-title"><a name="/definitions/ListCreationRequest"></a>ListCreationRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="published"> | |
<td class="name"> | |
published | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the owner has elected to publish the list for other members | |
to see.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Anyone, </span><span | |
class="json-property-enum-item">Friends, </span><span | |
class="json-property-enum-item">You</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The policy determining who can post comments to the list. <code>You</code> in this | |
context refers to the content owner. Use the <code>commentThreadState</code> property of | |
the <code>ListRelationship</code> to determine the signed-in member’s ability to comment | |
(or not).</p> | |
</td> | |
</tr> | |
<tr data-property-name="ranked"> | |
<td class="name"> | |
ranked | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the owner has elected to make this a ranked list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="description"> | |
<td class="name"> | |
description | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list description in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>. This field has a maximum size of 100,000 characters. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="clonedFrom"> | |
<td class="name"> | |
clonedFrom | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of a list to clone from. <em>Only supported for paying members.</em></p> | |
</td> | |
</tr> | |
<tr data-property-name="tags"> | |
<td class="name"> | |
tags | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tags for the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="entries"> | |
<td class="name"> | |
entries | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListCreateEntry">ListCreateEntry</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The films that comprise the list. Required unless <code>source</code> is set.</p> | |
</td> | |
</tr> | |
<tr data-property-name="share"> | |
<td class="name"> | |
share | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The third-party service or services to which this list should be shared. Valid options | |
are found in <a | |
href="#/definitions/MemberAccount"><code>MemberAccount.authorizedSharing*</code></a> | |
(see the <a href="#path--me">/me</a> endpoint).<span class="p"><strong | |
class="deprecated-label">DEPRECATED</strong> No longer supported by | |
Facebook.</span></p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListEntriesResponse"> | |
<h1 class="api-title"><a name="/definitions/ListEntriesResponse"></a>ListEntriesResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListEntry">ListEntry</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of entries.</p> | |
</td> | |
</tr> | |
<tr data-property-name="metadata"> | |
<td class="name"> | |
metadata | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/FilmsMetadata">FilmsMetadata</a></span> | |
</td> | |
<td class="desc"> | |
<p>The filtered and total count of films in the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="relationships"> | |
<td class="name"> | |
relationships | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmsMemberRelationship">FilmsMemberRelationship</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The relationships to the films in the list for the members referenced in the request.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListEntry"> | |
<h1 class="api-title"><a name="/definitions/ListEntry"></a>ListEntry </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="rank"> | |
<td class="name"> | |
rank | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the list is ranked, this is the entry’s rank in the list, numbered from 1.</p> | |
</td> | |
</tr> | |
<tr data-property-name="notesLbml"> | |
<td class="name"> | |
notesLbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The notes for the list entry in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="containsSpoilers"> | |
<td class="name"> | |
containsSpoilers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member has indicated that the <code>notes</code> field | |
contains plot spoilers for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/FilmSummary">FilmSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film for this entry. Includes a <code>MemberFilmRelationship</code> for the member | |
who created the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="notes"> | |
<td class="name"> | |
notes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The notes for the list entry formatted as HTML.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListEntrySummary"> | |
<h1 class="api-title"><a name="/definitions/ListEntrySummary"></a>ListEntrySummary </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="rank"> | |
<td class="name"> | |
rank | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the list is ranked, this is the entry’s rank in the list, numbered from 1.</p> | |
</td> | |
</tr> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/FilmSummary">FilmSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film for this entry.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListIdentifier"> | |
<h1 class="api-title"><a name="/definitions/ListIdentifier"></a>ListIdentifier </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the list.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListLikeActivity"> | |
<h1 class="api-title"><a name="/definitions/ListLikeActivity"></a>ListLikeActivity <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="list"> | |
<td class="name"> | |
list | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ListSummary">ListSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list associated with the activity.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ListRelationship"> | |
<h1 class="api-title"><a name="/definitions/ListRelationship"></a>ListRelationship </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="liked"> | |
<td class="name"> | |
liked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member likes the list (via the ‘heart’ icon). A member | |
may not like their own list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="subscribed"> | |
<td class="name"> | |
subscribed | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member is subscribed to comment notifications for the | |
list</p> | |
</td> | |
</tr> | |
<tr data-property-name="subscriptionState"> | |
<td class="name"> | |
subscriptionState | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Subscribed, </span><span | |
class="json-property-enum-item">NotSubscribed, </span><span | |
class="json-property-enum-item">Unsubscribed</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>Subscribed</code> for the list’s owner, and <code>NotSubscribed</code> | |
for other members. The subscription value may change when a member | |
(other than the owner) posts a comment, as follows: the member will | |
become automatically <code>Subscribed</code> unless they have previously | |
<code>Unsubscribed</code> | |
from the comment thread via the web interface or API, or unless they | |
have disabled comment notifications in their profile settings. <span | |
class="p"><code>NotSubscribed</code> and <code>Unsubscribed</code> | |
are maintained as separate states so the UI can, if needed, indicate to | |
the member how their subscription state will be affected if/when they | |
post a comment.</span></p> | |
</td> | |
</tr> | |
<tr data-property-name="commentThreadState"> | |
<td class="name"> | |
commentThreadState | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Banned, </span><span | |
class="json-property-enum-item">Blocked, </span><span | |
class="json-property-enum-item">BlockedThem, </span><span | |
class="json-property-enum-item">CanComment, </span><span | |
class="json-property-enum-item">Closed, </span><span | |
class="json-property-enum-item">FriendsOnly, </span><span | |
class="json-property-enum-item">Moderated, </span><span | |
class="json-property-enum-item">NotCommentable, </span><span | |
class="json-property-enum-item">NotValidated</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The authenticated member’s state with respect to posting comments to the list.<span | |
class="p"><code>Banned</code> means the Letterboxd community managers have | |
restricted the member’s ability to post comments.</span><span | |
class="p"><code>Blocked</code> means the owner has blocked the member from posting | |
comments.</span><span class="p"><code>BlockedThem</code> means the member has | |
blocked the owner and is therefore unable to post comments.</span><span | |
class="p"><code>CanComment</code> | |
means the authenticated member is authorized to post a comment (also | |
known as a “reply”). All other values mean the authenticated member is | |
not authorized to post a comment.</span><span class="p"><code>Closed</code> means | |
the owner has closed the comment thread to all other members.</span><span | |
class="p"><code>FriendsOnly</code> means the owner is only accepting comments from | |
members they follow.</span><span class="p"><code>Moderated</code> means the | |
Letterboxd community managers have removed the content (applies to reviews | |
only).</span><span class="p"><code>NotCommentable</code> means that comments may not | |
be posted to this thread.</span><span class="p"><code>NotValidated</code> means the | |
owner has not validated their email address.</span></p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListRelationshipUpdateMessage"> | |
<h1 class="api-title"><a name="/definitions/ListRelationshipUpdateMessage"></a>ListRelationshipUpdateMessage | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">LikeBlockedContent, </span><span | |
class="json-property-enum-item">LikeOwnList, </span><span | |
class="json-property-enum-item">LikeRateLimit, </span><span | |
class="json-property-enum-item">SubscribeWhenOptedOut, </span><span | |
class="json-property-enum-item">SubscribeToContentYouBlocked, </span><span | |
class="json-property-enum-item">SubscribeToBlockedContent</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListRelationshipUpdateRequest"> | |
<h1 class="api-title"><a name="/definitions/ListRelationshipUpdateRequest"></a>ListRelationshipUpdateRequest | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="liked"> | |
<td class="name"> | |
liked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member likes the list (via the ‘heart’ icon). A member | |
may not like their own list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="subscribed"> | |
<td class="name"> | |
subscribed | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> to subscribe the member to comment notifications for the list, | |
or <code>false</code> to unsubscribe them. A value of <code>true</code> will be ignored | |
if the member has disabled comment notifications in their profile settings.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListRelationshipUpdateResponse"> | |
<h1 class="api-title"><a name="/definitions/ListRelationshipUpdateResponse"></a>ListRelationshipUpdateResponse | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ListRelationship">ListRelationship</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListRelationshipUpdateMessage">ListRelationshipUpdateMessage</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListSearchItem"> | |
<h1 class="api-title"><a name="/definitions/ListSearchItem"></a>ListSearchItem <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractSearchItem">AbstractSearchItem</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="score"> | |
<td class="name"> | |
score <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="list"> | |
<td class="name"> | |
list | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ListSummary">ListSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ListsResponse"> | |
<h1 class="api-title"><a name="/definitions/ListsResponse"></a>ListsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListSummary">ListSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of lists.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListStatistics"> | |
<h1 class="api-title"><a name="/definitions/ListStatistics"></a>ListStatistics </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="list"> | |
<td class="name"> | |
list | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/ListIdentifier">ListIdentifier</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list for which statistics were requested.</p> | |
</td> | |
</tr> | |
<tr data-property-name="counts"> | |
<td class="name"> | |
counts | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ListStatisticsCounts">ListStatisticsCounts</a></span> | |
</td> | |
<td class="desc"> | |
<p>The number of comments and likes for the list.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListStatisticsCounts"> | |
<h1 class="api-title"><a name="/definitions/ListStatisticsCounts"></a>ListStatisticsCounts </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="comments"> | |
<td class="name"> | |
comments | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of comments for the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="likes"> | |
<td class="name"> | |
likes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of members who like the list.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListSummary"> | |
<h1 class="api-title"><a name="/definitions/ListSummary"></a>ListSummary </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="filmCount"> | |
<td class="name"> | |
filmCount | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films in the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="published"> | |
<td class="name"> | |
published | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the owner has elected to publish the list for other members | |
to see.</p> | |
</td> | |
</tr> | |
<tr data-property-name="ranked"> | |
<td class="name"> | |
ranked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the owner has elected to make this a ranked list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="descriptionLbml"> | |
<td class="name"> | |
descriptionLbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list description in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>. The text is a preview extract, and may be truncated if | |
it’s too long.</p> | |
</td> | |
</tr> | |
<tr data-property-name="descriptionTruncated"> | |
<td class="name"> | |
descriptionTruncated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the list description was truncated because it’s very long. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="owner"> | |
<td class="name"> | |
owner | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member who owns the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="clonedFrom"> | |
<td class="name"> | |
clonedFrom | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/ListIdentifier">ListIdentifier</a></span> | |
</td> | |
<td class="desc"> | |
<p>The list this was cloned from, if applicable.</p> | |
</td> | |
</tr> | |
<tr data-property-name="previewEntries"> | |
<td class="name"> | |
previewEntries | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListEntrySummary">ListEntrySummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The first 12 entries in the list. To fetch more than 12 entries, and to fetch the entry | |
notes, use the <code>/list/{id}/entries</code> endpoint.</p> | |
</td> | |
</tr> | |
<tr data-property-name="entriesOfNote"> | |
<td class="name"> | |
entriesOfNote | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/AListEntryOccurrence">AListEntryOccurrence</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Returned when one or more <code>filmsOfNote</code> | |
is specified in the request. Contains, for each list in the response, | |
the rank position of each film of note (if in the list) or <code>-1</code> (if not).</p> | |
</td> | |
</tr> | |
<tr data-property-name="description"> | |
<td class="name"> | |
description | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list description formatted as HTML. The text is a preview extract, and may be | |
truncated if it’s too long.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListUpdateEntry"> | |
<h1 class="api-title"><a name="/definitions/ListUpdateEntry"></a>ListUpdateEntry </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="rank"> | |
<td class="name"> | |
rank | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If | |
the list is ranked, this is the entry’s rank in the list, numbered from | |
1. If not set, the entry will stay in the same place (if already in the | |
list) or be appended to the end of the list (if not in the list). If | |
set, any entries at or after this position will be incremented by one. | |
Sending two or more <code>ListUpdateEntry</code>s with the same rank will return an | |
error.</p> | |
</td> | |
</tr> | |
<tr data-property-name="notes"> | |
<td class="name"> | |
notes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The notes for the list entry in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>. This field has a maximum size of 100,000 characters. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="containsSpoilers"> | |
<td class="name"> | |
containsSpoilers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member has indicated that the <code>notes</code> field | |
contains plot spoilers for the film.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListUpdateMessage"> | |
<h1 class="api-title"><a name="/definitions/ListUpdateMessage"></a>ListUpdateMessage </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">ListNameIsBlank, </span><span | |
class="json-property-enum-item">UnknownFilmCode, </span><span | |
class="json-property-enum-item">InvalidRatingValue, </span><span | |
class="json-property-enum-item">DuplicateRank, </span><span | |
class="json-property-enum-item">EmptyPublicList, </span><span | |
class="json-property-enum-item">SharingServiceNotAuthorized, </span><span | |
class="json-property-enum-item">CannotSharePrivateList, </span><span | |
class="json-property-enum-item">ListDescriptionIsTooLong, </span><span | |
class="json-property-enum-item">ListEntryNotesTooLong</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListUpdateRequest"> | |
<h1 class="api-title"><a name="/definitions/ListUpdateRequest"></a>ListUpdateRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="published"> | |
<td class="name"> | |
published | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the owner has elected to publish the list for other members | |
to see.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Anyone, </span><span | |
class="json-property-enum-item">Friends, </span><span | |
class="json-property-enum-item">You</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The policy determining who can post comments to the list. <code>You</code> in this | |
context refers to the content owner. Use the <code>commentThreadState</code> property of | |
the <code>ListRelationship</code> to determine the signed-in member’s ability to comment | |
(or not).</p> | |
</td> | |
</tr> | |
<tr data-property-name="ranked"> | |
<td class="name"> | |
ranked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the owner has elected to make this a ranked list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="description"> | |
<td class="name"> | |
description | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list description in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>. This field has a maximum size of 100,000 characters. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="tags"> | |
<td class="name"> | |
tags | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tags for the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="filmsToRemove"> | |
<td class="name"> | |
filmsToRemove | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Specify the LIDs of films to be removed from the list.</p> | |
</td> | |
</tr> | |
<tr data-property-name="entries"> | |
<td class="name"> | |
entries | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListUpdateEntry">ListUpdateEntry</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The specified entries will be inserted/appended to the list if they are not already | |
present, or updated if they are present.</p> | |
</td> | |
</tr> | |
<tr data-property-name="share"> | |
<td class="name"> | |
share | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The third-party service or services to which this list should be shared. Valid options | |
are found in <a href="#/definitions/ListRelationship"><code>ListRelationship</code></a> | |
(see the <a href="#path--list--id--me">/list/{id}/me</a> endpoint).<span | |
class="p"><strong class="deprecated-label">DEPRECATED</strong> No longer supported | |
by Facebook.</span></p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ListUpdateResponse"> | |
<h1 class="api-title"><a name="/definitions/ListUpdateResponse"></a>ListUpdateResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/List">List</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ListUpdateMessage">ListUpdateMessage</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntriesResponse"> | |
<h1 class="api-title"><a name="/definitions/LogEntriesResponse"></a>LogEntriesResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/LogEntry">LogEntry</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of log entries.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntry"> | |
<h1 class="api-title"><a name="/definitions/LogEntry"></a>LogEntry </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the log entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A descriptive title for the log entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="owner"> | |
<td class="name"> | |
owner | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member who created the log entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/FilmSummary">FilmSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film being logged. Includes a <code>MemberFilmRelationship</code> for the member who | |
created the log entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="diaryDetails"> | |
<td class="name"> | |
diaryDetails | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/DiaryDetails">DiaryDetails</a></span> | |
</td> | |
<td class="desc"> | |
<p>Details about the log entry, if present.</p> | |
</td> | |
</tr> | |
<tr data-property-name="review"> | |
<td class="name"> | |
review | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Review">Review</a></span> | |
</td> | |
<td class="desc"> | |
<p>Review details for the log entry, if present.</p> | |
</td> | |
</tr> | |
<tr data-property-name="tags"> | |
<td class="name"> | |
tags | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p><strong class="deprecated-label">DEPRECATED</strong> Use <code>tags2</code> instead.</p> | |
</td> | |
</tr> | |
<tr data-property-name="tags2"> | |
<td class="name"> | |
tags2 | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Tag">Tag</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tags for the log entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of when the log entry was created, in ISO 8601 format with UTC timezone, | |
i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="whenUpdated"> | |
<td class="name"> | |
whenUpdated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of when the log entry was last updated, in ISO 8601 format with UTC | |
timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="rating"> | |
<td class="name"> | |
rating | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s rating for the film. Allowable values are between <code>0.5</code> and | |
<code>5.0</code>, with increments of <code>0.5</code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="like"> | |
<td class="name"> | |
like | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member likes the film (via the ‘heart’ icon).</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentable"> | |
<td class="name"> | |
commentable | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> | |
if comments can be posted to the log entry by the member. This is | |
determined according to the existence of review text and other factors | |
such as the content owner’s comment policy.</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Anyone, </span><span | |
class="json-property-enum-item">Friends, </span><span | |
class="json-property-enum-item">You</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The policy determining who can post comments to the log entry. <code>You</code> in this | |
context refers to the content owner. Use the <code>commentThreadState</code> property of | |
the <code>ListRelationship</code> to determine the signed-in member’s ability to comment | |
(or not).</p> | |
</td> | |
</tr> | |
<tr data-property-name="links"> | |
<td class="name"> | |
links | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Link">Link</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of relevant URLs for this entity, on Letterboxd and external sites.</p> | |
</td> | |
</tr> | |
<tr data-property-name="backdrop"> | |
<td class="name"> | |
backdrop | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The log entry's backdrop image at multiple sizes, sourced from the film being logged, if | |
available. Only returned for <a href="https://letterboxd.com/patrons/">Patron</a> | |
members.</p> | |
</td> | |
</tr> | |
<tr data-property-name="backdropFocalPoint"> | |
<td class="name"> | |
backdropFocalPoint | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
vertical focal point of the log entry’s backdrop image, if available. | |
Expressed as a proportion of the image’s height, using values between <code>0.0</code> | |
and <code>1.0</code>. Use when cropping the image into a shorter space, such as in the | |
page for a film on the Letterboxd site.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntryCreationRequest"> | |
<h1 class="api-title"><a name="/definitions/LogEntryCreationRequest"></a>LogEntryCreationRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="filmId"> | |
<td class="name"> | |
filmId | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The film being logged.</p> | |
</td> | |
</tr> | |
<tr data-property-name="diaryDetails"> | |
<td class="name"> | |
diaryDetails | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/LogEntryCreationRequestDiaryDetails">LogEntryCreationRequestDiaryDetails</a></span> | |
</td> | |
<td class="desc"> | |
<p>Information about this log entry if adding to the member’s diary.</p> | |
</td> | |
</tr> | |
<tr data-property-name="review"> | |
<td class="name"> | |
review | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/LogEntryCreationRequestReview">LogEntryCreationRequestReview</a></span> | |
</td> | |
<td class="desc"> | |
<p>Information about the review if adding a review.</p> | |
</td> | |
</tr> | |
<tr data-property-name="tags"> | |
<td class="name"> | |
tags | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tags for the log entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="rating"> | |
<td class="name"> | |
rating | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Allowable values are between <code>0.5</code> and <code>5.0</code>, with increments of | |
<code>0.5</code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="like"> | |
<td class="name"> | |
like | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member likes the review (via the ‘heart’ icon). A member | |
may not like their own review.</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Anyone, </span><span | |
class="json-property-enum-item">Friends, </span><span | |
class="json-property-enum-item">You</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The policy determining who can post comments to the log entry. <code>You</code> in this | |
context refers to the content owner. Use the <code>commentThreadState</code> property of | |
the <code>ListRelationship</code> to determine the signed-in member’s ability to comment | |
(or not).</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntryCreationRequestDiaryDetails"> | |
<h1 class="api-title"><a | |
name="/definitions/LogEntryCreationRequestDiaryDetails"></a>LogEntryCreationRequestDiaryDetails </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="diaryDate"> | |
<td class="name"> | |
diaryDate | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The date the film was watched, if specified, in ISO 8601 format, i.e. | |
<code>YYYY-MM-DD</code></p> | |
</td> | |
</tr> | |
<tr data-property-name="rewatch"> | |
<td class="name"> | |
rewatch | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member has indicated (or it can be otherwise determined) | |
that the member has seen the film prior to this date.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntryCreationRequestReview"> | |
<h1 class="api-title"><a name="/definitions/LogEntryCreationRequestReview"></a>LogEntryCreationRequestReview | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="text"> | |
<td class="name"> | |
text | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The review text in LBML. May contain the following HTML tags: <code><br></code> | |
<code><strong></code> <code><em></code> <code><b></code> | |
<code><i></code> <code><a href=""></code> <code><blockquote></code>. | |
This field has a maximum size of 100,000 characters.</p> | |
</td> | |
</tr> | |
<tr data-property-name="containsSpoilers"> | |
<td class="name"> | |
containsSpoilers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member has indicated that the <code>review</code> field | |
contains plot spoilers for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="share"> | |
<td class="name"> | |
share | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The third-party service or services to which this review should be shared. Valid options | |
are found in <a | |
href="#/definitions/MemberAccount"><code>MemberAccount.authorizedSharing*</code></a> | |
(see the <a href="#path--me">/me</a> endpoint).<span class="p"><strong | |
class="deprecated-label">DEPRECATED</strong> No longer supported by | |
Facebook.</span></p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntrySummary"> | |
<h1 class="api-title"><a name="/definitions/LogEntrySummary"></a>LogEntrySummary </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the log entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
<tr data-property-name="review"> | |
<td class="name"> | |
review | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Does this log entry contain a review.</p> | |
</td> | |
</tr> | |
<tr data-property-name="diaryEntry"> | |
<td class="name"> | |
diaryEntry | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Does this log entry specify a diary entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="rating"> | |
<td class="name"> | |
rating | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s rating for this viewing of the film. Allowable values are between | |
<code>0.5</code> and <code>5.0</code>, with increments of <code>0.5</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntryUpdateMessage"> | |
<h1 class="api-title"><a name="/definitions/LogEntryUpdateMessage"></a>LogEntryUpdateMessage </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">InvalidRatingValue, </span><span | |
class="json-property-enum-item">InvalidDiaryDate, </span><span | |
class="json-property-enum-item">ReviewWithNoText, </span><span | |
class="json-property-enum-item">ReviewIsTooLong, </span><span | |
class="json-property-enum-item">LogEntryWithNoReviewOrDiaryDetails</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntryUpdateRequest"> | |
<h1 class="api-title"><a name="/definitions/LogEntryUpdateRequest"></a>LogEntryUpdateRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="diaryDetails"> | |
<td class="name"> | |
diaryDetails | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/LogEntryUpdateRequestDiaryDetails">LogEntryUpdateRequestDiaryDetails</a></span> | |
</td> | |
<td class="desc"> | |
<p>Information about this log entry if adding to the member’s diary. Set to | |
<code>null</code> to remove this log entry from the diary.</p> | |
</td> | |
</tr> | |
<tr data-property-name="review"> | |
<td class="name"> | |
review | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/LogEntryUpdateRequestReview">LogEntryUpdateRequestReview</a></span> | |
</td> | |
<td class="desc"> | |
<p>Information about the review. Set to <code>null</code> to remove the review from this log | |
entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="tags"> | |
<td class="name"> | |
tags | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tags for the log entry.</p> | |
</td> | |
</tr> | |
<tr data-property-name="rating"> | |
<td class="name"> | |
rating | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Accepts values between <code>0.5</code> and <code>5.0</code>, with increments of | |
<code>0.5</code>, or <code>null</code> (to remove the rating).</p> | |
</td> | |
</tr> | |
<tr data-property-name="like"> | |
<td class="name"> | |
like | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member likes the review (via the ‘heart’ icon). A member | |
may not like their own review.</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Anyone, </span><span | |
class="json-property-enum-item">Friends, </span><span | |
class="json-property-enum-item">You</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The policy determining who can post comments to the log entry. <code>You</code> in this | |
context refers to the content owner. Use the <code>commentThreadState</code> property of | |
the <code>ListRelationship</code> to determine the signed-in member’s ability to comment | |
(or not).</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntryUpdateRequestDiaryDetails"> | |
<h1 class="api-title"><a | |
name="/definitions/LogEntryUpdateRequestDiaryDetails"></a>LogEntryUpdateRequestDiaryDetails </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="diaryDate"> | |
<td class="name"> | |
diaryDate | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The date the film was watched, if specified, in ISO 8601 format, i.e. | |
<code>YYYY-MM-DD</code></p> | |
</td> | |
</tr> | |
<tr data-property-name="rewatch"> | |
<td class="name"> | |
rewatch | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member has indicated (or it can be otherwise determined) | |
that the member has seen the film prior to this date.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LogEntryUpdateRequestReview"> | |
<h1 class="api-title"><a name="/definitions/LogEntryUpdateRequestReview"></a>LogEntryUpdateRequestReview </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="text"> | |
<td class="name"> | |
text | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The review text in LBML. May contain the following HTML tags: <code><br></code> | |
<code><strong></code> <code><em></code> <code><b></code> | |
<code><i></code> <code><a href=""></code> <code><blockquote></code>. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="containsSpoilers"> | |
<td class="name"> | |
containsSpoilers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member has indicated that the <code>review</code> field | |
contains plot spoilers for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="share"> | |
<td class="name"> | |
share | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The third-party service or services to which this review should be shared. Valid options | |
are found in <a | |
href="#/definitions/ReviewRelationship"><code>ReviewRelationship.canShareOn</code></a> | |
(see the <a href="#path--log-entry--id--me">/log-entry/{id}/me</a> endpoint).<span | |
class="p"><strong class="deprecated-label">DEPRECATED</strong> No longer supported | |
by Facebook.</span></p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="LoginTokenResponse"> | |
<h1 class="api-title"><a name="/definitions/LoginTokenResponse"></a>LoginTokenResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="token"> | |
<td class="name"> | |
token | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A single-use token for signing into the Letterboxd website.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Member"> | |
<h1 class="api-title"><a name="/definitions/Member"></a>Member </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="username"> | |
<td class="name"> | |
username | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
member’s Letterboxd username. Usernames must be between 2 and 15 | |
characters long and may only contain upper or lowercase letters, numbers | |
or the underscore (<code>_</code>) character.</p> | |
</td> | |
</tr> | |
<tr data-property-name="givenName"> | |
<td class="name"> | |
givenName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The given name of the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="familyName"> | |
<td class="name"> | |
familyName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The family name of the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="displayName"> | |
<td class="name"> | |
displayName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A | |
convenience method that returns the member’s given name and family name | |
concatenated with a space, if both are set, or just their given name or | |
family name, if one is set, or their username, if neither is set. Will | |
never be empty.</p> | |
</td> | |
</tr> | |
<tr data-property-name="shortName"> | |
<td class="name"> | |
shortName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A convenience method that returns the member’s given name, if set, or their username. | |
Will never be empty.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pronoun"> | |
<td class="name"> | |
pronoun | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Pronoun">Pronoun</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member’s preferred pronoun. Use the <a | |
href="#path--members-pronouns">/members/pronouns</a> endpoint to request all | |
available pronouns.</p> | |
</td> | |
</tr> | |
<tr data-property-name="avatar"> | |
<td class="name"> | |
avatar | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The | |
member’s avatar image at multiple sizes. Avatar images to not have an | |
enforced aspect ratio, so should be center-cropped to a square if they | |
are not 1:1.</p> | |
</td> | |
</tr> | |
<tr data-property-name="memberStatus"> | |
<td class="name"> | |
memberStatus | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Crew, </span><span | |
class="json-property-enum-item">Alum, </span><span | |
class="json-property-enum-item">Hq, </span><span | |
class="json-property-enum-item">Patron, </span><span | |
class="json-property-enum-item">Pro, </span><span | |
class="json-property-enum-item">Member</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s account type.</p> | |
</td> | |
</tr> | |
<tr data-property-name="hideAdsInContent"> | |
<td class="name"> | |
hideAdsInContent | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p> <code>true</code> if ads should not be shown on the member's content.</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Anyone, </span><span | |
class="json-property-enum-item">Friends, </span><span | |
class="json-property-enum-item">You</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s default policy determing who can post comments to their content. Supported | |
options are <code>Anyone</code>, <code>Friends</code> and <code>You</code>. | |
<code>You</code> in this context refers to the content owner. Use the | |
<code>commentThreadState</code> property of the <code>ListRelationship</code> to | |
determine the signed-in member’s ability to comment (or not).</p> | |
</td> | |
</tr> | |
<tr data-property-name="accountStatus"> | |
<td class="name"> | |
accountStatus | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Active, </span><span | |
class="json-property-enum-item">Locked, </span><span | |
class="json-property-enum-item">Memorialized</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s account status.</p> | |
</td> | |
</tr> | |
<tr data-property-name="hideAds"> | |
<td class="name"> | |
hideAds | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p> <code>true</code> if member should not be shown ads.</p> | |
</td> | |
</tr> | |
<tr data-property-name="twitterUsername"> | |
<td class="name"> | |
twitterUsername | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s Twitter username, if they have authenticated their account.</p> | |
</td> | |
</tr> | |
<tr data-property-name="bioLbml"> | |
<td class="name"> | |
bioLbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s bio in LBML. May contain the following HTML tags: <code><br></code> | |
<code><strong></code> <code><em></code> <code><b></code> | |
<code><i></code> <code><a href=""></code> <code><blockquote></code>. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="location"> | |
<td class="name"> | |
location | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s location.</p> | |
</td> | |
</tr> | |
<tr data-property-name="website"> | |
<td class="name"> | |
website | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s website URL. URLs are not validated, so sanitizing may be required.</p> | |
</td> | |
</tr> | |
<tr data-property-name="backdrop"> | |
<td class="name"> | |
backdrop | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The | |
member’s backdrop image at multiple sizes, sourced from the first film | |
in the member’s list of favorite films, if available. Only returned for <a | |
href="https://letterboxd.com/patrons/">Patron</a> members.</p> | |
</td> | |
</tr> | |
<tr data-property-name="backdropFocalPoint"> | |
<td class="name"> | |
backdropFocalPoint | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
vertical focal point of the member’s backdrop image, if available. | |
Expressed as a proportion of the image’s height, using values between <code>0.0</code> | |
and <code>1.0</code>. Use when cropping the image into a shorter space, such as in the | |
page for a film on the Letterboxd site.</p> | |
</td> | |
</tr> | |
<tr data-property-name="favoriteFilms"> | |
<td class="name"> | |
favoriteFilms | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A summary of the member’s favorite films, up to a maximum of four.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pinnedReviews"> | |
<td class="name"> | |
pinnedReviews | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/LogEntry">LogEntry</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The reviews the member has pinned on their profile page, up to a maximum of two. <em>Only | |
returned for paying members.</em></p> | |
</td> | |
</tr> | |
<tr data-property-name="links"> | |
<td class="name"> | |
links | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Link">Link</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A link to the member’s profile page on the Letterboxd website.</p> | |
</td> | |
</tr> | |
<tr data-property-name="privateWatchlist"> | |
<td class="name"> | |
privateWatchlist | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>false</code> for new accounts. Indicates whether the member has elected | |
to hide their watchlist from other members.</p> | |
</td> | |
</tr> | |
<tr data-property-name="featuredList"> | |
<td class="name"> | |
featuredList | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/ListSummary">ListSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>A summary of the member’s featured list. Only returned for HQ members.</p> | |
</td> | |
</tr> | |
<tr data-property-name="teamMembers"> | |
<td class="name"> | |
teamMembers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A summary of the member’s team members. Only returned for HQ members.</p> | |
</td> | |
</tr> | |
<tr data-property-name="orgType"> | |
<td class="name"> | |
orgType | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Society, </span><span | |
class="json-property-enum-item">Educator, </span><span | |
class="json-property-enum-item">Exhibitor, </span><span | |
class="json-property-enum-item">Festival, </span><span | |
class="json-property-enum-item">Single_Film, </span><span | |
class="json-property-enum-item">Genre, </span><span | |
class="json-property-enum-item">Association, </span><span | |
class="json-property-enum-item">Media_Publisher, </span><span | |
class="json-property-enum-item">Product_Platform, </span><span | |
class="json-property-enum-item">Podcast, </span><span | |
class="json-property-enum-item">Streamer, </span><span | |
class="json-property-enum-item">Studio</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s organisation type. Only returned for HQ members.</p> | |
</td> | |
</tr> | |
<tr data-property-name="bio"> | |
<td class="name"> | |
bio | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s bio formatted as HTML.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberAccount"> | |
<h1 class="api-title"><a name="/definitions/MemberAccount"></a>MemberAccount </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="emailAddress"> | |
<td class="name"> | |
emailAddress | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s email address.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailAddressValidated"> | |
<td class="name"> | |
emailAddressValidated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member has validated their <code>emailAddress</code> via | |
an emailed link.</p> | |
</td> | |
</tr> | |
<tr data-property-name="privateAccount"> | |
<td class="name"> | |
privateAccount | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>false</code> for new accounts. Indicates whether the member has elected | |
for their content to appear in the API (other than in the <a href="#path--me">/me</a> | |
endpoint).</p> | |
</td> | |
</tr> | |
<tr data-property-name="includeInPeopleSection"> | |
<td class="name"> | |
includeInPeopleSection | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> for new accounts. Indicates whether the member has elected | |
to appear in the <a href="https://letterboxd.com/people/">People</a> section of the | |
Letterboxd website.</p> | |
</td> | |
</tr> | |
<tr data-property-name="privateWatchlist"> | |
<td class="name"> | |
privateWatchlist | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>false</code> for new accounts. Indicates whether the member has elected | |
to hide their watchlist from other members.<span class="p"><strong | |
class="deprecated-label">DEPRECATED</strong> Found in <code>member</code> | |
instead.</span></p> | |
</td> | |
</tr> | |
<tr data-property-name="emailWhenFollowed"> | |
<td class="name"> | |
emailWhenFollowed | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> for new accounts. Indicates whether the member has elected | |
to receive an email notification when another member follows them.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailAvailability"> | |
<td class="name"> | |
emailAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
an email notification when films on their watchlist become available to | |
stream on one of their favorite services.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailBuyAvailability"> | |
<td class="name"> | |
emailBuyAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
an email notification when films on their watchlist become available to | |
buy on one of their favorite services.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailRentAvailability"> | |
<td class="name"> | |
emailRentAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
an email notification when films on their watchlist become available to | |
rent on one of their favorite services.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailComments"> | |
<td class="name"> | |
emailComments | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
email notifications when new comments are posted in threads they are | |
subscribed to.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailNews"> | |
<td class="name"> | |
emailNews | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
regular email news (including ‘Call Sheet’) from Letterboxd.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailRushes"> | |
<td class="name"> | |
emailRushes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive a | |
weekly email digest of new and popular content (called ‘Rushes’).</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailPartnerMessages"> | |
<td class="name"> | |
emailPartnerMessages | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> for new accounts. Indicates whether the member has elected | |
to receive offers from trusted partners via Letterboxd.</p> | |
</td> | |
</tr> | |
<tr data-property-name="devicesRegisteredForPushNotifications"> | |
<td class="name"> | |
devicesRegisteredForPushNotifications | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of device IDs that may receive push notifications for this account.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForGeneralAnnouncements"> | |
<td class="name"> | |
pushNotificationsForGeneralAnnouncements | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> for new accounts. Indicates whether the member has elected | |
to receive push notifications for platform and account alerts.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForPartnerMessages"> | |
<td class="name"> | |
pushNotificationsForPartnerMessages | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> for new accounts. Indicates whether the member has elected | |
to receive push notifications with offers from trusted partners.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForComments"> | |
<td class="name"> | |
pushNotificationsForComments | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
push notifications when new comments are posted in threads they are | |
subscribed to.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForListLikes"> | |
<td class="name"> | |
pushNotificationsForListLikes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
push notifications when another member likes one of their lists.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForReviewLikes"> | |
<td class="name"> | |
pushNotificationsForReviewLikes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
push notifications when another member likes one of their reviews.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForNewFollowers"> | |
<td class="name"> | |
pushNotificationsForNewFollowers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> for new accounts. Indicates whether the member has elected | |
to receive push notifications when another member follows them.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForAvailability"> | |
<td class="name"> | |
pushNotificationsForAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
push notifications when films on a members watchlist become available to | |
stream on one of their favorite services.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForBuyAvailability"> | |
<td class="name"> | |
pushNotificationsForBuyAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
push notifications when films on a members watchlist become available to | |
buy on one of their favorite services.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForRentAvailability"> | |
<td class="name"> | |
pushNotificationsForRentAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>true</code> | |
for new accounts. Indicates whether the member has elected to receive | |
push notifications when films on a members watchlist become available to | |
rent on one of their favorite services.</p> | |
</td> | |
</tr> | |
<tr data-property-name="canComment"> | |
<td class="name"> | |
canComment | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>false</code> | |
for new accounts. Indicates whether the member has commenting | |
privileges. Commenting is disabled on new accounts until the member’s | |
<code>emailAddress</code> is validated. At present <code>canComment</code> is synonymous | |
with <code>emailAddressValidated</code> (unless the member is <code>suspended</code>) | |
but this may change in future.</p> | |
</td> | |
</tr> | |
<tr data-property-name="suspended"> | |
<td class="name"> | |
suspended | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Indicates whether the member is suspended from commenting due to a breach of the <a | |
href="https://letterboxd.com/legal/community-policy/">Community Policy</a>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="canCloneLists"> | |
<td class="name"> | |
canCloneLists | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Indicates whether the member is able to clone other members’ lists. Determined by | |
Letterboxd based upon <code>memberStatus</code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="canFilterActivity"> | |
<td class="name"> | |
canFilterActivity | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Indicates whether the member is able to filter activity by type. Determined by Letterboxd | |
based upon <code>memberStatus</code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="authorizedSharingServicesForLists"> | |
<td class="name"> | |
authorizedSharingServicesForLists | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The services the member has authorized Letterboxd to share lists to. More services may be | |
added in the future.<span class="p"><strong class="deprecated-label">DEPRECATED</strong> | |
No longer supported by Facebook.</span></p> | |
</td> | |
</tr> | |
<tr data-property-name="authorizedSharingServicesForReviews"> | |
<td class="name"> | |
authorizedSharingServicesForReviews | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The services the member has authorized Letterboxd to share reviews to. More services may | |
be added in the future.<span class="p"><strong | |
class="deprecated-label">DEPRECATED</strong> No longer supported by | |
Facebook.</span></p> | |
</td> | |
</tr> | |
<tr data-property-name="membershipDaysRemaining"> | |
<td class="name"> | |
membershipDaysRemaining | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of days the member has left in their subscription. <em>Only returned for | |
paying members.</em></p> | |
</td> | |
</tr> | |
<tr data-property-name="membershipWillAutoRenewViaIAP"> | |
<td class="name"> | |
membershipWillAutoRenewViaIAP | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Indicates whether the member’s subscription is expected to auto-renew via Apple’s IAP | |
subscription. <em>Only returned for members who have subscribed through IAP.</em></p> | |
</td> | |
</tr> | |
<tr data-property-name="hasActiveSubscription"> | |
<td class="name"> | |
hasActiveSubscription | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Indicates whether the member has an active subscription that will auto-renew. Will return | |
<code>false</code> | |
for members who did subscribe and then set their subscription to no | |
longer renew, even if the original subscription period has not yet | |
expired.</p> | |
</td> | |
</tr> | |
<tr data-property-name="subscriptionType"> | |
<td class="name"> | |
subscriptionType | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Indicates the member’s subscription type, possible values are <code>apple</code> or | |
<code>paddle</code>. <em>Only returned for members who have an active subscription.</em> | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Member">Member</a></span> | |
</td> | |
<td class="desc"> | |
<p>Standard member details.</p> | |
</td> | |
</tr> | |
<tr data-property-name="campaigns"> | |
<td class="name"> | |
campaigns | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of campaigns this account is involved in.</p> | |
</td> | |
</tr> | |
<tr data-property-name="adultContentPolicy"> | |
<td class="name"> | |
adultContentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Always, </span><span | |
class="json-property-enum-item">Default</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s adult content policy determing whether or not they see adult content. | |
Supported options are <code>Always</code> or <code>Default</code>. <code>Default</code> | |
means never show adult content.</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Anyone, </span><span | |
class="json-property-enum-item">Friends, </span><span | |
class="json-property-enum-item">You</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s default policy determing who can post comments to their content. Supported | |
options are <code>Anyone</code>, <code>Friends</code> and <code>You</code>. | |
<code>You</code> in this context refers to the content owner. Use the | |
<code>commentThreadState</code> property of the <code>ListRelationship</code> to | |
determine the signed-in member’s ability to comment (or not).</p> | |
</td> | |
</tr> | |
<tr data-property-name="accountStatus"> | |
<td class="name"> | |
accountStatus | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Active, </span><span | |
class="json-property-enum-item">Locked, </span><span | |
class="json-property-enum-item">Memorialized</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s account status.</p> | |
</td> | |
</tr> | |
<tr data-property-name="hideAds"> | |
<td class="name"> | |
hideAds | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p> <code>true</code> if member should not be shown ads.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberFilmRelationship"> | |
<h1 class="api-title"><a name="/definitions/MemberFilmRelationship"></a>MemberFilmRelationship </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="relationship"> | |
<td class="name"> | |
relationship | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmRelationship">FilmRelationship</a></span> | |
</td> | |
<td class="desc"> | |
<p>The relationship details.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberFilmRelationshipsResponse"> | |
<h1 class="api-title"><a name="/definitions/MemberFilmRelationshipsResponse"></a>MemberFilmRelationshipsResponse | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/MemberFilmRelationship">MemberFilmRelationship</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of film relationships for members.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberFilmViewingRelationship"> | |
<h1 class="api-title"><a name="/definitions/MemberFilmViewingRelationship"></a>MemberFilmViewingRelationship | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="relationship"> | |
<td class="name"> | |
relationship | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmRelationship">FilmRelationship</a></span> | |
</td> | |
<td class="desc"> | |
<p>The relationship details.</p> | |
</td> | |
</tr> | |
<tr data-property-name="logEntry"> | |
<td class="name"> | |
logEntry | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/LogEntrySummary">LogEntrySummary</a></span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberIdentifier"> | |
<h1 class="api-title"><a name="/definitions/MemberIdentifier"></a>MemberIdentifier </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the member.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberRelationship"> | |
<h1 class="api-title"><a name="/definitions/MemberRelationship"></a>MemberRelationship </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="following"> | |
<td class="name"> | |
following | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the authenticated member follows the member identified by | |
ID.</p> | |
</td> | |
</tr> | |
<tr data-property-name="followedBy"> | |
<td class="name"> | |
followedBy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member identified by ID follows the authenticated | |
member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="blocking"> | |
<td class="name"> | |
blocking | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the authenticated member has blocked the member identified | |
by ID.</p> | |
</td> | |
</tr> | |
<tr data-property-name="blockedBy"> | |
<td class="name"> | |
blockedBy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member identified by ID has blocked the authenticated | |
member.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberRelationshipUpdateMessage"> | |
<h1 class="api-title"><a name="/definitions/MemberRelationshipUpdateMessage"></a>MemberRelationshipUpdateMessage | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">BlockYourself, </span><span | |
class="json-property-enum-item">FollowYourself, </span><span | |
class="json-property-enum-item">FollowRateLimit, </span><span | |
class="json-property-enum-item">FollowBlockedMember, </span><span | |
class="json-property-enum-item">FollowMemberYouBlocked</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberRelationshipUpdateRequest"> | |
<h1 class="api-title"><a name="/definitions/MemberRelationshipUpdateRequest"></a>MemberRelationshipUpdateRequest | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="following"> | |
<td class="name"> | |
following | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the authenticated member wishes to follow the member | |
identified by ID, or <code>false</code> | |
if they wish to unfollow. A member may not follow their own account, or | |
the account of a member they have blocked or that has blocked them.</p> | |
</td> | |
</tr> | |
<tr data-property-name="blocking"> | |
<td class="name"> | |
blocking | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the authenticated member wishes to block the member | |
identified by ID, or <code>false</code> if they wish to unblock. A member may not block | |
their own account.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberRelationshipUpdateResponse"> | |
<h1 class="api-title"><a | |
name="/definitions/MemberRelationshipUpdateResponse"></a>MemberRelationshipUpdateResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberRelationship">MemberRelationship</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/MemberRelationshipUpdateMessage">MemberRelationshipUpdateMessage</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberSearchItem"> | |
<h1 class="api-title"><a name="/definitions/MemberSearchItem"></a>MemberSearchItem <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractSearchItem">AbstractSearchItem</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="score"> | |
<td class="name"> | |
score <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member returned by the search.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="MemberSettingsUpdateMessage"> | |
<h1 class="api-title"><a name="/definitions/MemberSettingsUpdateMessage"></a>MemberSettingsUpdateMessage </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">IncorrectCurrentPassword, </span><span | |
class="json-property-enum-item">BlankPassword, </span><span | |
class="json-property-enum-item">InvalidEmailAddress, </span><span | |
class="json-property-enum-item">EmailAddressInUse, </span><span | |
class="json-property-enum-item">InvalidFavoriteFilm, </span><span | |
class="json-property-enum-item">BioTooLong, </span><span | |
class="json-property-enum-item">InvalidPronounOption</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberSettingsUpdateRequest"> | |
<h1 class="api-title"><a name="/definitions/MemberSettingsUpdateRequest"></a>MemberSettingsUpdateRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="emailAddress"> | |
<td class="name"> | |
emailAddress | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s email address.</p> | |
</td> | |
</tr> | |
<tr data-property-name="currentPassword"> | |
<td class="name"> | |
currentPassword | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s current password. Required when updating the password.</p> | |
</td> | |
</tr> | |
<tr data-property-name="password"> | |
<td class="name"> | |
password | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s new password.</p> | |
</td> | |
</tr> | |
<tr data-property-name="givenName"> | |
<td class="name"> | |
givenName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The given name of the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="familyName"> | |
<td class="name"> | |
familyName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The family name of the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pronoun"> | |
<td class="name"> | |
pronoun | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the member’s preferred pronoun. Use the <a | |
href="#path--members-pronouns">/members/pronouns</a> endpoint to request all | |
available pronouns.</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s default policy determing who can post comments to their content. Supported | |
options are <code>Anyone</code>, <code>Friends</code> and <code>You</code>. | |
<code>You</code> in this context refers to the content owner. Use the | |
<code>commentThreadState</code> property of the <code>ListRelationship</code> to | |
determine the signed-in member’s ability to comment (or not).</p> | |
</td> | |
</tr> | |
<tr data-property-name="adultContentPolicy"> | |
<td class="name"> | |
adultContentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s adult content policy determing whether or not they see adult content. | |
Supported options are <code>Always</code> or <code>Default</code>. <code>Default</code> | |
means never show adult content.</p> | |
</td> | |
</tr> | |
<tr data-property-name="location"> | |
<td class="name"> | |
location | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s location.</p> | |
</td> | |
</tr> | |
<tr data-property-name="website"> | |
<td class="name"> | |
website | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s website URL. URLs are not validated, so sanitizing may be required.</p> | |
</td> | |
</tr> | |
<tr data-property-name="bio"> | |
<td class="name"> | |
bio | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s bio in LBML. May contain the following HTML tags: <code><br></code> | |
<code><strong></code> <code><em></code> <code><b></code> | |
<code><i></code> <code><a href=""></code> <code><blockquote></code>. | |
This field has a maximum size of 100,000 characters.</p> | |
</td> | |
</tr> | |
<tr data-property-name="favoriteFilms"> | |
<td class="name"> | |
favoriteFilms | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LIDs of the member’s favorite films, in order, up to a maximum of four.</p> | |
</td> | |
</tr> | |
<tr data-property-name="privateAccount"> | |
<td class="name"> | |
privateAccount | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> to prevent the member’s content from appearing in API requests | |
other than the <a href="#path--me">/me</a> endpoint.</p> | |
</td> | |
</tr> | |
<tr data-property-name="includeInPeopleSection"> | |
<td class="name"> | |
includeInPeopleSection | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>false</code> to remove the account from the <a | |
href="https://letterboxd.com/members/">Members</a> section of the Letterboxd | |
website.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailWhenFollowed"> | |
<td class="name"> | |
emailWhenFollowed | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive an email notification when | |
another member follows them.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailAvailability"> | |
<td class="name"> | |
emailAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
<tr data-property-name="emailBuyAvailability"> | |
<td class="name"> | |
emailBuyAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
<tr data-property-name="emailRentAvailability"> | |
<td class="name"> | |
emailRentAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
<tr data-property-name="emailComments"> | |
<td class="name"> | |
emailComments | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive email notifications when new | |
comments are posted in threads they are subscribed to.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailNews"> | |
<td class="name"> | |
emailNews | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive regular email news (including | |
‘Call Sheet’) from Letterboxd.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailRushes"> | |
<td class="name"> | |
emailRushes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive a weekly email digest of new and | |
popular content (called ‘Rushes’).</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailPartnerMessages"> | |
<td class="name"> | |
emailPartnerMessages | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive offers from trusted partners via | |
Letterboxd.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForGeneralAnnouncements"> | |
<td class="name"> | |
pushNotificationsForGeneralAnnouncements | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive push notifications for platform | |
and account alerts.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForPartnerMessages"> | |
<td class="name"> | |
pushNotificationsForPartnerMessages | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive push notifications with offers | |
from trusted partners.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForComments"> | |
<td class="name"> | |
pushNotificationsForComments | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive push notifications when new | |
comments are posted in threads they are subscribed to.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForReviewLikes"> | |
<td class="name"> | |
pushNotificationsForReviewLikes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive push notifications when another | |
member likes one of their reviews.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForListLikes"> | |
<td class="name"> | |
pushNotificationsForListLikes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive push notifications when another | |
member likes one of their lists.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForNewFollowers"> | |
<td class="name"> | |
pushNotificationsForNewFollowers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member wishes to receive push notifications when another | |
member follows them.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForAvailability"> | |
<td class="name"> | |
pushNotificationsForAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForBuyAvailability"> | |
<td class="name"> | |
pushNotificationsForBuyAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
<tr data-property-name="pushNotificationsForRentAvailability"> | |
<td class="name"> | |
pushNotificationsForRentAvailability | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberSettingsUpdateResponse"> | |
<h1 class="api-title"><a name="/definitions/MemberSettingsUpdateResponse"></a>MemberSettingsUpdateResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberAccount">MemberAccount</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/MemberSettingsUpdateMessage">MemberSettingsUpdateMessage</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MembersResponse"> | |
<h1 class="api-title"><a name="/definitions/MembersResponse"></a>MembersResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of members.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberStatistics"> | |
<h1 class="api-title"><a name="/definitions/MemberStatistics"></a>MemberStatistics </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberIdentifier">MemberIdentifier</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member for which statistics were requested.</p> | |
</td> | |
</tr> | |
<tr data-property-name="counts"> | |
<td class="name"> | |
counts | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberStatisticsCounts">MemberStatisticsCounts</a></span> | |
</td> | |
<td class="desc"> | |
<p>The number of watches, ratings, likes, etc. for the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="ratingsHistogram"> | |
<td class="name"> | |
ratingsHistogram | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/RatingsHistogramBar">RatingsHistogramBar</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A summary of the number of ratings the member has made for each increment between | |
<code>0.5</code> and <code>5.0</code>. Returns only the integer increments between | |
<code>1.0</code> and <code>5.0</code> if the member never (or rarely) awards half-star | |
ratings.</p> | |
</td> | |
</tr> | |
<tr data-property-name="yearsInReview"> | |
<td class="name"> | |
yearsInReview | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">integer[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of years the member has year-in-review pages for. <em>Only supported for paying | |
members.</em></p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberStatisticsCounts"> | |
<h1 class="api-title"><a name="/definitions/MemberStatisticsCounts"></a>MemberStatisticsCounts </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="filmLikes"> | |
<td class="name"> | |
filmLikes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films the member has liked.</p> | |
</td> | |
</tr> | |
<tr data-property-name="listLikes"> | |
<td class="name"> | |
listLikes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of lists the member has liked.</p> | |
</td> | |
</tr> | |
<tr data-property-name="reviewLikes"> | |
<td class="name"> | |
reviewLikes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of reviews the member has liked.</p> | |
</td> | |
</tr> | |
<tr data-property-name="watches"> | |
<td class="name"> | |
watches | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films the member has watched. This is a distinct total — films with | |
multiple log entries are only counted once.</p> | |
</td> | |
</tr> | |
<tr data-property-name="ratings"> | |
<td class="name"> | |
ratings | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films the member has rated.</p> | |
</td> | |
</tr> | |
<tr data-property-name="reviews"> | |
<td class="name"> | |
reviews | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films the member has reviewed.</p> | |
</td> | |
</tr> | |
<tr data-property-name="diaryEntries"> | |
<td class="name"> | |
diaryEntries | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of entries the member has in their diary.</p> | |
</td> | |
</tr> | |
<tr data-property-name="diaryEntriesThisYear"> | |
<td class="name"> | |
diaryEntriesThisYear | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
number of entries the member has in their diary for the current year. | |
The current year rolls over at midnight on 31 December in New Zealand | |
Daylight Time (GMT + 13).</p> | |
</td> | |
</tr> | |
<tr data-property-name="filmsInDiaryThisYear"> | |
<td class="name"> | |
filmsInDiaryThisYear | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
number of unique films the member has in their diary for the current | |
year. The current year rolls over at midnight on 31 December in New | |
Zealand Daylight Time (GMT + 13).</p> | |
</td> | |
</tr> | |
<tr data-property-name="watchlist"> | |
<td class="name"> | |
watchlist | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films the member has in their watchlist.</p> | |
</td> | |
</tr> | |
<tr data-property-name="lists"> | |
<td class="name"> | |
lists | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of lists for the member. Includes unpublished lists if the request is made for | |
the authenticated member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="unpublishedLists"> | |
<td class="name"> | |
unpublishedLists | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of unpublished lists for the member. Only included if the request is made for | |
the authenticated member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="followers"> | |
<td class="name"> | |
followers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of members who follow the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="following"> | |
<td class="name"> | |
following | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of members the member is following.</p> | |
</td> | |
</tr> | |
<tr data-property-name="listTags"> | |
<td class="name"> | |
listTags | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of tags the member has used for lists.</p> | |
</td> | |
</tr> | |
<tr data-property-name="filmTags"> | |
<td class="name"> | |
filmTags | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of tags the member has used for diary entries and reviews.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberSummary"> | |
<h1 class="api-title"><a name="/definitions/MemberSummary"></a>MemberSummary </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="username"> | |
<td class="name"> | |
username | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
member’s Letterboxd username. Usernames must be between 2 and 15 | |
characters long and may only contain upper or lowercase letters, numbers | |
or the underscore (<code>_</code>) character.</p> | |
</td> | |
</tr> | |
<tr data-property-name="givenName"> | |
<td class="name"> | |
givenName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The given name of the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="familyName"> | |
<td class="name"> | |
familyName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The family name of the member.</p> | |
</td> | |
</tr> | |
<tr data-property-name="displayName"> | |
<td class="name"> | |
displayName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A | |
convenience method that returns the member’s given name and family name | |
concatenated with a space, if both are set, or just their given name or | |
family name, if one is set, or their username, if neither is set. Will | |
never be empty.</p> | |
</td> | |
</tr> | |
<tr data-property-name="shortName"> | |
<td class="name"> | |
shortName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A convenience method that returns the member’s given name, if set, or their username. | |
Will never be empty.</p> | |
</td> | |
</tr> | |
<tr data-property-name="pronoun"> | |
<td class="name"> | |
pronoun | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Pronoun">Pronoun</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member’s preferred pronoun. Use the <a | |
href="#path--members-pronouns">/members/pronouns</a> endpoint to request all | |
available pronouns.</p> | |
</td> | |
</tr> | |
<tr data-property-name="avatar"> | |
<td class="name"> | |
avatar | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The | |
member’s avatar image at multiple sizes. Avatar images to not have an | |
enforced aspect ratio, so should be center-cropped to a square if they | |
are not 1:1.</p> | |
</td> | |
</tr> | |
<tr data-property-name="memberStatus"> | |
<td class="name"> | |
memberStatus | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Crew, </span><span | |
class="json-property-enum-item">Alum, </span><span | |
class="json-property-enum-item">Hq, </span><span | |
class="json-property-enum-item">Patron, </span><span | |
class="json-property-enum-item">Pro, </span><span | |
class="json-property-enum-item">Member</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s account type.</p> | |
</td> | |
</tr> | |
<tr data-property-name="hideAdsInContent"> | |
<td class="name"> | |
hideAdsInContent | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p> <code>true</code> if ads should not be shown on the member's content.</p> | |
</td> | |
</tr> | |
<tr data-property-name="commentPolicy"> | |
<td class="name"> | |
commentPolicy | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Anyone, </span><span | |
class="json-property-enum-item">Friends, </span><span | |
class="json-property-enum-item">You</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s default policy determing who can post comments to their content. Supported | |
options are <code>Anyone</code>, <code>Friends</code> and <code>You</code>. | |
<code>You</code> in this context refers to the content owner. Use the | |
<code>commentThreadState</code> property of the <code>ListRelationship</code> to | |
determine the signed-in member’s ability to comment (or not).</p> | |
</td> | |
</tr> | |
<tr data-property-name="accountStatus"> | |
<td class="name"> | |
accountStatus | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Active, </span><span | |
class="json-property-enum-item">Locked, </span><span | |
class="json-property-enum-item">Memorialized</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The member’s account status.</p> | |
</td> | |
</tr> | |
<tr data-property-name="hideAds"> | |
<td class="name"> | |
hideAds | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p> <code>true</code> if member should not be shown ads.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberTag"> | |
<h1 class="api-title"><a name="/definitions/MemberTag"></a>MemberTag </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="tag"> | |
<td class="name"> | |
tag | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p><strong class="deprecated-label">DEPRECATED</strong> Use <code>displayTag</code> instead. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tag code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="displayTag"> | |
<td class="name"> | |
displayTag | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tag text as entered by the tagger.</p> | |
</td> | |
</tr> | |
<tr data-property-name="counts"> | |
<td class="name"> | |
counts | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberTagCounts">MemberTagCounts</a></span> | |
</td> | |
<td class="desc"> | |
<p>Counts of the member’s uses of this tag.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberTagCounts"> | |
<h1 class="api-title"><a name="/definitions/MemberTagCounts"></a>MemberTagCounts </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="films"> | |
<td class="name"> | |
films | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of films the member has used this tag on.</p> | |
</td> | |
</tr> | |
<tr data-property-name="logEntries"> | |
<td class="name"> | |
logEntries | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of log entries the member has used this tag on.</p> | |
</td> | |
</tr> | |
<tr data-property-name="diaryEntries"> | |
<td class="name"> | |
diaryEntries | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of diary entries the member has used this tag on.</p> | |
</td> | |
</tr> | |
<tr data-property-name="reviews"> | |
<td class="name"> | |
reviews | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of reviews the member has used this tag on.</p> | |
</td> | |
</tr> | |
<tr data-property-name="lists"> | |
<td class="name"> | |
lists | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of lists the member has used this tag on.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="MemberTagsResponse"> | |
<h1 class="api-title"><a name="/definitions/MemberTagsResponse"></a>MemberTagsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/MemberTag">MemberTag</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of tag items, ordered by frequency of use.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Minigenre"> | |
<h1 class="api-title"><a name="/definitions/Minigenre"></a>Minigenre </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The identifying code for the minigenre.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the minigenre.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Nanogenre"> | |
<h1 class="api-title"><a name="/definitions/Nanogenre"></a>Nanogenre </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The identifying code for the nanogenre.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the nanogenre.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="NewsItem"> | |
<h1 class="api-title"><a name="/definitions/NewsItem"></a>NewsItem </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The title of the news item.</p> | |
</td> | |
</tr> | |
<tr data-property-name="image"> | |
<td class="name"> | |
image | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The image.</p> | |
</td> | |
</tr> | |
<tr data-property-name="url"> | |
<td class="name"> | |
url | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The URL of the news item.</p> | |
</td> | |
</tr> | |
<tr data-property-name="shortDescription"> | |
<td class="name"> | |
shortDescription | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A short description of the news item in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="longDescription"> | |
<td class="name"> | |
longDescription | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A long description of the news item in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="episode"> | |
<td class="name"> | |
episode | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The podcast episode number, if this news item is for a podcast</p> | |
</td> | |
</tr> | |
<tr data-property-name="season"> | |
<td class="name"> | |
season | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The podcast season number, if this news item is for a podcast</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="NewsResponse"> | |
<h1 class="api-title"><a name="/definitions/NewsResponse"></a>NewsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/NewsItem">NewsItem</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of news items.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="OAuthError"> | |
<h1 class="api-title"><a name="/definitions/OAuthError"></a>OAuthError </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="error"> | |
<td class="name"> | |
error | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error code, usually <code>invalid_grant</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="PodcastSearchItem"> | |
<h1 class="api-title"><a name="/definitions/PodcastSearchItem"></a>PodcastSearchItem <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractSearchItem">AbstractSearchItem</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="score"> | |
<td class="name"> | |
score <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="podcast"> | |
<td class="name"> | |
podcast | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/NewsItem">NewsItem</a></span> | |
</td> | |
<td class="desc"> | |
<p>The podcast.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="Pronoun"> | |
<h1 class="api-title"><a name="/definitions/Pronoun"></a>Pronoun </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID for this pronoun.</p> | |
</td> | |
</tr> | |
<tr data-property-name="label"> | |
<td class="name"> | |
label | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A label to describe this pronoun.</p> | |
</td> | |
</tr> | |
<tr data-property-name="subjectPronoun"> | |
<td class="name"> | |
subjectPronoun | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The pronoun to use when the member is the subject.</p> | |
<section class="json-schema-example"> | |
<pre><em>She</em> went to the movies.</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="objectPronoun"> | |
<td class="name"> | |
objectPronoun | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The pronoun to use when the member is the object.</p> | |
<section class="json-schema-example"> | |
<pre>I went with <em>her</em> to the cinema.</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="possessiveAdjective"> | |
<td class="name"> | |
possessiveAdjective | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The adjective to use when describing a specified thing or things belonging to or | |
associated with a member previously mentioned.</p> | |
<section class="json-schema-example"> | |
<pre>He bought <em>his</em> tickets.</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="possessivePronoun"> | |
<td class="name"> | |
possessivePronoun | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The pronoun to use when referring to a specified thing or things belonging to or | |
associated with a member previously mentioned.</p> | |
<section class="json-schema-example"> | |
<pre>That popcorn was <em>hers</em>.</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="reflexive"> | |
<td class="name"> | |
reflexive | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The pronoun to use to refer back to the member.</p> | |
<section class="json-schema-example"> | |
<pre>He saw <em>himself</em> as a great director.</pre> | |
</section> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="PronounsResponse"> | |
<h1 class="api-title"><a name="/definitions/PronounsResponse"></a>PronounsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/Pronoun">Pronoun</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of pronouns.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="RatingsHistogramBar"> | |
<h1 class="api-title"><a name="/definitions/RatingsHistogramBar"></a>RatingsHistogramBar </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="rating"> | |
<td class="name"> | |
rating | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The rating increment between <code>0.5</code> and <code>5.0</code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="normalizedWeight"> | |
<td class="name"> | |
normalizedWeight | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The height of this rating increment’s entry in a unit-height histogram, normalized | |
between <code>0.0</code> and <code>1.0</code>. The increment(s) with the highest number | |
of ratings will always return <code>1.0</code> (unless there are no ratings for the | |
film).</p> | |
</td> | |
</tr> | |
<tr data-property-name="count"> | |
<td class="name"> | |
count | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of ratings made at this increment.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="RegisterPushNotificationsRequest"> | |
<h1 class="api-title"><a | |
name="/definitions/RegisterPushNotificationsRequest"></a>RegisterPushNotificationsRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="deviceId"> | |
<td class="name"> | |
deviceId | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The device ID.</p> | |
</td> | |
</tr> | |
<tr data-property-name="deviceName"> | |
<td class="name"> | |
deviceName | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The device name.</p> | |
</td> | |
</tr> | |
<tr data-property-name="token"> | |
<td class="name"> | |
token | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The Firebase token.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="RegisterRequest"> | |
<h1 class="api-title"><a name="/definitions/RegisterRequest"></a>RegisterRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="username"> | |
<td class="name"> | |
username | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The username for the new account. Use the <a | |
href="#path--auth-username-check"><code>/auth/username-check</code></a> endpoint to | |
check availability.</p> | |
</td> | |
</tr> | |
<tr data-property-name="password"> | |
<td class="name"> | |
password | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The password for the new account.</p> | |
</td> | |
</tr> | |
<tr data-property-name="emailAddress"> | |
<td class="name"> | |
emailAddress | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The email address for the new account.</p> | |
</td> | |
</tr> | |
<tr data-property-name="captchaResponse"> | |
<td class="name"> | |
captchaResponse | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The captcha response value</p> | |
</td> | |
</tr> | |
<tr data-property-name="acceptTermsOfUse"> | |
<td class="name"> | |
acceptTermsOfUse | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the person creating the account has agreed to being at least | |
16 years of age, and to accepting Letterboxd’s <a | |
href="https://letterboxd.com/terms-of-use/">Terms of Use</a>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="RegistrationActivity"> | |
<h1 class="api-title"><a name="/definitions/RegistrationActivity"></a>RegistrationActivity <span | |
class="type">< <a class="json-schema-ref" | |
href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<span class="json-property-enum" title="Constant">RegistrationActivity</span> | |
</span> | |
</td> | |
<td class="desc"> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ReportCommentRequest"> | |
<h1 class="api-title"><a name="/definitions/ReportCommentRequest"></a>ReportCommentRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="reason"> | |
<td class="name"> | |
reason | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Abuse, </span><span | |
class="json-property-enum-item">Spoilers, </span><span | |
class="json-property-enum-item">Spam, </span><span | |
class="json-property-enum-item">Plagiarism, </span><span | |
class="json-property-enum-item">Other</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The reason why the comment was reported.</p> | |
</td> | |
</tr> | |
<tr data-property-name="message"> | |
<td class="name"> | |
message | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>An optional, explanatory message to accompany the report. Required if the | |
<code>reason</code> is <code>Plagiarism</code> or <code>Other</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReportFilmRequest"> | |
<h1 class="api-title"><a name="/definitions/ReportFilmRequest"></a>ReportFilmRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="reason"> | |
<td class="name"> | |
reason | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Duplicate, </span><span | |
class="json-property-enum-item">NotAFilm, </span><span | |
class="json-property-enum-item">Other</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The reason why the film was reported.</p> | |
</td> | |
</tr> | |
<tr data-property-name="message"> | |
<td class="name"> | |
message | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>An optional, explanatory message to accompany the report. Required if the | |
<code>reason</code> is <code>Duplicate</code> or <code>Other</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReportListRequest"> | |
<h1 class="api-title"><a name="/definitions/ReportListRequest"></a>ReportListRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="reason"> | |
<td class="name"> | |
reason | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Abuse, </span><span | |
class="json-property-enum-item">Spoilers, </span><span | |
class="json-property-enum-item">Spam, </span><span | |
class="json-property-enum-item">Plagiarism, </span><span | |
class="json-property-enum-item">Other</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The reason why the list was reported.</p> | |
</td> | |
</tr> | |
<tr data-property-name="message"> | |
<td class="name"> | |
message | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>An optional, explanatory message to accompany the report. Required if the | |
<code>reason</code> is <code>Plagiarism</code> or <code>Other</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReportMemberRequest"> | |
<h1 class="api-title"><a name="/definitions/ReportMemberRequest"></a>ReportMemberRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="reason"> | |
<td class="name"> | |
reason | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">AbusiveAccount, </span><span | |
class="json-property-enum-item">HatefulAccount, </span><span | |
class="json-property-enum-item">ManipulativeAccount, </span><span | |
class="json-property-enum-item">OffensiveAccount, </span><span | |
class="json-property-enum-item">ParodyAccount, </span><span | |
class="json-property-enum-item">PiracyAccount, </span><span | |
class="json-property-enum-item">PlagiaristAccount, </span><span | |
class="json-property-enum-item">SolicitousAccount, </span><span | |
class="json-property-enum-item">SpamAccount, </span><span | |
class="json-property-enum-item">Other</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The reason why the member was reported.</p> | |
</td> | |
</tr> | |
<tr data-property-name="message"> | |
<td class="name"> | |
message | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>An optional, explanatory message to accompany the report. Required if the | |
<code>reason</code> is <code>Other</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReportReviewRequest"> | |
<h1 class="api-title"><a name="/definitions/ReportReviewRequest"></a>ReportReviewRequest </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="reason"> | |
<td class="name"> | |
reason | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Abuse, </span><span | |
class="json-property-enum-item">Spoilers, </span><span | |
class="json-property-enum-item">Spam, </span><span | |
class="json-property-enum-item">Plagiarism, </span><span | |
class="json-property-enum-item">Other</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The reason why the review was reported.</p> | |
</td> | |
</tr> | |
<tr data-property-name="message"> | |
<td class="name"> | |
message | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>An optional, explanatory message to accompany the report. Required if the | |
<code>reason</code> is <code>Plagiarism</code> or <code>Other</code>.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Review"> | |
<h1 class="api-title"><a name="/definitions/Review"></a>Review </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="lbml"> | |
<td class="name"> | |
lbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The review text in LBML. May contain the following HTML tags: <code><br></code> | |
<code><strong></code> <code><em></code> <code><b></code> | |
<code><i></code> <code><a href=""></code> <code><blockquote></code>. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="containsSpoilers"> | |
<td class="name"> | |
containsSpoilers | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member has indicated that the <code>review</code> field | |
contains plot spoilers for the film.</p> | |
</td> | |
</tr> | |
<tr data-property-name="spoilersLocked"> | |
<td class="name"> | |
spoilersLocked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the spoilers flag has been locked by a moderator.</p> | |
</td> | |
</tr> | |
<tr data-property-name="moderated"> | |
<td class="name"> | |
moderated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the <code>review</code> has been removed by a moderator.</p> | |
</td> | |
</tr> | |
<tr data-property-name="canShareOn"> | |
<td class="name"> | |
canShareOn | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
third-party service or services to which this review can be shared. | |
Only included if the authenticated member is the review’s owner.<span class="p"><strong | |
class="deprecated-label">DEPRECATED</strong> No longer supported by | |
Facebook.</span></p> | |
</td> | |
</tr> | |
<tr data-property-name="sharedOn"> | |
<td class="name"> | |
sharedOn | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"> enum[] | |
<span class="json-property-enum" title="Constant"> | |
∈ | |
{<span class="json-property-enum-item">Facebook</span>} | |
</span> | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The | |
third-party service or services to which this review has been shared. | |
Only included if the authenticated member is the review’s owner.<span class="p"><strong | |
class="deprecated-label">DEPRECATED</strong> No longer supported by | |
Facebook.</span></p> | |
</td> | |
</tr> | |
<tr data-property-name="whenReviewed"> | |
<td class="name"> | |
whenReviewed | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp when this log entry’s review was first published, in ISO 8601 format with | |
UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="text"> | |
<td class="name"> | |
text | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The review text formatted as HTML.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewActivity"> | |
<h1 class="api-title"><a name="/definitions/ReviewActivity"></a>ReviewActivity <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="review"> | |
<td class="name"> | |
review | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/LogEntry">LogEntry</a></span> | |
</td> | |
<td class="desc"> | |
<p>The log entry associated with this activity</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ReviewComment"> | |
<h1 class="api-title"><a name="/definitions/ReviewComment"></a>ReviewComment </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the comment/reply.</p> | |
</td> | |
</tr> | |
<tr data-property-name="member"> | |
<td class="name"> | |
member | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member who posted the comment.</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="whenUpdated"> | |
<td class="name"> | |
whenUpdated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="commentLbml"> | |
<td class="name"> | |
commentLbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The message portion of the comment in LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>.</p> | |
</td> | |
</tr> | |
<tr data-property-name="removedByAdmin"> | |
<td class="name"> | |
removedByAdmin | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If Letterboxd moderators have removed the comment from the site, | |
<code>removedByAdmin</code> will be true and <code>comment</code> will not be included. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="removedByContentOwner"> | |
<td class="name"> | |
removedByContentOwner | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the content owner has removed the comment from the site, | |
<code>removedByContentOwner</code> will be true and <code>comment</code> will not be | |
included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="deleted"> | |
<td class="name"> | |
deleted | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the comment owner has removed the comment from the site, <code>deleted</code> will be | |
true and <code>comment</code> will not be included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="blocked"> | |
<td class="name"> | |
blocked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the authenticated member has blocked the commenter, <code>blocked</code> will be true | |
and <code>comment</code> will not be included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="blockedByOwner"> | |
<td class="name"> | |
blockedByOwner | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If the review owner has blocked the commenter, <code>blockedByOwner</code> will be true | |
and <code>comment</code> will not be included.</p> | |
</td> | |
</tr> | |
<tr data-property-name="editableWindowExpiresIn"> | |
<td class="name"> | |
editableWindowExpiresIn | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>If | |
the authenticated member posted this comment, and the comment is still | |
editable, this value shows the number of seconds remaining until the | |
editing window closes.</p> | |
</td> | |
</tr> | |
<tr data-property-name="review"> | |
<td class="name"> | |
review | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ReviewIdentifier">ReviewIdentifier</a></span> | |
</td> | |
<td class="desc"> | |
<p>The review on which the comment was posted.</p> | |
</td> | |
</tr> | |
<tr data-property-name="comment"> | |
<td class="name"> | |
comment | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The message portion of the comment formatted as HTML.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewCommentActivity"> | |
<h1 class="api-title"><a name="/definitions/ReviewCommentActivity"></a>ReviewCommentActivity <span | |
class="type">< <a class="json-schema-ref" | |
href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="review"> | |
<td class="name"> | |
review | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/LogEntry">LogEntry</a></span> | |
</td> | |
<td class="desc"> | |
<p>The review associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="comment"> | |
<td class="name"> | |
comment | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ReviewComment">ReviewComment</a></span> | |
</td> | |
<td class="desc"> | |
<p>The comment associated with the activity.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ReviewCommentsResponse"> | |
<h1 class="api-title"><a name="/definitions/ReviewCommentsResponse"></a>ReviewCommentsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ReviewComment">ReviewComment</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of comments.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewIdentifier"> | |
<h1 class="api-title"><a name="/definitions/ReviewIdentifier"></a>ReviewIdentifier </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the log entry.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewLikeActivity"> | |
<h1 class="api-title"><a name="/definitions/ReviewLikeActivity"></a>ReviewLikeActivity <span class="type">< | |
<a class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="review"> | |
<td class="name"> | |
review | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/LogEntry">LogEntry</a></span> | |
</td> | |
<td class="desc"> | |
<p>The review associated with the activity.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ReviewRelationship"> | |
<h1 class="api-title"><a name="/definitions/ReviewRelationship"></a>ReviewRelationship </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="liked"> | |
<td class="name"> | |
liked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member likes the review (via the ‘heart’ icon). A member | |
may not like their own review.</p> | |
</td> | |
</tr> | |
<tr data-property-name="subscribed"> | |
<td class="name"> | |
subscribed | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the member is subscribed to comment notifications for the | |
review</p> | |
</td> | |
</tr> | |
<tr data-property-name="subscriptionState"> | |
<td class="name"> | |
subscriptionState | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Subscribed, </span><span | |
class="json-property-enum-item">NotSubscribed, </span><span | |
class="json-property-enum-item">Unsubscribed</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Defaults to <code>Subscribed</code> for the review’s author, and | |
<code>NotSubscribed</code> | |
for other members. The subscription value may change when a member | |
(other than the owner) posts a comment, as follows: the member will | |
become automatically <code>Subscribed</code> unless they have previously | |
<code>Unsubscribed</code> | |
from the comment thread via the web interface or API, or unless they | |
have disabled comment notifications in their profile settings. <span | |
class="p"><code>NotSubscribed</code> and <code>Unsubscribed</code> | |
are maintained as separate states so the UI can, if needed, indicate to | |
the member how their subscription state will be affected if/when they | |
post a comment.</span></p> | |
</td> | |
</tr> | |
<tr data-property-name="commentThreadState"> | |
<td class="name"> | |
commentThreadState | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Banned, </span><span | |
class="json-property-enum-item">Blocked, </span><span | |
class="json-property-enum-item">BlockedThem, </span><span | |
class="json-property-enum-item">CanComment, </span><span | |
class="json-property-enum-item">Closed, </span><span | |
class="json-property-enum-item">FriendsOnly, </span><span | |
class="json-property-enum-item">Moderated, </span><span | |
class="json-property-enum-item">NotCommentable, </span><span | |
class="json-property-enum-item">NotValidated</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The authenticated member’s state with respect to adding comments for this review.<span | |
class="p"><code>Banned</code> means the Letterboxd community managers have | |
restricted the member’s ability to post comments.</span><span | |
class="p"><code>Blocked</code> means the owner has blocked the member from posting | |
comments.</span><span class="p"><code>BlockedThem</code> means the member has | |
blocked the owner and is therefore unable to post comments.</span><span | |
class="p"><code>CanComment</code> | |
means the authenticated member is authorized to post a comment (also | |
known as a “reply”). All other values mean the authenticated member is | |
not authorized to post a comment.</span><span class="p"><code>Closed</code> means | |
the owner has closed the comment thread to all other members.</span><span | |
class="p"><code>FriendsOnly</code> means the owner is only accepting comments from | |
members they follow.</span><span class="p"><code>Moderated</code> means the | |
Letterboxd community managers have removed the content (applies to reviews | |
only).</span><span class="p"><code>NotCommentable</code> means that comments may not | |
be posted to this thread.</span><span class="p"><code>NotValidated</code> means the | |
owner has not validated their email address.</span></p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewRelationshipUpdateMessage"> | |
<h1 class="api-title"><a name="/definitions/ReviewRelationshipUpdateMessage"></a>ReviewRelationshipUpdateMessage | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="type"> | |
<td class="name"> | |
type | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Error, </span><span | |
class="json-property-enum-item">Success</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The type of message.</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">LikeBlockedContent, </span><span | |
class="json-property-enum-item">LikeOwnReview, </span><span | |
class="json-property-enum-item">LikeRateLimit, </span><span | |
class="json-property-enum-item">LikeRemovedReview, </span><span | |
class="json-property-enum-item">LikeLogEntryWithoutReview, </span><span | |
class="json-property-enum-item">SubscribeWhenOptedOut, </span><span | |
class="json-property-enum-item">SubscribeToContentYouBlocked, </span><span | |
class="json-property-enum-item">SubscribeToBlockedContent</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="title"> | |
<td class="name"> | |
title | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The error message text in human-readable form.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewRelationshipUpdateRequest"> | |
<h1 class="api-title"><a name="/definitions/ReviewRelationshipUpdateRequest"></a>ReviewRelationshipUpdateRequest | |
</h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="liked"> | |
<td class="name"> | |
liked | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> if the member likes the review (via the ‘heart’ icon). A member | |
may not like their own review.</p> | |
</td> | |
</tr> | |
<tr data-property-name="subscribed"> | |
<td class="name"> | |
subscribed | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Set to <code>true</code> to subscribe the member to comment notifications for the review, | |
or <code>false</code> to unsubscribe them. A value of <code>true</code> will be ignored | |
if the member has disabled comment notifications in their profile settings.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewRelationshipUpdateResponse"> | |
<h1 class="api-title"><a | |
name="/definitions/ReviewRelationshipUpdateResponse"></a>ReviewRelationshipUpdateResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ReviewRelationship">ReviewRelationship</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/ReviewRelationshipUpdateMessage">ReviewRelationshipUpdateMessage</a>[] | |
</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewSearchItem"> | |
<h1 class="api-title"><a name="/definitions/ReviewSearchItem"></a>ReviewSearchItem <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractSearchItem">AbstractSearchItem</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="score"> | |
<td class="name"> | |
score <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="review"> | |
<td class="name"> | |
review | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/LogEntry">LogEntry</a></span> | |
</td> | |
<td class="desc"> | |
<p>Details of the review.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="ReviewStatistics"> | |
<h1 class="api-title"><a name="/definitions/ReviewStatistics"></a>ReviewStatistics </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="logEntry"> | |
<td class="name"> | |
logEntry | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ReviewIdentifier">ReviewIdentifier</a></span> | |
</td> | |
<td class="desc"> | |
<p>The log entry for which statistics were requested.</p> | |
</td> | |
</tr> | |
<tr data-property-name="counts"> | |
<td class="name"> | |
counts | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/ReviewStatisticsCounts">ReviewStatisticsCounts</a></span> | |
</td> | |
<td class="desc"> | |
<p>The number of comments and likes for the review.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewStatisticsCounts"> | |
<h1 class="api-title"><a name="/definitions/ReviewStatisticsCounts"></a>ReviewStatisticsCounts </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="comments"> | |
<td class="name"> | |
comments | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of comments for the review.</p> | |
</td> | |
</tr> | |
<tr data-property-name="likes"> | |
<td class="name"> | |
likes | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
integer | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The number of members who like the review.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="ReviewUpdateResponse"> | |
<h1 class="api-title"><a name="/definitions/ReviewUpdateResponse"></a>ReviewUpdateResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="data"> | |
<td class="name"> | |
data | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/LogEntry">LogEntry</a></span> | |
</td> | |
<td class="desc"> | |
<p>The response object.</p> | |
</td> | |
</tr> | |
<tr data-property-name="messages"> | |
<td class="name"> | |
messages | |
<span class="type">Required</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/LogEntryUpdateMessage">LogEntryUpdateMessage</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A list of messages the API client should show to the user.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="SearchResponse"> | |
<h1 class="api-title"><a name="/definitions/SearchResponse"></a>SearchResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/AbstractSearchItem">AbstractSearchItem</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of search results.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Service"> | |
<h1 class="api-title"><a name="/definitions/Service"></a>Service </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the service.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the service.</p> | |
</td> | |
</tr> | |
<tr data-property-name="icon"> | |
<td class="name"> | |
icon | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The URL of the thumbnail image for the service.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="StoriesResponse"> | |
<h1 class="api-title"><a name="/definitions/StoriesResponse"></a>StoriesResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="next"> | |
<td class="name"> | |
next | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Cursor">Cursor</a></span> | |
</td> | |
<td class="desc"> | |
<p>The cursor to the next page of results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/StorySummary">StorySummary</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of stories.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Story"> | |
<h1 class="api-title"><a name="/definitions/Story"></a>Story </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the story.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the story.</p> | |
</td> | |
</tr> | |
<tr data-property-name="author"> | |
<td class="name"> | |
author | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member who published the story.</p> | |
</td> | |
</tr> | |
<tr data-property-name="url"> | |
<td class="name"> | |
url | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The external URL linked to by the story (if applicable).</p> | |
</td> | |
</tr> | |
<tr data-property-name="source"> | |
<td class="name"> | |
source | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The publication name for the story (if applicable).</p> | |
</td> | |
</tr> | |
<tr data-property-name="videoUrl"> | |
<td class="name"> | |
videoUrl | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The URL of the story’s video (if applicable).</p> | |
</td> | |
</tr> | |
<tr data-property-name="bodyHtml"> | |
<td class="name"> | |
bodyHtml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The story body formatted as HTML. The text is a preview extract, and may be truncated if | |
it’s too long.</p> | |
</td> | |
</tr> | |
<tr data-property-name="bodyLbml"> | |
<td class="name"> | |
bodyLbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The story body formatted as LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>. The text is a preview extract, and may be truncated if | |
it’s too long.</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenUpdated"> | |
<td class="name"> | |
whenUpdated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="image"> | |
<td class="name"> | |
image | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The story’s hero image, in multiple resolutions.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="StoryActivity"> | |
<h1 class="api-title"><a name="/definitions/StoryActivity"></a>StoryActivity <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="story"> | |
<td class="name"> | |
story | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/StorySummary">StorySummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The story associated with the activity.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="StorySearchItem"> | |
<h1 class="api-title"><a name="/definitions/StorySearchItem"></a>StorySearchItem <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractSearchItem">AbstractSearchItem</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="score"> | |
<td class="name"> | |
score <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="story"> | |
<td class="name"> | |
story | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/StorySummary">StorySummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The story.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="StorySummary"> | |
<h1 class="api-title"><a name="/definitions/StorySummary"></a>StorySummary </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="id"> | |
<td class="name"> | |
id | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The LID of the story.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the story.</p> | |
</td> | |
</tr> | |
<tr data-property-name="author"> | |
<td class="name"> | |
author | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member who published the story.</p> | |
</td> | |
</tr> | |
<tr data-property-name="url"> | |
<td class="name"> | |
url | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The external URL linked to by the story (if applicable).</p> | |
</td> | |
</tr> | |
<tr data-property-name="source"> | |
<td class="name"> | |
source | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The publication name for the story (if applicable).</p> | |
</td> | |
</tr> | |
<tr data-property-name="videoUrl"> | |
<td class="name"> | |
videoUrl | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The URL of the story’s video (if applicable).</p> | |
</td> | |
</tr> | |
<tr data-property-name="bodyHtml"> | |
<td class="name"> | |
bodyHtml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The story body formatted as HTML. The text is a preview extract, and may be truncated if | |
it’s too long.</p> | |
</td> | |
</tr> | |
<tr data-property-name="bodyLbml"> | |
<td class="name"> | |
bodyLbml | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The story body formatted as LBML. May contain the following HTML tags: | |
<code><br></code> <code><strong></code> <code><em></code> | |
<code><b></code> <code><i></code> <code><a href=""></code> | |
<code><blockquote></code>. The text is a preview extract, and may be truncated if | |
it’s too long.</p> | |
</td> | |
</tr> | |
<tr data-property-name="bodyTruncated"> | |
<td class="name"> | |
bodyTruncated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
boolean | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>true</code> if the story body was truncated because it’s very long.</p> | |
</td> | |
</tr> | |
<tr data-property-name="whenUpdated"> | |
<td class="name"> | |
whenUpdated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>ISO 8601 format with UTC timezone, i.e. <code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr data-property-name="image"> | |
<td class="name"> | |
image | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Image">Image</a></span> | |
</td> | |
<td class="desc"> | |
<p>The story’s hero image, in multiple resolutions.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Tag"> | |
<h1 class="api-title"><a name="/definitions/Tag"></a>Tag </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="tag"> | |
<td class="name"> | |
tag | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p><strong class="deprecated-label">DEPRECATED</strong> Use <code>displayTag</code> instead. | |
</p> | |
</td> | |
</tr> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tag code.</p> | |
</td> | |
</tr> | |
<tr data-property-name="displayTag"> | |
<td class="name"> | |
displayTag | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The tag text as entered by the tagger.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="TagSearchItem"> | |
<h1 class="api-title"><a name="/definitions/TagSearchItem"></a>TagSearchItem <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractSearchItem">AbstractSearchItem</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="score"> | |
<td class="name"> | |
score <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
number | |
</span> | |
</td> | |
<td class="desc"> | |
<p>A relevancy value that can be used to order results.</p> | |
</td> | |
</tr> | |
<tr data-property-name="tag"> | |
<td class="name"> | |
tag | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" href="#/definitions/Tag">Tag</a></span> | |
</td> | |
<td class="desc"> | |
<p>The tag.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
<section class="summary" data-class-title="TagsResponse"> | |
<h1 class="api-title"><a name="/definitions/TagsResponse"></a>TagsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema">string[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of tags, ordered by frequency of use.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="Theme"> | |
<h1 class="api-title"><a name="/definitions/Theme"></a>Theme </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="code"> | |
<td class="name"> | |
code | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The identifying code for the theme.</p> | |
</td> | |
</tr> | |
<tr data-property-name="name"> | |
<td class="name"> | |
name | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The name of the theme.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="TopicsResponse"> | |
<h1 class="api-title"><a name="/definitions/TopicsResponse"></a>TopicsResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="items"> | |
<td class="name"> | |
items | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<section class="json-schema-array-items"> | |
<div class="json-inner-schema"><a class="json-schema-ref" | |
href="#/definitions/AListTopic">AListTopic</a>[]</div> | |
</section> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The list of topics.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="UsernameCheckResponse"> | |
<h1 class="api-title"><a name="/definitions/UsernameCheckResponse"></a>UsernameCheckResponse </h1> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr data-property-name="result"> | |
<td class="name"> | |
result | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
enum<span class="json-property-enum" title="Possible values"> | |
∈ | |
{<span class="json-property-enum-item">Available, </span><span | |
class="json-property-enum-item">NotAvailable, </span><span | |
class="json-property-enum-item">TooShort, </span><span | |
class="json-property-enum-item">TooLong, </span><span | |
class="json-property-enum-item">Invalid</span>} | |
</span> | |
</span> | |
</td> | |
<td class="desc"> | |
<p>Will be <code>Available</code> if the username is available to register, or | |
<code>NotAvailable</code> | |
if used by another member (or attached to a deactivated account, or | |
otherwise reserved). May return an appropriate error value if the | |
username doesn’t meet Letterboxd’s requirements: Usernames must be | |
between 2 and 15 characters long and may only contain upper or lowercase | |
letters, numbers or the underscore (<code>_</code>) character.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
<section class="summary" data-class-title="WatchlistActivity"> | |
<h1 class="api-title"><a name="/definitions/WatchlistActivity"></a>WatchlistActivity <span class="type">< <a | |
class="json-schema-ref" href="#/definitions/AbstractActivity">AbstractActivity</a></span></h1> | |
<section class="json-schema-allOf"> | |
<section class="json-schema-allOf-additional"> | |
<div class="params -properties"> | |
<h2>Properties</h2> | |
<table> | |
<tbody> | |
<tr class="-inherited-property" data-property-name="whenCreated"> | |
<td class="name"> | |
whenCreated <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
string | |
</span> | |
</td> | |
<td class="desc"> | |
<p>The timestamp of the activity, in ISO 8601 format with UTC timezone, i.e. | |
<code>YYYY-MM-DDThh:mm:ssZ</code></p> | |
<section class="json-schema-example"> | |
<pre>"1997-08-29T07:14:00Z"</pre> | |
</section> | |
</td> | |
</tr> | |
<tr class="-inherited-property" data-property-name="member"> | |
<td class="name"> | |
member <span class="type">Inherited</span> | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/MemberSummary">MemberSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The member associated with the activity.</p> | |
</td> | |
</tr> | |
<tr data-property-name="film"> | |
<td class="name"> | |
film | |
</td> | |
<td class="type"> | |
<span class="json-property-type"> | |
<a class="json-schema-ref" | |
href="#/definitions/FilmSummary">FilmSummary</a></span> | |
</td> | |
<td class="desc"> | |
<p>The film associated with the activity. Includes a | |
<code>MemberFilmRelationship</code> for the member who added the activity.</p> | |
</td> | |
</tr> | |
</tbody> | |
</table> | |
</div> | |
</section> | |
</section> | |
</section> | |
</article> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment