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

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

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

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

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

MixERP.Net.Entities.Office.StoreType	Get (int storeTypeId)
	Returns an instance of store type. More...

IEnumerable< MixERP.Net.Entities.Office.StoreType >	Get ([FromUri] int[] storeTypeIds)

IEnumerable< MixERP.Net.Entities.Office.StoreType >	GetPagedResult ()
	Creates a paginated collection containing 25 store types on each page, sorted by the property StoreTypeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Office.StoreType storeType)
	Adds your instance of StoreType class. More...

void	Edit (int storeTypeId, [FromBody] MixERP.Net.Entities.Office.StoreType storeType)
	Edits existing record with your instance of StoreType class. More...

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

void	Delete (int storeTypeId)
	Deletes an existing instance of StoreType class via StoreTypeId. 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 Types.

Member Function Documentation

void MixERP.Net.Api.Office.StoreTypeController.Add ( MixERP.Net.Entities.Office.StoreType storeType )

Adds your instance of StoreType class.

Parameters

storeType Your instance of store types class to add.

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

Adds or edits your instance of StoreType class.

Parameters

storeType Your instance of store types class to add or edit.

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

Adds or edits multiple instances of StoreType class.

Parameters

collection Your collection of StoreType class to bulk import.

Returns: Returns list of imported storeTypeIds.

Exceptions

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

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

Counts the number of store types.

Returns: Returns the count of the store types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered store types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered store types.

void MixERP.Net.Api.Office.StoreTypeController.Delete ( int storeTypeId )

Deletes an existing instance of StoreType class via StoreTypeId.

Parameters

storeTypeId Enter the value for StoreTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Office.StoreTypeController.Edit	(	int	storeTypeId,
		[FromBody] MixERP.Net.Entities.Office.StoreType	storeType
	)

Edits existing record with your instance of StoreType class.

Parameters

storeType	Your instance of StoreType class to edit.
storeTypeId	Enter the value for StoreTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.StoreType> MixERP.Net.Api.Office.StoreTypeController.Get ( )

Returns collection of store type for export.

Returns

MixERP.Net.Entities.Office.StoreType MixERP.Net.Api.Office.StoreTypeController.Get ( int storeTypeId )

Returns an instance of store type.

Parameters

storeTypeId Enter StoreTypeId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "store type" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.StoreType> MixERP.Net.Api.Office.StoreTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation