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

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

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

long	Count ()
	Counts the number of employment statuses. More...

IEnumerable< MixERP.Net.Entities.HRM.EmploymentStatus >	Get ()
	Returns collection of employment status for export. More...

MixERP.Net.Entities.HRM.EmploymentStatus	Get (int employmentStatusId)
	Returns an instance of employment status. More...

IEnumerable< MixERP.Net.Entities.HRM.EmploymentStatus >	Get ([FromUri] int[] employmentStatusIds)

IEnumerable< MixERP.Net.Entities.HRM.EmploymentStatus >	GetPagedResult ()
	Creates a paginated collection containing 25 employment statuses on each page, sorted by the property EmploymentStatusId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.EmploymentStatus employmentStatus)
	Adds your instance of EmploymentStatus class. More...

void	Edit (int employmentStatusId, [FromBody] MixERP.Net.Entities.HRM.EmploymentStatus employmentStatus)
	Edits existing record with your instance of EmploymentStatus class. More...

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

void	Delete (int employmentStatusId)
	Deletes an existing instance of EmploymentStatus class via EmploymentStatusId. 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 Employment Statuses.

Member Function Documentation

void MixERP.Net.Api.HRM.EmploymentStatusController.Add ( MixERP.Net.Entities.HRM.EmploymentStatus employmentStatus )

Adds your instance of EmploymentStatus class.

Parameters

employmentStatus Your instance of employment statuses class to add.

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

Adds or edits your instance of EmploymentStatus class.

Parameters

employmentStatus Your instance of employment statuses class to add or edit.

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

Adds or edits multiple instances of EmploymentStatus class.

Parameters

collection Your collection of EmploymentStatus class to bulk import.

Returns: Returns list of imported employmentStatusIds.

Exceptions

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

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

Counts the number of employment statuses.

Returns: Returns the count of the employment statuses.

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

Counts the number of employment statuses using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered employment statuses.

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

Counts the number of employment statuses using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered employment statuses.

void MixERP.Net.Api.HRM.EmploymentStatusController.Delete ( int employmentStatusId )

Deletes an existing instance of EmploymentStatus class via EmploymentStatusId.

Parameters

employmentStatusId Enter the value for EmploymentStatusId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.EmploymentStatusController.Edit	(	int	employmentStatusId,
		[FromBody] MixERP.Net.Entities.HRM.EmploymentStatus	employmentStatus
	)

Edits existing record with your instance of EmploymentStatus class.

Parameters

employmentStatus	Your instance of EmploymentStatus class to edit.
employmentStatusId	Enter the value for EmploymentStatusId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.EmploymentStatus> MixERP.Net.Api.HRM.EmploymentStatusController.Get ( )

Returns collection of employment status for export.

Returns

MixERP.Net.Entities.HRM.EmploymentStatus MixERP.Net.Api.HRM.EmploymentStatusController.Get ( int employmentStatusId )

Returns an instance of employment status.

Parameters

employmentStatusId Enter EmploymentStatusId to search for.

Returns

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

A custom field is a user defined field for employment statuses.

Returns: Returns an enumerable custom field collection of employment statuses.

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

A custom field is a user defined field for employment statuses.

Returns: Returns an enumerable custom field collection of employment statuses.

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

Displayfield is a lightweight key/value collection of employment statuses.

Returns: Returns an enumerable key/value collection of employment statuses.

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

Creates meta information of "employment status" entity.

Returns: Returns the "employment status" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 employment statuses on each page, sorted by the property EmploymentStatusId.

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

Creates a paginated collection containing 25 employment statuses on each page, sorted by the property EmploymentStatusId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.EmploymentStatus> MixERP.Net.Api.HRM.EmploymentStatusController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 employment statuses on each page, sorted by the property EmploymentStatusId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 employment statuses on each page, sorted by the property EmploymentStatusId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation