C# Class TradeMe.Api.Client.CatalogueMethods

The CatalogueMethods class contains the methods requried for making calls to the API related to the catalogue.
Afficher le fichier Open project: TradeMe/trade-me-api-wrapper Class Usage Examples

Méthodes publiques

Méthode Description
CatalogueMethods ( ConnectionMethods connect ) : System

Initializes a new instance of the CatalogueMethods class.
GetComplaintSubjects ( ) : ComplaintSubjectCollection

Performs the category method: Retrieves a list of possible complaint subjects. This is used in conjunction with the send a complaint API. GET

DOES NOT REQUIRE AUTHENTICATION.
GetMotorbikeMakes ( ) : MotorbikeMakeCollection

Performs the category method: Retrieves a list of all motorbike makes. Can be used when searching. GET

DOES NOT REQUIRE AUTHENTICATION.
RetrieveAttributesForCategory ( string categoryNumber ) : Attributes

Performs the category method: Retrieves the list of attributes which are applicable to a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.
RetrieveBluRayIds ( ) : BluRayValidations

Performs the category method: Returns a the list of Blu-ray catalogue ID numbers. You can use this list to validate the catalogue ID before listing a Blu-ray. GET

DOES NOT REQUIRE AUTHENTICATION.
RetrieveCategories ( ) : Category

Performs the category methods: Retrieve a list of all or part of our category tree.

DOES NOT REQUIRE AUTHENTICATION.
RetrieveCategoriesById ( string id ) : Category

Performs the category methods: Retrieve a list of all or part of our category tree. Does this by using the id string provided - should be the id of the category you wish to retrieve.

DOES NOT REQUIRE AUTHENTICATION.
RetrieveCategoriesByQueryString ( string query ) : Category

Performs the category methods: Retrieve a list of all or part of our category tree, Retrieve a list of Trade Me Motors used car categories, Retrieve a list of Trade Me Motors motorbike categories, using the "query" string provided - should be the "Categories/UsedCars.xml" part of the url it shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
RetrieveDurationOptionsForCategory ( string categoryNumber ) : ListingDurations

Performs the category method: Retrieves the default duration and the duration options that are available for listings in a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.
RetrieveDvdIds ( ) : DvdValidations

Performs the category method: Returns a list of DVD catalogue ID numbers. You can use this list to validate the catalogue ID before listing a DVD. GET

DOES NOT REQUIRE AUTHENTICATION.
RetrieveFeesForCategory ( string categoryNumber ) : ListingFees

Performs the category method: Retrieves a list of fees for a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.
RetrieveJobCategories ( ) : JobCategories

Performs the category method: Retrieve a list of Trade Me Jobs categories.

DOES NOT REQUIRE AUTHENTICATION.
RetrieveLegalNoticeForCategory ( string categoryNumber ) : LegalNotice

Performs the category method: Retrieves the legal notice that the user is required to agree to before listing. GET

DOES NOT REQUIRE AUTHENTICATION.
RetrieveLocalities ( string query ) : LocalityCollection

Performs the Localities methods: three-tier locality dataset, two-tier locality dataset,

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

DOES NOT REQUIRE AUTHENTICATION.
RetrieveLocalitiesThreeTier ( ) : LocalityCollection

Performs the Localities methods: three-tier locality dataset

Returns three-tier locality hierarchy of regions, districts and their respective suburbs. These values are used in Trade Me Property, Trade Me Jobs and Services.

DOES NOT REQUIRE AUTHENTICATION.
RetrieveLocalitiesTwoTier ( ) : LocalityCollection

Performs the Localities method: two-tier locality dataset.

Returns list of towns used in member registration. This information is displayed on member profile as “suburb” and also on listings where the approximate location of goods is important, such as in Trade Me Motors.

DOES NOT REQUIRE AUTHENTICATION.
RetrieveMotorBikeCategories ( ) : Category

Performs the category methods: Retrieve a list of Trade Me Motors motorbike categories.

DOES NOT REQUIRE AUTHENTICATION.
RetrieveTravelLocalities ( ) : LocalityCollection

Performs the category method: Returns a list of districts and suburbs as used by TradeMe travel. GET

DOES NOT REQUIRE AUTHENTICATION.
RetrieveUsedCarCategories ( ) : Category

Performs the category methods: Retrieve a list of Trade Me Motors used car categories.

DOES NOT REQUIRE AUTHENTICATION.
SearchBluRayCatalog ( String search = "" ) : MovieTitles

Performs the category method: Searches the Trade Me Blu-ray catalogue for movie titles. GET

DOES NOT REQUIRE AUTHENTICATION.
SearchDvdCatalog ( String search = "" ) : MovieTitles

Performs the category method: Searches the Trade Me DVD catalogue for movie titles. GET

DOES NOT REQUIRE AUTHENTICATION.

Method Details

CatalogueMethods() public méthode

Initializes a new instance of the CatalogueMethods class.
public CatalogueMethods ( ConnectionMethods connect ) : System
connect ConnectionMethods A ConnectionMethods class used to make calls to the API
Résultat System

GetComplaintSubjects() public méthode

Performs the category method: Retrieves a list of possible complaint subjects. This is used in conjunction with the send a complaint API. GET

DOES NOT REQUIRE AUTHENTICATION.
public GetComplaintSubjects ( ) : ComplaintSubjectCollection
Résultat ComplaintSubjectCollection

GetMotorbikeMakes() public méthode

Performs the category method: Retrieves a list of all motorbike makes. Can be used when searching. GET

DOES NOT REQUIRE AUTHENTICATION.
public GetMotorbikeMakes ( ) : MotorbikeMakeCollection
Résultat MotorbikeMakeCollection

RetrieveAttributesForCategory() public méthode

Performs the category method: Retrieves the list of attributes which are applicable to a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveAttributesForCategory ( string categoryNumber ) : Attributes
categoryNumber string The category number for which you wish to see the attributes for. /// This must be a leaf category (for example, you cannot view the attributes for Computers > Desktops, /// but you can for Computers > Desktops > CRT monitors).
Résultat Attributes

RetrieveBluRayIds() public méthode

Performs the category method: Returns a the list of Blu-ray catalogue ID numbers. You can use this list to validate the catalogue ID before listing a Blu-ray. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveBluRayIds ( ) : BluRayValidations
Résultat BluRayValidations

RetrieveCategories() public méthode

Performs the category methods: Retrieve a list of all or part of our category tree.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveCategories ( ) : Category
Résultat Category

RetrieveCategoriesById() public méthode

Performs the category methods: Retrieve a list of all or part of our category tree. Does this by using the id string provided - should be the id of the category you wish to retrieve.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveCategoriesById ( string id ) : Category
id string The id of the category you wish to retrieve.
Résultat Category

RetrieveCategoriesByQueryString() public méthode

Performs the category methods: Retrieve a list of all or part of our category tree, Retrieve a list of Trade Me Motors used car categories, Retrieve a list of Trade Me Motors motorbike categories, using the "query" string provided - should be the "Categories/UsedCars.xml" part of the url it shouldn't include "http://api.trademe.co.nz/v1/".

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveCategoriesByQueryString ( string query ) : Category
query string The query string that will be added to the base url and used to connect to the API with.
Résultat Category

RetrieveDurationOptionsForCategory() public méthode

Performs the category method: Retrieves the default duration and the duration options that are available for listings in a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveDurationOptionsForCategory ( string categoryNumber ) : ListingDurations
categoryNumber string The number of the category to retrieve durations for.
Résultat ListingDurations

RetrieveDvdIds() public méthode

Performs the category method: Returns a list of DVD catalogue ID numbers. You can use this list to validate the catalogue ID before listing a DVD. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveDvdIds ( ) : DvdValidations
Résultat DvdValidations

RetrieveFeesForCategory() public méthode

Performs the category method: Retrieves a list of fees for a specific category. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveFeesForCategory ( string categoryNumber ) : ListingFees
categoryNumber string The number of the category to retrieve fees for.
Résultat ListingFees

RetrieveJobCategories() public méthode

Performs the category method: Retrieve a list of Trade Me Jobs categories.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveJobCategories ( ) : JobCategories
Résultat JobCategories

RetrieveLegalNoticeForCategory() public méthode

Performs the category method: Retrieves the legal notice that the user is required to agree to before listing. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveLegalNoticeForCategory ( string categoryNumber ) : LegalNotice
categoryNumber string The category number for which you wish to see the legal notice for. /// The number of the category to retrieve the legal notice for. This must be a leaf category /// (for example, you cannot view the legal notice for Business, Farming and Industry, but you can /// for Business, Farming and Industry > Carbon credits).
Résultat LegalNotice

RetrieveLocalities() public méthode

Performs the Localities methods: three-tier locality dataset, two-tier locality dataset,

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

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveLocalities ( string query ) : LocalityCollection
query string The query string that will be added to the base url and used to connect to the API with.
Résultat LocalityCollection

RetrieveLocalitiesThreeTier() public méthode

Performs the Localities methods: three-tier locality dataset

Returns three-tier locality hierarchy of regions, districts and their respective suburbs. These values are used in Trade Me Property, Trade Me Jobs and Services.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveLocalitiesThreeTier ( ) : LocalityCollection
Résultat LocalityCollection

RetrieveLocalitiesTwoTier() public méthode

Performs the Localities method: two-tier locality dataset.

Returns list of towns used in member registration. This information is displayed on member profile as “suburb” and also on listings where the approximate location of goods is important, such as in Trade Me Motors.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveLocalitiesTwoTier ( ) : LocalityCollection
Résultat LocalityCollection

RetrieveMotorBikeCategories() public méthode

Performs the category methods: Retrieve a list of Trade Me Motors motorbike categories.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveMotorBikeCategories ( ) : Category
Résultat Category

RetrieveTravelLocalities() public méthode

Performs the category method: Returns a list of districts and suburbs as used by TradeMe travel. GET

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveTravelLocalities ( ) : LocalityCollection
Résultat LocalityCollection

RetrieveUsedCarCategories() public méthode

Performs the category methods: Retrieve a list of Trade Me Motors used car categories.

DOES NOT REQUIRE AUTHENTICATION.
public RetrieveUsedCarCategories ( ) : Category
Résultat Category

SearchBluRayCatalog() public méthode

Performs the category method: Searches the Trade Me Blu-ray catalogue for movie titles. GET

DOES NOT REQUIRE AUTHENTICATION.
public SearchBluRayCatalog ( String search = "" ) : MovieTitles
search String The partial title to search for.
Résultat MovieTitles

SearchDvdCatalog() public méthode

Performs the category method: Searches the Trade Me DVD catalogue for movie titles. GET

DOES NOT REQUIRE AUTHENTICATION.
public SearchDvdCatalog ( String search = "" ) : MovieTitles
search String The partial title to search for.
Résultat MovieTitles