POST api/role/lettings/{id}/setdeposit
Sets the deposit on a letting role
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The role id |
integer |
Required |
Body Parameters
The deposit to set on the role
Dezrez.Core.DataContracts.External.Api.Role.Command.SetDeposit.SetDepositCommandDataContractName | Description | Type | Additional information |
---|---|---|---|
PriceValue | decimal number |
None. |
|
CurrencyCode | string |
None. |
|
Scheme | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
Status | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
DepositIdentification | string |
None. |
|
Id | integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{ "PriceValue": 1.1, "CurrencyCode": "sample string 2", "Scheme": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Status": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DepositIdentification": "sample string 3", "Id": 4 }
Response Information
Resource Description
Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Marketing.DepositDataContractName | Description | Type | Additional information |
---|---|---|---|
PriceValue | decimal number |
None. |
|
CurrencyCode | string |
None. |
|
Scheme | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
DepositStatus | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
DepositIdentification | string |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "PriceValue": 1.1, "CurrencyCode": "sample string 2", "Scheme": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DepositStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DepositIdentification": "sample string 3", "Id": 4 }