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

Inheritance diagram for MixERP.Net.Api.Office.StoreController:

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

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

IEnumerable< MixERP.Net.Entities.Office.Store >	Get ()
	Returns collection of store for export. More...

MixERP.Net.Entities.Office.Store	Get (int storeId)
	Returns an instance of store. More...

IEnumerable< MixERP.Net.Entities.Office.Store >	Get ([FromUri] int[] storeIds)

IEnumerable< MixERP.Net.Entities.Office.Store >	GetPagedResult ()
	Creates a paginated collection containing 25 stores on each page, sorted by the property StoreId. More...

IEnumerable< MixERP.Net.Entities.Office.Store >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 stores on each page, sorted by the property StoreId. More...

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

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

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

IEnumerable< MixERP.Net.Entities.Office.Store >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 stores on each page, sorted by the property StoreId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Office.Store store)
	Adds your instance of Store class. More...

void	Edit (int storeId, [FromBody] MixERP.Net.Entities.Office.Store store)
	Edits existing record with your instance of Store class. More...

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

void	Delete (int storeId)
	Deletes an existing instance of Store class via StoreId. 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 Stores.

Member Function Documentation

void MixERP.Net.Api.Office.StoreController.Add ( MixERP.Net.Entities.Office.Store store )

Adds your instance of Store class.

Parameters

store Your instance of stores class to add.

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

Adds or edits your instance of Store class.

Parameters

store Your instance of stores class to add or edit.

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

Adds or edits multiple instances of Store class.

Parameters

collection Your collection of Store class to bulk import.

Returns: Returns list of imported storeIds.

Exceptions

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

long MixERP.Net.Api.Office.StoreController.Count ( )

Counts the number of stores.

Returns: Returns the count of the stores.

long MixERP.Net.Api.Office.StoreController.CountFiltered ( string filterName )

Counts the number of stores using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered stores.

long MixERP.Net.Api.Office.StoreController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered stores.

void MixERP.Net.Api.Office.StoreController.Delete ( int storeId )

Deletes an existing instance of Store class via StoreId.

Parameters

storeId Enter the value for StoreId in order to find and delete the existing record.

void MixERP.Net.Api.Office.StoreController.Edit	(	int	storeId,
		[FromBody] MixERP.Net.Entities.Office.Store	store
	)

Edits existing record with your instance of Store class.

Parameters

store	Your instance of Store class to edit.
storeId	Enter the value for StoreId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.Store> MixERP.Net.Api.Office.StoreController.Get ( )

Returns collection of store for export.

Returns

MixERP.Net.Entities.Office.Store MixERP.Net.Api.Office.StoreController.Get ( int storeId )

Returns an instance of store.

Parameters

storeId Enter StoreId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.StoreController.GetCustomFields ( )

A custom field is a user defined field for stores.

Returns: Returns an enumerable custom field collection of stores.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.StoreController.GetCustomFields ( string resourceId )

A custom field is a user defined field for stores.

Returns: Returns an enumerable custom field collection of stores.

IEnumerable<DisplayField> MixERP.Net.Api.Office.StoreController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of stores.

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

EntityView MixERP.Net.Api.Office.StoreController.GetEntityView ( )

Creates meta information of "store" entity.

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

IEnumerable<MixERP.Net.Entities.Office.Store> MixERP.Net.Api.Office.StoreController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Office.Store> MixERP.Net.Api.Office.StoreController.GetPagedResult ( )

Creates a paginated collection containing 25 stores on each page, sorted by the property StoreId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Store> MixERP.Net.Api.Office.StoreController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 stores on each page, sorted by the property StoreId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Store> MixERP.Net.Api.Office.StoreController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Office/StoreController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation