List.Search

Summary

Returns lists that contain the specified criteria in either their title or tags.

Signatures

Web Service Method Signature: ListPagedResults Search(string apiKey, string site, string criteria, int pageSize, int pageNumber)
REST Signature: /rest/list/Search?apiKey={apiKey}&site={site}&criteria={criteria}&pageSize={pageSize}&pageNumber={pageNumber}

Return Value

The paged results for the matching lists.

Arguments

apiKey

Your API key. For more information see here.

site

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

criteria

The criteria to search using.

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/list/Search?apiKey=xxxx&site=www.ditto.net&criteria=nostalgia&pageSize=4&pageNumber=1

Response Example

<ListPagedResults xmlns="http://www.ditto.net" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<PageNumber>1</PageNumber>
	<PageSize>3</PageSize>
	<Results>
		<List>
            <DittoUrl>http://www.ditto.net/Lists/TheBestKidsTVShows70s80s</DittoUrl>
			<CreateDate>2008-04-14T12:06:40.48</CreateDate>
			<Id>232</Id>
			<OwnerPersonId>95</OwnerPersonId>
			<Slug>TheBestKidsTVShows70s80s</Slug>
			<Title>The best kids' TV shows of the 70s and 80s</Title>
		</List>
		<List>
            <DittoUrl>http://www.ditto.net/Lists/BestClassicMovies</DittoUrl>
			<CreateDate>2008-02-11T11:53:51.467</CreateDate>
			<Id>99</Id>
			<OwnerPersonId>3726</OwnerPersonId>
			<Slug>BestClassicMovies</Slug>
			<Title>The best movies made before 1980</Title>
		</List>
		<List>
            <DittoUrl>http://www.ditto.net/Lists/Games-that-you-loved-as-a-kid</DittoUrl>
			<CreateDate>2008-04-10T23:18:46.623</CreateDate>
			<Id>214</Id>
			<OwnerPersonId>3965</OwnerPersonId>
			<Slug>Games-that-you-loved-as-a-kid</Slug>
			<Title>Games that you loved as a kid</Title>
		</List>
	</Results>
	<TotalResultCount>9</TotalResultCount>
</ListPagedResults>