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

Inheritance diagram for MixERP.Net.Api.Config.CurrencyLayerController:

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

long	Count ()
	Counts the number of currency layers. More...

IEnumerable< MixERP.Net.Entities.Config.CurrencyLayer >	Get ()
	Returns collection of currency layer for export. More...

MixERP.Net.Entities.Config.CurrencyLayer	Get (string key)
	Returns an instance of currency layer. More...

IEnumerable< MixERP.Net.Entities.Config.CurrencyLayer >	Get ([FromUri] string[] keys)

IEnumerable< MixERP.Net.Entities.Config.CurrencyLayer >	GetPagedResult ()
	Creates a paginated collection containing 25 currency layers on each page, sorted by the property Key. More...

IEnumerable< MixERP.Net.Entities.Config.CurrencyLayer >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 currency layers on each page, sorted by the property Key. More...

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

IEnumerable< MixERP.Net.Entities.Config.CurrencyLayer >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 currency layers on each page, sorted by the property Key. More...

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

IEnumerable< MixERP.Net.Entities.Config.CurrencyLayer >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 currency layers on each page, sorted by the property Key. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Config.CurrencyLayer currencyLayer)
	Adds your instance of CurrencyLayer class. More...

void	Edit (string key, [FromBody] MixERP.Net.Entities.Config.CurrencyLayer currencyLayer)
	Edits existing record with your instance of CurrencyLayer class. More...

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

void	Delete (string key)
	Deletes an existing instance of CurrencyLayer class via Key. 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 Currency Layers.

Member Function Documentation

void MixERP.Net.Api.Config.CurrencyLayerController.Add ( MixERP.Net.Entities.Config.CurrencyLayer currencyLayer )

Adds your instance of CurrencyLayer class.

Parameters

currencyLayer Your instance of currency layers class to add.

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

Adds or edits your instance of CurrencyLayer class.

Parameters

currencyLayer Your instance of currency layers class to add or edit.

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

Adds or edits multiple instances of CurrencyLayer class.

Parameters

collection Your collection of CurrencyLayer class to bulk import.

Returns: Returns list of imported keys.

Exceptions

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

long MixERP.Net.Api.Config.CurrencyLayerController.Count ( )

Counts the number of currency layers.

Returns: Returns the count of the currency layers.

long MixERP.Net.Api.Config.CurrencyLayerController.CountFiltered ( string filterName )

Counts the number of currency layers using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered currency layers.

long MixERP.Net.Api.Config.CurrencyLayerController.CountWhere ( [FromBody] dynamic filters )

Counts the number of currency layers using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered currency layers.

void MixERP.Net.Api.Config.CurrencyLayerController.Delete ( string key )

Deletes an existing instance of CurrencyLayer class via Key.

Parameters

key	Enter the value for Key in order to find and delete the existing record.

void MixERP.Net.Api.Config.CurrencyLayerController.Edit	(	string	key,
		[FromBody] MixERP.Net.Entities.Config.CurrencyLayer	currencyLayer
	)

Edits existing record with your instance of CurrencyLayer class.

Parameters

currencyLayer	Your instance of CurrencyLayer class to edit.
key	Enter the value for Key in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Config.CurrencyLayer> MixERP.Net.Api.Config.CurrencyLayerController.Get ( )

Returns collection of currency layer for export.

Returns

MixERP.Net.Entities.Config.CurrencyLayer MixERP.Net.Api.Config.CurrencyLayerController.Get ( string key )

Returns an instance of currency layer.

Parameters

key	Enter Key to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.CurrencyLayerController.GetCustomFields ( )

A custom field is a user defined field for currency layers.

Returns: Returns an enumerable custom field collection of currency layers.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Config.CurrencyLayerController.GetCustomFields ( string resourceId )

A custom field is a user defined field for currency layers.

Returns: Returns an enumerable custom field collection of currency layers.

IEnumerable<DisplayField> MixERP.Net.Api.Config.CurrencyLayerController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of currency layers.

Returns: Returns an enumerable key/value collection of currency layers.

EntityView MixERP.Net.Api.Config.CurrencyLayerController.GetEntityView ( )

Creates meta information of "currency layer" entity.

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

IEnumerable<MixERP.Net.Entities.Config.CurrencyLayer> MixERP.Net.Api.Config.CurrencyLayerController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 currency layers on each page, sorted by the property Key.

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.Config.CurrencyLayer> MixERP.Net.Api.Config.CurrencyLayerController.GetPagedResult ( )

Creates a paginated collection containing 25 currency layers on each page, sorted by the property Key.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Config.CurrencyLayer> MixERP.Net.Api.Config.CurrencyLayerController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 currency layers on each page, sorted by the property Key.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Config.CurrencyLayer> MixERP.Net.Api.Config.CurrencyLayerController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 currency layers on each page, sorted by the property Key.

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/Config/CurrencyLayerController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation