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

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

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

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

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

MixERP.Net.Entities.Core.Item	Get (int itemId)
	Returns an instance of item. More...

IEnumerable< MixERP.Net.Entities.Core.Item >	Get ([FromUri] int[] itemIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Item item)
	Adds your instance of Item class. More...

void	Edit (int itemId, [FromBody] MixERP.Net.Entities.Core.Item item)
	Edits existing record with your instance of Item class. More...

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

void	Delete (int itemId)
	Deletes an existing instance of Item class via ItemId. 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 Items.

Member Function Documentation

void MixERP.Net.Api.Core.ItemController.Add ( MixERP.Net.Entities.Core.Item item )

Adds your instance of Item class.

Parameters

item	Your instance of items class to add.

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

Adds or edits your instance of Item class.

Parameters

item	Your instance of items class to add or edit.

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

Adds or edits multiple instances of Item class.

Parameters

collection Your collection of Item class to bulk import.

Returns: Returns list of imported itemIds.

Exceptions

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

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

Counts the number of items.

Returns: Returns the count of the items.

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

Counts the number of items using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered items.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered items.

void MixERP.Net.Api.Core.ItemController.Delete ( int itemId )

Deletes an existing instance of Item class via ItemId.

Parameters

itemId Enter the value for ItemId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ItemController.Edit	(	int	itemId,
		[FromBody] MixERP.Net.Entities.Core.Item	item
	)

Edits existing record with your instance of Item class.

Parameters

item	Your instance of Item class to edit.
itemId	Enter the value for ItemId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Item> MixERP.Net.Api.Core.ItemController.Get ( )

Returns collection of item for export.

Returns

MixERP.Net.Entities.Core.Item MixERP.Net.Api.Core.ItemController.Get ( int itemId )

Returns an instance of item.

Parameters

itemId Enter ItemId to search for.

Returns

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

A custom field is a user defined field for items.

Returns: Returns an enumerable custom field collection of items.

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

A custom field is a user defined field for items.

Returns: Returns an enumerable custom field collection of items.

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

Displayfield is a lightweight key/value collection of items.

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

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

Creates meta information of "item" entity.

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

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

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

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

Creates a paginated collection containing 25 items on each page, sorted by the property ItemId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Item> MixERP.Net.Api.Core.ItemController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 items on each page, sorted by the property ItemId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation