SnCore::WebServices::WebLocationService

WebLocationService Class Reference

The WebLocationService provides location information. More...


Public Member Functions
int	CreateOrUpdateCountry (string ticket, TransitCountry country)
	Create or update a country.
TransitCountry	GetCountryById (string ticket, int id)
	Get a country.
List< TransitCountry >	GetCountries (string ticket, ServiceQueryOptions options)
	Get all countries.
List< TransitCountry >	GetCountriesWithDefault (string ticket, string defaultname, ServiceQueryOptions options)
	Get all countries.
int	GetCountriesCount (string ticket)
	Get all countries count.
void	DeleteCountry (string ticket, int id)
	Delete a country.
int	CreateOrUpdateState (string ticket, TransitState state)
	Create or update a state.
TransitState	GetStateById (string ticket, int id)
	Get a state.
List< TransitState >	GetStates (string ticket, ServiceQueryOptions options)
	Get all states.
int	GetStatesCount (string ticket)
	Get all states count.
List< TransitState >	GetStatesByCountryId (string ticket, int id, ServiceQueryOptions options)
	Get all states within a country.
int	GetStatesByCountryIdCount (string ticket, int id)
	Get all states within a country count.
List< TransitState >	GetStatesByCountryName (string ticket, string name, ServiceQueryOptions options)
	Get all states within a country.
int	GetStatesByCountryNameCount (string ticket, string name)
	Get all states within a country count.
void	DeleteState (string ticket, int id)
	Delete a state.
int	CreateOrUpdateCity (string ticket, TransitCity city)
	Create or update a city.
TransitCity	GetCityById (string ticket, int id)
	Get a city.
List< TransitCity >	GetCities (string ticket, ServiceQueryOptions options)
	Get all cities.
List< TransitAccountCity >	GetAccountCities (string ticket, ServiceQueryOptions options)
	Get all cities by their account sums.
int	GetAccountCitiesCount (string ticket)
	Get all cities by their account sums count.
int	GetCitiesCount (string ticket)
	Get all cities count.
List< TransitCity >	GetCitiesByCountryId (string ticket, int id, ServiceQueryOptions options)
	Get all cities within a country.
List< TransitCity >	GetCitiesByStateId (string ticket, int id, ServiceQueryOptions options)
	Get all cities within a state.
List< TransitCity >	GetCitiesByLocation (string ticket, string country, string state, ServiceQueryOptions options)
	Get cities within a country and state.
List< TransitNeighborhood >	GetNeighborhoodsByLocation (string ticket, string country, string state, string city, ServiceQueryOptions options)
	Get neighborhoods within a country, state and city.
int	GetCitiesByCountryIdCount (string ticket, int id)
	Get all cities within a country count.
int	GetCitiesByStateIdCount (string ticket, int id)
	Get all cities within a state count.
void	DeleteCity (string ticket, int id)
	Delete a city.
List< TransitCity >	SearchCitiesByName (string ticket, string name, ServiceQueryOptions options)
	Get all cities with a matching name.
TransitCity	GetCityByTag (string ticket, string tag)
	Get city by tag.
int	MergeCities (string ticket, int target_id, int merge_id)
	Merge cities.
int	MergeCitiesByName (string ticket, int target_id, string name, string state, string country)
	Merge cities by city name.
int	CreateOrUpdateNeighborhood (string ticket, TransitNeighborhood neighborhood)
	Create or update a neighborhood.
TransitNeighborhood	GetNeighborhoodById (string ticket, int id)
	Get a neighborhood.
List< TransitNeighborhood >	GetNeighborhoods (string ticket, ServiceQueryOptions options)
	Get all neighborhoods.
int	GetNeighborhoodsCount (string ticket)
	Get all neighborhoods count.
List< TransitNeighborhood >	GetNeighborhoodsByCityId (string ticket, int id, ServiceQueryOptions options)
	Get all neighborhoods within a city.
int	GetNeighborhoodsByCityIdCount (string ticket, int id)
	Get all neighborhouds within a city count.
void	DeleteNeighborhood (string ticket, int id)
	Delete a neighborhood.
List< TransitNeighborhood >	SearchNeighborhoodsByName (string ticket, string name, ServiceQueryOptions options)
	Get all neighborhoods with a matching name.
int	MergeNeighborhoods (string ticket, int target_id, int merge_id)
	Merge neighborhoods.

Detailed Description

The WebLocationService provides location information.

Member Function Documentation

int CreateOrUpdateCountry	(	string	ticket,
		TransitCountry	country
	)

Create or update a country.

Parameters:

	ticket	authentication ticket
	country	transit country

TransitCountry GetCountryById	(	string	ticket,
		int	id
	)

Get a country.

Returns:: transit country

List<TransitCountry> GetCountries	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all countries.

Returns:: list of transit countries

List<TransitCountry> GetCountriesWithDefault	(	string	ticket,
		string	defaultname,
		ServiceQueryOptions	options
	)

Get all countries.

Returns:: list of transit countries

int GetCountriesCount ( string ticket )

Get all countries count.

Returns:: number of countries

void DeleteCountry	(	string	ticket,
		int	id
	)

