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

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

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

long	Count ()
	Counts the number of frequency setups. More...

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

MixERP.Net.Entities.Core.FrequencySetup	Get (int frequencySetupId)
	Returns an instance of frequency setup. More...

IEnumerable< MixERP.Net.Entities.Core.FrequencySetup >	Get ([FromUri] int[] frequencySetupIds)

IEnumerable< MixERP.Net.Entities.Core.FrequencySetup >	GetPagedResult ()
	Creates a paginated collection containing 25 frequency setups on each page, sorted by the property FrequencySetupId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.FrequencySetup frequencySetup)
	Adds your instance of FrequencySetup class. More...

void	Edit (int frequencySetupId, [FromBody] MixERP.Net.Entities.Core.FrequencySetup frequencySetup)
	Edits existing record with your instance of FrequencySetup class. More...

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

void	Delete (int frequencySetupId)
	Deletes an existing instance of FrequencySetup class via FrequencySetupId. 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 Frequency Setups.

Member Function Documentation

void MixERP.Net.Api.Core.FrequencySetupController.Add ( MixERP.Net.Entities.Core.FrequencySetup frequencySetup )

Adds your instance of FrequencySetup class.

Parameters

frequencySetup Your instance of frequency setups class to add.

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

Adds or edits your instance of FrequencySetup class.

Parameters

frequencySetup Your instance of frequency setups class to add or edit.

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

Adds or edits multiple instances of FrequencySetup class.

Parameters

collection Your collection of FrequencySetup class to bulk import.

Returns: Returns list of imported frequencySetupIds.

Exceptions

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

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

Counts the number of frequency setups.

Returns: Returns the count of the frequency setups.

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

Counts the number of frequency setups using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered frequency setups.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered frequency setups.

void MixERP.Net.Api.Core.FrequencySetupController.Delete ( int frequencySetupId )

Deletes an existing instance of FrequencySetup class via FrequencySetupId.

Parameters

frequencySetupId Enter the value for FrequencySetupId in order to find and delete the existing record.

void MixERP.Net.Api.Core.FrequencySetupController.Edit	(	int	frequencySetupId,
		[FromBody] MixERP.Net.Entities.Core.FrequencySetup	frequencySetup
	)

Edits existing record with your instance of FrequencySetup class.

Parameters

frequencySetup	Your instance of FrequencySetup class to edit.
frequencySetupId	Enter the value for FrequencySetupId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.FrequencySetup> MixERP.Net.Api.Core.FrequencySetupController.Get ( )

Returns collection of frequency setup for export.

Returns

MixERP.Net.Entities.Core.FrequencySetup MixERP.Net.Api.Core.FrequencySetupController.Get ( int frequencySetupId )

Returns an instance of frequency setup.

Parameters

frequencySetupId Enter FrequencySetupId to search for.

Returns

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

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

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

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

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

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

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

Displayfield is a lightweight key/value collection of frequency setups.

Returns: Returns an enumerable key/value collection of frequency setups.

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

Creates meta information of "frequency setup" entity.

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

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

Creates a filtered and paginated collection containing 25 frequency setups on each page, sorted by the property FrequencySetupId.

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

Creates a paginated collection containing 25 frequency setups on each page, sorted by the property FrequencySetupId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.FrequencySetup> MixERP.Net.Api.Core.FrequencySetupController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 frequency setups on each page, sorted by the property FrequencySetupId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 frequency setups on each page, sorted by the property FrequencySetupId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation