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

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

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

long	Count ()
	Counts the number of compound item details. More...

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

MixERP.Net.Entities.Core.CompoundItemDetail	Get (int compoundItemDetailId)
	Returns an instance of compound item detail. More...

IEnumerable< MixERP.Net.Entities.Core.CompoundItemDetail >	Get ([FromUri] int[] compoundItemDetailIds)

IEnumerable< MixERP.Net.Entities.Core.CompoundItemDetail >	GetPagedResult ()
	Creates a paginated collection containing 25 compound item details on each page, sorted by the property CompoundItemDetailId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.CompoundItemDetail compoundItemDetail)
	Adds your instance of CompoundItemDetail class. More...

void	Edit (int compoundItemDetailId, [FromBody] MixERP.Net.Entities.Core.CompoundItemDetail compoundItemDetail)
	Edits existing record with your instance of CompoundItemDetail class. More...

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

void	Delete (int compoundItemDetailId)
	Deletes an existing instance of CompoundItemDetail class via CompoundItemDetailId. 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 Item Details.

Member Function Documentation

void MixERP.Net.Api.Core.CompoundItemDetailController.Add ( MixERP.Net.Entities.Core.CompoundItemDetail compoundItemDetail )

Adds your instance of CompoundItemDetail class.

Parameters

compoundItemDetail Your instance of compound item details class to add.

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

Adds or edits your instance of CompoundItemDetail class.

Parameters

compoundItemDetail Your instance of compound item details class to add or edit.

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

Adds or edits multiple instances of CompoundItemDetail class.

Parameters

collection Your collection of CompoundItemDetail class to bulk import.

Returns: Returns list of imported compoundItemDetailIds.

Exceptions

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

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

Counts the number of compound item details.

Returns: Returns the count of the compound item details.

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

Counts the number of compound item details using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered compound item details.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered compound item details.

void MixERP.Net.Api.Core.CompoundItemDetailController.Delete ( int compoundItemDetailId )

Deletes an existing instance of CompoundItemDetail class via CompoundItemDetailId.

Parameters

compoundItemDetailId Enter the value for CompoundItemDetailId in order to find and delete the existing record.

void MixERP.Net.Api.Core.CompoundItemDetailController.Edit	(	int	compoundItemDetailId,
		[FromBody] MixERP.Net.Entities.Core.CompoundItemDetail	compoundItemDetail
	)

Edits existing record with your instance of CompoundItemDetail class.

Parameters

compoundItemDetail	Your instance of CompoundItemDetail class to edit.
compoundItemDetailId	Enter the value for CompoundItemDetailId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.CompoundItemDetail> MixERP.Net.Api.Core.CompoundItemDetailController.Get ( )

Returns collection of compound item detail for export.

Returns

MixERP.Net.Entities.Core.CompoundItemDetail MixERP.Net.Api.Core.CompoundItemDetailController.Get ( int compoundItemDetailId )

Returns an instance of compound item detail.

Parameters

compoundItemDetailId Enter CompoundItemDetailId to search for.

Returns

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

A custom field is a user defined field for compound item details.

Returns: Returns an enumerable custom field collection of compound item details.

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

A custom field is a user defined field for compound item details.

Returns: Returns an enumerable custom field collection of compound item details.

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

Displayfield is a lightweight key/value collection of compound item details.

Returns: Returns an enumerable key/value collection of compound item details.

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

Creates meta information of "compound item detail" entity.

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

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

Creates a filtered and paginated collection containing 25 compound item details on each page, sorted by the property CompoundItemDetailId.

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

Creates a paginated collection containing 25 compound item details on each page, sorted by the property CompoundItemDetailId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CompoundItemDetail> MixERP.Net.Api.Core.CompoundItemDetailController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 compound item details on each page, sorted by the property CompoundItemDetailId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 compound item details on each page, sorted by the property CompoundItemDetailId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation