MixERP.Net.Api.Policy.AutoVerificationPolicyController Class Reference

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

Inheritance diagram for MixERP.Net.Api.Policy.AutoVerificationPolicyController:

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "auto verification policy" entity. More...
 
long Count ()
 Counts the number of auto verification policies. More...
 
IEnumerable< MixERP.Net.Entities.Policy.AutoVerificationPolicyGet ()
 Returns collection of auto verification policy for export. More...
 
MixERP.Net.Entities.Policy.AutoVerificationPolicy Get (int policyId)
 Returns an instance of auto verification policy. More...
 
IEnumerable< MixERP.Net.Entities.Policy.AutoVerificationPolicyGet ([FromUri] int[] policyIds)
 
IEnumerable< MixERP.Net.Entities.Policy.AutoVerificationPolicyGetPagedResult ()
 Creates a paginated collection containing 25 auto verification policies on each page, sorted by the property PolicyId. More...
 
IEnumerable< MixERP.Net.Entities.Policy.AutoVerificationPolicyGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 auto verification policies on each page, sorted by the property PolicyId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of auto verification policies using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Policy.AutoVerificationPolicyGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 auto verification policies on each page, sorted by the property PolicyId. More...
 
long CountFiltered (string filterName)
 Counts the number of auto verification policies using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Policy.AutoVerificationPolicyGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 auto verification policies on each page, sorted by the property PolicyId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of auto verification policies. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for auto verification policies. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for auto verification policies. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of AutoVerificationPolicy class. More...
 
void Add (MixERP.Net.Entities.Policy.AutoVerificationPolicy autoVerificationPolicy)
 Adds your instance of AutoVerificationPolicy class. More...
 
void Edit (int policyId, [FromBody] MixERP.Net.Entities.Policy.AutoVerificationPolicy autoVerificationPolicy)
 Edits existing record with your instance of AutoVerificationPolicy class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of AutoVerificationPolicy class. More...
 
void Delete (int policyId)
 Deletes an existing instance of AutoVerificationPolicy class via PolicyId. 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 Auto Verification Policies.

Member Function Documentation

void MixERP.Net.Api.Policy.AutoVerificationPolicyController.Add ( MixERP.Net.Entities.Policy.AutoVerificationPolicy  autoVerificationPolicy)

Adds your instance of AutoVerificationPolicy class.

Parameters
autoVerificationPolicyYour instance of auto verification policies class to add.
void MixERP.Net.Api.Policy.AutoVerificationPolicyController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of AutoVerificationPolicy class.

Parameters
autoVerificationPolicyYour instance of auto verification policies class to add or edit.
List<object> MixERP.Net.Api.Policy.AutoVerificationPolicyController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of AutoVerificationPolicy class.

Parameters
collectionYour collection of AutoVerificationPolicy class to bulk import.
Returns
Returns list of imported policyIds.
Exceptions
MixERPExceptionThrown when your any AutoVerificationPolicy class in the collection is invalid or malformed.
long MixERP.Net.Api.Policy.AutoVerificationPolicyController.Count ( )

Counts the number of auto verification policies.

Returns
Returns the count of the auto verification policies.
long MixERP.Net.Api.Policy.AutoVerificationPolicyController.CountFiltered ( string  filterName)

Counts the number of auto verification policies using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered auto verification policies.
long MixERP.Net.Api.Policy.AutoVerificationPolicyController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of auto verification policies using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered auto verification policies.
void MixERP.Net.Api.Policy.AutoVerificationPolicyController.Delete ( int  policyId)

Deletes an existing instance of AutoVerificationPolicy class via PolicyId.

Parameters
policyIdEnter the value for PolicyId in order to find and delete the existing record.
void MixERP.Net.Api.Policy.AutoVerificationPolicyController.Edit ( int  policyId,
[FromBody] MixERP.Net.Entities.Policy.AutoVerificationPolicy  autoVerificationPolicy 
)

Edits existing record with your instance of AutoVerificationPolicy class.

Parameters
autoVerificationPolicyYour instance of AutoVerificationPolicy class to edit.
policyIdEnter the value for PolicyId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Policy.AutoVerificationPolicy> MixERP.Net.Api.Policy.AutoVerificationPolicyController.Get ( )

Returns collection of auto verification policy for export.

Returns
MixERP.Net.Entities.Policy.AutoVerificationPolicy MixERP.Net.Api.Policy.AutoVerificationPolicyController.Get ( int  policyId)

Returns an instance of auto verification policy.

Parameters
policyIdEnter PolicyId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.AutoVerificationPolicyController.GetCustomFields ( )

A custom field is a user defined field for auto verification policies.

Returns
Returns an enumerable custom field collection of auto verification policies.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.AutoVerificationPolicyController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for auto verification policies.

Returns
Returns an enumerable custom field collection of auto verification policies.
IEnumerable<DisplayField> MixERP.Net.Api.Policy.AutoVerificationPolicyController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of auto verification policies.

Returns
Returns an enumerable key/value collection of auto verification policies.
EntityView MixERP.Net.Api.Policy.AutoVerificationPolicyController.GetEntityView ( )

Creates meta information of "auto verification policy" entity.

Returns
Returns the "auto verification policy" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Policy.AutoVerificationPolicy> MixERP.Net.Api.Policy.AutoVerificationPolicyController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 auto verification policies on each page, sorted by the property PolicyId.

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.Policy.AutoVerificationPolicy> MixERP.Net.Api.Policy.AutoVerificationPolicyController.GetPagedResult ( )

Creates a paginated collection containing 25 auto verification policies on each page, sorted by the property PolicyId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Policy.AutoVerificationPolicy> MixERP.Net.Api.Policy.AutoVerificationPolicyController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 auto verification policies on each page, sorted by the property PolicyId.

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

Creates a filtered and paginated collection containing 25 auto verification policies on each page, sorted by the property PolicyId.

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: