Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Switches. More...

Inheritance diagram for MixERP.Net.Api.Config.SwitchController:

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "switch" entity. More...

long	Count ()
	Counts the number of switches. More...

IEnumerable< MixERP.Net.Entities.Config.Switch >	Get ()
	Returns collection of switch for export. More...

MixERP.Net.Entities.Config.Switch	Get (string key)
	Returns an instance of switch. More...

IEnumerable< MixERP.Net.Entities.Config.Switch >	Get ([FromUri] string[] keys)

IEnumerable< MixERP.Net.Entities.Config.Switch >	GetPagedResult ()
	Creates a paginated collection containing 25 switches on each page, sorted by the property Key. More...

IEnumerable< MixERP.Net.Entities.Config.Switch >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 switches on each page, sorted by the property Key. More...

long	CountWhere ([FromBody]dynamic filters)
	Counts the number of switches using the supplied filter(s). More...

IEnumerable< MixERP.Net.Entities.Config.Switch >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 switches on each page, sorted by the property Key. More...

long	CountFiltered (string filterName)
	Counts the number of switches using the supplied filter name. More...

IEnumerable< MixERP.Net.Entities.Config.Switch >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 switches on each page, sorted by the property Key. More...

IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of switches. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for switches. More...

IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for switches. More...

void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of Switch class. More...

void	Add (MixERP.Net.Entities.Config.Switch switchParameter)
	Adds your instance of Switch class. More...

void	Edit (string key, [FromBody] MixERP.Net.Entities.Config.Switch switchParameter)
	Edits existing record with your instance of Switch class. More...

List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of Switch class. More...

void	Delete (string key)
	Deletes an existing instance of Switch class via Key. More...

Properties
long	LoginId `[get]`

int	UserId `[get]`

int	OfficeId `[get]`

string	Catalog `[get]`

Detailed Description

Provides a direct HTTP access to perform various tasks such as adding, editing, and removing Switches.

Member Function Documentation

void MixERP.Net.Api.Config.SwitchController.Add ( MixERP.Net.Entities.Config.Switch switchParameter )

Adds your instance of Switch class.

Parameters

switchParameter Your instance of switches class to add.

void MixERP.Net.Api.Config.SwitchController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray form )

Adds or edits your instance of Switch class.

Parameters

switchParameter Your instance of switches class to add or edit.

List<object> MixERP.Net.Api.Config.SwitchController.BulkImport ( [FromBody] dynamic collection )

Adds or edits multiple instances of Switch class.

Parameters

collection Your collection of Switch class to bulk import.

Returns: Returns list of imported keys.

Exceptions

MixERPException Thrown when your any Switch class in the collection is invalid or malformed.

long MixERP.Net.Api.Config.SwitchController.Count ( )

Counts the number of switches.

Returns: Returns the count of the switches.

long MixERP.Net.Api.Config.SwitchController.CountFiltered ( string filterName )

Counts the number of switches using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered switches.

long MixERP.Net.Api.Config.SwitchController.CountWhere ( [FromBody] dynamic filters )

Counts the number of switches using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered switches.

void MixERP.Net.Api.Config.SwitchController.Delete ( string key )

Deletes an existing instance of Switch class via Key.

Parameters

key	Enter the value for Key in order to find and delete the existing record.

void MixERP.Net.Api.Config.SwitchController.Edit	(	string	key,
		[FromBody] MixERP.Net.Entities.Config.Switch	switchParameter
	)

Edits existing record with your instance of Switch class.

Parameters

switchParameter	Your instance of Switch class to edit.
key	Enter the value for Key in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Config.Switch> MixERP.Net.Api.Config.SwitchController.Get ( )

Returns collection of switch for export.

Returns

MixERP.Net.Entities.Config.Switch MixERP.Net.Api.Config.SwitchController.Get ( string key )

Returns an instance of switch.

Parameters

key	Enter Key to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.SwitchController.GetCustomFields ( )

A custom field is a user defined field for switches.

Returns: Returns an enumerable custom field collection of switches.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.SwitchController.GetCustomFields ( string resourceId )

A custom field is a user defined field for switches.

Returns: Returns an enumerable custom field collection of switches.

IEnumerable<DisplayField> MixERP.Net.Api.Config.SwitchController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of switches.

Returns: Returns an enumerable key/value collection of switches.

EntityView MixERP.Net.Api.Config.SwitchController.GetEntityView ( )

Creates meta information of "switch" entity.

Returns: Returns the "switch" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Config.Switch> MixERP.Net.Api.Config.SwitchController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 switches on each page, sorted by the property Key.

Parameters

pageNumber	Enter the page number to produce the resultset.
filterName	The named filter.

Returns: Returns the requested page from the collection using the supplied filters.

IEnumerable<MixERP.Net.Entities.Config.Switch> MixERP.Net.Api.Config.SwitchController.GetPagedResult ( )

Creates a paginated collection containing 25 switches on each page, sorted by the property Key.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Config.Switch> MixERP.Net.Api.Config.SwitchController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 switches on each page, sorted by the property Key.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Config.Switch> MixERP.Net.Api.Config.SwitchController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 switches on each page, sorted by the property Key.

Parameters

pageNumber	Enter the page number to produce the resultset.
filters	The list of filter conditions.

Returns: Returns the requested page from the collection using the supplied filters.

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

C:/Users/nirvan/Desktop/mixerp/0. GitHub/src/Libraries/Web API/Config/SwitchController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation