Search the library anywhere by different methods

GET /library/search/{page}/{library_id}/{catalogue_id}/{collection_id}

Get a list of items that match the search terms by the method.

The

Add the following on the end of the URL to identify the search ?search_by={searchmethod}&searchtype={searchtype}&search={query}&sort={sort}

searchmethod: one of code,title,author,id

searchtype: one of article : Notes from a meeting for example document : A file uploaded which is not a music file but supported format .png, .jpg, .gif, .jpeg, .doc, .docx, .xls, .xlsx, .pdf, .ppt, .pptx, .gpx, .txt, .ai, .rtf, .dot lyrics : A formated lyrics which can be transposed music : A file uploaded which one of .mp3, .mp4, .aac, .mp4a, .m4a physical : A physical item that can be reserved and returned url : A link to a web page of some sort

query: the term being searched

sort: Use the combination of 4 terms to identify the sort order with a - in between. Use the following terms: library, catalogue, collection, title

example: library-catalogue-collection-title

Path parameters

page integer(int64) Required

Page number
library_id integer(int64) Required

(Optional) ID of the Library
catalogue_id integer(int64) Required

(Optional, but requires library if supplied) ID of the catalogue
collection_id integer(int64) Required

(Optional, but requires collection if supplied) ID of the collection

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- items array[object]
  
  Hide items attributes Show items attributes object
  
  name string
  
  item_id integer
  
  collection_id integer
  
  item_code string
  
  author string
  
  format_type string
  
  image_file_id string
  
  sub_format_type string
  
  number_available integer
  
  number_not_available integer
  
  description string
  
  date_ymd string
  
  date_display string
  
  library_name string
  
  catalogue_name string
  
  collection_name string
- paging object
  
  Additional properties are allowed.
  
  Hide paging attributes Show paging attributes object
  
  total integer
  
  pages integer
  
  thispage integer
  
  firstpage integer
  
  initialpage string
  
  finalpage string
  
  lastpage integer
  
  shown_on_this_page integer

GET /library/search/{page}/{library_id}/{catalogue_id}/{collection_id}

curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/library/search/{page}/{library_id}/{catalogue_id}/{collection_id} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "items": [
    {
      "name": "Hitchhiker's Guide to the Galaxy",
      "item_id": 10,
      "collection_id": 1,
      "item_code": 100022,
      "author": "asdf",
      "format_type": "physical",
      "image_file_id": "string",
      "sub_format_type": "string",
      "number_available": 10,
      "number_not_available": 2,
      "description": "asdfjhaskdfj",
      "date_ymd": "string",
      "date_display": "string",
      "library_name": "Book Library",
      "catalogue_name": "Fiction",
      "collection_name": "Comedies"
    }
  ],
  "paging": {
    "total": 1,
    "pages": 1,
    "thispage": 1,
    "firstpage": 1,
    "initialpage": "string",
    "finalpage": "string",
    "lastpage": 1,
    "shown_on_this_page": 1
  }
}