PUT api/role/{id}/updateprice

Update price for a given PropertySalesRole.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

the id of the role

integer

Required

Body Parameters

UpdatePriceDataContract

Dezrez.Core.DataContracts.External.Api.Role.Command.UpdatePrice.UpdatePriceDataContract
NameDescriptionTypeAdditional information
AskingPrice

decimal number

None.

PriceType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

PriceText

string

None.

PriceQualifierType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

MarkAsReduced

boolean

None.

PriceOnApplication

boolean

None.

HomeReportPrice

decimal number

None.

HomeReportPublishedDate

date

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 'UpdatePriceDataContract'.

application/json, text/json

Sample:
{
  "AskingPrice": 1.1,
  "PriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "PriceText": "sample string 2",
  "PriceQualifierType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "MarkAsReduced": true,
  "PriceOnApplication": true,
  "HomeReportPrice": 1.1,
  "HomeReportPublishedDate": "2024-03-28T19:57:20.9215991Z"
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Role.Command.UpdatePrice.UpdatePropertyPriceResponseDataContract
NameDescriptionTypeAdditional information
PriceChangeEventId

integer

None.

NewPrice

decimal number

None.

OldPrice

decimal number

None.

NewPriceType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

OldPriceType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

IsSuccessful

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "PriceChangeEventId": 1,
  "NewPrice": 1.1,
  "OldPrice": 2.1,
  "NewPriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "OldPriceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "IsSuccessful": true
}