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

Inheritance diagram for MixERP.Net.Api.Transactions.RoutineController:

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

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

IEnumerable< MixERP.Net.Entities.Transactions.Routine >	Get ()
	Returns collection of routine for export. More...

MixERP.Net.Entities.Transactions.Routine	Get (int routineId)
	Returns an instance of routine. More...

IEnumerable< MixERP.Net.Entities.Transactions.Routine >	Get ([FromUri] int[] routineIds)

IEnumerable< MixERP.Net.Entities.Transactions.Routine >	GetPagedResult ()
	Creates a paginated collection containing 25 routines on each page, sorted by the property RoutineId. More...

IEnumerable< MixERP.Net.Entities.Transactions.Routine >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 routines on each page, sorted by the property RoutineId. More...

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

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

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

IEnumerable< MixERP.Net.Entities.Transactions.Routine >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 routines on each page, sorted by the property RoutineId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Transactions.Routine routine)
	Adds your instance of Routine class. More...

void	Edit (int routineId, [FromBody] MixERP.Net.Entities.Transactions.Routine routine)
	Edits existing record with your instance of Routine class. More...

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

void	Delete (int routineId)
	Deletes an existing instance of Routine class via RoutineId. 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 Routines.

Member Function Documentation

void MixERP.Net.Api.Transactions.RoutineController.Add ( MixERP.Net.Entities.Transactions.Routine routine )

Adds your instance of Routine class.

Parameters

routine Your instance of routines class to add.

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

Adds or edits your instance of Routine class.

Parameters

routine Your instance of routines class to add or edit.

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

Adds or edits multiple instances of Routine class.

Parameters

collection Your collection of Routine class to bulk import.

Returns: Returns list of imported routineIds.

Exceptions

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

long MixERP.Net.Api.Transactions.RoutineController.Count ( )

Counts the number of routines.

Returns: Returns the count of the routines.

long MixERP.Net.Api.Transactions.RoutineController.CountFiltered ( string filterName )

Counts the number of routines using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered routines.

long MixERP.Net.Api.Transactions.RoutineController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered routines.

void MixERP.Net.Api.Transactions.RoutineController.Delete ( int routineId )

Deletes an existing instance of Routine class via RoutineId.

Parameters

routineId Enter the value for RoutineId in order to find and delete the existing record.

void MixERP.Net.Api.Transactions.RoutineController.Edit	(	int	routineId,
		[FromBody] MixERP.Net.Entities.Transactions.Routine	routine
	)

Edits existing record with your instance of Routine class.

Parameters

routine	Your instance of Routine class to edit.
routineId	Enter the value for RoutineId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Transactions.Routine> MixERP.Net.Api.Transactions.RoutineController.Get ( )

Returns collection of routine for export.

Returns

MixERP.Net.Entities.Transactions.Routine MixERP.Net.Api.Transactions.RoutineController.Get ( int routineId )

Returns an instance of routine.

Parameters

routineId Enter RoutineId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.RoutineController.GetCustomFields ( )

A custom field is a user defined field for routines.

Returns: Returns an enumerable custom field collection of routines.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Transactions.RoutineController.GetCustomFields ( string resourceId )

A custom field is a user defined field for routines.

Returns: Returns an enumerable custom field collection of routines.

IEnumerable<DisplayField> MixERP.Net.Api.Transactions.RoutineController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of routines.

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

EntityView MixERP.Net.Api.Transactions.RoutineController.GetEntityView ( )

Creates meta information of "routine" entity.

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

IEnumerable<MixERP.Net.Entities.Transactions.Routine> MixERP.Net.Api.Transactions.RoutineController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Transactions.Routine> MixERP.Net.Api.Transactions.RoutineController.GetPagedResult ( )

Creates a paginated collection containing 25 routines on each page, sorted by the property RoutineId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Transactions.Routine> MixERP.Net.Api.Transactions.RoutineController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 routines on each page, sorted by the property RoutineId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Transactions.Routine> MixERP.Net.Api.Transactions.RoutineController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Transactions/RoutineController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation