Request Information

URI Parameters

NameDescriptionTypeAdditional information
lockId

The lock identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The lock, if it exists.

Nano.Lock
NameDescriptionTypeAdditional information
agencyLoanNumber

Gets or sets the agency loan number.

string

None.

bulkCommitmentNumber

Gets or sets the bulk commitment number.

string

None.

investorDeliveryDeadline

Gets or sets the investor delivery deadline.

string

None.

investorId

Gets or sets the investor identifier.

integer

None.

investorLoanNumber

Gets or sets the investor loan number.

string

None.

investorLockExpirationDate

Gets or sets the investor lock expiration date.

string

None.

investorName

Gets or sets the investor name.

string

None.

isLocked

Gets or sets a value indicating whether it is locked.

boolean

None.

lockActionDate

Gets or sets the lock date.

date

None.

lockExpirationDate

Gets or sets the lock expiration date.

string

None.

lockPeriod

Gets or sets the lock period.

integer

None.

rate

Gets or sets the rate.

decimal number

None.

rateSheetDate

Gets or sets the rate sheet date.

date

None.

app

Gets or sets the application identifier.

integer

None.

id

Gets or sets the lock identifier.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "agencyLoanNumber": "sample String 1",
  "bulkCommitmentNumber": "sample String 2",
  "investorDeliveryDeadline": "sample String 3",
  "investorId": 1,
  "investorLoanNumber": "sample String 4",
  "investorLockExpirationDate": "sample String 5",
  "investorName": "sample String 6",
  "isLocked": true,
  "lockActionDate": "2025-04-25T18:34:09.272239Z",
  "lockExpirationDate": "sample String 8",
  "lockPeriod": 1,
  "rate": 1.0,
  "rateSheetDate": "2025-04-25T18:34:09.272239Z",
  "app": "9",
  "id": "10"
}

text/html

Sample:
{"agencyLoanNumber":"sample String 1","bulkCommitmentNumber":"sample String 2","investorDeliveryDeadline":"sample String 3","investorId":1,"investorLoanNumber":"sample String 4","investorLockExpirationDate":"sample String 5","investorName":"sample String 6","isLocked":true,"lockActionDate":"2025-04-25T18:34:09.272239Z","lockExpirationDate":"sample String 8","lockPeriod":1,"rate":1.0,"rateSheetDate":"2025-04-25T18:34:09.272239Z","app":"9","id":"10"}

application/xml, text/xml

Sample:
<Lock xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AgencyLoanNumber>sample String 1</AgencyLoanNumber>
  <BulkCommitmentNumber>sample String 2</BulkCommitmentNumber>
  <InvestorDeliveryDeadline>sample String 3</InvestorDeliveryDeadline>
  <InvestorId>1</InvestorId>
  <InvestorLoanNumber>sample String 4</InvestorLoanNumber>
  <InvestorLockExpirationDate>sample String 5</InvestorLockExpirationDate>
  <InvestorName>sample String 6</InvestorName>
  <IsLocked>true</IsLocked>
  <LockActionDate>2025-04-25T18:34:09.272239Z</LockActionDate>
  <LockExpirationDate>sample String 8</LockExpirationDate>
  <LockPeriod>1</LockPeriod>
  <Rate>1</Rate>
  <RateSheetDate>2025-04-25T18:34:09.272239Z</RateSheetDate>
  <AppId>9</AppId>
  <LockId>10</LockId>
</Lock>

application/vnd.api+json

Sample:

Sample not available.