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

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

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

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

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

MixERP.Net.Entities.Core.Account	Get (long accountId)
	Returns an instance of account. More...

IEnumerable< MixERP.Net.Entities.Core.Account >	Get ([FromUri] long[] accountIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Account account)
	Adds your instance of Account class. More...

void	Edit (long accountId, [FromBody] MixERP.Net.Entities.Core.Account account)
	Edits existing record with your instance of Account class. More...

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

void	Delete (long accountId)
	Deletes an existing instance of Account class via AccountId. 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 Accounts.

Member Function Documentation

void MixERP.Net.Api.Core.AccountController.Add ( MixERP.Net.Entities.Core.Account account )

Adds your instance of Account class.

Parameters

account Your instance of accounts class to add.

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

Adds or edits your instance of Account class.

Parameters

account Your instance of accounts class to add or edit.

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

Adds or edits multiple instances of Account class.

Parameters

collection Your collection of Account class to bulk import.

Returns: Returns list of imported accountIds.

Exceptions

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

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

Counts the number of accounts.

Returns: Returns the count of the accounts.

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

Counts the number of accounts using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered accounts.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered accounts.

void MixERP.Net.Api.Core.AccountController.Delete ( long accountId )

Deletes an existing instance of Account class via AccountId.

Parameters

accountId Enter the value for AccountId in order to find and delete the existing record.

void MixERP.Net.Api.Core.AccountController.Edit	(	long	accountId,
		[FromBody] MixERP.Net.Entities.Core.Account	account
	)

Edits existing record with your instance of Account class.

Parameters

account	Your instance of Account class to edit.
accountId	Enter the value for AccountId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Account> MixERP.Net.Api.Core.AccountController.Get ( )

Returns collection of account for export.

Returns

MixERP.Net.Entities.Core.Account MixERP.Net.Api.Core.AccountController.Get ( long accountId )

Returns an instance of account.

Parameters

accountId Enter AccountId to search for.

Returns

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

A custom field is a user defined field for accounts.

Returns: Returns an enumerable custom field collection of accounts.

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

A custom field is a user defined field for accounts.

Returns: Returns an enumerable custom field collection of accounts.

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

Displayfield is a lightweight key/value collection of accounts.

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

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

Creates meta information of "account" entity.

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

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

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

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

Creates a paginated collection containing 25 accounts on each page, sorted by the property AccountId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Account> MixERP.Net.Api.Core.AccountController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 accounts on each page, sorted by the property AccountId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation