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

Inheritance diagram for MixERP.Net.Api.Core.MenuController:

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

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

IEnumerable< MixERP.Net.Entities.Core.Menu >	Get ()
	Returns collection of menu for export. More...

MixERP.Net.Entities.Core.Menu	Get (int menuId)
	Returns an instance of menu. More...

IEnumerable< MixERP.Net.Entities.Core.Menu >	Get ([FromUri] int[] menuIds)

IEnumerable< MixERP.Net.Entities.Core.Menu >	GetPagedResult ()
	Creates a paginated collection containing 25 menus on each page, sorted by the property MenuId. More...

IEnumerable< MixERP.Net.Entities.Core.Menu >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 menus on each page, sorted by the property MenuId. More...

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

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

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

IEnumerable< MixERP.Net.Entities.Core.Menu >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 menus on each page, sorted by the property MenuId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Menu menu)
	Adds your instance of Menu class. More...

void	Edit (int menuId, [FromBody] MixERP.Net.Entities.Core.Menu menu)
	Edits existing record with your instance of Menu class. More...

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

void	Delete (int menuId)
	Deletes an existing instance of Menu class via MenuId. 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 Menus.

Member Function Documentation

void MixERP.Net.Api.Core.MenuController.Add ( MixERP.Net.Entities.Core.Menu menu )

Adds your instance of Menu class.

Parameters

menu	Your instance of menus class to add.

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

Adds or edits your instance of Menu class.

Parameters

menu	Your instance of menus class to add or edit.

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

Adds or edits multiple instances of Menu class.

Parameters

collection Your collection of Menu class to bulk import.

Returns: Returns list of imported menuIds.

Exceptions

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

long MixERP.Net.Api.Core.MenuController.Count ( )

Counts the number of menus.

Returns: Returns the count of the menus.

long MixERP.Net.Api.Core.MenuController.CountFiltered ( string filterName )

Counts the number of menus using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered menus.

long MixERP.Net.Api.Core.MenuController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered menus.

void MixERP.Net.Api.Core.MenuController.Delete ( int menuId )

Deletes an existing instance of Menu class via MenuId.

Parameters

menuId Enter the value for MenuId in order to find and delete the existing record.

void MixERP.Net.Api.Core.MenuController.Edit	(	int	menuId,
		[FromBody] MixERP.Net.Entities.Core.Menu	menu
	)

Edits existing record with your instance of Menu class.

Parameters

menu	Your instance of Menu class to edit.
menuId	Enter the value for MenuId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Menu> MixERP.Net.Api.Core.MenuController.Get ( )

Returns collection of menu for export.

Returns

MixERP.Net.Entities.Core.Menu MixERP.Net.Api.Core.MenuController.Get ( int menuId )

Returns an instance of menu.

Parameters

menuId Enter MenuId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.MenuController.GetCustomFields ( )

A custom field is a user defined field for menus.

Returns: Returns an enumerable custom field collection of menus.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.MenuController.GetCustomFields ( string resourceId )

A custom field is a user defined field for menus.

Returns: Returns an enumerable custom field collection of menus.

IEnumerable<DisplayField> MixERP.Net.Api.Core.MenuController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of menus.

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

EntityView MixERP.Net.Api.Core.MenuController.GetEntityView ( )

Creates meta information of "menu" entity.

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

IEnumerable<MixERP.Net.Entities.Core.Menu> MixERP.Net.Api.Core.MenuController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Core.Menu> MixERP.Net.Api.Core.MenuController.GetPagedResult ( )

Creates a paginated collection containing 25 menus on each page, sorted by the property MenuId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Menu> MixERP.Net.Api.Core.MenuController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 menus on each page, sorted by the property MenuId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Menu> MixERP.Net.Api.Core.MenuController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Core/MenuController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation