C# Class Systran.GeographicClientLib.Api.POIApi

Represents a collection of functions to interact with the API endpoints
Inheritance: IPOIApi
Mostra file Open project: SYSTRAN/geographic-api-csharp-client Class Usage Examples

Public Methods

Method Description
GeographicPoiGetGet ( string Id, string AcceptLanguage, string Callback ) : PoiDetailsResponse

Get specific point of interest Get a specific `Point of interest`.
GeographicPoiGetGetAsync ( string Id, string AcceptLanguage, string Callback ) : Task

Get specific point of interest Get a specific `Point of interest`.
GeographicPoiListGet ( double Latitude, double Longitude, double Radius, double MaximumLatitude, double MaximumLongitude, double MinimumLatitude, double MinimumLongitude, List Filter, List Name, string MainType, List Type, string Address, string Country, string State, string County, string City, string PostalCode, string Street, string RankBy, bool OpenNow, int MinimumRating, int MaximumRating, int MinimumPrice, int MaximumPrice, int Limit, int Offset, string AcceptLanguage, string Callback ) : PoiResponse

List points of interest\n Get a list of `Points of interest`.\n\nThe main criteria can be:\n* a position and a radius\n* a bounding box\n* a textual search\n\nAdditional critera can be added.\n
GeographicPoiListGetAsync ( double Latitude, double Longitude, double Radius, double MaximumLatitude, double MaximumLongitude, double MinimumLatitude, double MinimumLongitude, List Filter, List Name, string MainType, List Type, string Address, string Country, string State, string County, string City, string PostalCode, string Street, string RankBy, bool OpenNow, int MinimumRating, int MaximumRating, int MinimumPrice, int MaximumPrice, int Limit, int Offset, string AcceptLanguage, string Callback ) : Task

List points of interest\n Get a list of `Points of interest`.\n\nThe main criteria can be:\n* a position and a radius\n* a bounding box\n* a textual search\n\nAdditional critera can be added.\n
GeographicPoiTypesGet ( string AcceptLanguage, string Callback ) : PoiTypesResponse

Get available point of interest types Get available `Point of interest` types.
GeographicPoiTypesGetAsync ( string AcceptLanguage, string Callback ) : Task

Get available point of interest types Get available `Point of interest` types.
GetBasePath ( String basePath ) : String

Gets the base path of the API client.
POIApi ( ApiClient apiClient = null ) : System

Initializes a new instance of the POIApi class.
POIApi ( String basePath ) : System

Initializes a new instance of the POIApi class.
SetBasePath ( String basePath ) : void

Sets the base path of the API client.

Method Details

GeographicPoiGetGet() public method

Get specific point of interest Get a specific `Point of interest`.
public GeographicPoiGetGet ( string Id, string AcceptLanguage, string Callback ) : PoiDetailsResponse
Id string POI 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.PoiDetailsResponse

GeographicPoiGetGetAsync() public method

Get specific point of interest Get a specific `Point of interest`.
public GeographicPoiGetGetAsync ( string Id, string AcceptLanguage, string Callback ) : Task
Id string POI 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

GeographicPoiListGet() public method

List points of interest\n Get a list of `Points of interest`.\n\nThe main criteria can be:\n* a position and a radius\n* a bounding box\n* a textual search\n\nAdditional critera can be added.\n
public GeographicPoiListGet ( double Latitude, double Longitude, double Radius, double MaximumLatitude, double MaximumLongitude, double MinimumLatitude, double MinimumLongitude, List Filter, List Name, string MainType, List Type, string Address, string Country, string State, string County, string City, string PostalCode, string Street, string RankBy, bool OpenNow, int MinimumRating, int MaximumRating, int MinimumPrice, int MaximumPrice, int Limit, int Offset, string AcceptLanguage, string Callback ) : PoiResponse
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.
MaximumLatitude double Latitude of the top (northernmost) side of the bounding box. Musts be used together with `maximumLongitude`, `minimumLatitude` and `minimumLongitude` parameters.
MaximumLongitude double Longitude of the right (easternmost) side of the bounding box. Musts be used together with `maximumLatitude`, `minimumLatitude` and `minimumLongitude` parameters.
MinimumLatitude double Latitude of the bottom (southernmost) side of the bounding box. Musts be used together with `maximumLatitude`, `maximumLongitude` and `minimumLongitude` parameters.
MinimumLongitude double Longitude of the left (westernmost) side of the bounding box. Musts be used together with `maximumLatitude`, `maximumLongitude` and `minimumLatitude` parameters.
Filter List Filter on all relevent POI data (name, type, address, ...)
Name List POI name
MainType string POI main type
Type List POI type
Address string POI address
Country string POI country
State string POI state
County string POI county
City string POI city
PostalCode string POI postal code
Street string POI street
RankBy string Ranking criteria
OpenNow bool Only open for business POI
MinimumRating int Minimum rating (from 1 to 5)
MaximumRating int Maximum rating (from 1 to 5)
MinimumPrice int Minimum price level (from 0 to 3)
MaximumPrice int Maximum price level (from 0 to 3)
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.PoiResponse

GeographicPoiListGetAsync() public method

List points of interest\n Get a list of `Points of interest`.\n\nThe main criteria can be:\n* a position and a radius\n* a bounding box\n* a textual search\n\nAdditional critera can be added.\n
public GeographicPoiListGetAsync ( double Latitude, double Longitude, double Radius, double MaximumLatitude, double MaximumLongitude, double MinimumLatitude, double MinimumLongitude, List Filter, List Name, string MainType, List Type, string Address, string Country, string State, string County, string City, string PostalCode, string Street, string RankBy, bool OpenNow, int MinimumRating, int MaximumRating, int MinimumPrice, int MaximumPrice, 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.
MaximumLatitude double Latitude of the top (northernmost) side of the bounding box. Musts be used together with `maximumLongitude`, `minimumLatitude` and `minimumLongitude` parameters.
MaximumLongitude double Longitude of the right (easternmost) side of the bounding box. Musts be used together with `maximumLatitude`, `minimumLatitude` and `minimumLongitude` parameters.
MinimumLatitude double Latitude of the bottom (southernmost) side of the bounding box. Musts be used together with `maximumLatitude`, `maximumLongitude` and `minimumLongitude` parameters.
MinimumLongitude double Longitude of the left (westernmost) side of the bounding box. Musts be used together with `maximumLatitude`, `maximumLongitude` and `minimumLatitude` parameters.
Filter List Filter on all relevent POI data (name, type, address, ...)
Name List POI name
MainType string POI main type
Type List POI type
Address string POI address
Country string POI country
State string POI state
County string POI county
City string POI city
PostalCode string POI postal code
Street string POI street
RankBy string Ranking criteria
OpenNow bool Only open for business POI
MinimumRating int Minimum rating (from 1 to 5)
MaximumRating int Maximum rating (from 1 to 5)
MinimumPrice int Minimum price level (from 0 to 3)
MaximumPrice int Maximum price level (from 0 to 3)
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

GeographicPoiTypesGet() public method

Get available point of interest types Get available `Point of interest` types.
public GeographicPoiTypesGet ( string AcceptLanguage, string Callback ) : PoiTypesResponse
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.PoiTypesResponse

GeographicPoiTypesGetAsync() public method

Get available point of interest types Get available `Point of interest` types.
public GeographicPoiTypesGetAsync ( string AcceptLanguage, string Callback ) : Task
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

POIApi() public method

Initializes a new instance of the POIApi class.
public POIApi ( ApiClient apiClient = null ) : System
apiClient Systran.GeographicClientLib.Client.ApiClient
return System

POIApi() public method

Initializes a new instance of the POIApi class.
public POIApi ( 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