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

Create/Update additional service on lettings role

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lettings.Command.SetAdditionalServiceDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Description

string

None.

ProviderGroupId

integer

None.

PropertyServiceType

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

None.

IsPaidByOwner

boolean

None.

Notified

boolean

None.

AdditionalServiceType

Dezrez.Core.DataContracts.External.Api.Lettings.Command.AdditionalServiceType

None.

Readings

Dictionary of string [key] and date [value]

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "ProviderGroupId": 1,
  "PropertyServiceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "IsPaidByOwner": true,
  "Notified": true,
  "AdditionalServiceType": 0,
  "Readings": {
    "sample string 1": "2024-02-25T15:07:48.8251501Z",
    "sample string 3": "2024-02-25T15:07:48.8251501Z"
  },
  "Id": 5
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Lettings.Query.AdditionalServiceDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Description

string

None.

ProviderGroupId

integer

None.

ProviderGroupName

string

None.

PropertyServiceType

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

None.

IsPaidByOwner

boolean

None.

Notified

boolean

None.

AdditionalServiceType

Dezrez.Core.DataContracts.External.Api.Lettings.Command.AdditionalServiceType

None.

CreatedDate

date

None.

Readings

Collection of Dezrez.Core.DataContracts.External.Api.Lettings.Query.ReadingDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "ProviderGroupId": 3,
  "ProviderGroupName": "sample string 4",
  "PropertyServiceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "IsPaidByOwner": true,
  "Notified": true,
  "AdditionalServiceType": 0,
  "CreatedDate": "2024-02-25T15:07:48.8251501Z",
  "Readings": [
    {
      "Reading": "sample string 1",
      "ReadingDate": "2024-02-25T15:07:48.8251501Z",
      "CreatedDate": "2024-02-25T15:07:48.8251501Z",
      "Id": 3
    },
    {
      "Reading": "sample string 1",
      "ReadingDate": "2024-02-25T15:07:48.8251501Z",
      "CreatedDate": "2024-02-25T15:07:48.8251501Z",
      "Id": 3
    }
  ],
  "Id": 8
}