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

Inheritance diagram for MixERP.Net.Api.Core.KanbanController:

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

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

IEnumerable< MixERP.Net.Entities.Core.Kanban >	Get ()
	Returns collection of kanban for export. More...

MixERP.Net.Entities.Core.Kanban	Get (long kanbanId)
	Returns an instance of kanban. More...

IEnumerable< MixERP.Net.Entities.Core.Kanban >	Get ([FromUri] long[] kanbanIds)

IEnumerable< MixERP.Net.Entities.Core.Kanban >	GetPagedResult ()
	Creates a paginated collection containing 25 kanbans on each page, sorted by the property KanbanId. More...

IEnumerable< MixERP.Net.Entities.Core.Kanban >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 kanbans on each page, sorted by the property KanbanId. More...

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

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

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

IEnumerable< MixERP.Net.Entities.Core.Kanban >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 kanbans on each page, sorted by the property KanbanId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Kanban kanban)
	Adds your instance of Kanban class. More...

void	Edit (long kanbanId, [FromBody] MixERP.Net.Entities.Core.Kanban kanban)
	Edits existing record with your instance of Kanban class. More...

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

void	Delete (long kanbanId)
	Deletes an existing instance of Kanban class via KanbanId. 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 Kanbans.

Member Function Documentation

void MixERP.Net.Api.Core.KanbanController.Add ( MixERP.Net.Entities.Core.Kanban kanban )

Adds your instance of Kanban class.

Parameters

kanban Your instance of kanbans class to add.

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

Adds or edits your instance of Kanban class.

Parameters

kanban Your instance of kanbans class to add or edit.

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

Adds or edits multiple instances of Kanban class.

Parameters

collection Your collection of Kanban class to bulk import.

Returns: Returns list of imported kanbanIds.

Exceptions

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

long MixERP.Net.Api.Core.KanbanController.Count ( )

Counts the number of kanbans.

Returns: Returns the count of the kanbans.

long MixERP.Net.Api.Core.KanbanController.CountFiltered ( string filterName )

Counts the number of kanbans using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered kanbans.

long MixERP.Net.Api.Core.KanbanController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered kanbans.

void MixERP.Net.Api.Core.KanbanController.Delete ( long kanbanId )

Deletes an existing instance of Kanban class via KanbanId.

Parameters

kanbanId Enter the value for KanbanId in order to find and delete the existing record.

void MixERP.Net.Api.Core.KanbanController.Edit	(	long	kanbanId,
		[FromBody] MixERP.Net.Entities.Core.Kanban	kanban
	)

Edits existing record with your instance of Kanban class.

Parameters

kanban	Your instance of Kanban class to edit.
kanbanId	Enter the value for KanbanId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Kanban> MixERP.Net.Api.Core.KanbanController.Get ( )

Returns collection of kanban for export.

Returns

MixERP.Net.Entities.Core.Kanban MixERP.Net.Api.Core.KanbanController.Get ( long kanbanId )

Returns an instance of kanban.

Parameters

kanbanId Enter KanbanId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.KanbanController.GetCustomFields ( )

A custom field is a user defined field for kanbans.

Returns: Returns an enumerable custom field collection of kanbans.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.KanbanController.GetCustomFields ( string resourceId )

A custom field is a user defined field for kanbans.

Returns: Returns an enumerable custom field collection of kanbans.

IEnumerable<DisplayField> MixERP.Net.Api.Core.KanbanController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of kanbans.

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

EntityView MixERP.Net.Api.Core.KanbanController.GetEntityView ( )

Creates meta information of "kanban" entity.

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

IEnumerable<MixERP.Net.Entities.Core.Kanban> MixERP.Net.Api.Core.KanbanController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Core.Kanban> MixERP.Net.Api.Core.KanbanController.GetPagedResult ( )

Creates a paginated collection containing 25 kanbans on each page, sorted by the property KanbanId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Kanban> MixERP.Net.Api.Core.KanbanController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 kanbans on each page, sorted by the property KanbanId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Kanban> MixERP.Net.Api.Core.KanbanController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Libraries/Web API/Core/KanbanController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation