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

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

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

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

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

MixERP.Net.Entities.Core.CompoundUnit	Get (int compoundUnitId)
	Returns an instance of compound unit. More...

IEnumerable< MixERP.Net.Entities.Core.CompoundUnit >	Get ([FromUri] int[] compoundUnitIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.CompoundUnit compoundUnit)
	Adds your instance of CompoundUnit class. More...

void	Edit (int compoundUnitId, [FromBody] MixERP.Net.Entities.Core.CompoundUnit compoundUnit)
	Edits existing record with your instance of CompoundUnit class. More...

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

void	Delete (int compoundUnitId)
	Deletes an existing instance of CompoundUnit class via CompoundUnitId. 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 Units.

Member Function Documentation

void MixERP.Net.Api.Core.CompoundUnitController.Add ( MixERP.Net.Entities.Core.CompoundUnit compoundUnit )

Adds your instance of CompoundUnit class.

Parameters

compoundUnit Your instance of compound units class to add.

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

Adds or edits your instance of CompoundUnit class.

Parameters

compoundUnit Your instance of compound units class to add or edit.

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

Adds or edits multiple instances of CompoundUnit class.

Parameters

collection Your collection of CompoundUnit class to bulk import.

Returns: Returns list of imported compoundUnitIds.

Exceptions

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

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

Counts the number of compound units.

Returns: Returns the count of the compound units.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered compound units.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered compound units.

void MixERP.Net.Api.Core.CompoundUnitController.Delete ( int compoundUnitId )

Deletes an existing instance of CompoundUnit class via CompoundUnitId.

Parameters

compoundUnitId Enter the value for CompoundUnitId in order to find and delete the existing record.

void MixERP.Net.Api.Core.CompoundUnitController.Edit	(	int	compoundUnitId,
		[FromBody] MixERP.Net.Entities.Core.CompoundUnit	compoundUnit
	)

Edits existing record with your instance of CompoundUnit class.

Parameters

compoundUnit	Your instance of CompoundUnit class to edit.
compoundUnitId	Enter the value for CompoundUnitId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.CompoundUnit> MixERP.Net.Api.Core.CompoundUnitController.Get ( )

Returns collection of compound unit for export.

Returns

MixERP.Net.Entities.Core.CompoundUnit MixERP.Net.Api.Core.CompoundUnitController.Get ( int compoundUnitId )

Returns an instance of compound unit.

Parameters

compoundUnitId Enter CompoundUnitId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "compound unit" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CompoundUnit> MixERP.Net.Api.Core.CompoundUnitController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation