Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

as of 202001, latest commit to this repository was made in 201801. The schema is out of date with the user schema, so the local tenant may wish to use the user schema and endpoints instead.

Data record

Application

Prerequisite reference data or other data records

API endpoint for post

Schema or other documentation

Notes

instancesinventory
  • Reference data
    • MARC bib-to-Instance map (optional; if desired to change default marc-to-instance mapping for all MARC records)
    • FOLIO baseurl/settings/inventory instances section (optional)
    • FOLIO baseurl/settings/inventory/ Instance, holdings, items section statistical code types, statistical codes (optional)

https://github.com/folio-org/mod-source-record-manager/blob/master/mod-source-record-manager-server/src/main/resources/rules/rules.jsonInstitutions may wish to identify records with statistical codes for a variety of reasons. Example: grouping records supplied by a given ebook vendor.
holdingsinventory
  • Reference data:
    • full location hierarchy (institutions/campuses/libraries/locations) (required)
    • service points (required)
    • FOLIO baseurl/settings/inventory Holdings section (optional)
    • FOLIO baseurl/settings/inventory/ Instance, holdings, items section statistical code types, statistical codes (optional)
  • Data records
    • instances (required)

Institutions may wish to identify records with statistical codes for a variety of reasons. Example: grouping records supplied by a given ebook vendor.
itemsinventory
  • Reference data
    • full location hierarchy (institutions/campuses/libraries/locations) (required)
    • service points (required),
    • loan-types (required),
    • material-types (required),
    • FOLIO baseurl/settings/inventory Items section
    • FOLIO baseurl/settings/inventory/ Instance, holdings, items section statistical code types, statistical codes (optional)
  • Data records: instances, holdings (both required)
item-storage/itemshttps://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/item-storage.html#item_storage_items_postInstitutions may wish to identify records with statistical codes for a variety of reasons. Example: recording multiple item statuses from a previous system
contacts (organizations)organizations
  • Reference data: categories (optional)
organizations-storage/contactshttps://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/contact.html#organizations_storage_contacts_post
  • urls in the contact record must begin with 'http://' or 'https://', otherwise the record will be rejected as invalid.
organizationsorganizations
  • reference Reference data:
    • categories (optional),
     contacts
    • contacts (optional)
organizations-storage/categorieshttps://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/category.html#organizations_storage_categories_post
  • urls in the organizations record must begin with 'http://' or 'https://', otherwise the record will be rejected as invalid.
usersusers
  • reference Reference data:
    • groups (required)
    ,
    • addresstypes (required)
user-importhttps://github.com/folio-org/mod-user-import/blob/master/ramls/schemas/userdataimport.json


proxiesusers
  • other data Data records: users (required)
proxiesforhttps://s3.amazonaws.com/foliodocs/api/mod-users/p/proxiesFor.html#proxiesfor_post
purchase ordersorders
  • reference Reference data:
    • full location hierarchy (institutions/campuses/libraries/locations)
    and
    • service points (required), addresses
  • other data Data records:
    • instances (optional)
    ,
    • organizations (vendors)
     
    • (required)
    • finance structure (Ledgers, FY, Funds, Budgets required, Fund groups and expense classes optional)
    • acquisitions units required if orders/financials must be separated/permissioned differently for different users within the same tenant
orders/composite-ordershttps://s3.amazonaws.com/foliodocs/api/mod-orders/p/order.html#orders_composite_orders_post

...