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

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

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

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

IEnumerable< MixERP.Net.Entities.Core.Frequency >	Get ()
	Returns collection of frequency for export. More...

MixERP.Net.Entities.Core.Frequency	Get (int frequencyId)
	Returns an instance of frequency. More...

IEnumerable< MixERP.Net.Entities.Core.Frequency >	Get ([FromUri] int[] frequencyIds)

IEnumerable< MixERP.Net.Entities.Core.Frequency >	GetPagedResult ()
	Creates a paginated collection containing 25 frequencies on each page, sorted by the property FrequencyId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Frequency frequency)
	Adds your instance of Frequency class. More...

void	Edit (int frequencyId, [FromBody] MixERP.Net.Entities.Core.Frequency frequency)
	Edits existing record with your instance of Frequency class. More...

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

void	Delete (int frequencyId)
	Deletes an existing instance of Frequency class via FrequencyId. 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 Frequencies.

Member Function Documentation

void MixERP.Net.Api.Core.FrequencyController.Add ( MixERP.Net.Entities.Core.Frequency frequency )

Adds your instance of Frequency class.

Parameters

frequency Your instance of frequencies class to add.

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

Adds or edits your instance of Frequency class.

Parameters

frequency Your instance of frequencies class to add or edit.

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

Adds or edits multiple instances of Frequency class.

Parameters

collection Your collection of Frequency class to bulk import.

Returns: Returns list of imported frequencyIds.

Exceptions

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

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

Counts the number of frequencies.

Returns: Returns the count of the frequencies.

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

Counts the number of frequencies using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered frequencies.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered frequencies.

void MixERP.Net.Api.Core.FrequencyController.Delete ( int frequencyId )

Deletes an existing instance of Frequency class via FrequencyId.

Parameters

frequencyId Enter the value for FrequencyId in order to find and delete the existing record.

void MixERP.Net.Api.Core.FrequencyController.Edit	(	int	frequencyId,
		[FromBody] MixERP.Net.Entities.Core.Frequency	frequency
	)

Edits existing record with your instance of Frequency class.

Parameters

frequency	Your instance of Frequency class to edit.
frequencyId	Enter the value for FrequencyId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Frequency> MixERP.Net.Api.Core.FrequencyController.Get ( )

Returns collection of frequency for export.

Returns

MixERP.Net.Entities.Core.Frequency MixERP.Net.Api.Core.FrequencyController.Get ( int frequencyId )

Returns an instance of frequency.

Parameters

frequencyId Enter FrequencyId to search for.

Returns

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

A custom field is a user defined field for frequencies.

Returns: Returns an enumerable custom field collection of frequencies.

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

A custom field is a user defined field for frequencies.

Returns: Returns an enumerable custom field collection of frequencies.

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

Displayfield is a lightweight key/value collection of frequencies.

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

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

Creates meta information of "frequency" entity.

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

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

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

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

Creates a paginated collection containing 25 frequencies on each page, sorted by the property FrequencyId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Frequency> MixERP.Net.Api.Core.FrequencyController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 frequencies on each page, sorted by the property FrequencyId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation