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

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

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

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

IEnumerable< MixERP.Net.Entities.HRM.LeaveType >	Get ()
	Returns collection of leave type for export. More...

MixERP.Net.Entities.HRM.LeaveType	Get (int leaveTypeId)
	Returns an instance of leave type. More...

IEnumerable< MixERP.Net.Entities.HRM.LeaveType >	Get ([FromUri] int[] leaveTypeIds)

IEnumerable< MixERP.Net.Entities.HRM.LeaveType >	GetPagedResult ()
	Creates a paginated collection containing 25 leave types on each page, sorted by the property LeaveTypeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.LeaveType leaveType)
	Adds your instance of LeaveType class. More...

void	Edit (int leaveTypeId, [FromBody] MixERP.Net.Entities.HRM.LeaveType leaveType)
	Edits existing record with your instance of LeaveType class. More...

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

void	Delete (int leaveTypeId)
	Deletes an existing instance of LeaveType class via LeaveTypeId. 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 Leave Types.

Member Function Documentation

void MixERP.Net.Api.HRM.LeaveTypeController.Add ( MixERP.Net.Entities.HRM.LeaveType leaveType )

Adds your instance of LeaveType class.

Parameters

leaveType Your instance of leave types class to add.

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

Adds or edits your instance of LeaveType class.

Parameters

leaveType Your instance of leave types class to add or edit.

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

Adds or edits multiple instances of LeaveType class.

Parameters

collection Your collection of LeaveType class to bulk import.

Returns: Returns list of imported leaveTypeIds.

Exceptions

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

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

Counts the number of leave types.

Returns: Returns the count of the leave types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered leave types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered leave types.

void MixERP.Net.Api.HRM.LeaveTypeController.Delete ( int leaveTypeId )

Deletes an existing instance of LeaveType class via LeaveTypeId.

Parameters

leaveTypeId Enter the value for LeaveTypeId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.LeaveTypeController.Edit	(	int	leaveTypeId,
		[FromBody] MixERP.Net.Entities.HRM.LeaveType	leaveType
	)

Edits existing record with your instance of LeaveType class.

Parameters

leaveType	Your instance of LeaveType class to edit.
leaveTypeId	Enter the value for LeaveTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.LeaveType> MixERP.Net.Api.HRM.LeaveTypeController.Get ( )

Returns collection of leave type for export.

Returns

MixERP.Net.Entities.HRM.LeaveType MixERP.Net.Api.HRM.LeaveTypeController.Get ( int leaveTypeId )

Returns an instance of leave type.

Parameters

leaveTypeId Enter LeaveTypeId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "leave type" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.LeaveType> MixERP.Net.Api.HRM.LeaveTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation