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

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

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

long	Count ()
	Counts the number of shifts. More...

IEnumerable< MixERP.Net.Entities.HRM.Shift >	Get ()
	Returns collection of shift for export. More...

MixERP.Net.Entities.HRM.Shift	Get (int shiftId)
	Returns an instance of shift. More...

IEnumerable< MixERP.Net.Entities.HRM.Shift >	Get ([FromUri] int[] shiftIds)

IEnumerable< MixERP.Net.Entities.HRM.Shift >	GetPagedResult ()
	Creates a paginated collection containing 25 shifts on each page, sorted by the property ShiftId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.Shift shift)
	Adds your instance of Shift class. More...

void	Edit (int shiftId, [FromBody] MixERP.Net.Entities.HRM.Shift shift)
	Edits existing record with your instance of Shift class. More...

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

void	Delete (int shiftId)
	Deletes an existing instance of Shift class via ShiftId. 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 Shifts.

Member Function Documentation

void MixERP.Net.Api.HRM.ShiftController.Add ( MixERP.Net.Entities.HRM.Shift shift )

Adds your instance of Shift class.

Parameters

shift Your instance of shifts class to add.

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

Adds or edits your instance of Shift class.

Parameters

shift Your instance of shifts class to add or edit.

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

Adds or edits multiple instances of Shift class.

Parameters

collection Your collection of Shift class to bulk import.

Returns: Returns list of imported shiftIds.

Exceptions

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

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

Counts the number of shifts.

Returns: Returns the count of the shifts.

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

Counts the number of shifts using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered shifts.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered shifts.

void MixERP.Net.Api.HRM.ShiftController.Delete ( int shiftId )

Deletes an existing instance of Shift class via ShiftId.

Parameters

shiftId Enter the value for ShiftId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.ShiftController.Edit	(	int	shiftId,
		[FromBody] MixERP.Net.Entities.HRM.Shift	shift
	)

Edits existing record with your instance of Shift class.

Parameters

shift	Your instance of Shift class to edit.
shiftId	Enter the value for ShiftId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.Shift> MixERP.Net.Api.HRM.ShiftController.Get ( )

Returns collection of shift for export.

Returns

MixERP.Net.Entities.HRM.Shift MixERP.Net.Api.HRM.ShiftController.Get ( int shiftId )

Returns an instance of shift.

Parameters

shiftId Enter ShiftId to search for.

Returns

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

A custom field is a user defined field for shifts.

Returns: Returns an enumerable custom field collection of shifts.

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

A custom field is a user defined field for shifts.

Returns: Returns an enumerable custom field collection of shifts.

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

Displayfield is a lightweight key/value collection of shifts.

Returns: Returns an enumerable key/value collection of shifts.

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

Creates meta information of "shift" entity.

Returns: Returns the "shift" meta information to perform CRUD operation.

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

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

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

Creates a paginated collection containing 25 shifts on each page, sorted by the property ShiftId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.Shift> MixERP.Net.Api.HRM.ShiftController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 shifts on each page, sorted by the property ShiftId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation