SnCore::WebServices::WebPlaceService

WebPlaceService Class Reference

Place information services. More...

List of all members.

Public Member Functions

int CreateOrUpdatePlaceType (string ticket, TransitPlaceType type)

Create or update a place type.

TransitPlaceType GetPlaceTypeById (string ticket, int id)

Get a place type.

List< TransitPlaceType > GetPlaceTypes (string ticket, ServiceQueryOptions options)

Get all place types.

int GetPlaceTypesCount (string ticket)

Get all place types count.

void DeletePlaceType (string ticket, int id)

Delete a place type

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdatePlace (string ticket, TransitPlace place)

Create or update a place.

TransitPlace GetPlaceById (string ticket, int id)

Get a place.

int GetPlacesCount (string ticket, TransitPlaceQueryOptions qopt)

Get places count.

List< TransitPlace > GetPlaces (string ticket, TransitPlaceQueryOptions qopt, ServiceQueryOptions options)

Get all places.

void DeletePlace (string ticket, int id)

Delete a place.

Parameters:

	ticket	authentication ticket
	id	id

TransitPlace FindPlace (string ticket, string citytag, string name)

Find a place.

List< TransitPlace > GetNewPlaces (string ticket, ServiceQueryOptions options)

Get new places.

int CreateOrUpdatePlacePicture (string ticket, TransitPlacePicture placepicture)

Create or update a place picture.

TransitPlacePicture GetPlacePictureById (string ticket, int id)

Get a place picture.

int GetPlacePicturesCount (string ticket, int id)

Get place pictures count.

List< TransitPlacePicture > GetPlacePictures (string ticket, int id, ServiceQueryOptions options)

Get all place pictures.

void DeletePlacePicture (string ticket, int id)

Delete a place picture

Parameters:

	ticket	authentication ticket
	id	id

TransitPlacePicture GetPlacePictureIfModifiedSinceById (string ticket, int id, DateTime ifModifiedSince)

Get a place picture picture if modified since.

int CreateOrUpdateAccountPlaceType (string ticket, TransitAccountPlaceType type)

Create or update a account place type.

TransitAccountPlaceType GetAccountPlaceTypeById (string ticket, int id)

Get a account place type.

List< TransitAccountPlaceType > GetAccountPlaceTypes (string ticket, ServiceQueryOptions options)

Get all account place types.

int GetAccountPlaceTypesCount (string ticket)

Get all account place types count.

void DeleteAccountPlaceType (string ticket, int id)

Delete a account place type

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdateAccountPlace (string ticket, TransitAccountPlace accountplace)

Create or update a account place.

TransitAccountPlace GetAccountPlaceById (string ticket, int id)

Get a account place.

int GetAccountPlacesCountByPlaceId (string ticket, int id)

Get account places count by place id.

List< TransitAccountPlace > GetAccountPlacesByPlaceId (string ticket, int id, ServiceQueryOptions options)

Get account places by place id.

int GetAccountPlacesCount (string ticket, int id)

Get account places count by account id.

List< TransitAccountPlace > GetAccountPlaces (string ticket, int id, ServiceQueryOptions options)

Get account places by account id.

void DeleteAccountPlace (string ticket, int id)

Delete a account place.

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdateAccountPlaceRequest (string ticket, TransitAccountPlaceRequest request)

Create or update an account place request.

TransitAccountPlaceRequest GetAccountPlaceRequestById (string ticket, int id)

Get a place request.

int GetAccountPlaceRequestsCount (string ticket)

Get place requests count.

List< TransitAccountPlaceRequest > GetAccountPlaceRequests (string ticket, ServiceQueryOptions options)

Get place requests.

int GetAccountPlaceRequestsCountByPlaceId (string ticket, int id)

Get place requests count by place id.

List< TransitAccountPlaceRequest > GetAccountPlaceRequestsByPlaceId (string ticket, int id, ServiceQueryOptions options)

Get place requests by place id.

void DeleteAccountPlaceRequest (string ticket, int id)

Delete a place request.

Parameters:

	ticket	authentication ticket
	id	id

void AcceptAccountPlaceRequest (string ticket, int id, string message)

Approve a place request.

Parameters:

	ticket	authentication ticket
	id	id

void RejectAccountPlaceRequest (string ticket, int id, string message)

Reject a place request.

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdateAccountPlaceFavorite (string ticket, TransitAccountPlaceFavorite apf)

Create or update an account place favorite.

bool IsAccountPlaceFavorite (string ticket, int user_id, int place_id)

Is a place your favorite?

TransitAccountPlaceFavorite GetAccountPlaceFavoriteById (string ticket, int id)

Get an account place favorite.

int GetAccountPlaceFavoritesCount (string ticket, int id)

Get account place favorites count by place id.

List< TransitAccountPlaceFavorite > GetAccountPlaceFavorites (string ticket, int id, ServiceQueryOptions options)

Get account place favorites by place id.

int GetAccountPlaceFavoritesCountByAccountId (string ticket, int id)

Get account place favorites count.

List< TransitAccountPlaceFavorite > GetAccountPlaceFavoritesByAccountId (string ticket, int id, ServiceQueryOptions options)

Get account place favorites by account id.

void DeleteAccountPlaceFavorite (string ticket, int id)

Delete an account place favorite.

Parameters:

	ticket	authentication ticket
	id	id

List< TransitPlace > SearchPlaces (string ticket, string s, ServiceQueryOptions options)

Search places.

int SearchPlacesCount (string ticket, string s)

Return the number of places matching a query.

int CreateOrUpdatePlaceName (string ticket, TransitPlaceName placename)

Create or update a place name.

TransitPlaceName GetPlaceNameById (string ticket, int id)

Get a place name.

int GetPlaceNamesCount (string ticket, int id)

Get all place names count.

List< TransitPlaceName > GetPlaceNames (string ticket, int id, ServiceQueryOptions options)

Get all place names.

void DeletePlaceName (string ticket, int id)

Delete a place name

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdatePlacePropertyGroup (string ticket, TransitPlacePropertyGroup pg)

Create or update a property group.

TransitPlacePropertyGroup GetPlacePropertyGroupById (string ticket, int id)

Get a property group.

int GetPlacePropertyGroupsCount (string ticket)

Get all property groups count.

List< TransitPlacePropertyGroup > GetPlacePropertyGroups (string ticket, ServiceQueryOptions options)

Get all property groups.

void DeletePlacePropertyGroup (string ticket, int id)

Delete a property group

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdatePlaceProperty (string ticket, TransitPlaceProperty p)

Create or update a property.

TransitPlaceProperty GetPlacePropertyById (string ticket, int id)

Get a place property.

int GetPlacePropertiesCount (string ticket, int gid)

Get all properties count.

List< TransitPlaceProperty > GetPlaceProperties (string ticket, int gid, ServiceQueryOptions options)

Get all properties.

void DeletePlaceProperty (string ticket, int id)

Delete a property

Parameters:

	ticket	authentication ticket
	id	id

List< TransitDistinctPlacePropertyValue > GetDistinctPropertyValues (string ticket, string groupname, string propertyname, ServiceQueryOptions options)

Get distinct place property values.

List< TransitPlace > GetPlacesByPropertyValue (string ticket, string groupname, string propertyname, string propertyvalue, ServiceQueryOptions options)

Get places that match a property value by name.

int GetPlacesByPropertyValueCount (string ticket, string groupname, string propertyname, string propertyvalue)

Get the number of places that match a property value by name.

TransitPlacePropertyValue GetPlacePropertyValueByName (string ticket, int placeid, string groupname, string propertyname)

Get a place property value by name.

int CreateOrUpdatePlacePropertyValue (string ticket, TransitPlacePropertyValue propertyvalue)

Create or update a place property value.

TransitPlacePropertyValue GetPlacePropertyValueById (string ticket, int id)

Get a place property value.

int GetPlacePropertyValuesCount (string ticket, int placeid, int groupid)

Get place property values count.

List< TransitPlacePropertyValue > GetPlacePropertyValues (string ticket, int placeid, int groupid, ServiceQueryOptions options)

Get place property values.

