MixERP.Net.Api.HRM.ExitTypeController Class Reference

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

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

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "exit type" entity. More...
 
long Count ()
 Counts the number of exit types. More...
 
IEnumerable< MixERP.Net.Entities.HRM.ExitTypeGet ()
 Returns collection of exit type for export. More...
 
MixERP.Net.Entities.HRM.ExitType Get (int exitTypeId)
 Returns an instance of exit type. More...
 
IEnumerable< MixERP.Net.Entities.HRM.ExitTypeGet ([FromUri] int[] exitTypeIds)
 
IEnumerable< MixERP.Net.Entities.HRM.ExitTypeGetPagedResult ()
 Creates a paginated collection containing 25 exit types on each page, sorted by the property ExitTypeId. More...
 
IEnumerable< MixERP.Net.Entities.HRM.ExitTypeGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 exit types on each page, sorted by the property ExitTypeId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of exit types using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.HRM.ExitTypeGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 exit types on each page, sorted by the property ExitTypeId. More...
 
long CountFiltered (string filterName)
 Counts the number of exit types using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.HRM.ExitTypeGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 exit types on each page, sorted by the property ExitTypeId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of exit types. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for exit types. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for exit types. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of ExitType class. More...
 
void Add (MixERP.Net.Entities.HRM.ExitType exitType)
 Adds your instance of ExitType class. More...
 
void Edit (int exitTypeId, [FromBody] MixERP.Net.Entities.HRM.ExitType exitType)
 Edits existing record with your instance of ExitType class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of ExitType class. More...
 
void Delete (int exitTypeId)
 Deletes an existing instance of ExitType class via ExitTypeId. 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 Exit Types.

Member Function Documentation

void MixERP.Net.Api.HRM.ExitTypeController.Add ( MixERP.Net.Entities.HRM.ExitType  exitType)

Adds your instance of ExitType class.

Parameters
exitTypeYour instance of exit types class to add.
void MixERP.Net.Api.HRM.ExitTypeController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of ExitType class.

Parameters
exitTypeYour instance of exit types class to add or edit.
List<object> MixERP.Net.Api.HRM.ExitTypeController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of ExitType class.

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

Counts the number of exit types.

Returns
Returns the count of the exit types.
long MixERP.Net.Api.HRM.ExitTypeController.CountFiltered ( string  filterName)

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

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered exit types.
long MixERP.Net.Api.HRM.ExitTypeController.CountWhere ( [FromBody] dynamic  filters)

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered exit types.
void MixERP.Net.Api.HRM.ExitTypeController.Delete ( int  exitTypeId)

Deletes an existing instance of ExitType class via ExitTypeId.

Parameters
exitTypeIdEnter the value for ExitTypeId in order to find and delete the existing record.
void MixERP.Net.Api.HRM.ExitTypeController.Edit ( int  exitTypeId,
[FromBody] MixERP.Net.Entities.HRM.ExitType  exitType 
)

Edits existing record with your instance of ExitType class.

Parameters
exitTypeYour instance of ExitType class to edit.
exitTypeIdEnter the value for ExitTypeId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.HRM.ExitType> MixERP.Net.Api.HRM.ExitTypeController.Get ( )

Returns collection of exit type for export.

Returns
MixERP.Net.Entities.HRM.ExitType MixERP.Net.Api.HRM.ExitTypeController.Get ( int  exitTypeId)

Returns an instance of exit type.

Parameters
exitTypeIdEnter ExitTypeId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.ExitTypeController.GetCustomFields ( )

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

Returns
Returns an enumerable custom field collection of exit types.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.ExitTypeController.GetCustomFields ( string  resourceId)

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

Returns
Returns an enumerable custom field collection of exit types.
IEnumerable<DisplayField> MixERP.Net.Api.HRM.ExitTypeController.GetDisplayFields ( )

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

Returns
Returns an enumerable key/value collection of exit types.
EntityView MixERP.Net.Api.HRM.ExitTypeController.GetEntityView ( )

Creates meta information of "exit type" entity.

Returns
Returns the "exit type" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.HRM.ExitType> MixERP.Net.Api.HRM.ExitTypeController.GetFiltered ( long  pageNumber,
string  filterName 
)

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

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

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

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

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

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

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

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: