POST api/amenitydescription/Save

Save or update an Amenity Description

Request Information

URI Parameters

None.

Body Parameters

The amenity description to save

Dezrez.Core.DataContracts.External.Api.Descriptions.Command.AmenityDescriptionSaveDataContract

Name	Type	Additional information
Gardens	integer	None.
ParkingSpaces	integer	None.
ParkingTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
Garages	integer	None.
FixturesFittings	string	None.
Acreage	decimal number	None.
AcreageMeasurementUnitType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
RequiresNoGasSafetyCertificate	boolean	None.
AccessibilityTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
HeatingSources	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
ElectricitySupply	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
WaterSupply	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
Sewerage	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
BroadbandConnectionTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
Name	string	None.
Notes	string	None.
PropertyId	integer	None.
RoleId	integer	None.
ForceUpdate	boolean	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Gardens": 1,
  "ParkingSpaces": 2,
  "ParkingTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "Garages": 3,
  "FixturesFittings": "sample string 4",
  "Acreage": 5.1,
  "AcreageMeasurementUnitType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RequiresNoGasSafetyCertificate": true,
  "AccessibilityTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "HeatingSources": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "ElectricitySupply": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "WaterSupply": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Sewerage": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "BroadbandConnectionTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "Name": "sample string 7",
  "Notes": "sample string 8",
  "PropertyId": 9,
  "RoleId": 10,
  "ForceUpdate": true,
  "Id": 12
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Descriptions.Query.AmenityDescriptionDataContract

Name	Type	Additional information
Gardens	integer	None.
ParkingSpaces	integer	None.
ParkingTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
Garages	integer	None.
FixturesFittings	string	None.
Acreage	decimal number	None.
AcreageMeasurementUnitType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
RequiresNoGasSafetyCertificate	boolean	None.
AccessibilityTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
HeatingSources	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
ElectricitySupply	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
WaterSupply	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
Sewerage	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
BroadbandConnectionTypes	Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
Name	string	None.
Order	integer	None.
Type	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
PropertyId	integer	None.
Notes	string	None.
Roles	Collection of Dezrez.Core.DataContracts.External.Api.Descriptions.Query.DescriptionRoleDataContract	None.
CreatedDate	date	None.
CreatedBy	Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Gardens": 1,
  "ParkingSpaces": 2,
  "ParkingTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "Garages": 3,
  "FixturesFittings": "sample string 4",
  "Acreage": 5.1,
  "AcreageMeasurementUnitType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RequiresNoGasSafetyCertificate": true,
  "AccessibilityTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "HeatingSources": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "ElectricitySupply": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "WaterSupply": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Sewerage": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "BroadbandConnectionTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "Name": "sample string 7",
  "Order": 8,
  "Type": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "PropertyId": 9,
  "Notes": "sample string 10",
  "Roles": [
    {
      "Name": "sample string 1",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 2
    },
    {
      "Name": "sample string 1",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 2
    }
  ],
  "CreatedDate": "2024-10-30T15:16:19.7381869Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 12
}