List< TransitPlacePropertyValue > GetAllPlacePropertyValuesById (string ticket, int placeid, int groupid)

Get all place property values, including unfilled ones.

void DeletePlacePropertyValue (string ticket, int id)

Delete a place property value.

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdatePlaceAttribute (string ticket, TransitPlaceAttribute attribute)

Create or update a place attribute.

TransitPlaceAttribute GetPlaceAttributeById (string ticket, int id)

Get place attributes.

int GetPlaceAttributesCount (string ticket, int id)

Get place attributes count.

List< TransitPlaceAttribute > GetPlaceAttributes (string ticket, int id, ServiceQueryOptions options)

Get place attributes.

void DeletePlaceAttribute (string ticket, int id)

Delete a place attribute.

Parameters:

	ticket	authentication ticket
	id	id

int GetFavoritePlacesCount (string ticket)

Get favorite (popular) places count.

List< TransitPlace > GetFavoritePlaces (string ticket, ServiceQueryOptions serviceoptions)

Get favorite (popular) places.

int CreateOrUpdatePlaceQueue (string ticket, TransitPlaceQueue queue)

Create or update a place queue.

TransitPlaceQueue GetPlaceQueueById (string ticket, int id)

Get a place queue.

TransitPlaceQueue GetPlaceQueueByName (string ticket, int user_id, string name)

Get a place queue by name.

TransitPlaceQueue GetOrCreatePlaceQueueByName (string ticket, int user_id, string name)

Get or create a place queue by name, create if doesn't exist.

List< TransitPlaceQueue > GetPlaceQueues (string ticket, int id, ServiceQueryOptions options)

Get all place queues by user id.

int GetPlaceQueuesCount (string ticket, int id)

Get number of all place queues by user id.

void DeletePlaceQueue (string ticket, int id)

Delete a place queue

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdatePlaceQueueItem (string ticket, TransitPlaceQueueItem queueitem)

Create or update a place queue item.

TransitPlaceQueueItem GetPlaceQueueItemById (string ticket, int id)

Get a place queue item.

List< TransitPlaceQueueItem > GetPlaceQueueItems (string ticket, int id, ServiceQueryOptions options)

Get all place queue items in a queue.

int GetPlaceQueueItemsCount (string ticket, int id)

Get place queue items count.

void DeletePlaceQueueItem (string ticket, int id)

Delete a place queueitem

Parameters:

	ticket	authentication ticket
	id	id

int GetFriendsPlaceQueueItemsCount (string ticket, int user_id)

Get all place queue items count in a queue of self and friends.

List< TransitFriendsPlaceQueueItem > GetFriendsPlaceQueueItems (string ticket, int user_id, ServiceQueryOptions options)

Get all place queue items in a queue of self and friends.

List< TransitDistinctPlaceNeighborhood > GetPlaceNeighborhoods (string ticket, string country, string state, string city, ServiceQueryOptions options)

Get all place neighborhoods.

void MergePlaces (string ticket, int id, TransitPlace target)

Merge places.

int CreateOrUpdatePlaceChangeRequest (string ticket, TransitPlaceChangeRequest request)

Create or update an account place change request.

TransitPlaceChangeRequest GetPlaceChangeRequestById (string ticket, int id)

Get a place change request.

int GetPlaceChangeRequestsCount (string ticket, int id)

Get place change requests count.

List< TransitPlaceChangeRequest > GetPlaceChangeRequests (string ticket, int id, ServiceQueryOptions options)

Get place change requests.

int GetPlaceChangeRequestsCountByPlaceId (string ticket, int id)

Get place change requests count by place id.

List< TransitPlaceChangeRequest > GetPlaceChangeRequestsByPlaceId (string ticket, int id, ServiceQueryOptions options)

Get place change requests by place id.

void DeletePlaceChangeRequest (string ticket, int id)

Delete a place change request.

Parameters:

	ticket	authentication ticket
	id	id

Protected Member Functions

IList< Place > InternalSearchPlaces (ISession session, string s, ServiceQueryOptions options)

Detailed Description

Place information services.

Member Function Documentation

int CreateOrUpdateAccountPlace	(	string	ticket,
		TransitAccountPlace	accountplace
	)

Create or update a account place.

Parameters:

	ticket	authentication ticket
	account place	transit account place

Returns:: account place id

int CreateOrUpdateAccountPlaceFavorite	(	string	ticket,
		TransitAccountPlaceFavorite	apf
	)

Create or update an account place favorite.

Parameters:

	ticket	authentication ticket
	apf	transit account place favorite

Returns:: account place favorite id

int CreateOrUpdateAccountPlaceRequest	(	string	ticket,
		TransitAccountPlaceRequest	request
	)

Create or update an account place request.

Parameters:

	ticket	authentication ticket
	request	transit place request

Returns:: place id

int CreateOrUpdateAccountPlaceType	(	string	ticket,
		TransitAccountPlaceType	type
	)

Create or update a account place type.

Parameters:

	ticket	authentication ticket
	type	transit account place type

int CreateOrUpdatePlace	(	string	ticket,
		TransitPlace	place
	)

Create or update a place.

Parameters:

	ticket	authentication ticket
	place	transit place

Returns:: place id

int CreateOrUpdatePlaceAttribute	(	string	ticket,
		TransitPlaceAttribute	attribute
	)

Create or update a place attribute.

Parameters:

	ticket	authentication ticket
	type	transit place attribute

int CreateOrUpdatePlaceChangeRequest	(	string	ticket,
		TransitPlaceChangeRequest	request
	)

Create or update an account place change request.

Parameters:

	ticket	authentication ticket
	request	transit place change request

Returns:: place id

int CreateOrUpdatePlaceName	(	string	ticket,
		TransitPlaceName	placename
	)

Create or update a place name.

Parameters:

	ticket	authentication ticket
	placename	transit place name

int CreateOrUpdatePlacePicture	(	string	ticket,
		TransitPlacePicture	placepicture
	)

Create or update a place picture.

Parameters:

	ticket	authentication ticket
	placepicture	transit place picture

int CreateOrUpdatePlaceProperty	(	string	ticket,
		TransitPlaceProperty	p
	)

Create or update a property.

Parameters:

	ticket	authentication ticket
	property	transit property

int CreateOrUpdatePlacePropertyGroup	(	string	ticket,
		TransitPlacePropertyGroup	pg
	)

Create or update a property group.

Parameters:

	ticket	authentication ticket
	PropertyGroup	transit property group

int CreateOrUpdatePlacePropertyValue	(	string	ticket,
		TransitPlacePropertyValue	propertyvalue
	)

Create or update a place property value.

Parameters:

	ticket	authentication ticket
	type	transit place property value

int CreateOrUpdatePlaceQueue	(	string	ticket,
		TransitPlaceQueue	queue
	)

Create or update a place queue.

Parameters:

	ticket	authentication ticket
	queue	transit place queue

int CreateOrUpdatePlaceQueueItem	(	string	ticket,
		TransitPlaceQueueItem	queueitem
	)

Create or update a place queue item.

Parameters:

	ticket	authentication ticket
	queueitem	transit place queue item

int CreateOrUpdatePlaceType	(	string	ticket,
		TransitPlaceType	type
	)

Create or update a place type.

Parameters:

	ticket	authentication ticket
	type	transit place type

TransitPlace FindPlace	(	string	ticket,
		string	citytag,
		string	name
	)

Find a place.

Parameters:

	citytag	city name or tag
	name	place name

Returns:

TransitAccountPlace GetAccountPlaceById	(	string	ticket,
		int	id
	)

Get a account place.

Returns:: transit account place

TransitAccountPlaceFavorite GetAccountPlaceFavoriteById	(	string	ticket,
		int	id
	)

Get an account place favorite.

Returns:: transit account place favorite

List<TransitAccountPlaceFavorite> GetAccountPlaceFavorites	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get account place favorites by place id.

Returns:: transit account place favorites

List<TransitAccountPlaceFavorite> GetAccountPlaceFavoritesByAccountId	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get account place favorites by account id.

Returns:: transit account place favorites

int GetAccountPlaceFavoritesCount	(	string	ticket,
		int	id
	)

