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

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

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

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

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

MixERP.Net.Entities.Core.Brand	Get (int brandId)
	Returns an instance of brand. More...

IEnumerable< MixERP.Net.Entities.Core.Brand >	Get ([FromUri] int[] brandIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Brand brand)
	Adds your instance of Brand class. More...

void	Edit (int brandId, [FromBody] MixERP.Net.Entities.Core.Brand brand)
	Edits existing record with your instance of Brand class. More...

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

void	Delete (int brandId)
	Deletes an existing instance of Brand class via BrandId. 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 Brands.

Member Function Documentation

void MixERP.Net.Api.Core.BrandController.Add ( MixERP.Net.Entities.Core.Brand brand )

Adds your instance of Brand class.

Parameters

brand Your instance of brands class to add.

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

Adds or edits your instance of Brand class.

Parameters

brand Your instance of brands class to add or edit.

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

Adds or edits multiple instances of Brand class.

Parameters

collection Your collection of Brand class to bulk import.

Returns: Returns list of imported brandIds.

Exceptions

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

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

Counts the number of brands.

Returns: Returns the count of the brands.

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

Counts the number of brands using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered brands.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered brands.

void MixERP.Net.Api.Core.BrandController.Delete ( int brandId )

Deletes an existing instance of Brand class via BrandId.

Parameters

brandId Enter the value for BrandId in order to find and delete the existing record.

void MixERP.Net.Api.Core.BrandController.Edit	(	int	brandId,
		[FromBody] MixERP.Net.Entities.Core.Brand	brand
	)

Edits existing record with your instance of Brand class.

Parameters

brand	Your instance of Brand class to edit.
brandId	Enter the value for BrandId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Brand> MixERP.Net.Api.Core.BrandController.Get ( )

Returns collection of brand for export.

Returns

MixERP.Net.Entities.Core.Brand MixERP.Net.Api.Core.BrandController.Get ( int brandId )

Returns an instance of brand.

Parameters

brandId Enter BrandId to search for.

Returns

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

A custom field is a user defined field for brands.

Returns: Returns an enumerable custom field collection of brands.

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

A custom field is a user defined field for brands.

Returns: Returns an enumerable custom field collection of brands.

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

Displayfield is a lightweight key/value collection of brands.

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

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

Creates meta information of "brand" entity.

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

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

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

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

Creates a paginated collection containing 25 brands on each page, sorted by the property BrandId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Brand> MixERP.Net.Api.Core.BrandController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 brands on each page, sorted by the property BrandId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation