MixERP.Net.Api.Config.MixerpController Class Reference

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

Inheritance diagram for MixERP.Net.Api.Config.MixerpController:

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "mixerp" entity. More...
 
long Count ()
 Counts the number of mixerps. More...
 
IEnumerable< MixERP.Net.Entities.Config.MixerpGet ()
 Returns collection of mixerp for export. More...
 
MixERP.Net.Entities.Config.Mixerp Get (string key)
 Returns an instance of mixerp. More...
 
IEnumerable< MixERP.Net.Entities.Config.MixerpGet ([FromUri] string[] keys)
 
IEnumerable< MixERP.Net.Entities.Config.MixerpGetPagedResult ()
 Creates a paginated collection containing 25 mixerps on each page, sorted by the property Key. More...
 
IEnumerable< MixERP.Net.Entities.Config.MixerpGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 mixerps on each page, sorted by the property Key. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of mixerps using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Config.MixerpGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 mixerps on each page, sorted by the property Key. More...
 
long CountFiltered (string filterName)
 Counts the number of mixerps using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Config.MixerpGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 mixerps on each page, sorted by the property Key. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of mixerps. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for mixerps. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for mixerps. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of Mixerp class. More...
 
void Add (MixERP.Net.Entities.Config.Mixerp mixerp)
 Adds your instance of Mixerp class. More...
 
void Edit (string key, [FromBody] MixERP.Net.Entities.Config.Mixerp mixerp)
 Edits existing record with your instance of Mixerp class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of Mixerp class. More...
 
void Delete (string key)
 Deletes an existing instance of Mixerp class via Key. 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 Mixerps.

Member Function Documentation

void MixERP.Net.Api.Config.MixerpController.Add ( MixERP.Net.Entities.Config.Mixerp  mixerp)

Adds your instance of Mixerp class.

Parameters
mixerpYour instance of mixerps class to add.
void MixERP.Net.Api.Config.MixerpController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of Mixerp class.

Parameters
mixerpYour instance of mixerps class to add or edit.
List<object> MixERP.Net.Api.Config.MixerpController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of Mixerp class.

Parameters
collectionYour collection of Mixerp class to bulk import.
Returns
Returns list of imported keys.
Exceptions
MixERPExceptionThrown when your any Mixerp class in the collection is invalid or malformed.
long MixERP.Net.Api.Config.MixerpController.Count ( )

Counts the number of mixerps.

Returns
Returns the count of the mixerps.
long MixERP.Net.Api.Config.MixerpController.CountFiltered ( string  filterName)

Counts the number of mixerps using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered mixerps.
long MixERP.Net.Api.Config.MixerpController.CountWhere ( [FromBody] dynamic  filters)

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered mixerps.
void MixERP.Net.Api.Config.MixerpController.Delete ( string  key)

Deletes an existing instance of Mixerp class via Key.

Parameters
keyEnter the value for Key in order to find and delete the existing record.
void MixERP.Net.Api.Config.MixerpController.Edit ( string  key,
[FromBody] MixERP.Net.Entities.Config.Mixerp  mixerp 
)

Edits existing record with your instance of Mixerp class.

Parameters
mixerpYour instance of Mixerp class to edit.
keyEnter the value for Key in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Config.Mixerp> MixERP.Net.Api.Config.MixerpController.Get ( )

Returns collection of mixerp for export.

Returns
MixERP.Net.Entities.Config.Mixerp MixERP.Net.Api.Config.MixerpController.Get ( string  key)

Returns an instance of mixerp.

Parameters
keyEnter Key to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.MixerpController.GetCustomFields ( )

A custom field is a user defined field for mixerps.

Returns
Returns an enumerable custom field collection of mixerps.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.MixerpController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for mixerps.

Returns
Returns an enumerable custom field collection of mixerps.
IEnumerable<DisplayField> MixERP.Net.Api.Config.MixerpController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of mixerps.

Returns
Returns an enumerable key/value collection of mixerps.
EntityView MixERP.Net.Api.Config.MixerpController.GetEntityView ( )

Creates meta information of "mixerp" entity.

Returns
Returns the "mixerp" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Config.Mixerp> MixERP.Net.Api.Config.MixerpController.GetFiltered ( long  pageNumber,
string  filterName 
)

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

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.Config.Mixerp> MixERP.Net.Api.Config.MixerpController.GetPagedResult ( )

Creates a paginated collection containing 25 mixerps on each page, sorted by the property Key.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Config.Mixerp> MixERP.Net.Api.Config.MixerpController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 mixerps on each page, sorted by the property Key.

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

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

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: