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

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

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

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

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

MixERP.Net.Entities.Office.Counter	Get (int counterId)
	Returns an instance of counter. More...

IEnumerable< MixERP.Net.Entities.Office.Counter >	Get ([FromUri] int[] counterIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Office.Counter counter)
	Adds your instance of Counter class. More...

void	Edit (int counterId, [FromBody] MixERP.Net.Entities.Office.Counter counter)
	Edits existing record with your instance of Counter class. More...

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

void	Delete (int counterId)
	Deletes an existing instance of Counter class via CounterId. 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 Counters.

Member Function Documentation

void MixERP.Net.Api.Office.CounterController.Add ( MixERP.Net.Entities.Office.Counter counter )

Adds your instance of Counter class.

Parameters

counter Your instance of counters class to add.

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

Adds or edits your instance of Counter class.

Parameters

counter Your instance of counters class to add or edit.

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

Adds or edits multiple instances of Counter class.

Parameters

collection Your collection of Counter class to bulk import.

Returns: Returns list of imported counterIds.

Exceptions

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

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

Counts the number of counters.

Returns: Returns the count of the counters.

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

Counts the number of counters using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered counters.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered counters.

void MixERP.Net.Api.Office.CounterController.Delete ( int counterId )

Deletes an existing instance of Counter class via CounterId.

Parameters

counterId Enter the value for CounterId in order to find and delete the existing record.

void MixERP.Net.Api.Office.CounterController.Edit	(	int	counterId,
		[FromBody] MixERP.Net.Entities.Office.Counter	counter
	)

Edits existing record with your instance of Counter class.

Parameters

counter	Your instance of Counter class to edit.
counterId	Enter the value for CounterId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.Counter> MixERP.Net.Api.Office.CounterController.Get ( )

Returns collection of counter for export.

Returns

MixERP.Net.Entities.Office.Counter MixERP.Net.Api.Office.CounterController.Get ( int counterId )

Returns an instance of counter.

Parameters

counterId Enter CounterId to search for.

Returns

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

A custom field is a user defined field for counters.

Returns: Returns an enumerable custom field collection of counters.

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

A custom field is a user defined field for counters.

Returns: Returns an enumerable custom field collection of counters.

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

Displayfield is a lightweight key/value collection of counters.

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

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

Creates meta information of "counter" entity.

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

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

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

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

Creates a paginated collection containing 25 counters on each page, sorted by the property CounterId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Counter> MixERP.Net.Api.Office.CounterController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 counters on each page, sorted by the property CounterId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation