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

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

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

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

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

MixERP.Net.Entities.HRM.Salary	Get (long salaryId)
	Returns an instance of salary. More...

IEnumerable< MixERP.Net.Entities.HRM.Salary >	Get ([FromUri] long[] salaryIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.Salary salary)
	Adds your instance of Salary class. More...

void	Edit (long salaryId, [FromBody] MixERP.Net.Entities.HRM.Salary salary)
	Edits existing record with your instance of Salary class. More...

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

void	Delete (long salaryId)
	Deletes an existing instance of Salary class via SalaryId. 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 Salaries.

Member Function Documentation

void MixERP.Net.Api.HRM.SalaryController.Add ( MixERP.Net.Entities.HRM.Salary salary )

Adds your instance of Salary class.

Parameters

salary Your instance of salaries class to add.

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

Adds or edits your instance of Salary class.

Parameters

salary Your instance of salaries class to add or edit.

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

Adds or edits multiple instances of Salary class.

Parameters

collection Your collection of Salary class to bulk import.

Returns: Returns list of imported salaryIds.

Exceptions

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

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

Counts the number of salaries.

Returns: Returns the count of the salaries.

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

Counts the number of salaries using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered salaries.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered salaries.

void MixERP.Net.Api.HRM.SalaryController.Delete ( long salaryId )

Deletes an existing instance of Salary class via SalaryId.

Parameters

salaryId Enter the value for SalaryId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.SalaryController.Edit	(	long	salaryId,
		[FromBody] MixERP.Net.Entities.HRM.Salary	salary
	)

Edits existing record with your instance of Salary class.

Parameters

salary	Your instance of Salary class to edit.
salaryId	Enter the value for SalaryId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.Salary> MixERP.Net.Api.HRM.SalaryController.Get ( )

Returns collection of salary for export.

Returns

MixERP.Net.Entities.HRM.Salary MixERP.Net.Api.HRM.SalaryController.Get ( long salaryId )

Returns an instance of salary.

Parameters

salaryId Enter SalaryId to search for.

Returns

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

A custom field is a user defined field for salaries.

Returns: Returns an enumerable custom field collection of salaries.

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

A custom field is a user defined field for salaries.

Returns: Returns an enumerable custom field collection of salaries.

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

Displayfield is a lightweight key/value collection of salaries.

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

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

Creates meta information of "salary" entity.

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

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

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

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

Creates a paginated collection containing 25 salaries on each page, sorted by the property SalaryId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.Salary> MixERP.Net.Api.HRM.SalaryController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 salaries on each page, sorted by the property SalaryId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation