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

Inheritance diagram for MixERP.Net.Api.HRM.ExitController:

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

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

IEnumerable< MixERP.Net.Entities.HRM.Exit >	Get ()
	Returns collection of exit for export. More...

MixERP.Net.Entities.HRM.Exit	Get (long exitId)
	Returns an instance of exit. More...

IEnumerable< MixERP.Net.Entities.HRM.Exit >	Get ([FromUri] long[] exitIds)

IEnumerable< MixERP.Net.Entities.HRM.Exit >	GetPagedResult ()
	Creates a paginated collection containing 25 exits on each page, sorted by the property ExitId. More...

IEnumerable< MixERP.Net.Entities.HRM.Exit >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 exits on each page, sorted by the property ExitId. More...

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

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

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

IEnumerable< MixERP.Net.Entities.HRM.Exit >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 exits on each page, sorted by the property ExitId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.Exit exit)
	Adds your instance of Exit class. More...

void	Edit (long exitId, [FromBody] MixERP.Net.Entities.HRM.Exit exit)
	Edits existing record with your instance of Exit class. More...

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

void	Delete (long exitId)
	Deletes an existing instance of Exit class via ExitId. 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 Exits.

Member Function Documentation

void MixERP.Net.Api.HRM.ExitController.Add ( MixERP.Net.Entities.HRM.Exit exit )

Adds your instance of Exit class.

Parameters

exit	Your instance of exits class to add.

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

Adds or edits your instance of Exit class.

Parameters

exit	Your instance of exits class to add or edit.

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

Adds or edits multiple instances of Exit class.

Parameters

collection Your collection of Exit class to bulk import.

Returns: Returns list of imported exitIds.

Exceptions

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

long MixERP.Net.Api.HRM.ExitController.Count ( )

Counts the number of exits.

Returns: Returns the count of the exits.

long MixERP.Net.Api.HRM.ExitController.CountFiltered ( string filterName )

Counts the number of exits using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered exits.

long MixERP.Net.Api.HRM.ExitController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered exits.

void MixERP.Net.Api.HRM.ExitController.Delete ( long exitId )

Deletes an existing instance of Exit class via ExitId.

Parameters

exitId Enter the value for ExitId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.ExitController.Edit	(	long	exitId,
		[FromBody] MixERP.Net.Entities.HRM.Exit	exit
	)

Edits existing record with your instance of Exit class.

Parameters

exit	Your instance of Exit class to edit.
exitId	Enter the value for ExitId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.Exit> MixERP.Net.Api.HRM.ExitController.Get ( )

Returns collection of exit for export.

Returns

MixERP.Net.Entities.HRM.Exit MixERP.Net.Api.HRM.ExitController.Get ( long exitId )

Returns an instance of exit.

Parameters

exitId Enter ExitId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.ExitController.GetCustomFields ( )

A custom field is a user defined field for exits.

Returns: Returns an enumerable custom field collection of exits.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.ExitController.GetCustomFields ( string resourceId )

A custom field is a user defined field for exits.

Returns: Returns an enumerable custom field collection of exits.

IEnumerable<DisplayField> MixERP.Net.Api.HRM.ExitController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of exits.

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

EntityView MixERP.Net.Api.HRM.ExitController.GetEntityView ( )

Creates meta information of "exit" entity.

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

IEnumerable<MixERP.Net.Entities.HRM.Exit> MixERP.Net.Api.HRM.ExitController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.HRM.Exit> MixERP.Net.Api.HRM.ExitController.GetPagedResult ( )

Creates a paginated collection containing 25 exits on each page, sorted by the property ExitId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.Exit> MixERP.Net.Api.HRM.ExitController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 exits on each page, sorted by the property ExitId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.Exit> MixERP.Net.Api.HRM.ExitController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/FrontEnd/MixERP.Net.FrontEnd/Modules/HRM.API/ExitController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation