C# Class Systran.GeographicClientLib.Api.InspirationsApi

Represents a collection of functions to interact with the API endpoints

Inheritance: IInspirationsApi

Show file Open project: SYSTRAN/geographic-api-csharp-client Class Usage Examples

Public Methods

Method	Description
GeographicInspirationsDossiersListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse	List dossiers Get a list of `Inspirations` of type `dossier`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsDossiersListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task	List dossiers Get a list of `Inspirations` of type `dossier`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsEventsListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse	List events Get a list of `Inspirations` of type `event`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsEventsListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task	List events Get a list of `Inspirations` of type `event`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsGetGet ( string Id, string AcceptLanguage, string Callback ) : InspirationDetailsResponse	Get specific Inspiration Get a specific `Inspiration`.
GeographicInspirationsGetGetAsync ( string Id, string AcceptLanguage, string Callback ) : Task	Get specific Inspiration Get a specific `Inspiration`.
GeographicInspirationsListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse	List inspirations Get a list of `Inspirations`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task	List inspirations Get a list of `Inspirations`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsNewsInBriefListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse	List news in brief Get a list of `Inspirations` of type `news in brief`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsNewsInBriefListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task	List news in brief Get a list of `Inspirations` of type `news in brief`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsSlideShowsListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse	List slide shows Get a list of `Inspirations` of type `slide show`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsSlideShowsListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task	List slide shows Get a list of `Inspirations` of type `slide show`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsTestsListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse	List tests Get a list of `Inspirations` of type `test`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GeographicInspirationsTestsListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task	List tests Get a list of `Inspirations` of type `test`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n
GetBasePath ( String basePath ) : String	Gets the base path of the API client.
InspirationsApi ( ApiClient apiClient = null ) : System	Initializes a new instance of the InspirationsApi class.
InspirationsApi ( String basePath ) : System	Initializes a new instance of the InspirationsApi class.
SetBasePath ( String basePath ) : void	Sets the base path of the API client.

Method Details

GeographicInspirationsDossiersListGet() public method

List dossiers Get a list of `Inspirations` of type `dossier`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsDossiersListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Systran.GeographicClientLib.Model.InspirationResponse

GeographicInspirationsDossiersListGetAsync() public method

List dossiers Get a list of `Inspirations` of type `dossier`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsDossiersListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Task

GeographicInspirationsEventsListGet() public method

List events Get a list of `Inspirations` of type `event`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsEventsListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Systran.GeographicClientLib.Model.InspirationResponse

GeographicInspirationsEventsListGetAsync() public method

List events Get a list of `Inspirations` of type `event`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsEventsListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Task

GeographicInspirationsGetGet() public method

Get specific Inspiration Get a specific `Inspiration`.

public GeographicInspirationsGetGet ( string Id, string AcceptLanguage, string Callback ) : InspirationDetailsResponse
Id	string	Inspiration identifier
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Systran.GeographicClientLib.Model.InspirationDetailsResponse

GeographicInspirationsGetGetAsync() public method

Get specific Inspiration Get a specific `Inspiration`.

public GeographicInspirationsGetGetAsync ( string Id, string AcceptLanguage, string Callback ) : Task
Id	string	Inspiration identifier
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Task

GeographicInspirationsListGet() public method

List inspirations Get a list of `Inspirations`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Systran.GeographicClientLib.Model.InspirationResponse

GeographicInspirationsListGetAsync() public method

List inspirations Get a list of `Inspirations`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Task

GeographicInspirationsNewsInBriefListGet() public method

List news in brief Get a list of `Inspirations` of type `news in brief`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsNewsInBriefListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Systran.GeographicClientLib.Model.InspirationResponse

GeographicInspirationsNewsInBriefListGetAsync() public method

List news in brief Get a list of `Inspirations` of type `news in brief`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsNewsInBriefListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Task

GeographicInspirationsSlideShowsListGet() public method

List slide shows Get a list of `Inspirations` of type `slide show`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsSlideShowsListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	InspirationResponse

GeographicInspirationsSlideShowsListGetAsync() public method

List slide shows Get a list of `Inspirations` of type `slide show`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsSlideShowsListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Task

GeographicInspirationsTestsListGet() public method

List tests Get a list of `Inspirations` of type `test`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsTestsListGet ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : InspirationResponse
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	InspirationResponse

GeographicInspirationsTestsListGetAsync() public method

List tests Get a list of `Inspirations` of type `test`.\n\nThe main criteria can be:\n* a position and a radius\n* a textual search\n\nAdditional critera can be added.\n

public GeographicInspirationsTestsListGetAsync ( double Latitude, double Longitude, double Radius, string Address, string Country, string State, string County, string City, string PostalCode, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task
Latitude	double	Latitude location. Musts be used together with `longitude` and `radius` parameters.
Longitude	double	Longitude location. Musts be used together with `latitude` and `radius` parameters.
Radius	double	Radius in meters. Musts be used together with `latitude` and `longitude` parameters.
Address	string	Address
Country	string	Country
State	string	State
County	string	County
City	string	City
PostalCode	string	Postal Code
Limit	int	Pagination limit
Offset	int	Pagination offset
AcceptLanguage	string	Preferred languages for response localization.\n\nSee [Accept-Language header specification for HTTP\n1.1](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n
Callback	string	Javascript callback function name for JSONP Support\n
return	Task

GetBasePath() public method

Gets the base path of the API client.

public GetBasePath ( String basePath ) : String
basePath	String
return	String

InspirationsApi() public method

Initializes a new instance of the InspirationsApi class.

public InspirationsApi ( ApiClient apiClient = null ) : System
apiClient	ApiClient
return	System

InspirationsApi() public method

Initializes a new instance of the InspirationsApi class.

public InspirationsApi ( String basePath ) : System
basePath	String
return	System

SetBasePath() public method

Sets the base path of the API client.

public SetBasePath ( String basePath ) : void
basePath	String
return	void