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

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

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

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

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

MixERP.Net.Entities.HRM.EmployeeType	Get (int employeeTypeId)
	Returns an instance of employee type. More...

IEnumerable< MixERP.Net.Entities.HRM.EmployeeType >	Get ([FromUri] int[] employeeTypeIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.EmployeeType employeeType)
	Adds your instance of EmployeeType class. More...

void	Edit (int employeeTypeId, [FromBody] MixERP.Net.Entities.HRM.EmployeeType employeeType)
	Edits existing record with your instance of EmployeeType class. More...

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

void	Delete (int employeeTypeId)
	Deletes an existing instance of EmployeeType class via EmployeeTypeId. 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 Employee Types.

Member Function Documentation

void MixERP.Net.Api.HRM.EmployeeTypeController.Add ( MixERP.Net.Entities.HRM.EmployeeType employeeType )

Adds your instance of EmployeeType class.

Parameters

employeeType Your instance of employee types class to add.

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

Adds or edits your instance of EmployeeType class.

Parameters

employeeType Your instance of employee types class to add or edit.

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

Adds or edits multiple instances of EmployeeType class.

Parameters

collection Your collection of EmployeeType class to bulk import.

Returns: Returns list of imported employeeTypeIds.

Exceptions

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

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

Counts the number of employee types.

Returns: Returns the count of the employee types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered employee types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered employee types.

void MixERP.Net.Api.HRM.EmployeeTypeController.Delete ( int employeeTypeId )

Deletes an existing instance of EmployeeType class via EmployeeTypeId.

Parameters

employeeTypeId Enter the value for EmployeeTypeId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.EmployeeTypeController.Edit	(	int	employeeTypeId,
		[FromBody] MixERP.Net.Entities.HRM.EmployeeType	employeeType
	)

Edits existing record with your instance of EmployeeType class.

Parameters

employeeType	Your instance of EmployeeType class to edit.
employeeTypeId	Enter the value for EmployeeTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.EmployeeType> MixERP.Net.Api.HRM.EmployeeTypeController.Get ( )

Returns collection of employee type for export.

Returns

MixERP.Net.Entities.HRM.EmployeeType MixERP.Net.Api.HRM.EmployeeTypeController.Get ( int employeeTypeId )

Returns an instance of employee type.

Parameters

employeeTypeId Enter EmployeeTypeId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "employee type" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.EmployeeType> MixERP.Net.Api.HRM.EmployeeTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation