MixERP.Net.Api.Config.DbParameterController Class Reference

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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "db parameter" entity. More...
long	Count ()
	Counts the number of db parameters. More...
IEnumerable< MixERP.Net.Entities.Config.DbParameter >	Get ()
	Returns collection of db parameter for export. More...
MixERP.Net.Entities.Config.DbParameter	Get (string key)
	Returns an instance of db parameter. More...
IEnumerable< MixERP.Net.Entities.Config.DbParameter >	Get ([FromUri] string[] keys)
IEnumerable< MixERP.Net.Entities.Config.DbParameter >	GetPagedResult ()
	Creates a paginated collection containing 25 db parameters on each page, sorted by the property Key. More...
IEnumerable< MixERP.Net.Entities.Config.DbParameter >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 db parameters on each page, sorted by the property Key. More...
long	CountWhere ([FromBody]dynamic filters)
	Counts the number of db parameters using the supplied filter(s). More...
IEnumerable< MixERP.Net.Entities.Config.DbParameter >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 db parameters on each page, sorted by the property Key. More...
long	CountFiltered (string filterName)
	Counts the number of db parameters using the supplied filter name. More...
IEnumerable< MixERP.Net.Entities.Config.DbParameter >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 db parameters on each page, sorted by the property Key. More...
IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of db parameters. More...
IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for db parameters. More...
IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for db parameters. More...
void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of DbParameter class. More...
void	Add (MixERP.Net.Entities.Config.DbParameter dbParameter)
	Adds your instance of DbParameter class. More...
void	Edit (string key, [FromBody] MixERP.Net.Entities.Config.DbParameter dbParameter)
	Edits existing record with your instance of DbParameter class. More...
List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of DbParameter class. More...
void	Delete (string key)
	Deletes an existing instance of DbParameter 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 Db Parameters.

Member Function Documentation

void MixERP.Net.Api.Config.DbParameterController.Add

(

MixERP.Net.Entities.Config.DbParameter

dbParameter

)

Adds your instance of DbParameter class.

Parameters

dbParameter

Your instance of db parameters class to add.

void MixERP.Net.Api.Config.DbParameterController.AddOrEdit

(

[FromBody] Newtonsoft.Json.Linq.JArray

form

)

Adds or edits your instance of DbParameter class.

Parameters

dbParameter

Your instance of db parameters class to add or edit.

List<object> MixERP.Net.Api.Config.DbParameterController.BulkImport

(

[FromBody] dynamic

collection

)

Adds or edits multiple instances of DbParameter class.

Parameters

collection

Your collection of DbParameter class to bulk import.

Returns

Returns list of imported keys.

Exceptions

MixERPException

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

long MixERP.Net.Api.Config.DbParameterController.Count

(

)

Counts the number of db parameters.

Returns

Returns the count of the db parameters.

long MixERP.Net.Api.Config.DbParameterController.CountFiltered

(

string

filterName

)

Counts the number of db parameters using the supplied filter name.

Parameters

filterName

The named filter.

Returns

Returns the count of filtered db parameters.

long MixERP.Net.Api.Config.DbParameterController.CountWhere

(

[FromBody] dynamic

filters

)

Counts the number of db parameters using the supplied filter(s).

Parameters

filters

The list of filter conditions.

Returns

Returns the count of filtered db parameters.

void MixERP.Net.Api.Config.DbParameterController.Delete

(

string

key

)

Deletes an existing instance of DbParameter class via Key.

Parameters

key	Enter the value for Key in order to find and delete the existing record.

void MixERP.Net.Api.Config.DbParameterController.Edit	(	string	key,
		[FromBody] MixERP.Net.Entities.Config.DbParameter	dbParameter
	)

Edits existing record with your instance of DbParameter class.

Parameters

dbParameter	Your instance of DbParameter class to edit.
key	Enter the value for Key in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Config.DbParameter> MixERP.Net.Api.Config.DbParameterController.Get

(

)

Returns collection of db parameter for export.

Returns

MixERP.Net.Entities.Config.DbParameter MixERP.Net.Api.Config.DbParameterController.Get

(

string

key

)

Returns an instance of db parameter.

Parameters

key	Enter Key to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.DbParameterController.GetCustomFields

(

)

A custom field is a user defined field for db parameters.

Returns

Returns an enumerable custom field collection of db parameters.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.DbParameterController.GetCustomFields

(

string

resourceId

)

A custom field is a user defined field for db parameters.

Returns

Returns an enumerable custom field collection of db parameters.

IEnumerable<DisplayField> MixERP.Net.Api.Config.DbParameterController.GetDisplayFields

(

)

Displayfield is a lightweight key/value collection of db parameters.

Returns

Returns an enumerable key/value collection of db parameters.

EntityView MixERP.Net.Api.Config.DbParameterController.GetEntityView

(

)

Creates meta information of "db parameter" entity.

Returns

Returns the "db parameter" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Config.DbParameter> MixERP.Net.Api.Config.DbParameterController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Config.DbParameter> MixERP.Net.Api.Config.DbParameterController.GetPagedResult

(

)

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

Returns

Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Config.DbParameter> MixERP.Net.Api.Config.DbParameterController.GetPagedResult

(

long

pageNumber

)

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

Parameters

pageNumber

Enter the page number to produce the resultset.

Returns

Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Config.DbParameter> MixERP.Net.Api.Config.DbParameterController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Config/DbParameterController.cs