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

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

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

long	Count ()
	Counts the number of job titles. More...

IEnumerable< MixERP.Net.Entities.HRM.JobTitle >	Get ()
	Returns collection of job title for export. More...

MixERP.Net.Entities.HRM.JobTitle	Get (int jobTitleId)
	Returns an instance of job title. More...

IEnumerable< MixERP.Net.Entities.HRM.JobTitle >	Get ([FromUri] int[] jobTitleIds)

IEnumerable< MixERP.Net.Entities.HRM.JobTitle >	GetPagedResult ()
	Creates a paginated collection containing 25 job titles on each page, sorted by the property JobTitleId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.JobTitle jobTitle)
	Adds your instance of JobTitle class. More...

void	Edit (int jobTitleId, [FromBody] MixERP.Net.Entities.HRM.JobTitle jobTitle)
	Edits existing record with your instance of JobTitle class. More...

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

void	Delete (int jobTitleId)
	Deletes an existing instance of JobTitle class via JobTitleId. 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 Job Titles.

Member Function Documentation

void MixERP.Net.Api.HRM.JobTitleController.Add ( MixERP.Net.Entities.HRM.JobTitle jobTitle )

Adds your instance of JobTitle class.

Parameters

jobTitle Your instance of job titles class to add.

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

Adds or edits your instance of JobTitle class.

Parameters

jobTitle Your instance of job titles class to add or edit.

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

Adds or edits multiple instances of JobTitle class.

Parameters

collection Your collection of JobTitle class to bulk import.

Returns: Returns list of imported jobTitleIds.

Exceptions

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

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

Counts the number of job titles.

Returns: Returns the count of the job titles.

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

Counts the number of job titles using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered job titles.

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

Counts the number of job titles using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered job titles.

void MixERP.Net.Api.HRM.JobTitleController.Delete ( int jobTitleId )

Deletes an existing instance of JobTitle class via JobTitleId.

Parameters

jobTitleId Enter the value for JobTitleId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.JobTitleController.Edit	(	int	jobTitleId,
		[FromBody] MixERP.Net.Entities.HRM.JobTitle	jobTitle
	)

Edits existing record with your instance of JobTitle class.

Parameters

jobTitle	Your instance of JobTitle class to edit.
jobTitleId	Enter the value for JobTitleId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.JobTitle> MixERP.Net.Api.HRM.JobTitleController.Get ( )

Returns collection of job title for export.

Returns

MixERP.Net.Entities.HRM.JobTitle MixERP.Net.Api.HRM.JobTitleController.Get ( int jobTitleId )

Returns an instance of job title.

Parameters

jobTitleId Enter JobTitleId to search for.

Returns

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

A custom field is a user defined field for job titles.

Returns: Returns an enumerable custom field collection of job titles.

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

A custom field is a user defined field for job titles.

Returns: Returns an enumerable custom field collection of job titles.

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

Displayfield is a lightweight key/value collection of job titles.

Returns: Returns an enumerable key/value collection of job titles.

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

Creates meta information of "job title" entity.

Returns: Returns the "job title" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 job titles on each page, sorted by the property JobTitleId.

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

Creates a paginated collection containing 25 job titles on each page, sorted by the property JobTitleId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.JobTitle> MixERP.Net.Api.HRM.JobTitleController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 job titles on each page, sorted by the property JobTitleId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 job titles on each page, sorted by the property JobTitleId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation