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

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

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

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

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

MixERP.Net.Entities.HRM.Employee	Get (int employeeId)
	Returns an instance of employee. More...

IEnumerable< MixERP.Net.Entities.HRM.Employee >	Get ([FromUri] int[] employeeIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.Employee employee)
	Adds your instance of Employee class. More...

void	Edit (int employeeId, [FromBody] MixERP.Net.Entities.HRM.Employee employee)
	Edits existing record with your instance of Employee class. More...

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

void	Delete (int employeeId)
	Deletes an existing instance of Employee class via EmployeeId. 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 Employees.

Member Function Documentation

void MixERP.Net.Api.HRM.EmployeeController.Add ( MixERP.Net.Entities.HRM.Employee employee )

Adds your instance of Employee class.

Parameters

employee Your instance of employees class to add.

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

Adds or edits your instance of Employee class.

Parameters

employee Your instance of employees class to add or edit.

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

Adds or edits multiple instances of Employee class.

Parameters

collection Your collection of Employee class to bulk import.

Returns: Returns list of imported employeeIds.

Exceptions

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

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

Counts the number of employees.

Returns: Returns the count of the employees.

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

Counts the number of employees using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered employees.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered employees.

void MixERP.Net.Api.HRM.EmployeeController.Delete ( int employeeId )

Deletes an existing instance of Employee class via EmployeeId.

Parameters

employeeId Enter the value for EmployeeId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.EmployeeController.Edit	(	int	employeeId,
		[FromBody] MixERP.Net.Entities.HRM.Employee	employee
	)

Edits existing record with your instance of Employee class.

Parameters

employee	Your instance of Employee class to edit.
employeeId	Enter the value for EmployeeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.Employee> MixERP.Net.Api.HRM.EmployeeController.Get ( )

Returns collection of employee for export.

Returns

MixERP.Net.Entities.HRM.Employee MixERP.Net.Api.HRM.EmployeeController.Get ( int employeeId )

Returns an instance of employee.

Parameters

employeeId Enter EmployeeId to search for.

Returns

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

A custom field is a user defined field for employees.

Returns: Returns an enumerable custom field collection of employees.

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

A custom field is a user defined field for employees.

Returns: Returns an enumerable custom field collection of employees.

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

Displayfield is a lightweight key/value collection of employees.

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

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

Creates meta information of "employee" entity.

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

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

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

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

Creates a paginated collection containing 25 employees on each page, sorted by the property EmployeeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.Employee> MixERP.Net.Api.HRM.EmployeeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 employees on each page, sorted by the property EmployeeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation