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

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

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

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

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

MixERP.Net.Entities.Core.ItemType	Get (int itemTypeId)
	Returns an instance of item type. More...

IEnumerable< MixERP.Net.Entities.Core.ItemType >	Get ([FromUri] int[] itemTypeIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.ItemType itemType)
	Adds your instance of ItemType class. More...

void	Edit (int itemTypeId, [FromBody] MixERP.Net.Entities.Core.ItemType itemType)
	Edits existing record with your instance of ItemType class. More...

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

void	Delete (int itemTypeId)
	Deletes an existing instance of ItemType class via ItemTypeId. 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 Types.

Member Function Documentation

void MixERP.Net.Api.Core.ItemTypeController.Add ( MixERP.Net.Entities.Core.ItemType itemType )

Adds your instance of ItemType class.

Parameters

itemType Your instance of item types class to add.

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

Adds or edits your instance of ItemType class.

Parameters

itemType Your instance of item types class to add or edit.

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

Adds or edits multiple instances of ItemType class.

Parameters

collection Your collection of ItemType class to bulk import.

Returns: Returns list of imported itemTypeIds.

Exceptions

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

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

Counts the number of item types.

Returns: Returns the count of the item types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered item types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered item types.

void MixERP.Net.Api.Core.ItemTypeController.Delete ( int itemTypeId )

Deletes an existing instance of ItemType class via ItemTypeId.

Parameters

itemTypeId Enter the value for ItemTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ItemTypeController.Edit	(	int	itemTypeId,
		[FromBody] MixERP.Net.Entities.Core.ItemType	itemType
	)

Edits existing record with your instance of ItemType class.

Parameters

itemType	Your instance of ItemType class to edit.
itemTypeId	Enter the value for ItemTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.ItemType> MixERP.Net.Api.Core.ItemTypeController.Get ( )

Returns collection of item type for export.

Returns

MixERP.Net.Entities.Core.ItemType MixERP.Net.Api.Core.ItemTypeController.Get ( int itemTypeId )

Returns an instance of item type.

Parameters

itemTypeId Enter ItemTypeId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "item type" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.ItemType> MixERP.Net.Api.Core.ItemTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation