...
Data element | Description | Settings url in the UI (relative to base url for instance) | API endpoint for post | Schema | Prerequisites |
|---|---|---|---|---|---|
| addresses | used in purchase orders for Bill to and Ship to addresses. | settings/tenant-settings/addresses | configurations/entries | https://s3.amazonaws.com/foliodocs/api/mod-configuration/p/config.html#configurations_entries_post | |
| addresstypes | used in user records to identify type of user address | settings/users/addresstypes | addresstypes | https://s3.amazonaws.com/foliodocs/api/mod-users/p/addressTypes.html#addresstypes_post | |
| call-number-types | used in inventory holdings records to identify type of call number. As of 2019 Q4, the default reference data does not include a call-number-type for 'blank' as defined by MARC 852 indicator 1. Local tenants may need to add the 'blank' value for migration purposes. | settings/inventory/callNumberTypes | call-number-types | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/call-number-type.html#call_number_types_post | |
| categories (organizations) | used in organization records to identify classes of data, such as addresses, emails, urls, etc. | settings/organizations/category | organizations-storage/categories | https://s3.amazonaws.com/foliodocs/api/mod-organizations-storage/p/category.html#organizations_storage_categories_post | |
| campuses | used in inventory holdings & item records to identify 2nd level in location hierarchy. | settings/tenant-settings/location-campuses | location-units/campuses | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/locationunit.html#location_units_campuses_post | institutions |
| groups | used in user records to identify patron groups. As of 2019 Q4, the system loads reference data for groups, so local tenants will probably want to delete those groups before creating their own. | settings/users/groups | groups | https://s3.amazonaws.com/foliodocs/api/mod-users/p/groups.html#groups_post | |
| holdings-types | used in inventory holdings records to identify type of holdings record. If the local tenant wishes to base their holdings-types codes on USMARC holdings records leader/06, then they will have to create an additional holding type for 'unknown'. | settings/inventory/holdingsTypes | holdings-types | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/holdings-type.html#holdings_types_post | |
| holdings-note-types | used in inventory holdings records to identify types of note included in the record. Can be used, for instance, to define a type of note that contains "Latest volume or edition in alternate location". | settings/inventory/holdingsNoteTypes | holdings-note-types | ||
| identifier-types | used in inventory instance records to define type of identifier. Local tenant may wish to define specific identifier type for USMARC field 001 to uniquely identify previous system record key. As of Q4, USMARC field 001 is loaded as 'System control number' in FOLIO, along with other 035 fields. | settings/inventory/identifierTypes | identifier-types | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/identifier-type.html#identifier_types_post | |
| instance-formats | used in inventory instance records to identify record format. Identified in the inventory instance record UI and Settings/Inventory UI as "resource type". If instance record is created via Data Import of a MARC record, instance-type is assigned by mapping the MARC field 338 subfield $b. Default list provided in FOLIO based on RDA carrier type codes and names. If the MARC record lacks field 336 subfield $b, the instance record is assigned a default instance-type of 'unspecified'. !!! before wolfcon, test to see if leader-specific values can be added to default map !!! | settings/inventory/formats | instance-formats | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/instance-format.html | |
| instance-types | used in inventory instance records to identify record type. Identified in the inventory instance record UI and Settings/Inventory UI as "resource type". If instance record is created via Data Import of a MARC record, instance-type is assigned by mapping the MARC field 336 subfield $b. Default list provided in FOLIO based on RDA content type codes and names. If the MARC record lacks field 336 subfield $b, the instance record is assigned a default instance-type of 'unspecified'. !!! before wolfcon, test to see if leader-specific values can be added to default map !!! | settings/inventory/resourcetypes | instance-types | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/instance-type.html#instance_types_post | |
| institutions | used in inventory holdings & item records to identify top level in location hierarchy. | settings/tenant-settings/location-institutions | location-units/institutions | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/locationunit.html#location_units_institutions_post | |
| libraries | used in inventory holdings & item records to identify 3rd level in location hierarchy. | settings/tenant-settings/location-libraries | location-units/libraries | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/locationunit.html#location_units_libraries_post | institutions campuses |
| loan-policies | used in circulation module to define basic loan/renewal/recall configuration. If the local tenant wishes to migrate retrospective loans to FOLIO and link them to existing policies and rules, loan-policies must be created before migration. | settings/circulation/loan-policies | loan-policy-storage/loan-policies | https://s3.amazonaws.com/foliodocs/api/mod-circulation-storage/p/loan-policy-storage.html#loan_policy_storage_loan_policies_post | |
| loan-types | used in inventory item records and circulation rules to determine appropriate loan policy. Local tenant may wish to delete default loan types provided with FOLIO. | settings/inventory/loantypes | loan-types | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/loan-type.html#loan_types_post | |
| locations | used to identify shelf locations in inventory holdings & item records. | settings/tenant-settings/location-locations | locations | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/location.html#locations_post | institutions campuses libraries service points |
| service-points | used primarily in circulation apps to identify points where circulation actions take place. Local tenant may wish to delete default service points provided with FOLIO. As of Q4 2019, the local tenant will apparently have to do the delete using a curl command or other script that deletes from the API endpoint, as there doesn't appear to be a delete function for these in the Settings/Tenant/Service Points UI. Also, although the options to print slips at a specific Service Point appear to be selected by default, they do not become active unless Pickup location is set to 'Yes'. | settings/tenant-settings/servicePoints | service-points | https://s3.amazonaws.com/foliodocs/api/mod-inventory-storage/p/service-point.html#service_points_post |
...