C# Class TradeMe.Api.Client.SearchMethods

The SearchMethods class contains the methods requried for making calls to the API related to searching.
Mostra file Open project: TradeMe/trade-me-api-wrapper Class Usage Examples

Public Methods

Method Description
SearchCommercialLeaseProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, PropertyUsage usage ) : global::Properties

Performs the search method: Search Commercial Lease Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchCommercialSaleProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, PropertyUsage usage ) : global::Properties

Performs the search method: Search Commercial Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchFlatmates ( string query ) : Flatmates

Performs the Search Method: Search for Flatmate using the "query" string provided - should be the "Search/Flatmates.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchFlatmates ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax ) : Flatmates

Performs the Search Method: Search for Flatmate Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchGeneral ( string query ) : SearchResults

Performs Search method: Search General using the "query" string provided - should be the "Search/General.xml?search_string=Playstation" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchGeneral ( string category, string searchString, int userRegion, SortOrder sortOrder, bool buy, bool pay, System.Condition condition, System.DateTime dateFrom, int page, int rows, int memberListing ) : SearchResults

Performs Search method: Search General using the query paramaters provided it will construct a query string for you - can use null if the parameter is not required for your request.

DOES NOT REQUIRE AUTHENTICATION.

SearchJobs ( string query ) : Jobs

Performs the search method: Search Jobs

using the "query" string provided - should be the "Search/Jobs.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchJobs ( string searchString, SortOrder sortOrder, decimal salaryMin, decimal salaryMax, string region, string district, JobType type, string category, string subcategory, int page, int rows ) : Jobs

Performs the search method: Search Jobs.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchLifestyleProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, LifestylePropertyUsage usage, LifestylePropertyType propertyType ) : global::Properties

Performs the search method: Search Lifestyle Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchMethods ( ConnectionMethods connect ) : System

Initializes a new instance of the SearchMethods class.

SearchMotorBikes ( string query ) : MotorBikes

Performs the Search Method: Search Motor Bikes using the "query" string provided - should be the "Search/Motors/Bikes.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchMotorBikes ( string searchString, SortOrder sortOrder, decimal priceMin, decimal priceMax, string make, BikeType type, int yearMin, int yearMax, int energySizeMin, int energySizeMax, System.DateTime dateFrom, int page, int rows ) : MotorBikes

Performs the Search Method: Search Motor Bikes. It creates the query string using the paramaters - can be null if the parameter is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchMotorBoats ( string query ) : MotorBoats

Performs the Search Method: Search Motor Boats

using the "query" string provided - should be the "Search/Motors/Boats.xml?length_max=5000&type=inflatable" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchMotorBoats ( string searchString, SortOrder sortOrder, decimal priceMin, decimal priceMax, BoatType type, int lengthMin, int lengthMax, System.DateTime dateFrom, int page, int rows ) : MotorBoats

Performs the Search Method: Search Motor Boats using the parameters provided - can use null if the parameter is not required.

DOES NOT REQUIRE AUTHENTICATION.

SearchOpenHomeProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties

Performs the Search method: Search Residential Open Homes. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchProperties ( string query ) : global::Properties

Performs the Search Methods: Search Residential Property, Search Residential Rental Property, Residential Open Homes, Search Commercial Property, Search Commercial Lease Property, Search Rural Property, Search Lifestyle Property, Search Retirement Villages,

using the "query" string provided - should be the "Search/Property/Retirement.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchResidentialProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties

Performs the search method: Search Residential Property.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

SearchResidentialRentalProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties

Performs the Search Method: Search Residential Rental Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchRetirementVillages ( string query ) : RetirementVillages

Performs the search method: Search Retirement Villages using the "query" string provided - should be the "Search/Retirement.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchRetirementVillages ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int areaMin, int areaMax, int landAreaMin, int landAreaMax, RetirementVillagePropertyType propertyType, int bedroomsMin, int bedroomsMax ) : RetirementVillages

Performs the search method: Search Retirement Villages. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchRuralProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int landAreaMin, int landAreaMax, RuralPropertyUsage usage ) : global::Properties

Performs the search method: Search Rural Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

SearchStores ( string searchString = "", int page = 1, string category = "", StoreType storeType = StoreType.Normal ) : Stores

Performs the method:

Search for Stores.

As specified in the API Documentation.

Creates a query string using the paramaters provided - parameters can be null if they are not required for the request.

DOES NOT REQURE AUTHENTICATION.

SearchUsedMotors ( string query ) : Cars

Performs the Search Method: Search Used Motors using the "query" string provided - should be the "Search/Motors/Used.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.

SearchUsedMotors ( string searchString, int userRegion, SortOrder sortOrder, decimal priceMin, decimal priceMax, string make, string model, BodyStyle bodyStyle, int doorsMin, int doorsMax, Transmission transmission, int yearMax, int yearMin, int energySizeMin, int energySizeMax, int odometerMin, int odometerMax, ListingType listingType, System.DateTime dateFrom, int page, int rows ) : Cars

Performs the Search Method: Search Used Motors. Creates a query string based on the parameters provided, can be null if the parameter is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.

Private Methods

Method Description
ConstructQueryHelper ( string name, string value, bool addAnd ) : string

A helper method for constructing a query string in the form: "name = value" or "&name = value".

PageAndRowsHelper ( string page, string rows, bool addAnd ) : string

A helper method for constructing the "page" and "row" part of a request query.

PropertyConnectionHelper ( string url ) : global::Properties

A helper method for performing the http request for property requests - using the url provided.

PropertyHelper ( string searchString, string sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int landAreaMin, int landAreaMax ) : string

A helper method for construction a portion of the query string needed for property requests.

ResidentialPropertyHelper ( int bathroomsMin, int bathroomsMax, int bedroomsMax, int bedroomsMin, int areaMax, int areaMin, string propertyType, bool adjacentSuburbs ) : string

A helper method for constructing a portion of the query string for residential property requests.

RuralPropertiesHelper ( string searchString, string sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, string usage ) : string

A helper method for constructing a portion of the rural property query string.

SearchStringToDistrict ( string searchString, string sortOrder, int page, int rows, string region, string district ) : string

A helper method for construction part of the query string for requests.

Method Details

SearchCommercialLeaseProperties() public method

Performs the search method: Search Commercial Lease Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchCommercialLeaseProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, PropertyUsage usage ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
areaMax int Maximum floor area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
usage PropertyUsage The usage of the property.
return global::Properties

SearchCommercialSaleProperties() public method

Performs the search method: Search Commercial Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchCommercialSaleProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, PropertyUsage usage ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms.
bathroomsMax int Maximum number of bathrooms.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
areaMax int Maximum floor area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
usage PropertyUsage The usage of the property.
return global::Properties

SearchFlatmates() public method

Performs the Search Method: Search for Flatmate using the "query" string provided - should be the "Search/Flatmates.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchFlatmates ( string query ) : Flatmates
query string The query string that will be added to the base url and used to connect to the API.
return Flatmates

SearchFlatmates() public method

Performs the Search Method: Search for Flatmate Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchFlatmates ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax ) : Flatmates
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
return Flatmates

SearchGeneral() public method

Performs Search method: Search General using the "query" string provided - should be the "Search/General.xml?search_string=Playstation" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchGeneral ( string query ) : SearchResults
query string The query string that will be added to the base url and used to connect to the API with.
return SearchResults

SearchGeneral() public method

Performs Search method: Search General using the query paramaters provided it will construct a query string for you - can use null if the parameter is not required for your request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchGeneral ( string category, string searchString, int userRegion, SortOrder sortOrder, bool buy, bool pay, System.Condition condition, System.DateTime dateFrom, int page, int rows, int memberListing ) : SearchResults
category string Specifies the category in which you want to perform the search.
searchString string One or more keywords to use in a search query.
userRegion int Restricts search results to items from sellers located in the specified region.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
buy bool Return only listings with BuyNow price.
pay bool Return only listings with PayNow.
condition System.Condition Filter listings by condition.
dateFrom System.DateTime Return only listings started from this date.
page int Page number.
rows int Number of rows per page.
memberListing int Returns only listing from specified member ID.
return SearchResults

SearchJobs() public method

Performs the search method: Search Jobs

using the "query" string provided - should be the "Search/Jobs.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchJobs ( string query ) : Jobs
query string The query string that will be added to the base url and used to connect to the API with.
return Jobs

SearchJobs() public method

Performs the search method: Search Jobs.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchJobs ( string searchString, SortOrder sortOrder, decimal salaryMin, decimal salaryMax, string region, string district, JobType type, string category, string subcategory, int page, int rows ) : Jobs
searchString string One or more keywords to use in a search query.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
salaryMin decimal Minimum salary.
salaryMax decimal Maximum salary.
region string Job offer region.
district string Job offer district.
type JobType Type of position.
category string Category.
subcategory string Subcategory.
page int Page number.
rows int Number of rows per page.
return Jobs

SearchLifestyleProperties() public method

Performs the search method: Search Lifestyle Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchLifestyleProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, bool adjacentSuburbs, LifestylePropertyUsage usage, LifestylePropertyType propertyType ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms.
bathroomsMax int Maximum number of bathrooms.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
areaMax int Maximum floor area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
usage LifestylePropertyUsage The usage of the property.
propertyType LifestylePropertyType The type of the property.
return global::Properties

SearchMethods() public method

Initializes a new instance of the SearchMethods class.
public SearchMethods ( ConnectionMethods connect ) : System
connect ConnectionMethods A ConnectionMethods class used to make calls to the API
return System

SearchMotorBikes() public method

Performs the Search Method: Search Motor Bikes using the "query" string provided - should be the "Search/Motors/Bikes.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchMotorBikes ( string query ) : MotorBikes
query string The query string that will be added to the base url and used to connect to the API.
return MotorBikes

SearchMotorBikes() public method

Performs the Search Method: Search Motor Bikes. It creates the query string using the paramaters - can be null if the parameter is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchMotorBikes ( string searchString, SortOrder sortOrder, decimal priceMin, decimal priceMax, string make, BikeType type, int yearMin, int yearMax, int energySizeMin, int energySizeMax, System.DateTime dateFrom, int page, int rows ) : MotorBikes
searchString string One or more keywords to use in a search query.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
priceMin decimal Minimum price.
priceMax decimal Maximum price.
make string Motorbike make.
type BikeType Type of the Motor Bike.
yearMin int Minimum year of manufacture.
yearMax int Maximum year of manufacture.
energySizeMin int Minimum engine size in cubic centimetres (e.g. 2000 for 2 litre engine).
energySizeMax int Maximum engine size.
dateFrom System.DateTime Return only listings started from this date.
page int Page number.
rows int Number of rows per page.
return MotorBikes

SearchMotorBoats() public method

Performs the Search Method: Search Motor Boats

using the "query" string provided - should be the "Search/Motors/Boats.xml?length_max=5000&type=inflatable" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchMotorBoats ( string query ) : MotorBoats
query string The query string that will be added to the base url and used to connect to the API with.
return MotorBoats

SearchMotorBoats() public method

Performs the Search Method: Search Motor Boats using the parameters provided - can use null if the parameter is not required.

DOES NOT REQUIRE AUTHENTICATION.
public SearchMotorBoats ( string searchString, SortOrder sortOrder, decimal priceMin, decimal priceMax, BoatType type, int lengthMin, int lengthMax, System.DateTime dateFrom, int page, int rows ) : MotorBoats
searchString string One or more keywords to use in a search query.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
priceMin decimal Minimum price.
priceMax decimal Maximum price.
type BoatType Type of the Motor Boat.
lengthMin int Minimum length of a boat in metres.
lengthMax int Maximum length of a boat in metres.
dateFrom System.DateTime Return only listings started from this date.
page int Page number.
rows int Number of rows per page.
return MotorBoats

SearchOpenHomeProperties() public method

Performs the Search method: Search Residential Open Homes. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchOpenHomeProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bedrooms.
bathroomsMax int Maximum number of bedrooms.
bedroomsMin int Minimum number of bathrooms.
bedroomsMax int Maximum number of bathrooms.
areaMax int Maximum square area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
propertyType PropertyType The type of the property.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
return global::Properties

SearchProperties() public method

Performs the Search Methods: Search Residential Property, Search Residential Rental Property, Residential Open Homes, Search Commercial Property, Search Commercial Lease Property, Search Rural Property, Search Lifestyle Property, Search Retirement Villages,

using the "query" string provided - should be the "Search/Property/Retirement.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchProperties ( string query ) : global::Properties
query string The query string that will be added to the base url and used to connect to the API with.
return global::Properties

SearchResidentialProperties() public method

Performs the search method: Search Residential Property.

Creates a query string using the parameters provided - parameters can be null if they are not required for the request.
public SearchResidentialProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms.
bathroomsMax int Maximum number of bathrooms.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
areaMax int Maximum square area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
propertyType PropertyType The type of the property.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
return global::Properties

SearchResidentialRentalProperties() public method

Performs the Search Method: Search Residential Rental Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchResidentialRentalProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int bedroomsMin, int bedroomsMax, int areaMax, int areaMin, int landAreaMin, int landAreaMax, PropertyType propertyType, bool adjacentSuburbs ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms.
bathroomsMax int Maximum number of bathrooms.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
areaMax int Maximum square area in square meters.
areaMin int Minimum floor area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
propertyType PropertyType The type of the property.
adjacentSuburbs bool Indicates whether the search should include listings in adjacent suburbs.
return global::Properties

SearchRetirementVillages() public method

Performs the search method: Search Retirement Villages using the "query" string provided - should be the "Search/Retirement.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchRetirementVillages ( string query ) : RetirementVillages
query string The query string that will be added to the base url and used to connect to the API.
return RetirementVillages

SearchRetirementVillages() public method

Performs the search method: Search Retirement Villages. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchRetirementVillages ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int bathroomsMin, int bathroomsMax, int areaMin, int areaMax, int landAreaMin, int landAreaMax, RetirementVillagePropertyType propertyType, int bedroomsMin, int bedroomsMax ) : RetirementVillages
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
bathroomsMin int Minimum number of bathrooms..
bathroomsMax int Maximum number of bathrooms.
areaMin int Minimum floor area in square meters.
areaMax int Maximum square area in square meters.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
propertyType RetirementVillagePropertyType The property type.
bedroomsMin int Minimum number of bedrooms.
bedroomsMax int Maximum number of bedrooms.
return RetirementVillages

SearchRuralProperties() public method

Performs the search method: Search Rural Property. Creates a query string using the parameters provided - parameters can be null if they are not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchRuralProperties ( string searchString, PropertySortOrder sortOrder, int page, int rows, int region, int district, int suburb, System.DateTime dateFrom, int priceMin, int priceMax, int landAreaMin, int landAreaMax, RuralPropertyUsage usage ) : global::Properties
searchString string One or more keywords to use in a search query.
sortOrder PropertySortOrder Sort the returned record-set by a single specified sort order.
page int Page number.
rows int Number of rows per page.
region int Specifies the search region ID.
district int Specifies the search district ID.
suburb int Specifies the search suburb ID.
dateFrom System.DateTime Specifies minimum start date for returned listings.
priceMin int Minimum property price.
priceMax int Maximum property price.
landAreaMin int Minimum land area in square meters.
landAreaMax int Maximum land area in square meters.
usage RuralPropertyUsage The usage of the property.
return global::Properties

SearchStores() public method

Performs the method:

Search for Stores.

As specified in the API Documentation.

Creates a query string using the paramaters provided - parameters can be null if they are not required for the request.

DOES NOT REQURE AUTHENTICATION.

public SearchStores ( string searchString = "", int page = 1, string category = "", StoreType storeType = StoreType.Normal ) : Stores
searchString string The string to search for.
page int The number of the page to retrieve.
category string The category to search in.
storeType StoreType The type of the store.
return Stores

SearchUsedMotors() public method

Performs the Search Method: Search Used Motors using the "query" string provided - should be the "Search/Motors/Used.xml" part of the url. It shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public SearchUsedMotors ( string query ) : Cars
query string The query string that will be added to the base url and used to connect to the API with.
return Cars

SearchUsedMotors() public method

Performs the Search Method: Search Used Motors. Creates a query string based on the parameters provided, can be null if the parameter is not required for the request.

DOES NOT REQUIRE AUTHENTICATION.
public SearchUsedMotors ( string searchString, int userRegion, SortOrder sortOrder, decimal priceMin, decimal priceMax, string make, string model, BodyStyle bodyStyle, int doorsMin, int doorsMax, Transmission transmission, int yearMax, int yearMin, int energySizeMin, int energySizeMax, int odometerMin, int odometerMax, ListingType listingType, System.DateTime dateFrom, int page, int rows ) : Cars
searchString string One or more keywords to use in a search query.
userRegion int Restricts search results to items from sellers located in the specified region.
sortOrder SortOrder Sort the returned record-set by a single specified sort order.
priceMin decimal Minimum price.
priceMax decimal Maximum price.
make string Car make.
model string Car model.
bodyStyle BodyStyle Car body style.
doorsMin int Minimum number of doors (range from 2 to 5).
doorsMax int Maximum number of doors.
transmission Transmission Transmission type.
yearMax int Maximum year of manufacture.
yearMin int Minimum year of manufacture.
energySizeMin int Minimum engine size in cubic centimetres (e.g. 2000 for 2 litre engine).
energySizeMax int Maximum engine size.
odometerMin int Minimum odometer value in kilometres.
odometerMax int Maximum odometer value.
listingType ListingType Type of listing.
dateFrom System.DateTime Return only listings started from this date.
page int Page number.
rows int Number of rows per page.
return Cars