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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "custom field setup" entity. More...

long	Count ()
	Counts the number of custom field setups. More...

IEnumerable< MixERP.Net.Entities.Core.CustomFieldSetup >	Get ()
	Returns collection of custom field setup for export. More...

MixERP.Net.Entities.Core.CustomFieldSetup	Get (int customFieldSetupId)
	Returns an instance of custom field setup. More...

IEnumerable< MixERP.Net.Entities.Core.CustomFieldSetup >	Get ([FromUri] int[] customFieldSetupIds)

IEnumerable< MixERP.Net.Entities.Core.CustomFieldSetup >	GetPagedResult ()
	Creates a paginated collection containing 25 custom field setups on each page, sorted by the property CustomFieldSetupId. More...

IEnumerable< MixERP.Net.Entities.Core.CustomFieldSetup >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 custom field setups on each page, sorted by the property CustomFieldSetupId. More...

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

IEnumerable< MixERP.Net.Entities.Core.CustomFieldSetup >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 custom field setups on each page, sorted by the property CustomFieldSetupId. More...

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

IEnumerable< MixERP.Net.Entities.Core.CustomFieldSetup >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 custom field setups on each page, sorted by the property CustomFieldSetupId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Core.CustomFieldSetup customFieldSetup)
	Adds your instance of CustomFieldSetup class. More...

void	Edit (int customFieldSetupId, [FromBody] MixERP.Net.Entities.Core.CustomFieldSetup customFieldSetup)
	Edits existing record with your instance of CustomFieldSetup class. More...

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

void	Delete (int customFieldSetupId)
	Deletes an existing instance of CustomFieldSetup class via CustomFieldSetupId. 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 Custom Field Setups.

Member Function Documentation

void MixERP.Net.Api.Core.CustomFieldSetupController.Add ( MixERP.Net.Entities.Core.CustomFieldSetup customFieldSetup )

Adds your instance of CustomFieldSetup class.

Parameters

customFieldSetup Your instance of custom field setups class to add.

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

Adds or edits your instance of CustomFieldSetup class.

Parameters

customFieldSetup Your instance of custom field setups class to add or edit.

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

Adds or edits multiple instances of CustomFieldSetup class.

Parameters

collection Your collection of CustomFieldSetup class to bulk import.

Returns: Returns list of imported customFieldSetupIds.

Exceptions

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

long MixERP.Net.Api.Core.CustomFieldSetupController.Count ( )

Counts the number of custom field setups.

Returns: Returns the count of the custom field setups.

long MixERP.Net.Api.Core.CustomFieldSetupController.CountFiltered ( string filterName )

Counts the number of custom field setups using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered custom field setups.

long MixERP.Net.Api.Core.CustomFieldSetupController.CountWhere ( [FromBody] dynamic filters )

Counts the number of custom field setups using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered custom field setups.

void MixERP.Net.Api.Core.CustomFieldSetupController.Delete ( int customFieldSetupId )

Deletes an existing instance of CustomFieldSetup class via CustomFieldSetupId.

Parameters

customFieldSetupId Enter the value for CustomFieldSetupId in order to find and delete the existing record.

void MixERP.Net.Api.Core.CustomFieldSetupController.Edit	(	int	customFieldSetupId,
		[FromBody] MixERP.Net.Entities.Core.CustomFieldSetup	customFieldSetup
	)

Edits existing record with your instance of CustomFieldSetup class.

Parameters

customFieldSetup	Your instance of CustomFieldSetup class to edit.
customFieldSetupId	Enter the value for CustomFieldSetupId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldSetup> MixERP.Net.Api.Core.CustomFieldSetupController.Get ( )

Returns collection of custom field setup for export.

Returns

MixERP.Net.Entities.Core.CustomFieldSetup MixERP.Net.Api.Core.CustomFieldSetupController.Get ( int customFieldSetupId )

Returns an instance of custom field setup.

Parameters

customFieldSetupId Enter CustomFieldSetupId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.CustomFieldSetupController.GetCustomFields ( )

A custom field is a user defined field for custom field setups.

Returns: Returns an enumerable custom field collection of custom field setups.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.CustomFieldSetupController.GetCustomFields ( string resourceId )

A custom field is a user defined field for custom field setups.

Returns: Returns an enumerable custom field collection of custom field setups.

IEnumerable<DisplayField> MixERP.Net.Api.Core.CustomFieldSetupController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of custom field setups.

Returns: Returns an enumerable key/value collection of custom field setups.

EntityView MixERP.Net.Api.Core.CustomFieldSetupController.GetEntityView ( )

Creates meta information of "custom field setup" entity.

Returns: Returns the "custom field setup" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldSetup> MixERP.Net.Api.Core.CustomFieldSetupController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 custom field setups on each page, sorted by the property CustomFieldSetupId.

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

Creates a paginated collection containing 25 custom field setups on each page, sorted by the property CustomFieldSetupId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldSetup> MixERP.Net.Api.Core.CustomFieldSetupController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 custom field setups on each page, sorted by the property CustomFieldSetupId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldSetup> MixERP.Net.Api.Core.CustomFieldSetupController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 custom field setups on each page, sorted by the property CustomFieldSetupId.

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/Core/CustomFieldSetupController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation