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

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

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

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

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

MixERP.Net.Entities.Core.CustomFieldDataType	Get (string dataType)
	Returns an instance of custom field data type. More...

IEnumerable< MixERP.Net.Entities.Core.CustomFieldDataType >	Get ([FromUri] string[] dataTypes)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.CustomFieldDataType customFieldDataType)
	Adds your instance of CustomFieldDataType class. More...

void	Edit (string dataType, [FromBody] MixERP.Net.Entities.Core.CustomFieldDataType customFieldDataType)
	Edits existing record with your instance of CustomFieldDataType class. More...

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

void	Delete (string dataType)
	Deletes an existing instance of CustomFieldDataType class via DataType. 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 Data Types.

Member Function Documentation

void MixERP.Net.Api.Core.CustomFieldDataTypeController.Add ( MixERP.Net.Entities.Core.CustomFieldDataType customFieldDataType )

Adds your instance of CustomFieldDataType class.

Parameters

customFieldDataType Your instance of custom field data types class to add.

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

Adds or edits your instance of CustomFieldDataType class.

Parameters

customFieldDataType Your instance of custom field data types class to add or edit.

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

Adds or edits multiple instances of CustomFieldDataType class.

Parameters

collection Your collection of CustomFieldDataType class to bulk import.

Returns: Returns list of imported dataTypes.

Exceptions

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

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

Counts the number of custom field data types.

Returns: Returns the count of the custom field data types.

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

Counts the number of custom field data types using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered custom field data types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered custom field data types.

void MixERP.Net.Api.Core.CustomFieldDataTypeController.Delete ( string dataType )

Deletes an existing instance of CustomFieldDataType class via DataType.

Parameters

dataType Enter the value for DataType in order to find and delete the existing record.

void MixERP.Net.Api.Core.CustomFieldDataTypeController.Edit	(	string	dataType,
		[FromBody] MixERP.Net.Entities.Core.CustomFieldDataType	customFieldDataType
	)

Edits existing record with your instance of CustomFieldDataType class.

Parameters

customFieldDataType	Your instance of CustomFieldDataType class to edit.
dataType	Enter the value for DataType in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldDataType> MixERP.Net.Api.Core.CustomFieldDataTypeController.Get ( )

Returns collection of custom field data type for export.

Returns

MixERP.Net.Entities.Core.CustomFieldDataType MixERP.Net.Api.Core.CustomFieldDataTypeController.Get ( string dataType )

Returns an instance of custom field data type.

Parameters

dataType Enter DataType to search for.

Returns

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

A custom field is a user defined field for custom field data types.

Returns: Returns an enumerable custom field collection of custom field data types.

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

A custom field is a user defined field for custom field data types.

Returns: Returns an enumerable custom field collection of custom field data types.

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

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

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

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

Creates meta information of "custom field data type" entity.

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

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

Creates a filtered and paginated collection containing 25 custom field data types on each page, sorted by the property DataType.

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

Creates a paginated collection containing 25 custom field data types on each page, sorted by the property DataType.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CustomFieldDataType> MixERP.Net.Api.Core.CustomFieldDataTypeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 custom field data types on each page, sorted by the property DataType.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 custom field data types on each page, sorted by the property DataType.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation