POST api/amenitydescription/Save

Save or update an Amenity Description Processes this amenity description API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The amenity description to save

AmenityDescriptionSaveDataContract

Name	Description	Type	Additional information
Gardens	The gardens value.	integer	None.
ParkingSpaces	The parking spaces value.	integer	None.
ParkingTypes	The collection of parking types.	Collection of EnumDataContract	None.
Garages	The garages value.	integer	None.
FixturesFittings	The fixtures fittings value.	string	None.
Acreage	The acreage value.	decimal number	None.
AcreageMeasurementUnitType	The acreage measurement unit type value.	EnumDataContract	None.
RequiresNoGasSafetyCertificate	Indicates whether requires no gas safety certificate is true.	boolean	None.
AccessibilityTypes	The collection of accessibility types.	Collection of EnumDataContract	None.
HeatingSources	The collection of heating sources.	Collection of EnumDataContract	None.
ElectricitySupply	The collection of electricity supply.	Collection of EnumDataContract	None.
WaterSupply	The water supply value.	EnumDataContract	None.
Sewerage	The sewerage value.	EnumDataContract	None.
BroadbandConnectionTypes	The collection of broadband connection types.	Collection of EnumDataContract	None.
Name	The name value.	string	None.
Notes	The notes value.	string	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
RoleId	The unique identifier of the related role resource.	integer	None.
ForceUpdate	Indicates whether force update is true.	boolean	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:

{
  "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

The response returned after the operation completes.

AmenityDescriptionDataContract

Name	Description	Type	Additional information
Gardens	The gardens value.	integer	None.
ParkingSpaces	The parking spaces value.	integer	None.
ParkingTypes	The collection of parking types.	Collection of EnumDataContract	None.
Garages	The garages value.	integer	None.
FixturesFittings	The fixtures fittings value.	string	None.
Acreage	The acreage value.	decimal number	None.
AcreageMeasurementUnitType	The acreage measurement unit type value.	EnumDataContract	None.
RequiresNoGasSafetyCertificate	Indicates whether requires no gas safety certificate is true.	boolean	None.
AccessibilityTypes	The collection of accessibility types.	Collection of EnumDataContract	None.
HeatingSources	The collection of heating sources.	Collection of EnumDataContract	None.
ElectricitySupply	The collection of electricity supply.	Collection of EnumDataContract	None.
WaterSupply	The water supply value.	EnumDataContract	None.
Sewerage	The sewerage value.	EnumDataContract	None.
BroadbandConnectionTypes	The collection of broadband connection types.	Collection of EnumDataContract	None.
Name	The name value.	string	None.
Order	The order value.	integer	None.
Type	The type value.	EnumDataContract	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
Notes	The notes value.	string	None.
Roles	The collection of roles.	Collection of DescriptionRoleDataContract	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
CreatedBy	The created by value.	CreatedByDataContract	None.
Id	The unique identifier of this resource.	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": "2026-08-04T23:16:55.82941Z",
  "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
}