Polaris.ApplicationServices Help
  • Introduction
  • The API
  • Security and Authentication
  • Headers
  • Common Response Structures
  • Collections
  • Authentication
  • Staff user
  • API Key
  • Authority Records
  • Get Auth Record
  • Get Auth Record MARC Display
  • Get Auth Record Linked Bibs
  • Get Auth Record Linked Bibs Count
  • Get Linked Auth Records
  • Get Linked Record Sets
  • Backorder Instructions
  • Backorder Instructions
  • Barcodes
  • Item Barcode
  • Patron Barcode
  • Bibliographic Bulk Change
  • Bibliographic Bulk Change Operations List
  • Biblioraphic Records
  • Get Bib Record
  • Get Bib Record Tags Subfields
  • Get Bib Record MARC Display
  • Get Bib Designations
  • Get Bib Headings
  • Get Bib Items
  • Get Bib Items Count
  • Get Bib Local Items
  • Get Bib New Item Info
  • Get Bib ORS Patrons
  • Get Bib Resource Entities
  • Get Bib Spoof Info
  • Get Bib Statistics Counts
  • Get Bib Availability
  • Get Bib TOMs
  • Get Bib Volumes
  • Get Linked Record Sets
  • Get Purchase Order Line Item's Bibliographic Data
  • Create Bib Record
  • Load Location Data
  • Patch Bib Record
  • Binding Formats
  • Acquisitions Binding Formats
  • Binding Substitution Instructions
  • Binding Substitution Instructions
  • Catalog Services Instructions
  • Catalog Services Instructions
  • Call Number Schemes
  • Call Number Schemes
  • Claim Alert List
  • Get Claim Alert List
  • Claim Multiple Serial Issues/Parts
  • Circulation
  • Checkin
  • Checkout
  • Check Special Loan Date
  • Collection Agency
  • Collection Agency Summary
  • Collection Item Fee Transaction History
  • Collections
  • Collections
  • Completeness Codes
  • Completeness Codes
  • Copy Retention Designators
  • Copy Retention Designators
  • Copy SHR Statuses
  • Copy SHR Statuses
  • Countries
  • Countries
  • Credit Card Transaction
  • Overview
  • Start Credit Card Payment
  • Update Succeeded Credit Card Payment
  • Update Failed Credit Card Payment
  • Start Credit Card Refund
  • Update Succeeded Credit Card Refund
  • Culture Info
  • Culture Info
  • Currencies
  • Currencies
  • Dates Closed
  • Dates Closed
  • Delayed Billing Instructions
  • Delayed Billing Instructions
  • Delivery Options
  • Delivery Options
  • Display Strings
  • Display Strings
  • Display Strings Custom
  • Due Date Modification Reasons
  • Due Date Modification Reasons
  • E-Receipt Delivery Options
  • Get all by Org Id
  • ERMS Session
  • Session
  • Fee Reason Codes
  • Fee Reason Codes
  • Files
  • Overview
  • Get File
  • Upload File
  • Fine Codes
  • Fine Codes
  • Fines and Fees
  • Get Fines Fees
  • Get Registration Fees
  • Get Patron Fees
  • Add Charge
  • Accrued Fines
  • Bill Charge
  • Pay Fee
  • Waive Fee
  • Distribute Waive
  • Patron Stops
  • Get Patron Stop
  • Get Patron Stops
  • Deposit Transactions
  • Transaction Summary
  • Transaction Record Detail
  • Transaction History Detail
  • Add Patron Fee Async
  • Fiscal Years
  • Create Fiscal Year
  • Get Fiscal Year
  • Get Fiscal Year Linked Funds
  • Update Fiscal Year
  • Delete Fiscal Year
  • Fund Categories
  • Fund Categories
  • Fund Types
  • Fund Types
  • Funds
  • Create Fund
  • Delete Fund
  • Get Fund
  • Get Fund Transaction History
  • Get Funds For Transfer
  • Get Org Funds
  • Get Subfunds
  • Transfer Money Between Funds
  • Update Fund
  • Update Fund Balance
  • Health
  • Get Health
  • Hold Queues
  • Get Hold Queue Info
  • Get Hold Queue Entries
  • Update Hold Queue
  • Hold Requests
  • Overview
  • Add Local Hold Request
  • Cancel Local Hold Request
  • Cancel Multiple Local Hold Requests
  • Convert Hold Request to ILL
  • Delete Local Hold Request
  • Deny Local Hold Request
  • Deny Multiple Local Hold Requests
  • Fill Local Hold Request Now
  • Get Local Hold Request
  • Get Hold Record History
  • Get Hold Reservation
  • Get Hold Pickup Area Descriptions
  • Get Hold Record Properties
  • Get Hold Record Satisfy info
  • Get Hold Request Summary List
  • Get Hold Request Cancelled Held List
  • Get Hold Request Held to transfer List
  • Get Hold Request Holds to Action List
  • Get Hold Request Unclaimed List
  • Get Bib Data for Hold
  • Get Patron blocks for Pre-Check
  • Get Picklist holds counts
  • Group/Ungroup Local Hold Requests
  • Hold Request Defaults
  • Locate Local Hold Request
  • Locate Multiple Local Hold Requests
  • Pre-Check Add Hold Request
  • Reactivate Local Hold Request
  • Return Local Hold Request
  • Return Multiple Local Hold Requests
  • RTF process of Hold Requests
  • Set Multiple Local Hold Requests to "Ask Me Later"
  • Set Pickup Branch
  • Set a Hold Request to "Ask Me Later"
  • Set Unclaim Date
  • Update Local Hold Request
  • Hold User Not Supplied Reasons
  • Hold User Not Supplied Reasons
  • Identifiers
  • Item ID
  • Patron ID
  • ILL Requests
  • Cancel ILL Request
  • Delete ILL Request
  • Export ILL Request
  • Get ILL Request
  • Receive ILL Request
  • Return ILL Request
  • Get Unclaimed Received List
  • ILL Statuses
  • ILL Statuses
  • ILS Transactions
  • Post Transactions
  • Import Jobs
  • Delete Import Job
  • Get Import Jobs with Paging
  • Post Express Import Job to Job Queue
  • Post MARC Import Job to Job Queue
  • Stop Import Job
  • Import Profiles
  • Get Import Embedded Item Information
  • Get Import Profile
  • Get Import Profiles
  • Import Profile Dedup Rules
  • Get Authority Dedup Rules
  • Get Bib Dedup Rules
  • Import Profile Retention Rules
  • Get Bib Retentinon Rules
  • INN-Reach
  • Get INN-Reach Request
  • Member Agencies
  • Visiting Patron Authorization
  • Invoice Delivery Methods
  • Get Invoice Delivery Methods
  • Invoice Line Items
  • Create Invoice Line Item
  • Copy PO Lines To Exisiting Invoice
  • Copy PO Line Segments To Exisiting Invoice
  • Copy PO Lines To A New Invoice
  • Get Invoice Line Item
  • Get Invoice Line Item Linked Funds
  • Receive Invoice Line Items
  • Update Invoice Line Items
  • Invoice Line Item Segments
  • Delete Invoice Line Item Segments
  • Get Invoice Line Item Segments
  • Invoices
  • Add Invoice Header Charge
  • Credit Invoice
  • Credit Invoice Lines
  • Delete Invoice
  • Delete Invoice Header Charges
  • Delete Invoice Line Item(s)
  • Invoices
  • Invoice Header Charges
  • Invoice Lines
  • Invoice Linked Bibliographic Records
  • Invoice Linked Item Records
  • Invoice Linked Funds
  • Invoice Linked Purchase Orders
  • Invoice Payment Details
  • Invoice Types
  • Update Invoice
  • Invoice Payment History
  • Update Payment Check Or Voucher
  • Invoice Payment Methods
  • Invoice Payment Exchange Rate details
  • Pay Invoice
  • Post Invoice
  • Undo Invoice Payment
  • Invoice Sequencing
  • Invoice Sequencing
  • Item Blocks
  • Item Blocks
  • Itemrecord Open Options
  • Itemrecord Open Options
  • Item Checkouts
  • Reset Due Date
  • Process check-out eReceipt
  • Item Records
  • Declare Item damaged
  • Declare Item lost
  • Get Item details to declare it lost or damaged
  • Get Item Record by ID
  • Get Item Records by IDs
  • Item Circulation Brief Information
  • Item History
  • Item Holds
  • Item State
  • Linked Record Sets
  • Manage Item Record - Update
  • Manage Item Record - Retrieve
  • Post Blocking Note
  • Post Item Record
  • Patch Item Record
  • Delete Blocking Note
  • Manage Damaged Items
  • Manage Missing parts
  • Replace Item Barcode
  • Get Item details for special check in
  • Item Statuses
  • Item Statuses
  • Job Queue
  • Bulk Change Job Queue
  • Post Bibliographic Bulk Change Job Queue
  • Purge Bibliographic Bulk Change Job Queue
  • Purge Patron Bulk Change Job Queue
  • Label Configurations
  • Get Label Configurations
  • Label Setup
  • Get Label Setup
  • Update Label Setup
  • Labels
  • Delete Labels
  • Get Labels
  • Put Labels
  • Languages
  • Languages
  • Licenses
  • Licenses
  • Line Item Statuses
  • Get Line Item Statuses
  • Loan Period Codes
  • Loan Period Codes
  • MARC
  • Get Bib Bulk Change Data Fields Repeatability
  • Get Fixed Tag Types
  • Get MARC Records
  • Update MARC Record
  • MARC TargetAudiences
  • MARC Target Audiences Options
  • MARC Languages
  • Marc Language Display Options
  • Marc Language Codes
  • MARC Tag Definitions
  • MARC Tag Definitions
  • MARC Tag Definitions Brief
  • Material Types
  • Material Types
  • Media
  • Cover Image Configuration
  • Patron
  • MFHD Categories
  • MFHD Categories
  • MFHD Issue Statuses
  • MFHD Issue Statuses
  • MFHD Frequencies
  • MFHD Frequencies
  • Name Titles
  • Name Titles
  • Notices
  • Post
  • Object Locking
  • Overview
  • Object Locks
  • Lock
  • Unlock
  • Offline Transactions
  • Create Transaction Set
  • Order Types
  • Order Types
  • Organizations
  • Organizations
  • Outreach patrons
  • Get Built title list
  • Get items for title
  • Get Outreach Patron
  • Get Outreach Patrons
  • Get Held Item record List
  • Get Pick List
  • Update Pick List
  • Get Patrons Combined Pick List
  • Get Patrons Held Items
  • Delete Pick List
  • Preferences - Author
  • Preferences - Subject
  • Preferences - General
  • Preferences - Genre
  • Preferences - Other
  • Selection List Display Data
  • Update Outreach Patron
  • Update Patron Last Service Date
  • Update Last Service Dates
  • Patrons
  • Patron Account
  • Association Defaults
  • Associations
  • Basic Data
  • Claims
  • Claims/Lost Counts
  • Date Info
  • Items Out
  • Linked Record Sets
  • Merge Patron Records
  • Minimum Patron Data
  • System Notes
  • Notification History Summary
  • Notification History Summary Details
  • Patron
  • Patron Address Label
  • Post Patron
  • Patch Patron
  • Patch Patron Hold Update
  • Patron Name Title
  • Patron Update
  • Patron eReceipt Options Update
  • Patron Fees Summary
  • Patron Quotas Summary
  • Patron Transactions Summary
  • Patron Flags
  • Patron Holds
  • Patron Information
  • Patron Item Checkouts
  • Photo
  • PreCheckout Brief
  • Reading History
  • Registration Defaults
  • Registration Required
  • Requests
  • Requests ILL
  • Requests Local
  • Request ILL Detail Info
  • Secure/Release Record
  • Set Password
  • Patron Registration
  • New Patron
  • Get Patron ID By UDF
  • Patron Blocks
  • Patron Blocks
  • Patron Blocks Extension
  • Patron Merge Blocks
  • Delete Patron Stop
  • Patron Bulk Changes
  • Create Patron Bulk Change
  • Patron Claims
  • Reset Claims
  • Patron Codes
  • Patron Codes
  • Patron Genders
  • Patron Genders
  • Patron Credit
  • Add Credit
  • Refund Credit
  • Add Credit From Payment
  • Refund From Payment
  • Patron Custom Data
  • Patron custom data
  • Patron Messages
  • Overview
  • System-defined Messages
  • Patron Messages
  • Patron Notes
  • Add/Modify/Delete Patron Notes
  • Get Patron Notes
  • Get Patron System Notes
  • Patron Payment Methods
  • Patron Payment Methods
  • Patron Stat Class Codes
  • Patron Stat Class Codes
  • Patron User-defined Fields
  • Patron User-defined Fields
  • Polaris Users
  • Polaris User
  • Polaris User by External ID
  • Polaris Users search
  • Patch Polaris User
  • Delete Polaris User
  • Polaris Permission Groups
  • Polaris Group
  • Polaris Groups Search
  • Delete Polaris User from Permission Group
  • Add Polaris User to Permission Group
  • Postal Codes
  • Postal Codes
  • Publication Patterns
  • Close Publication Pattern
  • Create Publication Pattern
  • Delete Publication Pattern
  • Get Publication Pattern
  • Get Publication Pattern Chronology
  • Get Publication Pattern Enumeration
  • Get Publication Pattern Regularity Patterns
  • Get Publication Pattern Templates
  • Get Received Issues/Parts
  • Re-open Publication Pattern
  • Update Publication Pattern
  • Validate Enumeration
  • Purchase Orders
  • Add Header Charges
  • Create EDI File
  • Create Purchase Order
  • Copy PO Line Items
  • Delete Header Charges
  • Delete PO Line Items
  • Delete Purchase Order
  • EDI File Upload Post-processing
  • Get Purchase Order
  • Purchase Order Header Charges
  • Purchase Order Line Items
  • Purchase Order Linked Bibliographic Records
  • Purchase Order Linked Funds
  • Purchase Order Linked Invoices
  • Purchase Order Linked Item Records
  • PO Line Items Undo Receipt
  • Receive PO Line Items
  • Send Purchase Order Overview
  • Update Purchase Order
  • Purchase Order Line Items
  • Copy PO Line Item Segments
  • Get Purchase Order Line Item
  • Get Purchase Order Line Item's ISBN/Price List
  • Purchase Order Line Item's Linked Funds
  • Purchase Order Line Item's Linked Invoices
  • Get Purchase Order Line Item's Other Standard Identifiers
  • Get Purchase Order Line Item Segments
  • Delete Purchase Order Line Item Segments
  • Modify Purchase Order Line Item Status
  • Undo Receipt Purchase Order Line Item Segments
  • Receive Purchase Order Line Item Segments
  • Split Receive Purchase Order Line Item Segment
  • Purchase Order Line Item Segments
  • Get Purchase Order Line Item Segments
  • Reader Services
  • Get Delivery Mode Options
  • Get Delivery Route Options
  • Get Delivery Schedule Options
  • Get Delivery Stop Options
  • Get Disability Options
  • Get Equipment Options
  • Get Pick List Header IDs
  • Get Publication Date Options
  • Get Selection List branch Options
  • Get Status Options
  • Receive Shelf Ready Shipment
  • Receive Shelf Ready Shipment
  • Receipts and Slips
  • Account Summary Receipts
  • Checkout Receipts
  • Checkin Receipts
  • Itemsout Receipts
  • Receipt Options
  • Transaction Summary Receipts
  • Record Sets
  • Add Record Set Contents
  • Bulk Add to Purchase Order
  • Bulk Change of Contents
  • Create Record Set and Contents
  • Create Record Set of Associated Records
  • Create Record Set with Unlinked Records
  • Delete Record Set
  • Export Record Set Contents
  • Get Patron Codes from Record Set
  • Get Record Set Contents
  • Get Record Sets
  • Item Record Set Reset Due Date
  • Undelete Record Sets
  • Record Statuses
  • Record Statuses
  • Regularity Pattern
  • Get regularity pattern display string
  • Get regularity pattern list for frequency
  • Remote Files
  • Upload files to FTP server
  • Reports
  • Overview
  • Request
  • Hold request Pick up branches
  • Processing branches
  • Route Statuses
  • Route Statuses
  • Request Manager
  • Request manager
  • SA_PhoneCarriers
  • SA_PhoneCarriers
  • Serial CheckIn
  • GET Holdings record
  • GET Breif bib record
  • GET Serial Issue records or Standing Order Parts
  • Get Publication Pattern Details
  • Update Holdings record notes
  • UncheckIn issue or part
  • Check Bib Display in PAC
  • Claim Issue
  • Serial Holdings Record
  • Create Holdings Record
  • Get Holdings Record
  • Update Holdings Record
  • Add Claim
  • Remove Claims
  • Serial Issue
  • Get Chronology Codes
  • Create Serial Issue
  • Get Serial Issue
  • Get Serial Issue Claim
  • Get Serial Issue Claim History
  • Update Serial Issue
  • Claim On Serial Issue
  • Undo Serial Issue claim
  • Serial Issue Chronology
  • Serial Issue Enumeration
  • Serial Issue Enumeration
  • Validate Serial Issue Enumeration
  • Shelf Locations
  • Shelf Locations
  • Shipping Methods
  • Shipping Methods
  • Statistical Codes
  • Statistical Codes
  • Startup Assets
  • Startup Assets
  • Supplier
  • Delete Supplier
  • Get Supplier
  • Post Supplier
  • Put Supplier
  • System Administration
  • Language Strings
  • PermissionIDs
  • SysAdminPermissions
  • Parameters and Profiles
  • SA Display Options
  • SA Value by Organization
  • SA Value by User
  • SA Value by Workstation
  • Set system admin attribute
  • Get Item Pickup Branches
  • Get Display of Issues on Check-in
  • Get SA Marc Validation Rules
  • Get System Generated PO number
  • SysHold Statuses
  • SysHold Statuses
  • Tax Rates
  • All tax rates
  • Tax rates by ID
  • Tax Calculations
  • Tax calculations result
  • Templates
  • Get Templates by ID
  • Get Templates by Object Type
  • Delete a Template by ID
  • Bib On Order Templates
  • Item Bulk Change Template
  • Item Templates
  • Weeding Templates
  • Title Ratings
  • Title Ratings
  • Vendor Account
  • Vendor Accounts
  • Waive Actions
  • Bulk Waive Criteria
  • Bulk Waive Jobs
  • Waiver Requests
  • Weeding
  • Weeding Templates
  • Weeding Criteria
  • Weeding Jobs
  • Workflow
  • Overview
  • Add or Update Authority Record
  • Add or Update Bib Record
  • Add or Update Item Record
  • Add or Update MARC Record
  • Cancel Purchase Order Line Items
  • Check In
  • Check Out
  • Convert Hold Request to ILL
  • Create Hold Request
  • Create Hold Request for multiple patrons
  • Combine Serial Issues
  • Delete Authority Record
  • Delete Bib Record
  • Delete ILL Request
  • Delete Item Record
  • Delete Patron
  • Delete Serial Holdings Record
  • Delete Serial Issue or Part
  • Fill Local Hold
  • Pay Invoice
  • Make Claim
  • Patron Registration
  • Reactivate Local Hold
  • Receive ILL Request
  • Release Purchase Order
  • Save Purchase Order Line Item
  • Serial Check In
  • Transfer Local Hold
  • Undelete Authority Record
  • Undelete Bib Record
  • Undelete Item Record
  • Update Bibliographic Record
  • Update Hold Request
  • Update ILL Request
  • Example: Renewal
  • Example: Resolve Lost Item
  • Workstations
  • Workstations
  • Workstation

© 2025 Clarivate

Hold Requests

Overview

Hold requests can be placed at local level or ILL requests for remote systems.

  • Add a LOCAL hold request for a patron
  • Get a LOCAL hold request for a patron
  • Cancel a LOCAL hold request for a patron
  • Deny a LOCAL item from satifying a LOACAL hold request for a patron
  • Set a LOCAL item as located for a hold request for a patron
  • Return a LOCAL item as pending to fill a hold request for a patron, if the request had been set to "located" in error
  • Get history of a specific holds request
  • Get specific hold request satisfy info
  • Get a list of hold requests for a pickup branch, item branch, or patron branch.

Patron Account Listings

The following are the hold request API calls used for the Patron Account listings and details:

  • Retrieve list of all hold requests for a patron
  • Retrieve list of LOCAL hold requests for a patron
  • Retrieve list of ILL requests for a patron
  • Detailed info for a LOCAL hold requests for a patron
  • Detailed info for an ILL requests for a patron