Basic Calls

Number of APIs: 11

These scripts require no outside data/software and can be run from the Qodex web client.

FOLIO API endpoint documentation: https://dev.folio.org/reference/api/

  1. Tenant Information - Find Service Point by Name GET {{baseUrl}}/service-points?query=(name == "REPLACE WITH SERVICE POINT NAME*")

  2. Tenant Information - List All Material Types GET {{baseUrl}}/material-types

  3. Tenant Information - Find Location by FOLIO Name GET {{baseUrl}}/locations?query=(name == REPLACE WITH LOCATION NAME*)

  4. Circulation - In-House Use by Date Range GET {{baseUrl}}/check-in-storage/check-ins?limit=0&query=(itemStatusPriorToCheckIn=="Available" and occurredDateTime >= "REPLACE WITH BEGINNING RANGE IN YYYY-MM-DD FORMAT*" and occurredDateTime <= "REPLACE WITH ENDING RANGE IN YYYY-MM-DD FORMAT**")

  5. Circulation - Loans by Service Point and Date Range GET {{baseUrl}}/circulation/loans?limit=0&query=(checkoutServicePointId == "REPLACE WITH SERVICE POINT ID" and (loanDate >= REPLACE WITH BEGINNING RANGE IN YYYY-MM-DD FORMAT* and loanDate <= REPLACE WITH ENDING RANGE IN YYYY-MM-DD FORMAT*))

  6. Circulation - Find User by Date Updated GET {{baseUrl}}/users?query= metadata.updatedDate >= "YYYY-MM-DD"

  7. Inventory - Count Instances GET {{baseUrl}}/instance-storage/instances?limit=0

  8. Inventory - Find items by Location and Call number Prefix from STORAGE GET {{baseUrl}}/item-storage/items?limit=300&query=(effectiveCallNumberComponents.prefix=="REPLACE WITH CALL NUMBER START RANGE*" and effectiveLocationId =REPLACE WITH LOCATION ID) sortBy effectiveShelvingOrder

  9. Inventory - Find Location by Discovery Display Name GET {{baseUrl}}/locations?query=(discoveryDisplayName == "REPLACE WITH DISCOVERY DISPLAY NAME")

  10. Inventory - Count Items by Location GET {{baseUrl}}/inventory/items?limit=0&query=(effectiveLocationId == "REPLACE WITH LOCATION ID" NOT discoverySuppress==true)