MixERP.Net.Api.HRM.EmploymentStatusCodeController Class Reference

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

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

Public Member Functions

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

Member Function Documentation

void MixERP.Net.Api.HRM.EmploymentStatusCodeController.Add ( MixERP.Net.Entities.HRM.EmploymentStatusCode  employmentStatusCode)

Adds your instance of EmploymentStatusCode class.

Parameters
employmentStatusCodeYour instance of employment status codes class to add.
void MixERP.Net.Api.HRM.EmploymentStatusCodeController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of EmploymentStatusCode class.

Parameters
employmentStatusCodeYour instance of employment status codes class to add or edit.
List<object> MixERP.Net.Api.HRM.EmploymentStatusCodeController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of EmploymentStatusCode class.

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

Counts the number of employment status codes.

Returns
Returns the count of the employment status codes.
long MixERP.Net.Api.HRM.EmploymentStatusCodeController.CountFiltered ( string  filterName)

Counts the number of employment status codes using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered employment status codes.
long MixERP.Net.Api.HRM.EmploymentStatusCodeController.CountWhere ( [FromBody] dynamic  filters)

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered employment status codes.
void MixERP.Net.Api.HRM.EmploymentStatusCodeController.Delete ( int  employmentStatusCodeId)

Deletes an existing instance of EmploymentStatusCode class via EmploymentStatusCodeId.

Parameters
employmentStatusCodeIdEnter the value for EmploymentStatusCodeId in order to find and delete the existing record.
void MixERP.Net.Api.HRM.EmploymentStatusCodeController.Edit ( int  employmentStatusCodeId,
[FromBody] MixERP.Net.Entities.HRM.EmploymentStatusCode  employmentStatusCode 
)

Edits existing record with your instance of EmploymentStatusCode class.

Parameters
employmentStatusCodeYour instance of EmploymentStatusCode class to edit.
employmentStatusCodeIdEnter the value for EmploymentStatusCodeId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.HRM.EmploymentStatusCode> MixERP.Net.Api.HRM.EmploymentStatusCodeController.Get ( )

Returns collection of employment status code for export.

Returns
MixERP.Net.Entities.HRM.EmploymentStatusCode MixERP.Net.Api.HRM.EmploymentStatusCodeController.Get ( int  employmentStatusCodeId)

Returns an instance of employment status code.

Parameters
employmentStatusCodeIdEnter EmploymentStatusCodeId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.EmploymentStatusCodeController.GetCustomFields ( )

A custom field is a user defined field for employment status codes.

Returns
Returns an enumerable custom field collection of employment status codes.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.HRM.EmploymentStatusCodeController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for employment status codes.

Returns
Returns an enumerable custom field collection of employment status codes.
IEnumerable<DisplayField> MixERP.Net.Api.HRM.EmploymentStatusCodeController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of employment status codes.

Returns
Returns an enumerable key/value collection of employment status codes.
EntityView MixERP.Net.Api.HRM.EmploymentStatusCodeController.GetEntityView ( )

Creates meta information of "employment status code" entity.

Returns
Returns the "employment status code" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.HRM.EmploymentStatusCode> MixERP.Net.Api.HRM.EmploymentStatusCodeController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 employment status codes on each page, sorted by the property EmploymentStatusCodeId.

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

Creates a paginated collection containing 25 employment status codes on each page, sorted by the property EmploymentStatusCodeId.

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

Creates a paginated collection containing 25 employment status codes on each page, sorted by the property EmploymentStatusCodeId.

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

Creates a filtered and paginated collection containing 25 employment status codes on each page, sorted by the property EmploymentStatusCodeId.

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: