GET api/simplepropertyrole/{roleId}

Get a property with an associated role by their Id's

Request Information

URI Parameters

NameDescriptionTypeAdditional information
roleId

The role Id. Pass 0 to be returned an empty data contract.

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

The property and role data if successful and associated. Returns null if either the property or role don't exist.

Dezrez.Core.DataContracts.External.SimpleWebGateway.Roles.SimpleWebGatewaySearchResultDataContract
NameDescriptionTypeAdditional information
RoleId

integer

None.

PropertyId

integer

None.

PropertyStyle

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

None.

Address

Dezrez.Core.DataContracts.External.SimpleWebGateway.Location.SimpleWebGatewayAddressDataContract

None.

RoomCountsDescription

Dezrez.Core.DataContracts.External.SimpleWebGateway.Descriptions.SimpleWebGatewayRoomCountDescriptionDataContract

None.

AmenityDescription

Dezrez.Core.DataContracts.External.SimpleWebGateway.Descriptions.SimpleWebGatewayAmenityDescriptionDataContract

None.

FloodErosionDescription

Dezrez.Core.DataContracts.External.SimpleWebGateway.Descriptions.SimpleWebGatewayFloodErosionDescriptionDataContract

None.

RightsRestrictionsDescription

Dezrez.Core.DataContracts.External.SimpleWebGateway.Descriptions.SimpleWebGatewayRightsRestrictionsDescriptionDataContract

None.

BranchDetails

Dezrez.Core.DataContracts.External.SimpleWebGateway.Agency.SimpleWebGatewayBranchDetailsDataContract

None.

PropertyType

Dezrez.Core.DataContracts.External.SimpleWebGateway.SimpleWebGatewayEnumDataContract

None.

Tags

Collection of Dezrez.Core.DataContracts.External.SimpleWebGateway.SimpleWebGatewayTagDataContract

None.

Images

Collection of Dezrez.Core.DataContracts.External.SimpleWebGateway.Documents.SimpleWebGatewayImageDataContract

None.

SummaryTextDescription

string

None.

RoleType

Dezrez.Core.DataContracts.External.SimpleWebGateway.SimpleWebGatewayEnumDataContract

None.

Flags

Collection of Dezrez.Core.DataContracts.External.SimpleWebGateway.SimpleWebGatewayEnumDataContract

None.

RoleStatus

Dezrez.Core.DataContracts.External.SimpleWebGateway.SimpleWebGatewayEnumDataContract

None.

EPC

Dezrez.Core.DataContracts.External.SimpleWebGateway.Documents.SimpleWebGatewayEPCDataContract

None.

DateInstructed

date

None.

LastUpdated

date

None.

ClosingDate

date

None.

Price

Dezrez.Core.DataContracts.External.SimpleWebGateway.Roles.SimpleWebGatewayPriceDataContract

None.

Deposit

Dezrez.Core.DataContracts.External.SimpleWebGateway.Roles.SimpleWebGatewayDepositDataContract

None.

ViewPoints

Collection of Dezrez.Core.DataContracts.External.SimpleWebGateway.Location.SimpleWebGatewayViewPointDataContract

None.

OwningTeam

Dezrez.Core.DataContracts.External.SimpleWebGateway.Agency.SimpleWebGatewayOwningTeamDataContract

None.

Documents

Collection of Dezrez.Core.DataContracts.External.SimpleWebGateway.Documents.SimpleWebGatewayDocumentDataContract

None.

Fees

Collection of Dezrez.Core.DataContracts.External.SimpleWebGateway.Roles.SimpleWebGatewayAgencyFeeDataContract

None.

Descriptions

Collection of Dezrez.Core.DataContracts.External.SimpleWebGateway.Descriptions.SimpleWebGatewayDescriptionDataContractBase

None.

Response Formats

application/json, text/json

