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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "open exchange rate" entity. More...

long	Count ()
	Counts the number of open exchange rates. More...

IEnumerable< MixERP.Net.Entities.Config.OpenExchangeRate >	Get ()
	Returns collection of open exchange rate for export. More...

MixERP.Net.Entities.Config.OpenExchangeRate	Get (string key)
	Returns an instance of open exchange rate. More...

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

IEnumerable< MixERP.Net.Entities.Config.OpenExchangeRate >	GetPagedResult ()
	Creates a paginated collection containing 25 open exchange rates on each page, sorted by the property Key. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Config.OpenExchangeRate openExchangeRate)
	Adds your instance of OpenExchangeRate class. More...

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

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

void	Delete (string key)
	Deletes an existing instance of OpenExchangeRate 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 Open Exchange Rates.

Member Function Documentation

void MixERP.Net.Api.Config.OpenExchangeRateController.Add ( MixERP.Net.Entities.Config.OpenExchangeRate openExchangeRate )

Adds your instance of OpenExchangeRate class.

Parameters

openExchangeRate Your instance of open exchange rates class to add.

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

Adds or edits your instance of OpenExchangeRate class.

Parameters

openExchangeRate Your instance of open exchange rates class to add or edit.

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

Adds or edits multiple instances of OpenExchangeRate class.

Parameters

collection Your collection of OpenExchangeRate class to bulk import.

Returns: Returns list of imported keys.

Exceptions

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

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

Counts the number of open exchange rates.

Returns: Returns the count of the open exchange rates.

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

Counts the number of open exchange rates using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered open exchange rates.

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

Counts the number of open exchange rates using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered open exchange rates.

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

Deletes an existing instance of OpenExchangeRate class via Key.

Parameters

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

void MixERP.Net.Api.Config.OpenExchangeRateController.Edit	(	string	key,
		[FromBody] MixERP.Net.Entities.Config.OpenExchangeRate	openExchangeRate
	)

Edits existing record with your instance of OpenExchangeRate class.

Parameters

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

IEnumerable<MixERP.Net.Entities.Config.OpenExchangeRate> MixERP.Net.Api.Config.OpenExchangeRateController.Get ( )

Returns collection of open exchange rate for export.

Returns

MixERP.Net.Entities.Config.OpenExchangeRate MixERP.Net.Api.Config.OpenExchangeRateController.Get ( string key )

Returns an instance of open exchange rate.

Parameters

key	Enter Key to search for.

Returns

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

A custom field is a user defined field for open exchange rates.

Returns: Returns an enumerable custom field collection of open exchange rates.

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

A custom field is a user defined field for open exchange rates.

Returns: Returns an enumerable custom field collection of open exchange rates.

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

Displayfield is a lightweight key/value collection of open exchange rates.

Returns: Returns an enumerable key/value collection of open exchange rates.

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

Creates meta information of "open exchange rate" entity.

Returns: Returns the "open exchange rate" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 open exchange rates 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.OpenExchangeRate> MixERP.Net.Api.Config.OpenExchangeRateController.GetPagedResult ( )

Creates a paginated collection containing 25 open exchange rates on each page, sorted by the property Key.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Config.OpenExchangeRate> MixERP.Net.Api.Config.OpenExchangeRateController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 open exchange rates 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.OpenExchangeRate> MixERP.Net.Api.Config.OpenExchangeRateController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 open exchange rates 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/OpenExchangeRateController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation