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

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

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

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

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

MixERP.Net.Entities.Core.Currency	Get (string currencyCode)
	Returns an instance of currency. More...

IEnumerable< MixERP.Net.Entities.Core.Currency >	Get ([FromUri] string[] currencyCodes)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Currency currency)
	Adds your instance of Currency class. More...

void	Edit (string currencyCode, [FromBody] MixERP.Net.Entities.Core.Currency currency)
	Edits existing record with your instance of Currency class. More...

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

void	Delete (string currencyCode)
	Deletes an existing instance of Currency class via CurrencyCode. 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 Currencies.

Member Function Documentation

void MixERP.Net.Api.Core.CurrencyController.Add ( MixERP.Net.Entities.Core.Currency currency )

Adds your instance of Currency class.

Parameters

currency Your instance of currencies class to add.

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

Adds or edits your instance of Currency class.

Parameters

currency Your instance of currencies class to add or edit.

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

Adds or edits multiple instances of Currency class.

Parameters

collection Your collection of Currency class to bulk import.

Returns: Returns list of imported currencyCodes.

Exceptions

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

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

Counts the number of currencies.

Returns: Returns the count of the currencies.

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

Counts the number of currencies using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered currencies.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered currencies.

void MixERP.Net.Api.Core.CurrencyController.Delete ( string currencyCode )

Deletes an existing instance of Currency class via CurrencyCode.

Parameters

currencyCode Enter the value for CurrencyCode in order to find and delete the existing record.

void MixERP.Net.Api.Core.CurrencyController.Edit	(	string	currencyCode,
		[FromBody] MixERP.Net.Entities.Core.Currency	currency
	)

Edits existing record with your instance of Currency class.

Parameters

currency	Your instance of Currency class to edit.
currencyCode	Enter the value for CurrencyCode in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Currency> MixERP.Net.Api.Core.CurrencyController.Get ( )

Returns collection of currency for export.

Returns

MixERP.Net.Entities.Core.Currency MixERP.Net.Api.Core.CurrencyController.Get ( string currencyCode )

Returns an instance of currency.

Parameters

currencyCode Enter CurrencyCode to search for.

Returns

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

A custom field is a user defined field for currencies.

Returns: Returns an enumerable custom field collection of currencies.

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

A custom field is a user defined field for currencies.

Returns: Returns an enumerable custom field collection of currencies.

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

Displayfield is a lightweight key/value collection of currencies.

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

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

Creates meta information of "currency" entity.

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

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

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

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

Creates a paginated collection containing 25 currencies on each page, sorted by the property CurrencyCode.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Currency> MixERP.Net.Api.Core.CurrencyController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 currencies on each page, sorted by the property CurrencyCode.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation