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

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

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

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

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

MixERP.Net.Entities.Core.Industry	Get (int industryId)
	Returns an instance of industry. More...

IEnumerable< MixERP.Net.Entities.Core.Industry >	Get ([FromUri] int[] industryIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Industry industry)
	Adds your instance of Industry class. More...

void	Edit (int industryId, [FromBody] MixERP.Net.Entities.Core.Industry industry)
	Edits existing record with your instance of Industry class. More...

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

void	Delete (int industryId)
	Deletes an existing instance of Industry class via IndustryId. 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 Industries.

Member Function Documentation

void MixERP.Net.Api.Core.IndustryController.Add ( MixERP.Net.Entities.Core.Industry industry )

Adds your instance of Industry class.

Parameters

industry Your instance of industries class to add.

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

Adds or edits your instance of Industry class.

Parameters

industry Your instance of industries class to add or edit.

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

Adds or edits multiple instances of Industry class.

Parameters

collection Your collection of Industry class to bulk import.

Returns: Returns list of imported industryIds.

Exceptions

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

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

Counts the number of industries.

Returns: Returns the count of the industries.

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

Counts the number of industries using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered industries.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered industries.

void MixERP.Net.Api.Core.IndustryController.Delete ( int industryId )

Deletes an existing instance of Industry class via IndustryId.

Parameters

industryId Enter the value for IndustryId in order to find and delete the existing record.

void MixERP.Net.Api.Core.IndustryController.Edit	(	int	industryId,
		[FromBody] MixERP.Net.Entities.Core.Industry	industry
	)

Edits existing record with your instance of Industry class.

Parameters

industry	Your instance of Industry class to edit.
industryId	Enter the value for IndustryId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Industry> MixERP.Net.Api.Core.IndustryController.Get ( )

Returns collection of industry for export.

Returns

MixERP.Net.Entities.Core.Industry MixERP.Net.Api.Core.IndustryController.Get ( int industryId )

Returns an instance of industry.

Parameters

industryId Enter IndustryId to search for.

Returns

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

A custom field is a user defined field for industries.

Returns: Returns an enumerable custom field collection of industries.

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

A custom field is a user defined field for industries.

Returns: Returns an enumerable custom field collection of industries.

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

Displayfield is a lightweight key/value collection of industries.

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

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

Creates meta information of "industry" entity.

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

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

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

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

Creates a paginated collection containing 25 industries on each page, sorted by the property IndustryId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Industry> MixERP.Net.Api.Core.IndustryController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 industries on each page, sorted by the property IndustryId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation