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

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

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

long	Count ()
	Counts the number of custom fields. More...

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

MixERP.Net.Entities.Core.CustomField	Get (long customFieldId)
	Returns an instance of custom field. More...

IEnumerable< MixERP.Net.Entities.Core.CustomField >	Get ([FromUri] long[] customFieldIds)

IEnumerable< MixERP.Net.Entities.Core.CustomField >	GetPagedResult ()
	Creates a paginated collection containing 25 custom fields on each page, sorted by the property CustomFieldId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.CustomField customField)
	Adds your instance of CustomField class. More...

void	Edit (long customFieldId, [FromBody] MixERP.Net.Entities.Core.CustomField customField)
	Edits existing record with your instance of CustomField class. More...

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

void	Delete (long customFieldId)
	Deletes an existing instance of CustomField class via CustomFieldId. 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 Fields.

Member Function Documentation

void MixERP.Net.Api.Core.CustomFieldController.Add ( MixERP.Net.Entities.Core.CustomField customField )

Adds your instance of CustomField class.

Parameters

customField Your instance of custom fields class to add.

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

Adds or edits your instance of CustomField class.

Parameters

customField Your instance of custom fields class to add or edit.

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

Adds or edits multiple instances of CustomField class.

Parameters

collection Your collection of CustomField class to bulk import.

Returns: Returns list of imported customFieldIds.

Exceptions

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

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

Counts the number of custom fields.

Returns: Returns the count of the custom fields.

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

Counts the number of custom fields using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered custom fields.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered custom fields.

void MixERP.Net.Api.Core.CustomFieldController.Delete ( long customFieldId )

Deletes an existing instance of CustomField class via CustomFieldId.

Parameters

customFieldId Enter the value for CustomFieldId in order to find and delete the existing record.

void MixERP.Net.Api.Core.CustomFieldController.Edit	(	long	customFieldId,
		[FromBody] MixERP.Net.Entities.Core.CustomField	customField
	)

Edits existing record with your instance of CustomField class.

Parameters

customField	Your instance of CustomField class to edit.
customFieldId	Enter the value for CustomFieldId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.CustomField> MixERP.Net.Api.Core.CustomFieldController.Get ( )

Returns collection of custom field for export.

Returns

MixERP.Net.Entities.Core.CustomField MixERP.Net.Api.Core.CustomFieldController.Get ( long customFieldId )

Returns an instance of custom field.

Parameters

customFieldId Enter CustomFieldId to search for.

Returns

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

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

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

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

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

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

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

Displayfield is a lightweight key/value collection of custom fields.

Returns: Returns an enumerable key/value collection of custom fields.

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

Creates meta information of "custom field" entity.

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

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

Creates a filtered and paginated collection containing 25 custom fields on each page, sorted by the property CustomFieldId.

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

Creates a paginated collection containing 25 custom fields on each page, sorted by the property CustomFieldId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CustomField> MixERP.Net.Api.Core.CustomFieldController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 custom fields on each page, sorted by the property CustomFieldId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 custom fields on each page, sorted by the property CustomFieldId.

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/CustomFieldController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation