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

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

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

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

IEnumerable< MixERP.Net.Entities.Office.Configuration >	Get ()
	Returns collection of configuration for export. More...

MixERP.Net.Entities.Office.Configuration	Get (int configurationId)
	Returns an instance of configuration. More...

IEnumerable< MixERP.Net.Entities.Office.Configuration >	Get ([FromUri] int[] configurationIds)

IEnumerable< MixERP.Net.Entities.Office.Configuration >	GetPagedResult ()
	Creates a paginated collection containing 25 configurations on each page, sorted by the property ConfigurationId. More...

IEnumerable< MixERP.Net.Entities.Office.Configuration >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 configurations on each page, sorted by the property ConfigurationId. More...

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

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

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

IEnumerable< MixERP.Net.Entities.Office.Configuration >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 configurations on each page, sorted by the property ConfigurationId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Office.Configuration configuration)
	Adds your instance of Configuration class. More...

void	Edit (int configurationId, [FromBody] MixERP.Net.Entities.Office.Configuration configuration)
	Edits existing record with your instance of Configuration class. More...

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

void	Delete (int configurationId)
	Deletes an existing instance of Configuration class via ConfigurationId. 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 Configurations.

Member Function Documentation

void MixERP.Net.Api.Office.ConfigurationController.Add ( MixERP.Net.Entities.Office.Configuration configuration )

Adds your instance of Configuration class.

Parameters

configuration Your instance of configurations class to add.

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

Adds or edits your instance of Configuration class.

Parameters

configuration Your instance of configurations class to add or edit.

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

Adds or edits multiple instances of Configuration class.

Parameters

collection Your collection of Configuration class to bulk import.

Returns: Returns list of imported configurationIds.

Exceptions

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

long MixERP.Net.Api.Office.ConfigurationController.Count ( )

Counts the number of configurations.

Returns: Returns the count of the configurations.

long MixERP.Net.Api.Office.ConfigurationController.CountFiltered ( string filterName )

Counts the number of configurations using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered configurations.

long MixERP.Net.Api.Office.ConfigurationController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered configurations.

void MixERP.Net.Api.Office.ConfigurationController.Delete ( int configurationId )

Deletes an existing instance of Configuration class via ConfigurationId.

Parameters

configurationId Enter the value for ConfigurationId in order to find and delete the existing record.

void MixERP.Net.Api.Office.ConfigurationController.Edit	(	int	configurationId,
		[FromBody] MixERP.Net.Entities.Office.Configuration	configuration
	)

Edits existing record with your instance of Configuration class.

Parameters

configuration	Your instance of Configuration class to edit.
configurationId	Enter the value for ConfigurationId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.Configuration> MixERP.Net.Api.Office.ConfigurationController.Get ( )

Returns collection of configuration for export.

Returns

MixERP.Net.Entities.Office.Configuration MixERP.Net.Api.Office.ConfigurationController.Get ( int configurationId )

Returns an instance of configuration.

Parameters

configurationId Enter ConfigurationId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.ConfigurationController.GetCustomFields ( )

A custom field is a user defined field for configurations.

Returns: Returns an enumerable custom field collection of configurations.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.ConfigurationController.GetCustomFields ( string resourceId )

A custom field is a user defined field for configurations.

Returns: Returns an enumerable custom field collection of configurations.

IEnumerable<DisplayField> MixERP.Net.Api.Office.ConfigurationController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of configurations.

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

EntityView MixERP.Net.Api.Office.ConfigurationController.GetEntityView ( )

Creates meta information of "configuration" entity.

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

IEnumerable<MixERP.Net.Entities.Office.Configuration> MixERP.Net.Api.Office.ConfigurationController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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

Creates a paginated collection containing 25 configurations on each page, sorted by the property ConfigurationId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Configuration> MixERP.Net.Api.Office.ConfigurationController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 configurations on each page, sorted by the property ConfigurationId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Configuration> MixERP.Net.Api.Office.ConfigurationController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Office/ConfigurationController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation