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

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

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

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

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

MixERP.Net.Entities.Core.Salesperson	Get (int salespersonId)
	Returns an instance of salesperson. More...

IEnumerable< MixERP.Net.Entities.Core.Salesperson >	Get ([FromUri] int[] salespersonIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Salesperson salesperson)
	Adds your instance of Salesperson class. More...

void	Edit (int salespersonId, [FromBody] MixERP.Net.Entities.Core.Salesperson salesperson)
	Edits existing record with your instance of Salesperson class. More...

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

void	Delete (int salespersonId)
	Deletes an existing instance of Salesperson class via SalespersonId. 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 Salespeople.

Member Function Documentation

void MixERP.Net.Api.Core.SalespersonController.Add ( MixERP.Net.Entities.Core.Salesperson salesperson )

Adds your instance of Salesperson class.

Parameters

salesperson Your instance of salespeople class to add.

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

Adds or edits your instance of Salesperson class.

Parameters

salesperson Your instance of salespeople class to add or edit.

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

Adds or edits multiple instances of Salesperson class.

Parameters

collection Your collection of Salesperson class to bulk import.

Returns: Returns list of imported salespersonIds.

Exceptions

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

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

Counts the number of salespeople.

Returns: Returns the count of the salespeople.

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

Counts the number of salespeople using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered salespeople.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered salespeople.

void MixERP.Net.Api.Core.SalespersonController.Delete ( int salespersonId )

Deletes an existing instance of Salesperson class via SalespersonId.

Parameters

salespersonId Enter the value for SalespersonId in order to find and delete the existing record.

void MixERP.Net.Api.Core.SalespersonController.Edit	(	int	salespersonId,
		[FromBody] MixERP.Net.Entities.Core.Salesperson	salesperson
	)

Edits existing record with your instance of Salesperson class.

Parameters

salesperson	Your instance of Salesperson class to edit.
salespersonId	Enter the value for SalespersonId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Salesperson> MixERP.Net.Api.Core.SalespersonController.Get ( )

Returns collection of salesperson for export.

Returns

MixERP.Net.Entities.Core.Salesperson MixERP.Net.Api.Core.SalespersonController.Get ( int salespersonId )

Returns an instance of salesperson.

Parameters

salespersonId Enter SalespersonId to search for.

Returns

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

A custom field is a user defined field for salespeople.

Returns: Returns an enumerable custom field collection of salespeople.

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

A custom field is a user defined field for salespeople.

Returns: Returns an enumerable custom field collection of salespeople.

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

Displayfield is a lightweight key/value collection of salespeople.

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

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

Creates meta information of "salesperson" entity.

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

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

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

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

Creates a paginated collection containing 25 salespeople on each page, sorted by the property SalespersonId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Salesperson> MixERP.Net.Api.Core.SalespersonController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 salespeople on each page, sorted by the property SalespersonId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation