POST api/role/lettings/{id}/setdeposit

Sets the deposit on a letting role Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The role id	integer	Required

Body Parameters

The deposit to set on the role

SetDepositCommandDataContract

Name	Description	Type	Additional information
PriceValue	The price value value.	decimal number	None.
CurrencyCode	The currency code value.	string	None.
Scheme	The scheme value.	EnumDataContract	None.
Status	The status value.	EnumDataContract	None.
DepositIdentification	The deposit identification value.	string	None.
Id	The unique identifier of this resource.	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

The response returned after the operation completes.

DepositDataContract

Name	Description	Type	Additional information
PriceValue	The price value value.	decimal number	None.
CurrencyCode	The currency code value.	string	None.
Scheme	The scheme value.	EnumDataContract	None.
DepositStatus	The deposit status value.	EnumDataContract	None.
DepositIdentification	The deposit identification value.	string	None.
Id	The unique identifier of this resource.	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
}