MixERP.Net.Api.Office.WorkCenterController Class Reference

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

Inheritance diagram for MixERP.Net.Api.Office.WorkCenterController:

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "work center" entity. More...
 
long Count ()
 Counts the number of work centers. More...
 
IEnumerable< MixERP.Net.Entities.Office.WorkCenterGet ()
 Returns collection of work center for export. More...
 
MixERP.Net.Entities.Office.WorkCenter Get (int workCenterId)
 Returns an instance of work center. More...
 
IEnumerable< MixERP.Net.Entities.Office.WorkCenterGet ([FromUri] int[] workCenterIds)
 
IEnumerable< MixERP.Net.Entities.Office.WorkCenterGetPagedResult ()
 Creates a paginated collection containing 25 work centers on each page, sorted by the property WorkCenterId. More...
 
IEnumerable< MixERP.Net.Entities.Office.WorkCenterGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 work centers on each page, sorted by the property WorkCenterId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of work centers using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Office.WorkCenterGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 work centers on each page, sorted by the property WorkCenterId. More...
 
long CountFiltered (string filterName)
 Counts the number of work centers using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Office.WorkCenterGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 work centers on each page, sorted by the property WorkCenterId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of work centers. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for work centers. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for work centers. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of WorkCenter class. More...
 
void Add (MixERP.Net.Entities.Office.WorkCenter workCenter)
 Adds your instance of WorkCenter class. More...
 
void Edit (int workCenterId, [FromBody] MixERP.Net.Entities.Office.WorkCenter workCenter)
 Edits existing record with your instance of WorkCenter class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of WorkCenter class. More...
 
void Delete (int workCenterId)
 Deletes an existing instance of WorkCenter class via WorkCenterId. 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 Work Centers.

Member Function Documentation

void MixERP.Net.Api.Office.WorkCenterController.Add ( MixERP.Net.Entities.Office.WorkCenter  workCenter)

Adds your instance of WorkCenter class.

Parameters
workCenterYour instance of work centers class to add.
void MixERP.Net.Api.Office.WorkCenterController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of WorkCenter class.

Parameters
workCenterYour instance of work centers class to add or edit.
List<object> MixERP.Net.Api.Office.WorkCenterController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of WorkCenter class.

Parameters
collectionYour collection of WorkCenter class to bulk import.
Returns
Returns list of imported workCenterIds.
Exceptions
MixERPExceptionThrown when your any WorkCenter class in the collection is invalid or malformed.
long MixERP.Net.Api.Office.WorkCenterController.Count ( )

Counts the number of work centers.

Returns
Returns the count of the work centers.
long MixERP.Net.Api.Office.WorkCenterController.CountFiltered ( string  filterName)

Counts the number of work centers using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered work centers.
long MixERP.Net.Api.Office.WorkCenterController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of work centers using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered work centers.
void MixERP.Net.Api.Office.WorkCenterController.Delete ( int  workCenterId)

Deletes an existing instance of WorkCenter class via WorkCenterId.

Parameters
workCenterIdEnter the value for WorkCenterId in order to find and delete the existing record.
void MixERP.Net.Api.Office.WorkCenterController.Edit ( int  workCenterId,
[FromBody] MixERP.Net.Entities.Office.WorkCenter  workCenter 
)

Edits existing record with your instance of WorkCenter class.

Parameters
workCenterYour instance of WorkCenter class to edit.
workCenterIdEnter the value for WorkCenterId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Office.WorkCenter> MixERP.Net.Api.Office.WorkCenterController.Get ( )

Returns collection of work center for export.

Returns
MixERP.Net.Entities.Office.WorkCenter MixERP.Net.Api.Office.WorkCenterController.Get ( int  workCenterId)

Returns an instance of work center.

Parameters
workCenterIdEnter WorkCenterId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.WorkCenterController.GetCustomFields ( )

A custom field is a user defined field for work centers.

Returns
Returns an enumerable custom field collection of work centers.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.WorkCenterController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for work centers.

Returns
Returns an enumerable custom field collection of work centers.
IEnumerable<DisplayField> MixERP.Net.Api.Office.WorkCenterController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of work centers.

Returns
Returns an enumerable key/value collection of work centers.
EntityView MixERP.Net.Api.Office.WorkCenterController.GetEntityView ( )

Creates meta information of "work center" entity.

Returns
Returns the "work center" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Office.WorkCenter> MixERP.Net.Api.Office.WorkCenterController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 work centers on each page, sorted by the property WorkCenterId.

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.Office.WorkCenter> MixERP.Net.Api.Office.WorkCenterController.GetPagedResult ( )

Creates a paginated collection containing 25 work centers on each page, sorted by the property WorkCenterId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Office.WorkCenter> MixERP.Net.Api.Office.WorkCenterController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 work centers on each page, sorted by the property WorkCenterId.

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

Creates a filtered and paginated collection containing 25 work centers on each page, sorted by the property WorkCenterId.

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: