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

Inheritance diagram for MixERP.Net.Api.Policy.StorePolicyController:

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

long	Count ()
	Counts the number of store policies. More...

IEnumerable< MixERP.Net.Entities.Policy.StorePolicy >	Get ()
	Returns collection of store policy for export. More...

MixERP.Net.Entities.Policy.StorePolicy	Get (long storePolicyId)
	Returns an instance of store policy. More...

IEnumerable< MixERP.Net.Entities.Policy.StorePolicy >	Get ([FromUri] long[] storePolicyIds)

IEnumerable< MixERP.Net.Entities.Policy.StorePolicy >	GetPagedResult ()
	Creates a paginated collection containing 25 store policies on each page, sorted by the property StorePolicyId. More...

IEnumerable< MixERP.Net.Entities.Policy.StorePolicy >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 store policies on each page, sorted by the property StorePolicyId. More...

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

IEnumerable< MixERP.Net.Entities.Policy.StorePolicy >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 store policies on each page, sorted by the property StorePolicyId. More...

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

IEnumerable< MixERP.Net.Entities.Policy.StorePolicy >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 store policies on each page, sorted by the property StorePolicyId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Policy.StorePolicy storePolicy)
	Adds your instance of StorePolicy class. More...

void	Edit (long storePolicyId, [FromBody] MixERP.Net.Entities.Policy.StorePolicy storePolicy)
	Edits existing record with your instance of StorePolicy class. More...

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

void	Delete (long storePolicyId)
	Deletes an existing instance of StorePolicy class via StorePolicyId. 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 Store Policies.

Member Function Documentation

void MixERP.Net.Api.Policy.StorePolicyController.Add ( MixERP.Net.Entities.Policy.StorePolicy storePolicy )

Adds your instance of StorePolicy class.

Parameters

storePolicy Your instance of store policies class to add.

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

Adds or edits your instance of StorePolicy class.

Parameters

storePolicy Your instance of store policies class to add or edit.

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

Adds or edits multiple instances of StorePolicy class.

Parameters

collection Your collection of StorePolicy class to bulk import.

Returns: Returns list of imported storePolicyIds.

Exceptions

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

long MixERP.Net.Api.Policy.StorePolicyController.Count ( )

Counts the number of store policies.

Returns: Returns the count of the store policies.

long MixERP.Net.Api.Policy.StorePolicyController.CountFiltered ( string filterName )

Counts the number of store policies using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered store policies.

long MixERP.Net.Api.Policy.StorePolicyController.CountWhere ( [FromBody] dynamic filters )

Counts the number of store policies using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered store policies.

void MixERP.Net.Api.Policy.StorePolicyController.Delete ( long storePolicyId )

Deletes an existing instance of StorePolicy class via StorePolicyId.

Parameters

storePolicyId Enter the value for StorePolicyId in order to find and delete the existing record.

void MixERP.Net.Api.Policy.StorePolicyController.Edit	(	long	storePolicyId,
		[FromBody] MixERP.Net.Entities.Policy.StorePolicy	storePolicy
	)

Edits existing record with your instance of StorePolicy class.

Parameters

storePolicy	Your instance of StorePolicy class to edit.
storePolicyId	Enter the value for StorePolicyId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Policy.StorePolicy> MixERP.Net.Api.Policy.StorePolicyController.Get ( )

Returns collection of store policy for export.

Returns

MixERP.Net.Entities.Policy.StorePolicy MixERP.Net.Api.Policy.StorePolicyController.Get ( long storePolicyId )

Returns an instance of store policy.

Parameters

storePolicyId Enter StorePolicyId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.StorePolicyController.GetCustomFields ( )

A custom field is a user defined field for store policies.

Returns: Returns an enumerable custom field collection of store policies.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.StorePolicyController.GetCustomFields ( string resourceId )

A custom field is a user defined field for store policies.

Returns: Returns an enumerable custom field collection of store policies.

IEnumerable<DisplayField> MixERP.Net.Api.Policy.StorePolicyController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of store policies.

Returns: Returns an enumerable key/value collection of store policies.

EntityView MixERP.Net.Api.Policy.StorePolicyController.GetEntityView ( )

Creates meta information of "store policy" entity.

Returns: Returns the "store policy" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Policy.StorePolicy> MixERP.Net.Api.Policy.StorePolicyController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 store policies on each page, sorted by the property StorePolicyId.

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.Policy.StorePolicy> MixERP.Net.Api.Policy.StorePolicyController.GetPagedResult ( )

Creates a paginated collection containing 25 store policies on each page, sorted by the property StorePolicyId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.StorePolicy> MixERP.Net.Api.Policy.StorePolicyController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 store policies on each page, sorted by the property StorePolicyId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.StorePolicy> MixERP.Net.Api.Policy.StorePolicyController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 store policies on each page, sorted by the property StorePolicyId.

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/Policy/StorePolicyController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation