MixERP.Net.Api.Core.SalesTeamController Class Reference

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

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

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "sales team" entity. More...
 
long Count ()
 Counts the number of sales teams. More...
 
IEnumerable< MixERP.Net.Entities.Core.SalesTeamGet ()
 Returns collection of sales team for export. More...
 
MixERP.Net.Entities.Core.SalesTeam Get (int salesTeamId)
 Returns an instance of sales team. More...
 
IEnumerable< MixERP.Net.Entities.Core.SalesTeamGet ([FromUri] int[] salesTeamIds)
 
IEnumerable< MixERP.Net.Entities.Core.SalesTeamGetPagedResult ()
 Creates a paginated collection containing 25 sales teams on each page, sorted by the property SalesTeamId. More...
 
IEnumerable< MixERP.Net.Entities.Core.SalesTeamGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 sales teams on each page, sorted by the property SalesTeamId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of sales teams using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Core.SalesTeamGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 sales teams on each page, sorted by the property SalesTeamId. More...
 
long CountFiltered (string filterName)
 Counts the number of sales teams using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Core.SalesTeamGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 sales teams on each page, sorted by the property SalesTeamId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of sales teams. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for sales teams. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for sales teams. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of SalesTeam class. More...
 
void Add (MixERP.Net.Entities.Core.SalesTeam salesTeam)
 Adds your instance of SalesTeam class. More...
 
void Edit (int salesTeamId, [FromBody] MixERP.Net.Entities.Core.SalesTeam salesTeam)
 Edits existing record with your instance of SalesTeam class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of SalesTeam class. More...
 
void Delete (int salesTeamId)
 Deletes an existing instance of SalesTeam class via SalesTeamId. 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 Sales Teams.

Member Function Documentation

void MixERP.Net.Api.Core.SalesTeamController.Add ( MixERP.Net.Entities.Core.SalesTeam  salesTeam)

Adds your instance of SalesTeam class.

Parameters
salesTeamYour instance of sales teams class to add.
void MixERP.Net.Api.Core.SalesTeamController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of SalesTeam class.

Parameters
salesTeamYour instance of sales teams class to add or edit.
List<object> MixERP.Net.Api.Core.SalesTeamController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of SalesTeam class.

Parameters
collectionYour collection of SalesTeam class to bulk import.
Returns
Returns list of imported salesTeamIds.
Exceptions
MixERPExceptionThrown when your any SalesTeam class in the collection is invalid or malformed.
long MixERP.Net.Api.Core.SalesTeamController.Count ( )

Counts the number of sales teams.

Returns
Returns the count of the sales teams.
long MixERP.Net.Api.Core.SalesTeamController.CountFiltered ( string  filterName)

Counts the number of sales teams using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered sales teams.
long MixERP.Net.Api.Core.SalesTeamController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of sales teams using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered sales teams.
void MixERP.Net.Api.Core.SalesTeamController.Delete ( int  salesTeamId)

Deletes an existing instance of SalesTeam class via SalesTeamId.

Parameters
salesTeamIdEnter the value for SalesTeamId in order to find and delete the existing record.
void MixERP.Net.Api.Core.SalesTeamController.Edit ( int  salesTeamId,
[FromBody] MixERP.Net.Entities.Core.SalesTeam  salesTeam 
)

Edits existing record with your instance of SalesTeam class.

Parameters
salesTeamYour instance of SalesTeam class to edit.
salesTeamIdEnter the value for SalesTeamId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.SalesTeam> MixERP.Net.Api.Core.SalesTeamController.Get ( )

Returns collection of sales team for export.

Returns
MixERP.Net.Entities.Core.SalesTeam MixERP.Net.Api.Core.SalesTeamController.Get ( int  salesTeamId)

Returns an instance of sales team.

Parameters
salesTeamIdEnter SalesTeamId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.SalesTeamController.GetCustomFields ( )

A custom field is a user defined field for sales teams.

Returns
Returns an enumerable custom field collection of sales teams.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.SalesTeamController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for sales teams.

Returns
Returns an enumerable custom field collection of sales teams.
IEnumerable<DisplayField> MixERP.Net.Api.Core.SalesTeamController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of sales teams.

Returns
Returns an enumerable key/value collection of sales teams.
EntityView MixERP.Net.Api.Core.SalesTeamController.GetEntityView ( )

Creates meta information of "sales team" entity.

Returns
Returns the "sales team" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Core.SalesTeam> MixERP.Net.Api.Core.SalesTeamController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 sales teams on each page, sorted by the property SalesTeamId.

Parameters
pageNumberEnter the page number to produce the resultset.
filterNameThe named filter.
Returns
Returns the requested page from the collection using the supplied filters.
IEnumerable<MixERP.Net.Entities.Core.SalesTeam> MixERP.Net.Api.Core.SalesTeamController.GetPagedResult ( )

Creates a paginated collection containing 25 sales teams on each page, sorted by the property SalesTeamId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Core.SalesTeam> MixERP.Net.Api.Core.SalesTeamController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 sales teams on each page, sorted by the property SalesTeamId.

Parameters
pageNumberEnter the page number to produce the resultset.
Returns
Returns the requested page from the collection.
IEnumerable<MixERP.Net.Entities.Core.SalesTeam> MixERP.Net.Api.Core.SalesTeamController.GetWhere ( long  pageNumber,
[FromBody] dynamic  filters 
)

Creates a filtered and paginated collection containing 25 sales teams on each page, sorted by the property SalesTeamId.

Parameters
pageNumberEnter the page number to produce the resultset.
filtersThe 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: