MixERP.Net.Api.HRM.ResignationController Class Reference

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

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

Public Member Functions

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

Member Function Documentation

void MixERP.Net.Api.HRM.ResignationController.Add ( MixERP.Net.Entities.HRM.Resignation  resignation)

Adds your instance of Resignation class.

Parameters
resignationYour instance of resignations class to add.
void MixERP.Net.Api.HRM.ResignationController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of Resignation class.

Parameters
resignationYour instance of resignations class to add or edit.
List<object> MixERP.Net.Api.HRM.ResignationController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of Resignation class.

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

Counts the number of resignations.

Returns
Returns the count of the resignations.
long MixERP.Net.Api.HRM.ResignationController.CountFiltered ( string  filterName)

Counts the number of resignations using the supplied filter name.

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

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered resignations.
void MixERP.Net.Api.HRM.ResignationController.Delete ( int  resignationId)

Deletes an existing instance of Resignation class via ResignationId.

Parameters
resignationIdEnter the value for ResignationId in order to find and delete the existing record.
void MixERP.Net.Api.HRM.ResignationController.Edit ( int  resignationId,
[FromBody] MixERP.Net.Entities.HRM.Resignation  resignation 
)

Edits existing record with your instance of Resignation class.

Parameters
resignationYour instance of Resignation class to edit.
resignationIdEnter the value for ResignationId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.HRM.Resignation> MixERP.Net.Api.HRM.ResignationController.Get ( )

Returns collection of resignation for export.

Returns
MixERP.Net.Entities.HRM.Resignation MixERP.Net.Api.HRM.ResignationController.Get ( int  resignationId)

Returns an instance of resignation.

Parameters
resignationIdEnter ResignationId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.ResignationController.GetCustomFields ( )

A custom field is a user defined field for resignations.

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

A custom field is a user defined field for resignations.

Returns
Returns an enumerable custom field collection of resignations.
IEnumerable<DisplayField> MixERP.Net.Api.HRM.ResignationController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of resignations.

Returns
Returns an enumerable key/value collection of resignations.
EntityView MixERP.Net.Api.HRM.ResignationController.GetEntityView ( )

Creates meta information of "resignation" entity.

Returns
Returns the "resignation" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.HRM.Resignation> MixERP.Net.Api.HRM.ResignationController.GetFiltered ( long  pageNumber,
string  filterName 
)

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

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

Creates a paginated collection containing 25 resignations on each page, sorted by the property ResignationId.

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

Creates a paginated collection containing 25 resignations on each page, sorted by the property ResignationId.

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

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

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: