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

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

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

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

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

MixERP.Net.Entities.HRM.Contract	Get (long contractId)
	Returns an instance of contract. More...

IEnumerable< MixERP.Net.Entities.HRM.Contract >	Get ([FromUri] long[] contractIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.HRM.Contract contract)
	Adds your instance of Contract class. More...

void	Edit (long contractId, [FromBody] MixERP.Net.Entities.HRM.Contract contract)
	Edits existing record with your instance of Contract class. More...

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

void	Delete (long contractId)
	Deletes an existing instance of Contract class via ContractId. 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 Contracts.

Member Function Documentation

void MixERP.Net.Api.HRM.ContractController.Add ( MixERP.Net.Entities.HRM.Contract contract )

Adds your instance of Contract class.

Parameters

contract Your instance of contracts class to add.

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

Adds or edits your instance of Contract class.

Parameters

contract Your instance of contracts class to add or edit.

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

Adds or edits multiple instances of Contract class.

Parameters

collection Your collection of Contract class to bulk import.

Returns: Returns list of imported contractIds.

Exceptions

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

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

Counts the number of contracts.

Returns: Returns the count of the contracts.

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

Counts the number of contracts using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered contracts.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered contracts.

void MixERP.Net.Api.HRM.ContractController.Delete ( long contractId )

Deletes an existing instance of Contract class via ContractId.

Parameters

contractId Enter the value for ContractId in order to find and delete the existing record.

void MixERP.Net.Api.HRM.ContractController.Edit	(	long	contractId,
		[FromBody] MixERP.Net.Entities.HRM.Contract	contract
	)

Edits existing record with your instance of Contract class.

Parameters

contract	Your instance of Contract class to edit.
contractId	Enter the value for ContractId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.HRM.Contract> MixERP.Net.Api.HRM.ContractController.Get ( )

Returns collection of contract for export.

Returns

MixERP.Net.Entities.HRM.Contract MixERP.Net.Api.HRM.ContractController.Get ( long contractId )

Returns an instance of contract.

Parameters

contractId Enter ContractId to search for.

Returns

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

A custom field is a user defined field for contracts.

Returns: Returns an enumerable custom field collection of contracts.

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

A custom field is a user defined field for contracts.

Returns: Returns an enumerable custom field collection of contracts.

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

Displayfield is a lightweight key/value collection of contracts.

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

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

Creates meta information of "contract" entity.

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

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

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

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

Creates a paginated collection containing 25 contracts on each page, sorted by the property ContractId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.HRM.Contract> MixERP.Net.Api.HRM.ContractController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 contracts on each page, sorted by the property ContractId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation