Versions Compared

Key

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

...

Data record

Application

Prerequisite reference data or other data records

API endpoint for post

Schema

Notes

instancesinventory
  • reference data: instance-types (required if loading through Data Import), formats (optional)
  • MARC bib-to-Instance map (required if storing MARC records in SRS)
instance-storage/instanceshttps://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/instance-storage.html#instance_storage_instances_post
holdingsinventory
  • reference data: full location hierarchy (institutions/campuses/libraries/locations) and service points (required), call-number-types (required), holdings-types (required), holdings-type-notes (optional).
  • instances (required)
holdings-storage/holdingshttps://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/holdings-storage.html#holdings_storage_holdings_post
itemsinventory
  • reference data: full location hierarchy (institutions/campuses/libraries/locations) and service points (required), loan-types (required), material-types (required), statistical-code-types (optional), statistical-codes (optional)
  • other data records: instances, holdings (both required)
item-storage/itemshttps://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/item-storage.html#item_storage_items_post
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 data: categories (optional), 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 data: groups (required), addresstypes (required)
user-importhttps://github.com/folio-org/mod-user-import/blob/master/ramls/schemas/userdataimport.json
  • 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.
proxiesusers
  • other data records: users (required)
proxiesforhttps://s3.amazonaws.com/foliodocs/api/mod-users/p/proxiesFor.html#proxiesfor_post
purchase ordersorders
  • reference data: full location hierarchy (institutions/campuses/libraries/locations) and service points (required), addresses
  • other data records: instances (optional), organizations (vendors) (required)
  • finance structure (Ledgers, FY, Funds, Budgets required, Fund groups 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

...