Object Locks

Overview

To help prevent multiple users from modifying a given Polaris object at the same time, there is a system of object locking in place as part of the Polaris API platform.

Some API calls will handle checking/setting of locks as part of normal processing. For example, if an API call is made to update a patron and that patron object is already locked by another user, the API will return the appropriate HTTP status (409) indicating the object is already locked.

There are also a set of API calls that a calling application can use to explicitly lock and unlock specific objects. There are four required parameters:

  • Polaris User ID - Automically included in the call as part of normal authorization
  • Polaris Workstation ID - Specified as part of base URL of the API call
  • Object Type ID - (see table below)
  • Object ID - The Object ID is the primary ID of the object being locked. For example, for an Object Type ID of 27 (Patron), the Object ID would be the PatronID field of the patron object being locked or unlocked.


Object Type IDs
IDDescription
1Authority Record
2Bibliographic Record
3Item Record
4Authority Template
5Bibliographic Template
6Item Template
7Record Set
8Polaris User
9Organization
10Library
11Branch
12Collection
13Contact Person
14Claim
15Invoice
16Invoice Line Item
17Fiscal Year
18Fund
19Purchase Order
20Purchase Order Line Item
21Selection List
22Selection List Line Item
24Serial Holdings Record
25Serial Issue
26Supplier Record
27Patron
28Hold Request
29Reserve Course
30ILL Request
31Check Out
32Patron Address
33Credit Card
34Payment History
35Transaction History
36Serial Check-In
37Claim Serial
38Receiving
39Workstation
40Server
41System
42Admin Explorer
43Standing Order Part
44Patron Status
45Claim Alert List
46Request To Fill
47Patron Claim
48Patron Fee
49Purchase Order Templates
50Serial Holdings Record (Standing Order)
51Serial Holdings Record (Subscription)
52Browse Headings
53Database
54Multiple Servers
55Purchase Order Line Item Segment
56Invoice Line Item Segment
57Selection List Line Item Segment
58Route List
59Lost Item
60Subscription
61Subscription List
62Groups
63Polaris Export
64Permission
65Publication Pattern
67Purge Criteria
68Reserve Item Template
69Reserve Item Record
70Reserve Course Template
71Import Profile
72Bibliographic Bulk Change Job
73Authority Bulk Change Job
74Authority Create Links Job
75Authority Update Links Job
76Quick-circ Item
77ILS Store Order
78Media Resource Record
79Item Record History
80Import Job
81Community Record
82Browse Headings (CI)
83Promotions
84Event Record
85EDI ASN
86Resource Group
87Vendor
88Vendor Account
89Resource Entity
90Event Import Profile