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

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

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

long	Count ()
	Counts the number of price types. More...

IEnumerable< MixERP.Net.Entities.Core.PriceType >	Get ()
	Returns collection of price type for export. More...

MixERP.Net.Entities.Core.PriceType	Get (int priceTypeId)
	Returns an instance of price type. More...

IEnumerable< MixERP.Net.Entities.Core.PriceType >	Get ([FromUri] int[] priceTypeIds)

IEnumerable< MixERP.Net.Entities.Core.PriceType >	GetPagedResult ()
	Creates a paginated collection containing 25 price types on each page, sorted by the property PriceTypeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.PriceType priceType)
	Adds your instance of PriceType class. More...

void	Edit (int priceTypeId, [FromBody] MixERP.Net.Entities.Core.PriceType priceType)
	Edits existing record with your instance of PriceType class. More...

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

void	Delete (int priceTypeId)
	Deletes an existing instance of PriceType class via PriceTypeId. 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 Price Types.

Member Function Documentation

void MixERP.Net.Api.Core.PriceTypeController.Add ( MixERP.Net.Entities.Core.PriceType priceType )

Adds your instance of PriceType class.

Parameters

priceType Your instance of price types class to add.

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

Adds or edits your instance of PriceType class.

Parameters

priceType Your instance of price types class to add or edit.

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

Adds or edits multiple instances of PriceType class.

Parameters

collection Your collection of PriceType class to bulk import.

Returns: Returns list of imported priceTypeIds.

Exceptions

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

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

Counts the number of price types.

Returns: Returns the count of the price types.

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

Counts the number of price types using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered price types.

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

Counts the number of price types using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered price types.

void MixERP.Net.Api.Core.PriceTypeController.Delete ( int priceTypeId )

Deletes an existing instance of PriceType class via PriceTypeId.

Parameters

priceTypeId Enter the value for PriceTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.PriceTypeController.Edit	(	int	priceTypeId,
		[FromBody] MixERP.Net.Entities.Core.PriceType	priceType
	)

Edits existing record with your instance of PriceType class.

Parameters

priceType	Your instance of PriceType class to edit.
priceTypeId	Enter the value for PriceTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.PriceType> MixERP.Net.Api.Core.PriceTypeController.Get ( )

Returns collection of price type for export.

Returns

MixERP.Net.Entities.Core.PriceType MixERP.Net.Api.Core.PriceTypeController.Get ( int priceTypeId )

Returns an instance of price type.

Parameters

priceTypeId Enter PriceTypeId to search for.

Returns

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

A custom field is a user defined field for price types.

Returns: Returns an enumerable custom field collection of price types.

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

A custom field is a user defined field for price types.

Returns: Returns an enumerable custom field collection of price types.

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

Displayfield is a lightweight key/value collection of price types.

Returns: Returns an enumerable key/value collection of price types.

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

Creates meta information of "price type" entity.

Returns: Returns the "price type" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 price types on each page, sorted by the property PriceTypeId.

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

Creates a paginated collection containing 25 price types on each page, sorted by the property PriceTypeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.PriceType> MixERP.Net.Api.Core.PriceTypeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 price types on each page, sorted by the property PriceTypeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 price types on each page, sorted by the property PriceTypeId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation