V3 Lock Resource

post

https://api.elliemae.com/encompass/v3/resourceLocks

Locks the specified resource in Encompass.

Query Params

view

string

Possible values are:
entity - Returns all properties for an entity.
id - Returns the ID assigned to the entity.

Body Params

string

The lockId, which is the unique identifier assigned to the lock and returned in the response when the lock is created.

resource

object

required

References the entity ID and entity type. Both must include the loan ID and borrower application ID associated with the loan. Both are returned by getLoan.

userId

string

The Encompass user ID of the user holding the lock.

fullName

string

RetrieveOnly. The full name of the user holding the lock.

userType

string

RetrieveOnly. The user type of the user holding the lock. Valid values: Internal, External, Virtual

lockType

string

required

Whether the type of lock is exclusive or shared. This is case-insensitive.

lockTime

date-time

RetrieveOnly. The date and time the resource was locked.

restricted

boolean

Defaults to false

RetrieveOnly. Indicates that the resource lock is restricted for certain operations because the loan is also open in Encompass desktop. Restricted loan operations are prohibited by the API user, while the loan remains open in Encompass desktop. The restricted operations include the following: Create or Delete Borrower Pair, and Swap/Move Borrowers

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

201Created