Bondi Data and Image Web API Help Page

Introduction

Provide a general description of your APIs here.

Bookmark

API	Description
GET v1/Bookmark/Collections?username={username}	This will return all collections for a user.
GET v2/Bookmark/Collections/{userId}	This will return all collections for a user.
GET v1/Bookmark/Collection?collectionId={collectionId}	This will return all collections for a user.
GET v2/Bookmark/Collection/{collectionId}	This will return a single collection.
GET v1/Bookmarks?username={username}	This will return all bookmarks for a user.
POST v1/Bookmark/Save	Save an individual bookmark.
POST v2/Bookmark/Save	Save an individual bookmark.
POST v1/Bookmark/SaveCollection	This will return all issues for the magazine.
POST v2/Bookmark/SaveCollection	This will return all issues for the magazine.
POST v1/Bookmark/DeleteCollection	Deletes a collection by CollectionId.
POST v2/Bookmark/DeleteCollection	Deletes a collection by CollectionId.
GET v1/Bookmark/CollectionsWith?username={username}&documentId={documentId}	This will return all collections for a user.
GET v1/Bookmark/CollectionsWith/{userId}/{documentId}	This will return all collections for a user.
GET v2/Bookmark/CollectionsWith/{userId}/{documentId}	This will return all collections for a user.
POST v1/Bookmark/CollectionsWith/{userId}/{documentId}	This will return all collections for a user.
POST v2/Bookmark/CollectionsWith/{userId}/{documentId}	This will return all collections for a user.
POST v1/Bookmark/AddToCollection	No documentation available.
POST v2/Bookmark/AddToCollection	No documentation available.
POST v1/Bookmark/CloneCollection	No documentation available.
POST v2/Bookmark/CloneCollection	No documentation available.
POST v1/Bookmark/RemoveFromCollection	No documentation available.
POST v2/Bookmark/RemoveFromCollection	No documentation available.
GET v1/Bookmark/{issueKey}/Page/{pageName}/Assets	No documentation available.
GET v2/Bookmark/{issueKey}/Page/{pageName}/{spread}/Assets	No documentation available.
POST v2/Collection/Share	Share a colleciton
GET v2/Collection/ByToken/{token}	Finds the shared collection matching the specified token.
GET v2/Collection/{id}/Bookmarks?sort={sort}&order={order}&offset={offset}&limit={limit}&filter={filter}&docType={docType}	Finds the shared collection matching the specified token.
GET v2/Collection/{id}/Bookmarks/Filter	Finds the related articles matching the specified articleKey.

Topic

API	Description
GET v1/Topics	This will return all topics for this archive.
GET v1/Topics/All	This will return all topics for this archive.
GET v1/Topics?typeName={typeName}	No documentation available.
GET v1/Topics/ByType/{typeName}	No documentation available.
GET v1/Topics/WhereIn/{ids}	No documentation available.
GET v1/Topic/{topicId}	This will return a single topic given a valid Topic ID.
GET v1/Topic/Name/{name}	This will return a single topic given a valid Topic ID.
GET v1/Topic/Name/{name}/Type/{type}	This will return a single topic given a valid Topic ID.
GET v1/Topic/{topicId}/Rows/{startIndex}-{count}/{sort}-{order}	This will return a single topic given a valid Topic ID.
GET v1/Topic/{topicId}/Creators	This will return a single topic list of article creators.
GET v1/Topic/{topicId}/Decades	This will return a single topic list of article creators.
GET v1/Topic/{topicId}/Years	This will return a single topic list of article creators.
GET v1/Topic/{topicId}/Creator?value={value}&limit={limit}&order={order}	This will return a single topic list of article creators.
GET v1/Topic/{topicId}/Decade?value={value}&limit={limit}&order={order}	This will return a single topic list of article creators.
GET v1/Topic/{topicId}/Year?value={value}&limit={limit}&order={order}	This will return a single topic list of article creators.
GET v1/Topic/{topicId}/Search/{search}	This will return a single topic list of article creators.
GET v1/Topic/{topicId}/Articles/{keys}	No documentation available.
GET v1/Topic/{topicId}/Modules	No documentation available.
GET v1/TopicModule/{topicModuleId}	No documentation available.
GET v1/Topic/Landing/Articles/{number}	No documentation available.

Settings

API	Description
GET v1/Settings/All	No documentation available.

Post

API	Description
GET v1/Posts	Finds the post matching the specified postId.
GET v1/Post/{postId}	Finds the post matching the specified postId.
GET v1/Post/Slug/{slug}	Finds the post matching the specified postId.
GET v1/Posts/ByType/{postTypeId}/{limit}	Finds the post matching the specified postId.

API	Description
GET v1/Advertisements	Finds the advertisement matching the specified postId.
GET v1/Advertisement/{advertisementId}	Finds the post matching the specified postId.
GET v1/Advertisement/ByLocationType/{locationTypeId}	Finds the advertisement matching the specified locationTypeId.

Media

API	Description
GET v1/Media/{mediaKey}	Finds the media matching the specified mediaKey.
GET v1/Media/{mediaKey}/Bookmark	Finds the media matching the specified mediaKey for a bookmark.

User

API	Description
POST v1/User/Create
GET v1/User/Status/ClearBogus	No documentation available.

Search

API	Description
GET v2/Search	This will return indexed search results given a query
GET v1/Search/Lookups/{customFieldId}?query={query}	This will return indexed search results given a query

Article

API	Description
GET v1/Article/{articleKey}	Finds the article matching the specified articleKey.
GET v3/Article/{articleKey}	Finds the article matching the specified articleKey.
GET v1/Article/{articleKey}/Lite	Finds the article matching the specified articleKey.
GET v1/Articles/Featured	Gets all Featured Articles
GET v2/Article/{articleKey}	Finds the article matching the specified articleKey.
GET v1/Article/{articleKey}/Related	Finds the related articles matching the specified articleKey.
GET v1/Article/{articleKey}/Related/Type	Finds the related articles matching the specified articleKey.
GET v1/Article/Keys/{keys}	Finds the related articles matching the specified articleKey.
GET v1/Article/Tokens/{tokens}	Finds the related articles matching the specified articleKey.
GET v1/Section/Articles?section={section}	Finds the related articles matching the specified articleKey.
GET v1/Section/Articles/Count?section={section}	Finds the related articles matching the specified articleKey.
GET v1/Sections	Finds the related articles matching the specified articleKey.
POST v1/Article/{articleKey}/Featured	Finds the article matching the specified articleKey and updates the "featured" attributes.
POST v1/Article/Share	Finds the article matching the specified articleKey.
GET v1/Article/BySlug/{slug}	Finds the article matching the specified slug.
GET v1/Article/BySlug/{year}/{month}/{slug}	Finds the article matching the specified slug.
GET v1/Article/BySlug/{year}/{month}/{day}/{slug}	Finds the article matching the specified slug.
GET v1/Article/ByToken/{token}	Finds the article matching the specified articleKey.
GET v1/Article/Shared/All	Finds the article matching the specified articleKey.
GET v1/Article/{articleKey}/Share	Finds the shared article matching the specified articleKey.
POST v1/Article/Share/Delete	Finds the article matching the specified articleKey.
GET v1/Articles/{keys}	Finds the articles given a comma delimited list of article keys
GET v1/Article/Notes?offset={offset}&limit={limit}	Finds the articles given a comma delimited list of article keys
GET v1/Article/{articleKey}/Text	Finds the related articles matching the specified articleKey.
GET v1/Article/{articleKey}/Product	Finds the related product to this Article

FreeMeter

API	Description
POST v1/FreeMeter/Add	Add a free meter entry
POST v1/FreeMeter/Article/Count	Get article count

Issue

An Issue corresponds to a single, physical magazine. An issue has multiple articles. An issue has multiple pages. An article will be printed on a subset of the issue's pages.

API	Description
GET v1/Issues	This will return all issues for the magazine.
GET v1/Issues/{year}	This will return all issues for the magazine matching the specified year.
GET v1/Timeline	This will return all issues as the archive timeline
GET v1/Archive/Attributes	This will return all issues for the magazine.
GET v1/Issues/Featured	This will return all featured issues for the magazine.
GET v1/Issues/Featured/Articles	This will return all featured issues for the magazine.
GET v1/Issue/{issueKey}	This will return a single issue matching the IssueKey provided.
GET v2/Issue/{issueKey}	This will return a single issue matching the IssueKey provided.
GET v3/Issue/{issueKey}	This will return a single issue matching the IssueKey provided.
GET v1/Issue/{issueKey}/Lite	This will return a single issue matching the IssueKey provided.
GET v1/Issue/Identifier/{issueIdentifier}	This will return a single issue matching the IssueKey provided.
GET v1/IssueKey/Identifier/{issueIdentifier}	This will return a single issue matching the IssueKey provided.
GET v1/Issue/{issueKey}/Articles	This will return all articles in a single issue
GET v1/Issue/{issueKey}/ArticlesOnly	This will return all articles in a single issue
GET v1/Issue/{issueKey}/ArticlesOnly/{type}?value={value}	This will return all articles in a single issue
GET v1/Issue/{issueKey}/ArticlesLegacy	This will return all articles in a single issue
GET v1/Issue/{issueKey}/Spread/{spread}/Pages	This will return a single issue matching the IssueKey provided.
GET v1/Issue/{issueKey}/Spread/{spread}/Sizes	This will return a single issue matching the IssueKey provided.
GET v1/Issue/{issueKey}/Page/{page}/Sizes	This will return a single issue page available sizes.
GET v1/Issue/{issueKey}/Cover	This will return a single issue cover page the IssueKey provided.
GET v1/Issue/{issueKey}/Page/{pageName}/Assets	No documentation available.
GET v1/Issue/{issueKey}/Page/{pageName}/{spread}/Assets	No documentation available.
GET v1/Issue/{issueKey}/Text	No documentation available.