POST api/progression/lettings/{roleId}/addtenantdeposit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
roleId

integer

Required

Body Parameters

Dezrez.Core.DataContracts.External.Api.Role.Command.AddTenantCharge.AddTenantDepositDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Deposit

Dezrez.Core.DataContracts.External.Api.Role.Command.SetDeposit.SetDepositCommandDataContract

None.

TenantChargeInfo

Dezrez.Core.DataContracts.External.Api.Role.Command.AddTenantCharge.AddTenantChargeInfoDataContract

None.

HistoricDeposit

boolean

None.

DateProtected

date

None.

DepositSchemeId

integer

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AddTenantDepositDataContract'.

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Deposit": {
    "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
  },
  "TenantChargeInfo": {
    "AmountPaid": 1.1,
    "DiscountPercentage": 2.1,
    "DueDate": "2024-03-29T13:08:13.395197Z",
    "Id": 3
  },
  "HistoricDeposit": true,
  "DateProtected": "2024-03-29T13:08:13.395197Z",
  "DepositSchemeId": 3,
  "Id": 4
}

Response Information

Resource Description

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.

Content

System.Net.Http.HttpContent

None.

StatusCode

System.Net.HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

System.Net.Http.HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.