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

Add or Update a utility for the letting role

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The letting role id

integer

Required

Body Parameters

The details of the utility to be added

Dezrez.Core.DataContracts.External.Api.Role.Command.SaveUtility.SaveUtilityDataContract
NameDescriptionTypeAdditional information
UtilityType

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

None.

SupplierGroupId

integer

None.

MeterReading

string

None.

ReadingDate

date

None.

BillId

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

application/json, text/json

Sample:
{
  "UtilityType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SupplierGroupId": 1,
  "MeterReading": "sample string 2",
  "ReadingDate": "2024-04-25T00:50:07.7001777Z",
  "BillId": 1,
  "Id": 4
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Marketing.UtilityDataContract
NameDescriptionTypeAdditional information
UtilityType

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

None.

Supplier

Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PeopleGroupDataContract

None.

MeterReading

string

None.

ReadingDate

date

None.

Id

integer

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'Dezrez.Core.Client.Common.Formatters.SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PreferredCompanyDataContract'. Path 'Supplier.PreferredCompanies[0].Group.PreferredCompanies'.

text/json

Sample:

An exception has occurred while using the formatter 'Dezrez.Core.Client.Common.Formatters.SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PreferredCompanyDataContract'. Path 'Supplier.PreferredCompanies[0].Group.PreferredCompanies'.