SnCore::WebServices::WebObjectService

WebObjectService Class Reference

Managed web business objects services. More...


Public Member Functions
int	CreateOrUpdateSchedule (string ticket, TransitSchedule schedule)
	Create or update a schedule.
TransitSchedule	GetScheduleById (string ticket, int id)
	Get a schedule.
List< TransitSchedule >	GetSchedules (string ticket, ServiceQueryOptions options)
	Get all schedules.
int	GetSchedulesCount (string ticket)
	Get all schedules count.
void	DeleteSchedule (string ticket, int id)
	Delete a schedule.
string	GetScheduleString (string ticket, TransitSchedule schedule, int offset)
	Get a humanly readable representation of a schedule.
int	CreateOrUpdateAttribute (string ticket, TransitAttribute attr)
	Create or update an attribute.
TransitAttribute	GetAttributeById (string ticket, int id)
	Get an attribute.
TransitAttribute	GetAttributeIfModifiedSinceById (string ticket, int id, DateTime ifModifiedSince)
	Get attribute data if modified since.
int	GetAttributesCount (string ticket)
	Get all attributes count.
List< TransitAttribute >	GetAttributes (string ticket, ServiceQueryOptions options)
	Get all attributes.
void	DeleteAttribute (string ticket, int id)
	Delete an attribute.
List< TransitSurveyQuestion >	GetSurveyQuestions (string ticket, int id, ServiceQueryOptions options)
	Get survey questions.
int	GetSurveyQuestionsCount (string ticket, int id)
	Get survey questions count.
TransitSurveyQuestion	GetSurveyQuestionById (string ticket, int id)
	Get survey question by id.
int	CreateOrUpdateSurveyQuestion (string ticket, TransitSurveyQuestion surveyquestion)
	Create or update a survey question.
void	DeleteSurveyQuestion (string ticket, int id)
	Delete a survey question.
int	CreateOrUpdateSurvey (string ticket, TransitSurvey survey)
	Create or update a survey.
void	DeleteSurvey (string ticket, int id)
	Delete a survey.
List< TransitSurvey >	GetSurveys (string ticket, ServiceQueryOptions options)
	Get surveys.
int	GetSurveysCount (string ticket)
	Get surveys count.
TransitSurvey	GetSurveyById (string ticket, int id)
	Get a survey by id.
int	CreateOrUpdatePicture (string ticket, TransitPicture picture)
	Create or update a picture.
TransitPicture	GetPictureById (string ticket, int id)
	Get a picture.
TransitPicture	GetPictureIfModifiedSinceById (string ticket, int id, DateTime ifModifiedSince)
	Get a picture if modified since.
TransitPicture	GetRandomPictureByType (string ticket, string type)
	Get random picture.
List< TransitPicture >	GetPictures (string ticket, ServiceQueryOptions options)
	Get all pictures.
int	GetPicturesCount (string ticket)
	Get all pictures count.
void	DeletePicture (string ticket, int id)
	Delete a picture.
int	CreateOrUpdatePictureType (string ticket, TransitPictureType picturetype)
	Create or update a picture type.
TransitPictureType	GetPictureTypeById (string ticket, int id)
	Get a picture type.
List< TransitPictureType >	GetPictureTypes (string ticket, ServiceQueryOptions options)
	Get all picture types.
int	GetPictureTypesCount (string ticket)
	Get all picture types count.
void	DeletePictureType (string ticket, int id)
	Delete a picture type.
int	CreateOrUpdateReminder (string ticket, TransitReminder reminder)
	Create or update a reminder.
TransitReminder	GetReminderById (string ticket, int id)
	Get a reminder.
List< TransitReminder >	GetReminders (string ticket, ServiceQueryOptions options)
	Get all reminders.
int	GetRemindersCount (string ticket)
	Get all reminders count.
void	DeleteReminder (string ticket, int id)
	Delete a reminder.
bool	CanSendReminder (int reminder_id, int account_id)
	Test whether a reminder is being sent to an account.
int	CreateOrUpdateReminderAccountProperty (string ticket, TransitReminderAccountProperty reminderaccountproperty)
	Create or update a reminder account property.
TransitReminderAccountProperty	GetReminderAccountPropertyById (string ticket, int id)
	Get a reminder account property.
int	GetReminderAccountPropertiesCount (string ticket, int id)
	Get all reminder account properties count.
List < TransitReminderAccountProperty >	GetReminderAccountProperties (string ticket, int id, ServiceQueryOptions options)
	Get all reminder account properties.
void	DeleteReminderAccountProperty (string ticket, int id)
	Delete a reminder account property.
int	CreateOrUpdateReminderEvent (string ticket, TransitReminderEvent reminderevent)
	Create or update a reminder event.
TransitReminderEvent	GetReminderEventById (string ticket, int id)
	Get a reminder event.
List< TransitReminderEvent >	GetReminderEvents (string ticket, ServiceQueryOptions options)
	Get all reminder events.
int	GetReminderEventsCount (string ticket)
	Get all reminder events count.
void	DeleteReminderEvent (string ticket, int id)
	Delete a reminder event.
int	CreateOrUpdateDataObject (string ticket, TransitDataObject dataobject)
	Create or update a data object.
TransitDataObject	GetDataObjectById (string ticket, int id)
	Get a data object.
List< TransitDataObject >	GetDataObjects (string ticket, ServiceQueryOptions options)
	Get all data objects.
int	GetDataObjectsCount (string ticket)
	Get all data objects count.
void	DeleteDataObject (string ticket, int id)
	Delete a data object.
List< string >	GetDataObjectFieldsById (string ticket, int id)
	Get data object fields.
int	CreateOrUpdateBookmark (string ticket, TransitBookmark bookmark)
	Create or update a bookmark.
TransitBookmark	GetBookmarkById (string ticket, int id)
	Get a bookmark.
TransitBookmark	GetBookmarkIfModifiedSinceById (string ticket, int id, DateTime ifModifiedSince)
	Get a bookmark if modified since.
List< TransitBookmark >	GetBookmarks (string ticket, ServiceQueryOptions options)
	Get all bookmarks.
int	GetBookmarksCount (string ticket)
	Get all bookmarks count.
void	DeleteBookmark (string ticket, int id)
	Delete a bookmark.
List< TransitBookmark >	GetBookmarksWithOptions (string ticket, BookmarkQueryOptions qopt, ServiceQueryOptions options)
	Get all bookmarks that have bitmaps associated.
int	CreateOrUpdateFeature (string ticket, TransitFeature feature)
	Feature an object.
TransitFeature	GetFeatureById (string ticket, int id)
	Get a feature.
int	GetFeaturesCount (string ticket, string featuretype)
	Get the number of features of a certain type.
List< TransitFeature >	GetFeatures (string ticket, string featuretype, ServiceQueryOptions options)
	Get all features of a certain type.
TransitFeature	GetLatestFeature (string ticket, string featuretype)
	Get latest feature of a certain type.
TransitFeature	FindLatestFeature (string ticket, string featuretype, int objectid)
	Find the latest feature of a certain type for an item.
void	DeleteFeature (string ticket, int id)
	Delete a feature.
void	DeleteAllFeatures (string ticket, TransitFeature token)
	Delete all features of an object.

Detailed Description

Managed web business objects services.

Member Function Documentation

int CreateOrUpdateSchedule	(	string	ticket,
		TransitSchedule	schedule
	)

Create or update a schedule.

Parameters:

	ticket	authentication ticket
	schedule	transit schedule

TransitSchedule GetScheduleById	(	string	ticket,
		int	id
	)

Get a schedule.

Returns:: transit schedule

List<TransitSchedule> GetSchedules	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all schedules.

Returns:: list of transit schedules

int GetSchedulesCount ( string ticket )

Get all schedules count.

Returns:: list of transit schedules

void DeleteSchedule	(	string	ticket,
		int	id
	)

Delete a schedule.

Parameters:

	ticket	authentication ticket
	id	id

string GetScheduleString	(	string	ticket,
		TransitSchedule	schedule,
		int	offset
	)

Get a humanly readable representation of a schedule.

int CreateOrUpdateAttribute	(	string	ticket,
		TransitAttribute	attr
	)

Create or update an attribute.

Parameters:

	ticket	authentication ticket
	PropertyGroup	transit attribute

TransitAttribute GetAttributeById	(	string	ticket,
		int	id
	)

Get an attribute.

Returns:: transit attribute

TransitAttribute GetAttributeIfModifiedSinceById	(	string	ticket,
		int	id,
		DateTime	ifModifiedSince
	)

Get attribute data if modified since.

Parameters:

	id	attribute id
	ticket	authentication ticket
	ifModifiedSince	last update date/time

Returns:: transit attribute with bitmap

int GetAttributesCount ( string ticket )

Get all attributes count.

Returns:: list of transit attributes

List<TransitAttribute> GetAttributes	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all attributes.

Returns:: list of transit attributes

void DeleteAttribute	(	string	ticket,
		int	id
	)

Delete an attribute.

Parameters:

	ticket	authentication ticket
	id	id

List<TransitSurveyQuestion> GetSurveyQuestions	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get survey questions.

Parameters:

surveyid

survey id

Returns:: transit survey questions

int GetSurveyQuestionsCount	(	string	ticket,
		int	id
	)

Get survey questions count.

Parameters:

	ticket
	id

Returns:

TransitSurveyQuestion GetSurveyQuestionById	(	string	ticket,
		int	id
	)

Get survey question by id.

Parameters:

survey question id

Returns:: transit survey question

int CreateOrUpdateSurveyQuestion	(	string	ticket,
		TransitSurveyQuestion	surveyquestion
	)

Create or update a survey question.

Parameters:

	ticket	authentication ticket
	surveyquestion	new survey question

void DeleteSurveyQuestion	(	string	ticket,
		int	id
	)

Delete a survey question.

Parameters:

	ticket	authentication ticket
	surveyquestionid	survey question id

int CreateOrUpdateSurvey	(	string	ticket,
		TransitSurvey	survey
	)

Create or update a survey.

Parameters:

	ticket	authentication ticket
	c	transit survey information

Returns:: new survey id

void DeleteSurvey	(	string	ticket,
		int	id
	)

Delete a survey.

Parameters:

	ticket	authentication ticket
	id	survey id

List<TransitSurvey> GetSurveys	(	string	ticket,
		ServiceQueryOptions	options
	)

Get surveys.

Returns:: transit surveys

int GetSurveysCount ( string ticket )

Get surveys count.

Returns:: number of transit surveys

TransitSurvey GetSurveyById	(	string	ticket,
		int	id
	)

Get a survey by id.

Parameters:

survey id

Returns:: transit survey

int CreateOrUpdatePicture	(	string	ticket,
		TransitPicture	picture
	)

Create or update a picture.

Parameters:

	ticket	authentication ticket
	picture	transit picture

TransitPicture GetPictureById	(	string	ticket,
		int	id
	)

Get a picture.

Returns:: transit picture

TransitPicture GetPictureIfModifiedSinceById	(	string	ticket,
		int	id,
		DateTime	ifModifiedSince
	)

Get a picture if modified since.

Parameters:

	ticket	authentication ticket
	id	picture id
	ifModifiedSince	timestamp

TransitPicture GetRandomPictureByType	(	string	ticket,
		string	type
	)

Get random picture.

Parameters:

type

picture type

Returns:: transit random picture, thumbnail only

List<TransitPicture> GetPictures	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all pictures.

Returns:: list of transit pictures

int GetPicturesCount ( string ticket )

Get all pictures count.

Returns:: number of transit pictures

void DeletePicture	(	string	ticket,
		int	id
	)

Delete a picture.

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdatePictureType	(	string	ticket,
		TransitPictureType	picturetype
	)

Create or update a picture type.

Parameters:

	ticket	authentication ticket
	picturetype	transit picture type

TransitPictureType GetPictureTypeById	(	string	ticket,
		int	id
	)

Get a picture type.

Returns:: transit picture type

List<TransitPictureType> GetPictureTypes	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all picture types.

Returns:: list of transit picture types

int GetPictureTypesCount ( string ticket )

Get all picture types count.

Returns:: number of transit picture types

void DeletePictureType	(	string	ticket,
		int	id
	)

Delete a picture type.

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdateReminder	(	string	ticket,
		TransitReminder	reminder
	)

Create or update a reminder.

Parameters:

	ticket	authentication ticket
	reminder	transit reminder

TransitReminder GetReminderById	(	string	ticket,
		int	id
	)

Get a reminder.

Returns:: transit reminder

List<TransitReminder> GetReminders	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all reminders.

Returns:: list of transit reminders

int GetRemindersCount ( string ticket )

Get all reminders count.

Returns:: number of transit reminders

void DeleteReminder	(	string	ticket,
		int	id
	)

Delete a reminder.

Parameters:

	ticket	authentication ticket
	id	id

bool CanSendReminder	(	int	reminder_id,
		int	account_id
	)

Test whether a reminder is being sent to an account.

int CreateOrUpdateReminderAccountProperty	(	string	ticket,
		TransitReminderAccountProperty	reminderaccountproperty
	)

Create or update a reminder account property.

Parameters:

	ticket	authentication ticket
	reminderaccountproperty	transit reminder account property

TransitReminderAccountProperty GetReminderAccountPropertyById	(	string	ticket,
		int	id
	)

Get a reminder account property.

Returns:: transit reminder account property

int GetReminderAccountPropertiesCount	(	string	ticket,
		int	id
	)

Get all reminder account properties count.

List<TransitReminderAccountProperty> GetReminderAccountProperties	(	string	ticket,
		int	id,
		ServiceQueryOptions	options
	)

Get all reminder account properties.

Returns:: list of transit reminder account properties

void DeleteReminderAccountProperty	(	string	ticket,
		int	id
	)

Delete a reminder account property.

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdateReminderEvent	(	string	ticket,
		TransitReminderEvent	reminderevent
	)

Create or update a reminder event.

Parameters:

	ticket	authentication ticket
	reminderevent	transit reminder event

TransitReminderEvent GetReminderEventById	(	string	ticket,
		int	id
	)

Get a reminder event.

Returns:: transit reminder event

List<TransitReminderEvent> GetReminderEvents	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all reminder events.

Returns:: list of transit reminder events

int GetReminderEventsCount ( string ticket )

Get all reminder events count.

Returns:: number of transit reminder events

void DeleteReminderEvent	(	string	ticket,
		int	id
	)

Delete a reminder event.

Parameters:

	ticket	authentication ticket
	id	id

int CreateOrUpdateDataObject	(	string	ticket,
		TransitDataObject	dataobject
	)

Create or update a data object.

Parameters:

	ticket	authentication ticket
	data object	transit data object

TransitDataObject GetDataObjectById	(	string	ticket,
		int	id
	)

Get a data object.

Returns:: transit data object

List<TransitDataObject> GetDataObjects	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all data objects.

Returns:: list of transit data objects

int GetDataObjectsCount ( string ticket )

Get all data objects count.

Returns:: number of transit data objects

void DeleteDataObject	(	string	ticket,
		int	id
	)

Delete a data object.

Parameters:

	ticket	authentication ticket
	id	id

List<string> GetDataObjectFieldsById	(	string	ticket,
		int	id
	)

Get data object fields.

Returns:: list of fields

int CreateOrUpdateBookmark	(	string	ticket,
		TransitBookmark	bookmark
	)

Create or update a bookmark.

Parameters:

	ticket	authentication ticket
	bookmark	transit bookmark

TransitBookmark GetBookmarkById	(	string	ticket,
		int	id
	)

Get a bookmark.

Returns:: transit bookmark

TransitBookmark GetBookmarkIfModifiedSinceById	(	string	ticket,
		int	id,
		DateTime	ifModifiedSince
	)

Get a bookmark if modified since.

Parameters:

	ticket
	id
	ifModifiedSince

Returns:

List<TransitBookmark> GetBookmarks	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all bookmarks.

Returns:: list of transit bookmarks

int GetBookmarksCount ( string ticket )

Get all bookmarks count.

Returns:: number of transit bookmarks

void DeleteBookmark	(	string	ticket,
		int	id
	)

Delete a bookmark.

Parameters:

	ticket	authentication ticket
	id	id

List<TransitBookmark> GetBookmarksWithOptions	(	string	ticket,
		BookmarkQueryOptions	qopt,
		ServiceQueryOptions	options
	)

Get all bookmarks that have bitmaps associated.

Returns:: list of transit bookmarks

int CreateOrUpdateFeature	(	string	ticket,
		TransitFeature	feature
	)

Feature an object.

Parameters:

	ticket	authentication ticket
	tf	transit feature

TransitFeature GetFeatureById	(	string	ticket,
		int	id
	)

Get a feature.

Returns:: transit feature

int GetFeaturesCount	(	string	ticket,
		string	featuretype
	)

Get the number of features of a certain type.

Returns:: number of features

List<TransitFeature> GetFeatures	(	string	ticket,
		string	featuretype,
		ServiceQueryOptions	options
	)

Get all features of a certain type.

Returns:: list of transit features

TransitFeature GetLatestFeature	(	string	ticket,
		string	featuretype
	)

Get latest feature of a certain type.

Returns:: transit features

TransitFeature FindLatestFeature	(	string	ticket,
		string	featuretype,
		int	objectid
	)

Find the latest feature of a certain type for an item.

Returns:: transit features

void DeleteFeature	(	string	ticket,
		int	id
	)

Delete a feature.

Parameters:

	ticket	authentication ticket
	id	id

void DeleteAllFeatures	(	string	ticket,
		TransitFeature	token
	)

Delete all features of an object.

Parameters:

	ticket	authentication ticket
	feature	token transit feature

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

WebObjectService.cs

WebObjectService Class Reference

Public Member Functions

Detailed Description

Member Function Documentation