SnCore::WebServices::WebSystemService

WebSystemService Class Reference

System information services. More...

List of all members.

Public Member Functions

string GetVersion ()

System version.

string GetTitle ()

System title.

string GetCopyright ()

Product copyright.

string GetDescription ()

Product description.

long GetUptime ()

Product uptime in ticks.

int CreateOrUpdateConfiguration (string ticket, TransitConfiguration configuration)

Create or update a configuration.

TransitConfiguration GetConfigurationById (string ticket, int id)

Get a configuration.

int GetConfigurationsCount (string ticket)

Get all configurations count.

List< TransitConfiguration > GetConfigurations (string ticket, ServiceQueryOptions options)

Get all configurations.

void DeleteConfiguration (string ticket, int id)

Delete a configuration.

Parameters:

	ticket	authentication ticket
	id	id

TransitConfiguration GetConfigurationByName (string ticket, string name)

Get a configuration by name.

string GetConfigurationValue (string ticket, string name)

Get a configuration value by name.

string GetConfigurationByNameValueWithDefault (string ticket, string name, string defaultvalue)

Get a configuration value by name with default.

TransitConfiguration GetConfigurationByNameWithDefault (string ticket, string name, string defaultvalue)

Get a configuration by name with default.

sp_column[] GetTypeColumns (string type)

Get the underlying domain model for a type.

Detailed Description

System information services.

Member Function Documentation

int CreateOrUpdateConfiguration	(	string	ticket,
		TransitConfiguration	configuration
	)

Create or update a configuration.

Parameters:

	ticket	authentication ticket
	type	transit configuration

TransitConfiguration GetConfigurationById	(	string	ticket,
		int	id
	)

Get a configuration.

Returns:: transit configuration

TransitConfiguration GetConfigurationByName	(	string	ticket,
		string	name
	)

Get a configuration by name.

Parameters:

	ticket
	name

Returns:

string GetConfigurationByNameValueWithDefault	(	string	ticket,
		string	name,
		string	defaultvalue
	)

Get a configuration value by name with default.

Parameters:

	ticket
	name
	defaultvalue

Returns:

TransitConfiguration GetConfigurationByNameWithDefault	(	string	ticket,
		string	name,
		string	defaultvalue
	)

Get a configuration by name with default.

Parameters:

	ticket
	name
	defaultvalue

Returns:

List<TransitConfiguration> GetConfigurations	(	string	ticket,
		ServiceQueryOptions	options
	)

Get all configurations.

Returns:: list of transit configurations

int GetConfigurationsCount

(

string

ticket

)

Get all configurations count.

Returns:: number of configurations

string GetConfigurationValue	(	string	ticket,
		string	name
	)

Get a configuration value by name.

Parameters:

	ticket
	name

Returns:

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

WebSystemService.cs