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

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

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

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

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

MixERP.Net.Entities.Office.Cashier	Get (long cashierId)
	Returns an instance of cashier. More...

IEnumerable< MixERP.Net.Entities.Office.Cashier >	Get ([FromUri] long[] cashierIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Office.Cashier cashier)
	Adds your instance of Cashier class. More...

void	Edit (long cashierId, [FromBody] MixERP.Net.Entities.Office.Cashier cashier)
	Edits existing record with your instance of Cashier class. More...

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

void	Delete (long cashierId)
	Deletes an existing instance of Cashier class via CashierId. 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 Cashiers.

Member Function Documentation

void MixERP.Net.Api.Office.CashierController.Add ( MixERP.Net.Entities.Office.Cashier cashier )

Adds your instance of Cashier class.

Parameters

cashier Your instance of cashiers class to add.

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

Adds or edits your instance of Cashier class.

Parameters

cashier Your instance of cashiers class to add or edit.

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

Adds or edits multiple instances of Cashier class.

Parameters

collection Your collection of Cashier class to bulk import.

Returns: Returns list of imported cashierIds.

Exceptions

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

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

Counts the number of cashiers.

Returns: Returns the count of the cashiers.

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

Counts the number of cashiers using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered cashiers.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered cashiers.

void MixERP.Net.Api.Office.CashierController.Delete ( long cashierId )

Deletes an existing instance of Cashier class via CashierId.

Parameters

cashierId Enter the value for CashierId in order to find and delete the existing record.

void MixERP.Net.Api.Office.CashierController.Edit	(	long	cashierId,
		[FromBody] MixERP.Net.Entities.Office.Cashier	cashier
	)

Edits existing record with your instance of Cashier class.

Parameters

cashier	Your instance of Cashier class to edit.
cashierId	Enter the value for CashierId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.Cashier> MixERP.Net.Api.Office.CashierController.Get ( )

Returns collection of cashier for export.

Returns

MixERP.Net.Entities.Office.Cashier MixERP.Net.Api.Office.CashierController.Get ( long cashierId )

Returns an instance of cashier.

Parameters

cashierId Enter CashierId to search for.

Returns

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

A custom field is a user defined field for cashiers.

Returns: Returns an enumerable custom field collection of cashiers.

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

A custom field is a user defined field for cashiers.

Returns: Returns an enumerable custom field collection of cashiers.

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

Displayfield is a lightweight key/value collection of cashiers.

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

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

Creates meta information of "cashier" entity.

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

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

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

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

Creates a paginated collection containing 25 cashiers on each page, sorted by the property CashierId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Cashier> MixERP.Net.Api.Office.CashierController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 cashiers on each page, sorted by the property CashierId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation