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

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

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

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

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

MixERP.Net.Entities.Core.CompoundItem	Get (int compoundItemId)
	Returns an instance of compound item. More...

IEnumerable< MixERP.Net.Entities.Core.CompoundItem >	Get ([FromUri] int[] compoundItemIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.CompoundItem compoundItem)
	Adds your instance of CompoundItem class. More...

void	Edit (int compoundItemId, [FromBody] MixERP.Net.Entities.Core.CompoundItem compoundItem)
	Edits existing record with your instance of CompoundItem class. More...

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

void	Delete (int compoundItemId)
	Deletes an existing instance of CompoundItem class via CompoundItemId. 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 Compound Items.

Member Function Documentation

void MixERP.Net.Api.Core.CompoundItemController.Add ( MixERP.Net.Entities.Core.CompoundItem compoundItem )

Adds your instance of CompoundItem class.

Parameters

compoundItem Your instance of compound items class to add.

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

Adds or edits your instance of CompoundItem class.

Parameters

compoundItem Your instance of compound items class to add or edit.

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

Adds or edits multiple instances of CompoundItem class.

Parameters

collection Your collection of CompoundItem class to bulk import.

Returns: Returns list of imported compoundItemIds.

Exceptions

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

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

Counts the number of compound items.

Returns: Returns the count of the compound items.

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

Counts the number of compound items using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered compound items.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered compound items.

void MixERP.Net.Api.Core.CompoundItemController.Delete ( int compoundItemId )

Deletes an existing instance of CompoundItem class via CompoundItemId.

Parameters

compoundItemId Enter the value for CompoundItemId in order to find and delete the existing record.

void MixERP.Net.Api.Core.CompoundItemController.Edit	(	int	compoundItemId,
		[FromBody] MixERP.Net.Entities.Core.CompoundItem	compoundItem
	)

Edits existing record with your instance of CompoundItem class.

Parameters

compoundItem	Your instance of CompoundItem class to edit.
compoundItemId	Enter the value for CompoundItemId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.CompoundItem> MixERP.Net.Api.Core.CompoundItemController.Get ( )

Returns collection of compound item for export.

Returns

MixERP.Net.Entities.Core.CompoundItem MixERP.Net.Api.Core.CompoundItemController.Get ( int compoundItemId )

Returns an instance of compound item.

Parameters

compoundItemId Enter CompoundItemId to search for.

Returns

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

A custom field is a user defined field for compound items.

Returns: Returns an enumerable custom field collection of compound items.

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

A custom field is a user defined field for compound items.

Returns: Returns an enumerable custom field collection of compound items.

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

Displayfield is a lightweight key/value collection of compound items.

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

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

Creates meta information of "compound item" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CompoundItem> MixERP.Net.Api.Core.CompoundItemController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation