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

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

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

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

IEnumerable< MixERP.Net.Entities.Core.ExchangeRate >	Get ()
	Returns collection of exchange rate for export. More...

MixERP.Net.Entities.Core.ExchangeRate	Get (long exchangeRateId)
	Returns an instance of exchange rate. More...

IEnumerable< MixERP.Net.Entities.Core.ExchangeRate >	Get ([FromUri] long[] exchangeRateIds)

IEnumerable< MixERP.Net.Entities.Core.ExchangeRate >	GetPagedResult ()
	Creates a paginated collection containing 25 exchange rates on each page, sorted by the property ExchangeRateId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.ExchangeRate exchangeRate)
	Adds your instance of ExchangeRate class. More...

void	Edit (long exchangeRateId, [FromBody] MixERP.Net.Entities.Core.ExchangeRate exchangeRate)
	Edits existing record with your instance of ExchangeRate class. More...

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

void	Delete (long exchangeRateId)
	Deletes an existing instance of ExchangeRate class via ExchangeRateId. 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 Exchange Rates.

Member Function Documentation

void MixERP.Net.Api.Core.ExchangeRateController.Add ( MixERP.Net.Entities.Core.ExchangeRate exchangeRate )

Adds your instance of ExchangeRate class.

Parameters

exchangeRate Your instance of exchange rates class to add.

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

Adds or edits your instance of ExchangeRate class.

Parameters

exchangeRate Your instance of exchange rates class to add or edit.

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

Adds or edits multiple instances of ExchangeRate class.

Parameters

collection Your collection of ExchangeRate class to bulk import.

Returns: Returns list of imported exchangeRateIds.

Exceptions

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

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

Counts the number of exchange rates.

Returns: Returns the count of the exchange rates.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered exchange rates.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered exchange rates.

void MixERP.Net.Api.Core.ExchangeRateController.Delete ( long exchangeRateId )

Deletes an existing instance of ExchangeRate class via ExchangeRateId.

Parameters

exchangeRateId Enter the value for ExchangeRateId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ExchangeRateController.Edit	(	long	exchangeRateId,
		[FromBody] MixERP.Net.Entities.Core.ExchangeRate	exchangeRate
	)

Edits existing record with your instance of ExchangeRate class.

Parameters

exchangeRate	Your instance of ExchangeRate class to edit.
exchangeRateId	Enter the value for ExchangeRateId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.ExchangeRate> MixERP.Net.Api.Core.ExchangeRateController.Get ( )

Returns collection of exchange rate for export.

Returns

MixERP.Net.Entities.Core.ExchangeRate MixERP.Net.Api.Core.ExchangeRateController.Get ( long exchangeRateId )

Returns an instance of exchange rate.

Parameters

exchangeRateId Enter ExchangeRateId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "exchange rate" entity.

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

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

Creates a filtered and paginated collection containing 25 exchange rates on each page, sorted by the property ExchangeRateId.

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.ExchangeRate> MixERP.Net.Api.Core.ExchangeRateController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 exchange rates on each page, sorted by the property ExchangeRateId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation