Person.GetListEntries

Summary

Returns the selections that a user has made in a list, including any annotations they have provided.

Signatures

Web Service Method Signature: ListPagedResults GetListEntries(string apiKey, string site, string slug, string listSlug, int pageSize, int pageNumber)
REST Signature: /rest/person/{slug}/lists/{listSlug}/entries?apiKey={apiKey}&site={site}&pageSize={pageSize}&pageNumber={pageNumber}

Return Value

The lists that the user has filled out.

Arguments

apiKey

Your API key. For more information see here.

site

The site the API should be executed against, e.g. www.ditto.net.

slug

The slug of the user to retrieve the filled out lists for.

listSlug

The slug of the list to get the entries for.

pageSize (Optional)

The size of the page of data to return.

If this argument is omitted, it defaults to 10.

The minimum allowed value is 1 and the maximum is 50.

pageNumber (Optional)

The page number of the results to return.

If this argument is omitted or set to less than 1, it defaults to 1.

REST Example

http://api.ditto.net/rest/person/Mike/lists/BestMoviesEver/Entries?apiKey=xxxx&site=www.ditto.net&pageSize=3

Response Example

<ListSelectionPagedResults xmlns="http://www.ditto.net" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<PageNumber>1</PageNumber>
	<PageSize>10</PageSize>
	<Results>
		<ListSelection>
			<Differentiator>1946</Differentiator>
			<DittoUrl>http://www.ditto.net/Lists/AllTimeMovies/Films_Its-a-Wonderful-Life</DittoUrl>
			<EntityId>2</EntityId>
			<Name>It's a Wonderful Life</Name>
			<Slug>Films_Its-a-Wonderful-Life</Slug>
			<Annotation>It really is wonderful</Annotation>
			<ListPosition>0</ListPosition>
		</ListSelection>
		<ListSelection>
			<Differentiator>1985</Differentiator>
			<DittoUrl>http://www.ditto.net/Lists/AllTimeMovies/Films_Goonies</DittoUrl>
			<EntityId>10</EntityId>
			<Name>The Goonies</Name>
			<Slug>Films_Goonies</Slug>
			<Annotation i:nil="true"/>
			<ListPosition>1</ListPosition>
		</ListSelection>
	</Results>
	<TotalResultCount>2</TotalResultCount>
</ListSelectionPagedResults>