Get account place favorites count by place id.

Returns:: number of account place favorites

int GetAccountPlaceFavoritesCountByAccountId	(	string	ticket,
		int	id
	)

Get account place favorites count.

Parameters:

account id

Returns:: transit account place favorites count

TransitAccountPlaceRequest GetAccountPlaceRequestById	(	string	ticket,
		int	id
	)

Get a place request.

Returns:: transit place

List<TransitAccountPlaceRequest> GetAccountPlaceRequests	(	string	ticket,
		ServiceQueryOptions	options
	)

Get place requests.

Returns:: list of transit place requests

List<TransitAccountPlaceRequest> GetAccountPlaceRequestsByPlaceId	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get place requests by place id.

Returns:: list of transit place requests

int GetAccountPlaceRequestsCount

(

string

ticket

)

Get place requests count.

Returns:: number of transit place requests

int GetAccountPlaceRequestsCountByPlaceId	(	string	ticket,
		int	id
	)

Get place requests count by place id.

Returns:: number of transit place requests

List<TransitAccountPlace> GetAccountPlaces	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get account places by account id.

Returns:: transit account places

List<TransitAccountPlace> GetAccountPlacesByPlaceId	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get account places by place id.

Returns:: transit account places

int GetAccountPlacesCount	(	string	ticket,
		int	id
	)

Get account places count by account id.

Returns:: number of account places

int GetAccountPlacesCountByPlaceId	(	string	ticket,
		int	id
	)

Get account places count by place id.

Returns:: number of account places

TransitAccountPlaceType GetAccountPlaceTypeById	(	string	ticket,
		int	id
	)

Get a account place type.

Returns:: transit account place type

List<TransitAccountPlaceType> GetAccountPlaceTypes	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all account place types.

Returns:: list of transit account place types

int GetAccountPlaceTypesCount

(

string

ticket

)

Get all account place types count.

Returns:: number of transit account place types

List<TransitPlacePropertyValue> GetAllPlacePropertyValuesById	(	string	ticket,
		int	placeid,
		int	groupid
	)

Get all place property values, including unfilled ones.

Returns:: list of place property values

List<TransitDistinctPlacePropertyValue> GetDistinctPropertyValues	(	string	ticket,
		string	groupname,
		string	propertyname,
		ServiceQueryOptions	options
	)

Get distinct place property values.

Returns:: list of possible values

List<TransitPlace> GetFavoritePlaces	(	string	ticket,
		ServiceQueryOptions	serviceoptions
	)

Get favorite (popular) places.

Returns:: list of transit places

int GetFavoritePlacesCount

(

string

ticket

)

Get favorite (popular) places count.

Returns:: list of transit places

List<TransitFriendsPlaceQueueItem> GetFriendsPlaceQueueItems	(	string	ticket,
		int	user_id,
		ServiceQueryOptions	options
	)

Get all place queue items in a queue of self and friends.

Returns:: list of transit place queue items

List<TransitPlace> GetNewPlaces	(	string	ticket,
		ServiceQueryOptions	options
	)

Get new places.

Returns:: transit places

TransitPlaceQueue GetOrCreatePlaceQueueByName	(	string	ticket,
		int	user_id,
		string	name
	)

Get or create a place queue by name, create if doesn't exist.

Returns:: transit place queue

TransitPlaceAttribute GetPlaceAttributeById	(	string	ticket,
		int	id
	)

Get place attributes.

Returns:: transit place attribute

List<TransitPlaceAttribute> GetPlaceAttributes	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get place attributes.

Returns:: list of place attributes

int GetPlaceAttributesCount	(	string	ticket,
		int	id
	)

Get place attributes count.

Returns:: number of place attributes

TransitPlace GetPlaceById	(	string	ticket,
		int	id
	)

Get a place.

Returns:: transit place

TransitPlaceChangeRequest GetPlaceChangeRequestById	(	string	ticket,
		int	id
	)

Get a place change request.

Returns:: transit place change request

List<TransitPlaceChangeRequest> GetPlaceChangeRequests	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get place change requests.

Returns:: list of transit place change requests