POST api/property/{id}/setadditionalservice

Create/Update additional service on a property. Defaults to Landlord liability Processes this property API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique identifier of the requested resource.

integer

Required

Body Parameters

The set additional service data contract supplied with the request.

SetAdditionalServiceDataContract
NameDescriptionTypeAdditional information
Name

The name value.

string

None.

Description

The description value.

string

None.

ProviderGroupId

The unique identifier of the related provider group resource.

integer

None.

PropertyServiceType

The property service type value.

EnumDataContract

None.

IsPaidByOwner

Indicates whether this item is paid by owner.

boolean

None.

Notified

Indicates whether notified is true.

boolean

None.

AdditionalServiceType

The additional service type classification.

AdditionalServiceType

None.

Readings

The collection of readings.

Dictionary of string [key] and date [value]

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:
{
  "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": "2026-07-23T08:19:13.8734518Z",
    "sample string 3": "2026-07-23T08:19:13.8734518Z"
  },
  "Id": 5
}

Response Information

Resource Description

The response returned after the operation completes.

AdditionalServiceDataContract
NameDescriptionTypeAdditional information
Name

The name value.

string

None.

Description

The description value.

string

None.

ProviderGroupId

The unique identifier of the related provider group resource.

integer

None.

ProviderGroupName

The provider group name value.

string

None.

PropertyServiceType

The property service type value.

EnumDataContract

None.

IsPaidByOwner

Indicates whether this item is paid by owner.

boolean

None.

Notified

Indicates whether notified is true.

boolean

None.

AdditionalServiceType

The additional service type classification.

AdditionalServiceType

None.

CreatedDate

The created date, expressed as a date and time.

date

None.

Readings

The collection of readings.

Collection of ReadingDataContract

None.

Id

The unique identifier of this resource.

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": "2026-07-23T08:19:13.8734518Z",
  "Readings": [
    {
      "Reading": "sample string 1",
      "ReadingDate": "2026-07-23T08:19:13.8734518Z",
      "CreatedDate": "2026-07-23T08:19:13.8734518Z",
      "Id": 3
    },
    {
      "Reading": "sample string 1",
      "ReadingDate": "2026-07-23T08:19:13.8734518Z",
      "CreatedDate": "2026-07-23T08:19:13.8734518Z",
      "Id": 3
    }
  ],
  "Id": 8
}