POST api/property/add

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Property	PropertyCommandDataContract	None.
AmenityDescription	BookValuationAmenityDescriptionCommandDataContract	None.
RoomCountDescription	BookValuationRoomCountDescriptionCommandDataContract	None.
StyleAgeDescription	BookValuationStyleAgeDescriptionCommandDataContract	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 'AddPropertyCommandDataContract'.

application/json, text/json

Sample:

{
  "Property": {
    "Address": {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 3",
      "OrganizationName": "sample string 4",
      "Number": "sample string 5",
      "BuildingName": "sample string 6",
      "Street": "sample string 7",
      "Town": "sample string 8",
      "Locality": "sample string 9",
      "County": "sample string 10",
      "Postcode": "sample string 11",
      "Uprn": "sample string 12",
      "CreatedDate": "2025-09-15T11:15:47.3367208Z",
      "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": 14
    },
    "Id": 1
  },
  "AmenityDescription": {
    "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"
    },
    "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 6",
    "Id": 7
  },
  "RoomCountDescription": {
    "Bedrooms": 1,
    "Bathrooms": 2,
    "Receptions": 3,
    "Others": 4,
    "Conservatories": 5,
    "Extensions": 6,
    "Name": "sample string 7",
    "Id": 8
  },
  "StyleAgeDescription": {
    "PropertyType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "StyleType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "LeaseType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "AgeType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Name": "sample string 1",
    "Id": 2
  }
}

Response Information

Resource Description

PropertyDataContract

Name	Type	Additional information
Address	AddressDataContract	None.
Keys	Collection of PropertyKeyDataContract	None.
Alarms	Collection of PropertyAlarmDataContract	None.
Roles	Collection of RoleDataContract	None.
InactiveRoleIds	Collection of integer	None.
SpecialArrangements	Collection of PropertySpecialArrangementDataContract	None.
SystemStatusName	string	None.
Certificates	Collection of PropertyCertificateDataContract	None.
DefaultPicture	DocumentDataContract	None.
CustomFields	Collection of CustomFieldGroupWithValuesDataContract	None.
RetentionAmount	decimal number	None.
PreApprovedSpendAmount	decimal number	None.
Id	integer	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Certificates[0].Documents[0].Attachments'.

text/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path 'Certificates[0].Documents[0].Attachments'.