Request Information
URI Parameters
None.
Body Parameters
The investor lock request.
InvestorLockRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| agencyLoanNumber | string |
None. |
|
| appId | integer |
None. |
|
| buyPriceAdjustment | decimal number |
None. |
|
| commitmentNumber | string |
None. |
|
| finalPrice | decimal number |
None. |
|
| initialPrice | decimal number |
None. |
|
| investorDeliveryDeadline | date |
None. |
|
| investorId | integer |
None. |
|
| investorLoanNumber | string |
None. |
|
| investorLockType | string |
None. |
|
| investorLockExpirationDate | date |
None. |
|
| lockActionCode | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"agencyLoanNumber": "sample String 1",
"appId": 2,
"buyPriceAdjustment": 3.0,
"commitmentNumber": "sample String 4",
"finalPrice": 1.0,
"initialPrice": 1.0,
"investorDeliveryDeadline": "2025-11-09T05:57:31.1826838Z",
"investorId": 5,
"investorLoanNumber": "sample String 6",
"investorLockType": "sample String 7",
"investorLockExpirationDate": "2025-11-09T05:57:31.1826838Z",
"lockActionCode": "sample String 9"
}
text/html
Sample:
{"agencyLoanNumber":"sample String 1","appId":2,"buyPriceAdjustment":3.0,"commitmentNumber":"sample String 4","finalPrice":1.0,"initialPrice":1.0,"investorDeliveryDeadline":"2025-11-09T05:57:31.1826838Z","investorId":5,"investorLoanNumber":"sample String 6","investorLockType":"sample String 7","investorLockExpirationDate":"2025-11-09T05:57:31.1826838Z","lockActionCode":"sample String 9"}
application/xml, text/xml
Sample:
<InvestorLockRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <AgencyLoanNumber>sample String 1</AgencyLoanNumber> <AppId>2</AppId> <BuyPriceAdjustment>3</BuyPriceAdjustment> <CommitmentNumber>sample String 4</CommitmentNumber> <FinalPrice>1</FinalPrice> <InitialPrice>1</InitialPrice> <InvestorDeliveryDeadline>2025-11-09T05:57:31.1826838Z</InvestorDeliveryDeadline> <InvestorId>5</InvestorId> <InvestorLoanNumber>sample String 6</InvestorLoanNumber> <InvestorLockType>sample String 7</InvestorLockType> <InvestorLockExpirationDate>2025-11-09T05:57:31.1826838Z</InvestorLockExpirationDate> <LockActionCode>sample String 9</LockActionCode> </InvestorLockRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The RPC response with a value indicating success or failure.
RPCResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| data |
Gets or sets the data. |
Object |
None. |
| errors |
Gets or sets the errors. |
Collection of RPCError2 |
None. |
| included |
Gets or sets the included. |
Collection of Object |
None. |
| messages |
Gets or sets the errors. |
Collection of string |
None. |
| modelId |
Gets or sets the model identifier. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": {},
"errors": [
{
"code": "DataValidation",
"detail": "sample String 1",
"id": "sample String 2",
"status": 100,
"title": "sample String 3"
},
{
"code": "DataValidation",
"detail": "sample String 1",
"id": "sample String 2",
"status": 100,
"title": "sample String 3"
}
],
"included": [
{},
{}
],
"messages": [
"sample String 1",
"sample String 2"
],
"modelId": 1
}
text/html
Sample:
{"data":{},"errors":[{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"},{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"}],"included":[{},{}],"messages":["sample String 1","sample String 2"],"modelId":1}