...
You can create requests by doing a POST to circulation/requests in mod-circulation: https://s3.amazonaws.com/foliodocs/api/mod-circulation/circulation.html
FOLIO has three request types.
- Hold. The item has been requested and is not currently available.
- Page. The item has been requested and has a status of Available.
- Recall. The item has been recalled (shortening the loan period of the patron who currently has the item.)
If your ILS only has Holds and Recalls (such as Aleph or Voyager), you need to figure out how to logically split your holds into holds and pages for migration. FOLIO only allows you to create a hold if the item that is currently in circulation. E.g., if it's a hold on an item that's out, you can migrate it as a hold, but if it's a hold on an item that is returned and awaiting pickup to the user who placed the hold, it has to be migrated as a page.Request types are part of the request POST and depend on the item status and the allowed request types in the applicable request policy. That means that if you are using business logic to migrate, you need to determine the associated request type in order to form the API request.
If the request policy doesn't allow any requests to be placed, the request will be denied.
The chart below outlines how the mapping works.
| Expand |
|---|
| title | Item Status and Request Policy Mapping to Request Type |
|---|
|
| FOLIO item status | Request Policy | Item Status and Request Policy | Notes |
| Recall Allowed? | Holds Allowed? | Page Allowed? |
|
| | Aged to lost | Either | Either | Either | Deny request | Item status type does not allow requesting | | Available | Either | Either | No | Deny request | Available items can only be paged. | | Available | Either | Either | Yes | Page |
| | Awaiting delivery | No | No | Yes | Deny request | You cannot page an "Awaiting delivery" item | | Awaiting delivery | No | Yes | Either | Hold |
| | Awaiting delivery | Yes | Either | Either | Recall |
| | Awaiting Pickup | No | No | Yes | Deny request | You cannot page an awaiting pickup item | | Awaiting Pickup | No | Yes | Either | Hold |
| | Awaiting Pickup | Yes | Either | Either | Recall |
| | Checked Out | No | No | Yes | Deny request | You cannot page a checked out item. | | Checked Out | No | Yes | Either | Hold |
| | Checked Out | Yes | Either | Either | Recall |
| | Claim returned | Either | Either | Either | Deny request | Item status type does not allow requesting | | Declared lost | Either | Either | Either | Deny request | Item status type does not allow requesting | | In process | No | No | Yes | Deny request | You cannot page an in process item. | | In process | No | Yes | Either | Hold |
| | In process | Yes | Either | Either | Recall |
| | In process (non-requestable) | Either | Either | Either | Deny request | Item status type does not allow requesting | | In transit | No | No | Yes | Deny request | You cannot page an in transit item. | | In transit | No | Yes | Either | Hold |
| | In transit | Yes | Either | Either | Recall |
| | Intellectual item | Either | Either | Either | Deny request | Item status type does not allow requesting | | Long missing | Either | Either | Either | Deny request | Item status type does not allow requesting | | Lost and paid | Either | Either | Either | Deny request | Item status type does not allow requesting | | Missing | Either | No | Either | Deny request | You cannot place a page or recall on a missing item. | | Missing | Either | Yes | Either | Hold | You are allowed to place a hold on a missing item. | | On order | No | No | Yes | Deny request | You cannot page an on order item | | On order | No | Yes | Either | Hold |
| | On order | Yes | Either | Either | Recall |
| | Order closed | Either | Either | Either | Deny request | Item status type does not allow requesting | | Paged | No | No | Yes | Deny request | You cannot page a paged item. | | Paged | Either | Yes | Either | Hold |
| | Paged | Yes | Either | Either | Recall |
| | Recently returned | Either | Either | No | Deny request | Recently returned items can only be paged. | | Recently returned | Either | Either | Yes | Page |
| | Restricted | No | No | Yes | Deny request | You cannot page a restricted item. | | Restricted | No | Yes | Either | Hold |
| | Restricted | Yes | Either | Either | Recall |
| | Unavailable | Either | Either | Either | Deny request | Item status type does not allow requesting | | Unknown | Either | Either | Either | Deny request | Item status type does not allow requesting | | Withdrawn | Either | Either | Either | Deny request | Item status type does not allow requesting |
|
Migrating directly to storage
...