MixERP.Net.Api.HRM.EducationLevelController Class Reference

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

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

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "education level" entity. More...
 
long Count ()
 Counts the number of education levels. More...
 
IEnumerable< MixERP.Net.Entities.HRM.EducationLevelGet ()
 Returns collection of education level for export. More...
 
MixERP.Net.Entities.HRM.EducationLevel Get (int educationLevelId)
 Returns an instance of education level. More...
 
IEnumerable< MixERP.Net.Entities.HRM.EducationLevelGet ([FromUri] int[] educationLevelIds)
 
IEnumerable< MixERP.Net.Entities.HRM.EducationLevelGetPagedResult ()
 Creates a paginated collection containing 25 education levels on each page, sorted by the property EducationLevelId. More...
 
IEnumerable< MixERP.Net.Entities.HRM.EducationLevelGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 education levels on each page, sorted by the property EducationLevelId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of education levels using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.HRM.EducationLevelGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 education levels on each page, sorted by the property EducationLevelId. More...
 
long CountFiltered (string filterName)
 Counts the number of education levels using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.HRM.EducationLevelGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 education levels on each page, sorted by the property EducationLevelId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of education levels. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for education levels. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for education levels. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of EducationLevel class. More...
 
void Add (MixERP.Net.Entities.HRM.EducationLevel educationLevel)
 Adds your instance of EducationLevel class. More...
 
void Edit (int educationLevelId, [FromBody] MixERP.Net.Entities.HRM.EducationLevel educationLevel)
 Edits existing record with your instance of EducationLevel class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of EducationLevel class. More...
 
void Delete (int educationLevelId)
 Deletes an existing instance of EducationLevel class via EducationLevelId. 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 Education Levels.

Member Function Documentation

void MixERP.Net.Api.HRM.EducationLevelController.Add ( MixERP.Net.Entities.HRM.EducationLevel  educationLevel)

Adds your instance of EducationLevel class.

Parameters
educationLevelYour instance of education levels class to add.
void MixERP.Net.Api.HRM.EducationLevelController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of EducationLevel class.

Parameters
educationLevelYour instance of education levels class to add or edit.
List<object> MixERP.Net.Api.HRM.EducationLevelController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of EducationLevel class.

Parameters
collectionYour collection of EducationLevel class to bulk import.
Returns
Returns list of imported educationLevelIds.
Exceptions
MixERPExceptionThrown when your any EducationLevel class in the collection is invalid or malformed.
long MixERP.Net.Api.HRM.EducationLevelController.Count ( )

Counts the number of education levels.

Returns
Returns the count of the education levels.
long MixERP.Net.Api.HRM.EducationLevelController.CountFiltered ( string  filterName)

Counts the number of education levels using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered education levels.
long MixERP.Net.Api.HRM.EducationLevelController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of education levels using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered education levels.
void MixERP.Net.Api.HRM.EducationLevelController.Delete ( int  educationLevelId)

Deletes an existing instance of EducationLevel class via EducationLevelId.

Parameters
educationLevelIdEnter the value for EducationLevelId in order to find and delete the existing record.
void MixERP.Net.Api.HRM.EducationLevelController.Edit ( int  educationLevelId,
[FromBody] MixERP.Net.Entities.HRM.EducationLevel  educationLevel 
)

Edits existing record with your instance of EducationLevel class.

Parameters
educationLevelYour instance of EducationLevel class to edit.
educationLevelIdEnter the value for EducationLevelId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.HRM.EducationLevel> MixERP.Net.Api.HRM.EducationLevelController.Get ( )

Returns collection of education level for export.

Returns
MixERP.Net.Entities.HRM.EducationLevel MixERP.Net.Api.HRM.EducationLevelController.Get ( int  educationLevelId)

Returns an instance of education level.

Parameters
educationLevelIdEnter EducationLevelId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.EducationLevelController.GetCustomFields ( )

A custom field is a user defined field for education levels.

Returns
Returns an enumerable custom field collection of education levels.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.EducationLevelController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for education levels.

Returns
Returns an enumerable custom field collection of education levels.
IEnumerable<DisplayField> MixERP.Net.Api.HRM.EducationLevelController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of education levels.

Returns
Returns an enumerable key/value collection of education levels.
EntityView MixERP.Net.Api.HRM.EducationLevelController.GetEntityView ( )

Creates meta information of "education level" entity.

Returns
Returns the "education level" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.HRM.EducationLevel> MixERP.Net.Api.HRM.EducationLevelController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 education levels on each page, sorted by the property EducationLevelId.

Parameters
pageNumberEnter the page number to produce the resultset.
filterNameThe named filter.
Returns
Returns the requested page from the collection using the supplied filters.
IEnumerable<MixERP.Net.Entities.HRM.EducationLevel> MixERP.Net.Api.HRM.EducationLevelController.GetPagedResult ( )

Creates a paginated collection containing 25 education levels on each page, sorted by the property EducationLevelId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.HRM.EducationLevel> MixERP.Net.Api.HRM.EducationLevelController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 education levels on each page, sorted by the property EducationLevelId.

Parameters
pageNumberEnter the page number to produce the resultset.
Returns
Returns the requested page from the collection.
IEnumerable<MixERP.Net.Entities.HRM.EducationLevel> MixERP.Net.Api.HRM.EducationLevelController.GetWhere ( long  pageNumber,
[FromBody] dynamic  filters 
)

Creates a filtered and paginated collection containing 25 education levels on each page, sorted by the property EducationLevelId.

Parameters
pageNumberEnter the page number to produce the resultset.
filtersThe 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: