Skip to content

Search Objects

Jana Rajakumar edited this page Feb 21, 2018 · 3 revisions

Reference: https://iiif.library.utoronto.ca/presentation/v2/#!/Search/SearchCollectionGet

All IIIF objects can be searched via a GET request with query parameters.

The search will perform a Case insensitive contains in query.

Valid query parameters

  • The query parameter must be in the form of : param=value&antherparam=anothervalue
  • Valid values for param are the fields that are of type string in the object.
  • (eg): label, description, viewingHint and etc

Searching for Objects

  • Search Collections: /search/collection/?{query}
  • Search Manifests: /search/manifest/?{query}
  • Search Sequences: /search/sequence/?{query}
  • Search Ranges: /search/range/?{query}
  • Search Canvases: /search/canvas/?{query}
  • Search Annotations: /search/annotation/?{query}
  • Search AnnotationLists: /search/list/?{query}
  • Search Layers: /search/layer/?{query}
  • Search Activities: /search/activity/?{query}

Search Results

  • A search result will give a list of matching objects.
  • (eg): A search on canvases would give
[
  {
    "@id": "http://localhost:8000/b28928118/canvas/c0",
    "@type": "sc:Canvas",
    "label": " - "
  },
  {
    "@id": "http://localhost:8000/b28928118/canvas/c69",
    "@type": "sc:Canvas",
    "label": "68"
  },
  {
    "@id": "http://localhost:8000/b28928118/canvas/c70",
    "@type": "sc:Canvas",
    "label": "69"
  },
  {
    "@id": "http://localhost:8000/localhost:8000/canvas/cover",
    "@type": "sc:Canvas",
    "label": "Front Cover"
  },
  {
    "@id": "http://localhost:8000/localhost:8000/canvas/backCover",
    "@type": "sc:Canvas",
    "label": "Back Cover"
  }
]
Clone this wiki locally