Delete a country.

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdateState	(	string	ticket,
		TransitState	state
	)

Create or update a state.

Parameters:

	ticket	authentication ticket
	state	transit state

TransitState GetStateById	(	string	ticket,
		int	id
	)

Get a state.

Returns:: transit state

List<TransitState> GetStates	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all states.

Returns:: list of transit states

int GetStatesCount ( string ticket )

Get all states count.

Returns:: number of states

List<TransitState> GetStatesByCountryId	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get all states within a country.

Returns:: list of transit states

int GetStatesByCountryIdCount	(	string	ticket,
		int	id
	)

Get all states within a country count.

Returns:: number of states

List<TransitState> GetStatesByCountryName	(	string	ticket,
		string	name,
		ServiceQueryOptions	options
	)

Get all states within a country.

Returns:: list of transit states

int GetStatesByCountryNameCount	(	string	ticket,
		string	name
	)

Get all states within a country count.

Returns:: number of states

void DeleteState	(	string	ticket,
		int	id
	)

Delete a state.

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdateCity	(	string	ticket,
		TransitCity	city
	)

Create or update a city.

Parameters:

	ticket	authentication ticket
	city	transit city

TransitCity GetCityById	(	string	ticket,
		int	id
	)

Get a city.

Returns:: transit city

List<TransitCity> GetCities	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all cities.

Returns:: list of transit cities

List<TransitAccountCity> GetAccountCities	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all cities by their account sums.

Returns:: list of transit account cities

int GetAccountCitiesCount ( string ticket )

Get all cities by their account sums count.

Returns:: list of transit account cities

int GetCitiesCount ( string ticket )

Get all cities count.

Returns:: number of cities

List<TransitCity> GetCitiesByCountryId	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get all cities within a country.

Returns:: list of transit cities

List<TransitCity> GetCitiesByStateId	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get all cities within a state.

Returns:: list of transit cities

List<TransitCity> GetCitiesByLocation	(	string	ticket,
		string	country,
		string	state,
		ServiceQueryOptions	options
	)

Get cities within a country and state.

Parameters:

	state	state name
	country	country name

Returns:: list of cities

List<TransitNeighborhood> GetNeighborhoodsByLocation	(	string	ticket,
		string	country,
		string	state,
		string	city,
		ServiceQueryOptions	options
	)

Get neighborhoods within a country, state and city.

Parameters:

	city	city name
	state	state name
	country	country name

Returns:: list of neighborhoods

int GetCitiesByCountryIdCount	(	string	ticket,
		int	id
	)

Get all cities within a country count.

Returns:: number of cities

int GetCitiesByStateIdCount	(	string	ticket,
		int	id
	)

Get all cities within a state count.

Returns:: number of cities

void DeleteCity	(	string	ticket,
		int	id
	)

Delete a city.

Parameters:

	ticket	authentication ticket
	id	id

List<TransitCity> SearchCitiesByName	(	string	ticket,
		string	name,
		ServiceQueryOptions	options
	)

Get all cities with a matching name.

Returns:: list of cities

TransitCity GetCityByTag	(	string	ticket,
		string	tag
	)

Get city by tag.

Parameters:

tag

city tag

Returns:

int MergeCities	(	string	ticket,
		int	target_id,
		int	merge_id
	)

Merge cities.

Parameters:

ticket

authentication ticket

int MergeCitiesByName	(	string	ticket,
		int	target_id,
		string	name,
		string	state,
		string	country
	)

Merge cities by city name.

Parameters:

ticket

authentication ticket

int CreateOrUpdateNeighborhood	(	string	ticket,
		TransitNeighborhood	neighborhood
	)

Create or update a neighborhood.

Parameters:

	ticket	authentication ticket
	neighborhood	transit neighborhood

TransitNeighborhood GetNeighborhoodById	(	string	ticket,
		int	id
	)

Get a neighborhood.

Returns:: transit neighborhood

List<TransitNeighborhood> GetNeighborhoods	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all neighborhoods.

Returns:: list of transit neighborhoods

int GetNeighborhoodsCount ( string ticket )

Get all neighborhoods count.

Returns:: number of neighborhoods

List<TransitNeighborhood> GetNeighborhoodsByCityId	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get all neighborhoods within a city.

Returns:: list of transit neighborhoods

int GetNeighborhoodsByCityIdCount	(	string	ticket,
		int	id
	)

Get all neighborhouds within a city count.

Returns:: number of states

void DeleteNeighborhood	(	string	ticket,
		int	id
	)

Delete a neighborhood.

Parameters:

	ticket	authentication ticket
	id	id

List<TransitNeighborhood> SearchNeighborhoodsByName	(	string	ticket,
		string	name,
		ServiceQueryOptions	options
	)

Get all neighborhoods with a matching name.

Returns:: list of neighborhoods

int MergeNeighborhoods	(	string	ticket,
		int	target_id,
		int	merge_id
	)

Merge neighborhoods.

Parameters:

ticket

authentication ticket

The documentation for this class was generated from the following file:

WebLocationService.cs

WebLocationService Class Reference

Public Member Functions

Detailed Description

Member Function Documentation