Loan Locks

Question: When do I need to request a Resource Lock?

Answer:

Resource lock requests are only required when you need to hold a lock through multiple API calls; otherwise, a session-less lock is automatically applied, locking the loan only for the duration of the single API call.

The V3 Resource Lock API supports two types of locks: "Exclusive" and "NGSharedLock".

• An "Exclusive" lock restricts write access to the user with exclusive lock, preventing others from modifying the loan until the lock is released. For example: If the API caller has placed the loan in "Exclusive" lock, a user in the app, or any other API caller is blocked from updating the same loan file.
• The "NGSharedLock" lock is typically used by Encompass apps (or custom applications) to allow API updates while the user has the loan open in the app. For example: Encompass Web app has placed the loan in "shared" lock mode, in which case API updates to the same loan file are allowed while the user is also updating the same loan in the app. The changes are merged upon save, the last update wins.

Use the Subscribing to Loan Lock and Unlock Events to manage when the loan is unlocked or locked.