Sample:
{
  "RoleId": 1,
  "PropertyId": 2,
  "PropertyStyle": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Address": {
    "OrganizationName": "sample string 1",
    "Number": "sample string 2",
    "BuildingName": "sample string 3",
    "Street": "sample string 4",
    "Town": "sample string 5",
    "Locality": "sample string 6",
    "County": "sample string 7",
    "Postcode": "sample string 8",
    "Location": {
      "Latitude": 1.1,
      "Longitude": 2.1,
      "Altitude": 3.1
    }
  },
  "RoomCountsDescription": {
    "Bedrooms": 1,
    "Bathrooms": 2,
    "Receptions": 3,
    "Conservatories": 4,
    "Extensions": 5,
    "Others": 6,
    "DescriptionType": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "Name": "sample string 7",
    "Notes": "sample string 8"
  },
  "AmenityDescription": {
    "Gardens": 1,
    "ParkingSpaces": 2,
    "ParkingTypes": "sample string 3",
    "Garages": 4,
    "Acreage": 5.1,
    "AcreageMeasurementUnitType": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "AccessibilityTypes": "sample string 6",
    "HeatingSources": "sample string 7",
    "ElectricitySupply": "sample string 8",
    "WaterSupply": "sample string 9",
    "Sewerage": "sample string 10",
    "BroadbandConnectionTypes": "sample string 11",
    "DescriptionType": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "Name": "sample string 12",
    "Notes": "sample string 13"
  },
  "FloodErosionDescription": {
    "Flooded": true,
    "FloodingSources": "sample string 2",
    "FloodDefences": true,
    "CoastalErosion": true,
    "DescriptionType": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "Name": "sample string 5",
    "Notes": "sample string 6"
  },
  "RightsRestrictionsDescription": {
    "IsListed": true,
    "Restrictions": true,
    "RequiredAccess": true,
    "RightsOfWay": true,
    "DescriptionType": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "Name": "sample string 5",
    "Notes": "sample string 6"
  },
  "BranchDetails": {
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "ContactDetails": {
      "Addresses": [
        {
          "AddressType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "Address": {
            "OrganizationName": "sample string 1",
            "Number": "sample string 2",
            "BuildingName": "sample string 3",
            "Street": "sample string 4",
            "Town": "sample string 5",
            "Locality": "sample string 6",
            "County": "sample string 7",
            "Postcode": "sample string 8",
            "Location": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1
            }
          },
          "ContactOrder": 1
        },
        {
          "AddressType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "Address": {
            "OrganizationName": "sample string 1",
            "Number": "sample string 2",
            "BuildingName": "sample string 3",
            "Street": "sample string 4",
            "Town": "sample string 5",
            "Locality": "sample string 6",
            "County": "sample string 7",
            "Postcode": "sample string 8",
            "Location": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1
            }
          },
          "ContactOrder": 1
        }
      ],
      "ContactItems": [
        {
          "ContactItemType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true
        },
        {
          "ContactItemType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true
        }
      ]
    }
  },
  "PropertyType": {
    "DisplayName": "sample string 1",
    "SystemName": "sample string 2"
  },
  "Tags": [
    {
      "Name": "sample string 1"
    },
    {
      "Name": "sample string 1"
    }
  ],
  "Images": [
    {
      "IsPrimaryImage": true,
      "Id": 2,
      "Url": "sample string 3",
      "DocumentType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "DocumentSubType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "Order": 4
    },
    {
      "IsPrimaryImage": true,
      "Id": 2,
      "Url": "sample string 3",
      "DocumentType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "DocumentSubType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "Order": 4
    }
  ],
  "SummaryTextDescription": "sample string 3",
  "RoleType": {
    "DisplayName": "sample string 1",
    "SystemName": "sample string 2"
  },
  "Flags": [
    {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    }
  ],
  "RoleStatus": {
    "DisplayName": "sample string 1",
    "SystemName": "sample string 2"
  },
  "EPC": {
    "EPCType": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "EERCurrent": 1,
    "EERPotential": 2,
    "EIRCurrent": 3,
    "EIRPotential": 4,
    "EPARCurrent": 5,
    "EPARPotential": 6,
    "Image": {
      "Id": 1,
      "Url": "sample string 2",
      "DocumentType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "DocumentSubType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "Order": 3
    }
  },
  "DateInstructed": "2024-10-05T10:04:11.9549461Z",
  "LastUpdated": "2024-10-05T10:04:11.9549461Z",
  "ClosingDate": "2024-10-05T10:04:11.9549461Z",
  "Price": {
    "PriceValue": 1.1,
    "CurrencyCode": "sample string 2",
    "PriceType": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "PriceQualifierType": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "PriceText": "sample string 3",
    "AnnualGroundRent": 4.0,
    "GroundRentReviewPeriodYears": 5,
    "AnnualServiceCharge": 6.0
  },
  "Deposit": {
    "PriceValue": 1.1,
    "CurrencyCode": "sample string 2",
    "Scheme": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "DepositStatus": {
      "DisplayName": "sample string 1",
      "SystemName": "sample string 2"
    },
    "DepositIdentification": "sample string 3"
  },
  "ViewPoints": [
    {
      "Point": {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Altitude": 3.1
      },
      "Pitch": 1.1,
      "Heading": 2.1,
      "FieldOfVision": 3.1,
      "Zoom": 4.1,
      "Label": "sample string 5"
    },
    {
      "Point": {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Altitude": 3.1
      },
      "Pitch": 1.1,
      "Heading": 2.1,
      "FieldOfVision": 3.1,
      "Zoom": 4.1,
      "Label": "sample string 5"
    }
  ],
  "OwningTeam": {
    "Name": "sample string 1",
    "Title": "sample string 2",
    "Email": "sample string 3",
    "Phone": "sample string 4"
  },
  "Documents": [
    {
      "Id": 1,
      "Url": "sample string 2",
      "DocumentType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "DocumentSubType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "Order": 3
    },
    {
      "Id": 1,
      "Url": "sample string 2",
      "DocumentType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "DocumentSubType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "Order": 3
    }
  ],
  "Fees": [
    {
      "FeeId": 1,
      "Name": "sample string 1",
      "FeeValueType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "FeeCategoryType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "FeeChargeType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "FeeLiabilityType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "FeeFrequency": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "ApplyTax": true,
      "VatValue": 3.1,
      "DefaultValue": 4.1,
      "ScaleableFees": [
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "ValueType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        },
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "ValueType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        }
      ],
      "AdditionalFees": [
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "ValueType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        },
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "ValueType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        }
      ],
      "Notes": "sample string 5",
      "TransactionType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      }
    },
    {
      "FeeId": 1,
      "Name": "sample string 1",
      "FeeValueType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "FeeCategoryType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "FeeChargeType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "FeeLiabilityType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "FeeFrequency": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "ApplyTax": true,
      "VatValue": 3.1,
      "DefaultValue": 4.1,
      "ScaleableFees": [
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "ValueType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        },
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "ValueType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        }
      ],
      "AdditionalFees": [
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "ValueType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        },
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "ValueType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        }
      ],
      "Notes": "sample string 5",
      "TransactionType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      }
    }
  ],
  "Descriptions": [
    {
      "DescriptionType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "Name": "sample string 1",
      "Notes": "sample string 2"
    },
    {
      "DescriptionType": {
        "DisplayName": "sample string 1",
        "SystemName": "sample string 2"
      },
      "Name": "sample string 1",
      "Notes": "sample string 2"
    }
  ]
}