Skip to content

Latest commit

 

History

History
48 lines (42 loc) · 2.06 KB

Lists API.md

File metadata and controls

48 lines (42 loc) · 2.06 KB
Raw

Lists API

Documentation on the OpenLibrary lists API

The Lists API serves to get user-created lists.

For more usage examples of this API, see MiscellaneousExamples.

To make requests to the list API, either use the OpenLibraryClient

OpenLibraryClient client = new OpenLibraryClient();
OLListData listData = await client.List.GetListAsync("username", "listID");

or the static OLListLoader class:

HttpClient httpClient = new HttpClient();
OLListData listData = await OLListLoader.GetListAsync(httpClient, "username", "listID");

You can also get all lists of a user

await client.List.GetUserListsAsync("username");

or get the editions, subjects, or just general seeds of a list

var parameters = new List<KeyValuePair<string,string>>() { ... };
await client.List.GetListEditionsAsync("username", "listID", parameters);
await client.List.GetListSubjectsAsync("username", "listID", parameters);
await client.List.GetListSeedsAsync("username", "listID");

For valid parameters, see the link above. Alternatively, see OpenLibraryUtility's Maps.

When using the OpenLibraryClient, you may also create or delete lists (after logging in).

string listID = await client.CreateListAsync("listName", "listDescription");
await client.DeleteListAsync(listID);

You can also edit a list:

await client.AddEditionsToListAsync(listID, "OL7427011M", "OL29479385M");
await client.AddSubjectsToListAsync(listID, "place:japan", "fiction");
await client.AddSeedsToListAsync(listID, "/subject/psychological", "/works/OL2045111W", "/books/OL5282569M");

await client.RemoveSeedsFromListAsync(listID, "/subjects/place:japan", "/subjects/psychological", "/books/OL5282569M", "/works/OL2045111W");

You can of course only delete and edit lists that belong to your account.