community.lexicon.media.book.searchEditions

Search a provider's catalog using text and structured hints. Fuzzy matching, field interpretation, and ranking are provider-specific. This operation does not write user records.

Details · procedure
Kindprocedure
Authoritybook.media.lexicon.community
Commit rev3n2h5sw223y2o
Indexed

Procedure

procedure · POST

Input

application/json

author

string

Author relevance hint, interpreted by the provider.

  • minLength: 1

Structured identifier relevance hints; search matching and ranking are provider-defined.

  • minLength: 1

limit

integer

Maximum number of editions to return in this page.

  • minimum: 1
  • maximum: 100
  • default: 25

offset

integer

Number of matching editions to skip in the provider's ordered result set.

  • minimum: 0
  • default: 0

q

string

Broad search text, which may describe a title, contributor, description, or identifier. Matching and ranking are provider-defined.

  • minLength: 1

title

string

Title relevance hint, interpreted by the provider.

  • minLength: 1

Output

application/json

Errors

InvalidQuery

No nonblank q, title, author, or nonempty identifiers array was supplied.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • Resolve one book by exact equality of at least one identifier issuer/value pair. Shared grouping identifiers may match several editions. Results are in provider-defined relevance order. This operation does not write user records.

  • Search dropped books by free text against title, authors, and publicationId. Results are de-duplicated per (publicationId, currentLocation) — multiple copies of the same publication at the same location collapse to the most recently-active copy. Ordered by last_event_at desc.

  • Find books matching the search criteria. Does not require authentication.