POST api/simplepropertyrole/search

Request Information

URI Parameters

None.

Body Parameters

SimpleWebGatewaySearchCriteriaDataContract
NameDescriptionTypeAdditional information
BranchIDList

Collection of integer

None.

MaximumPrice

decimal number

None.

MinimumPrice

decimal number

None.

MinimumBedrooms

integer

None.

MaximumBedrooms

integer

None.

MinimumGardens

integer

None.

MaximumGardens

integer

None.

MinimumParking

integer

None.

MaximumParking

integer

None.

IncludeStc

boolean

None.

PropertyTypes

Collection of string

None.

MinimumTimeOnMarket

time interval

None.

MaximumTimeOnMarket

time interval

None.

RoleTypes

Collection of string

None.

MarketingFlags

Collection of string

None.

Tags

Collection of string

None.

PageSize

integer

None.

PageNumber

integer

None.

SortBy

SortBy

None.

SortOrder

SortOrder

None.

Address

string

None.

LastUpdated

date

None.

MarketingRoleIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "BranchIDList": [
    1,
    2
  ],
  "MaximumPrice": 1.1,
  "MinimumPrice": 1.1,
  "MinimumBedrooms": 1,
  "MaximumBedrooms": 1,
  "MinimumGardens": 1,
  "MaximumGardens": 1,
  "MinimumParking": 1,
  "MaximumParking": 1,
  "IncludeStc": true,
  "PropertyTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "MinimumTimeOnMarket": "00:00:00.1234567",
  "MaximumTimeOnMarket": "00:00:00.1234567",
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "MarketingFlags": [
    "sample string 1",
    "sample string 2"
  ],
  "Tags": [
    "sample string 1",
    "sample string 2"
  ],
  "PageSize": 1,
  "PageNumber": 1,
  "SortBy": 0,
  "SortOrder": 0,
  "Address": "sample string 1",
  "LastUpdated": "2018-11-16T21:16:10.298077Z",
  "MarketingRoleIds": [
    1,
    2
  ]
}

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 'SimpleWebGatewaySearchCriteriaDataContract'.

Response Information

Resource Description

PagedCollectionDataContractOfSimpleWebGatewaySearchResultDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of SimpleWebGatewaySearchResultDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "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,
        "Others": 4,
        "DescriptionType": {
          "DisplayName": "sample string 1",
          "SystemName": "sample string 2"
        },
        "Name": "sample string 5",
        "Notes": "sample string 6"
      },
      "AmenityDescription": {
        "Gardens": 1,
        "ParkingSpaces": 2,
        "Garages": 3,
        "Acreage": 4.1,
        "AcreageMeasurementUnitType": {
          "DisplayName": "sample string 1",
          "SystemName": "sample string 2"
        },
        "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": [
        {
          "Order": 1,
          "IsPrimaryImage": true,
          "Id": 3,
          "Url": "sample string 4",
          "DocumentType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "DocumentSubType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        },
        {
          "Order": 1,
          "IsPrimaryImage": true,
          "Id": 3,
          "Url": "sample string 4",
          "DocumentType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "DocumentSubType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        }
      ],
      "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,
        "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"
          }
        }
      },
      "DateInstructed": "2018-11-16T21:16:11.0167229Z",
      "LastUpdated": "2018-11-16T21:16:11.0167229Z",
      "ClosingDate": "2018-11-16T21:16:11.0167229Z",
      "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"
      },
      "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"
          }
        },
        {
          "Id": 1,
          "Url": "sample string 2",
          "DocumentType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "DocumentSubType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        }
      ],
      "Fees": [
        {
          "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"
              }
            },
            {
              "Name": "sample string 1",
              "Threshold": 2.1,
              "Value": 3.1,
              "ThresholdType": {
                "DisplayName": "sample string 1",
                "SystemName": "sample string 2"
              }
            }
          ],
          "Notes": "sample string 5",
          "TransactionType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        },
        {
          "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"
              }
            },
            {
              "Name": "sample string 1",
              "Threshold": 2.1,
              "Value": 3.1,
              "ThresholdType": {
                "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"
        }
      ]
    },
    {
      "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,
        "Others": 4,
        "DescriptionType": {
          "DisplayName": "sample string 1",
          "SystemName": "sample string 2"
        },
        "Name": "sample string 5",
        "Notes": "sample string 6"
      },
      "AmenityDescription": {
        "Gardens": 1,
        "ParkingSpaces": 2,
        "Garages": 3,
        "Acreage": 4.1,
        "AcreageMeasurementUnitType": {
          "DisplayName": "sample string 1",
          "SystemName": "sample string 2"
        },
        "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": [
        {
          "Order": 1,
          "IsPrimaryImage": true,
          "Id": 3,
          "Url": "sample string 4",
          "DocumentType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "DocumentSubType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        },
        {
          "Order": 1,
          "IsPrimaryImage": true,
          "Id": 3,
          "Url": "sample string 4",
          "DocumentType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "DocumentSubType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        }
      ],
      "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,
        "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"
          }
        }
      },
      "DateInstructed": "2018-11-16T21:16:11.0167229Z",
      "LastUpdated": "2018-11-16T21:16:11.0167229Z",
      "ClosingDate": "2018-11-16T21:16:11.0167229Z",
      "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"
      },
      "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"
          }
        },
        {
          "Id": 1,
          "Url": "sample string 2",
          "DocumentType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          },
          "DocumentSubType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        }
      ],
      "Fees": [
        {
          "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"
              }
            },
            {
              "Name": "sample string 1",
              "Threshold": 2.1,
              "Value": 3.1,
              "ThresholdType": {
                "DisplayName": "sample string 1",
                "SystemName": "sample string 2"
              }
            }
          ],
          "Notes": "sample string 5",
          "TransactionType": {
            "DisplayName": "sample string 1",
            "SystemName": "sample string 2"
          }
        },
        {
          "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"
              }
            },
            {
              "Name": "sample string 1",
              "Threshold": 2.1,
              "Value": 3.1,
              "ThresholdType": {
                "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"
        }
      ]
    }
  ]
}