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

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

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

long	Count ()
	Counts the number of item groups. More...

IEnumerable< MixERP.Net.Entities.Core.ItemGroup >	Get ()
	Returns collection of item group for export. More...

MixERP.Net.Entities.Core.ItemGroup	Get (int itemGroupId)
	Returns an instance of item group. More...

IEnumerable< MixERP.Net.Entities.Core.ItemGroup >	Get ([FromUri] int[] itemGroupIds)

IEnumerable< MixERP.Net.Entities.Core.ItemGroup >	GetPagedResult ()
	Creates a paginated collection containing 25 item groups on each page, sorted by the property ItemGroupId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.ItemGroup itemGroup)
	Adds your instance of ItemGroup class. More...

void	Edit (int itemGroupId, [FromBody] MixERP.Net.Entities.Core.ItemGroup itemGroup)
	Edits existing record with your instance of ItemGroup class. More...

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

void	Delete (int itemGroupId)
	Deletes an existing instance of ItemGroup class via ItemGroupId. 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 Item Groups.

Member Function Documentation

void MixERP.Net.Api.Core.ItemGroupController.Add ( MixERP.Net.Entities.Core.ItemGroup itemGroup )

Adds your instance of ItemGroup class.

Parameters

itemGroup Your instance of item groups class to add.

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

Adds or edits your instance of ItemGroup class.

Parameters

itemGroup Your instance of item groups class to add or edit.

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

Adds or edits multiple instances of ItemGroup class.

Parameters

collection Your collection of ItemGroup class to bulk import.

Returns: Returns list of imported itemGroupIds.

Exceptions

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

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

Counts the number of item groups.

Returns: Returns the count of the item groups.

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

Counts the number of item groups using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered item groups.

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

Counts the number of item groups using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered item groups.

void MixERP.Net.Api.Core.ItemGroupController.Delete ( int itemGroupId )

Deletes an existing instance of ItemGroup class via ItemGroupId.

Parameters

itemGroupId Enter the value for ItemGroupId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ItemGroupController.Edit	(	int	itemGroupId,
		[FromBody] MixERP.Net.Entities.Core.ItemGroup	itemGroup
	)

Edits existing record with your instance of ItemGroup class.

Parameters

itemGroup	Your instance of ItemGroup class to edit.
itemGroupId	Enter the value for ItemGroupId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.ItemGroup> MixERP.Net.Api.Core.ItemGroupController.Get ( )

Returns collection of item group for export.

Returns

MixERP.Net.Entities.Core.ItemGroup MixERP.Net.Api.Core.ItemGroupController.Get ( int itemGroupId )

Returns an instance of item group.

Parameters

itemGroupId Enter ItemGroupId to search for.

Returns

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

A custom field is a user defined field for item groups.

Returns: Returns an enumerable custom field collection of item groups.

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

A custom field is a user defined field for item groups.

Returns: Returns an enumerable custom field collection of item groups.

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

Displayfield is a lightweight key/value collection of item groups.

Returns: Returns an enumerable key/value collection of item groups.

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

Creates meta information of "item group" entity.

Returns: Returns the "item group" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 item groups on each page, sorted by the property ItemGroupId.

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

Creates a paginated collection containing 25 item groups on each page, sorted by the property ItemGroupId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.ItemGroup> MixERP.Net.Api.Core.ItemGroupController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 item groups on each page, sorted by the property ItemGroupId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 item groups on each page, sorted by the property ItemGroupId.

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/ItemGroupController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation