MixERP.Net.Api.Core.KanbanDetailController Class Reference

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

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

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "kanban detail" entity. More...
 
long Count ()
 Counts the number of kanban details. More...
 
IEnumerable< MixERP.Net.Entities.Core.KanbanDetailGet ()
 Returns collection of kanban detail for export. More...
 
MixERP.Net.Entities.Core.KanbanDetail Get (long kanbanDetailId)
 Returns an instance of kanban detail. More...
 
IEnumerable< MixERP.Net.Entities.Core.KanbanDetailGet ([FromUri] long[] kanbanDetailIds)
 
IEnumerable< MixERP.Net.Entities.Core.KanbanDetailGetPagedResult ()
 Creates a paginated collection containing 25 kanban details on each page, sorted by the property KanbanDetailId. More...
 
IEnumerable< MixERP.Net.Entities.Core.KanbanDetailGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 kanban details on each page, sorted by the property KanbanDetailId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of kanban details using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Core.KanbanDetailGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 kanban details on each page, sorted by the property KanbanDetailId. More...
 
long CountFiltered (string filterName)
 Counts the number of kanban details using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Core.KanbanDetailGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 kanban details on each page, sorted by the property KanbanDetailId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of kanban details. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for kanban details. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for kanban details. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of KanbanDetail class. More...
 
void Add (MixERP.Net.Entities.Core.KanbanDetail kanbanDetail)
 Adds your instance of KanbanDetail class. More...
 
void Edit (long kanbanDetailId, [FromBody] MixERP.Net.Entities.Core.KanbanDetail kanbanDetail)
 Edits existing record with your instance of KanbanDetail class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of KanbanDetail class. More...
 
void Delete (long kanbanDetailId)
 Deletes an existing instance of KanbanDetail class via KanbanDetailId. More...
 
IEnumerable< MixERP.Net.Entities.Core.KanbanDetailGet ([FromUri] long[] kanbanIds, [FromUri] object[] resourceIds)
 

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 Kanban Details.

Member Function Documentation

void MixERP.Net.Api.Core.KanbanDetailController.Add ( MixERP.Net.Entities.Core.KanbanDetail  kanbanDetail)

Adds your instance of KanbanDetail class.

Parameters
kanbanDetailYour instance of kanban details class to add.
void MixERP.Net.Api.Core.KanbanDetailController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of KanbanDetail class.

Parameters
kanbanDetailYour instance of kanban details class to add or edit.
List<object> MixERP.Net.Api.Core.KanbanDetailController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of KanbanDetail class.

Parameters
collectionYour collection of KanbanDetail class to bulk import.
Returns
Returns list of imported kanbanDetailIds.
Exceptions
MixERPExceptionThrown when your any KanbanDetail class in the collection is invalid or malformed.
long MixERP.Net.Api.Core.KanbanDetailController.Count ( )

Counts the number of kanban details.

Returns
Returns the count of the kanban details.
long MixERP.Net.Api.Core.KanbanDetailController.CountFiltered ( string  filterName)

Counts the number of kanban details using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered kanban details.
long MixERP.Net.Api.Core.KanbanDetailController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of kanban details using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered kanban details.
void MixERP.Net.Api.Core.KanbanDetailController.Delete ( long  kanbanDetailId)

Deletes an existing instance of KanbanDetail class via KanbanDetailId.

Parameters
kanbanDetailIdEnter the value for KanbanDetailId in order to find and delete the existing record.
void MixERP.Net.Api.Core.KanbanDetailController.Edit ( long  kanbanDetailId,
[FromBody] MixERP.Net.Entities.Core.KanbanDetail  kanbanDetail 
)

Edits existing record with your instance of KanbanDetail class.

Parameters
kanbanDetailYour instance of KanbanDetail class to edit.
kanbanDetailIdEnter the value for KanbanDetailId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.KanbanDetail> MixERP.Net.Api.Core.KanbanDetailController.Get ( )

Returns collection of kanban detail for export.

Returns
MixERP.Net.Entities.Core.KanbanDetail MixERP.Net.Api.Core.KanbanDetailController.Get ( long  kanbanDetailId)

Returns an instance of kanban detail.

Parameters
kanbanDetailIdEnter KanbanDetailId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.KanbanDetailController.GetCustomFields ( )

A custom field is a user defined field for kanban details.

Returns
Returns an enumerable custom field collection of kanban details.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.KanbanDetailController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for kanban details.

Returns
Returns an enumerable custom field collection of kanban details.
IEnumerable<DisplayField> MixERP.Net.Api.Core.KanbanDetailController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of kanban details.

Returns
Returns an enumerable key/value collection of kanban details.
EntityView MixERP.Net.Api.Core.KanbanDetailController.GetEntityView ( )

Creates meta information of "kanban detail" entity.

Returns
Returns the "kanban detail" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Core.KanbanDetail> MixERP.Net.Api.Core.KanbanDetailController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 kanban details on each page, sorted by the property KanbanDetailId.

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

Creates a paginated collection containing 25 kanban details on each page, sorted by the property KanbanDetailId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Core.KanbanDetail> MixERP.Net.Api.Core.KanbanDetailController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 kanban details on each page, sorted by the property KanbanDetailId.

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

Creates a filtered and paginated collection containing 25 kanban details on each page, sorted by the property KanbanDetailId.

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: