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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "api access policy" entity. More...

long	Count ()
	Counts the number of api access policies. More...

IEnumerable< MixERP.Net.Entities.Policy.ApiAccessPolicy >	Get ()
	Returns collection of api access policy for export. More...

MixERP.Net.Entities.Policy.ApiAccessPolicy	Get (long apiAccessPolicyId)
	Returns an instance of api access policy. More...

IEnumerable< MixERP.Net.Entities.Policy.ApiAccessPolicy >	Get ([FromUri] long[] apiAccessPolicyIds)

IEnumerable< MixERP.Net.Entities.Policy.ApiAccessPolicy >	GetPagedResult ()
	Creates a paginated collection containing 25 api access policies on each page, sorted by the property ApiAccessPolicyId. More...

IEnumerable< MixERP.Net.Entities.Policy.ApiAccessPolicy >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 api access policies on each page, sorted by the property ApiAccessPolicyId. More...

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

IEnumerable< MixERP.Net.Entities.Policy.ApiAccessPolicy >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 api access policies on each page, sorted by the property ApiAccessPolicyId. More...

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

IEnumerable< MixERP.Net.Entities.Policy.ApiAccessPolicy >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 api access policies on each page, sorted by the property ApiAccessPolicyId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Policy.ApiAccessPolicy apiAccessPolicy)
	Adds your instance of ApiAccessPolicy class. More...

void	Edit (long apiAccessPolicyId, [FromBody] MixERP.Net.Entities.Policy.ApiAccessPolicy apiAccessPolicy)
	Edits existing record with your instance of ApiAccessPolicy class. More...

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

void	Delete (long apiAccessPolicyId)
	Deletes an existing instance of ApiAccessPolicy class via ApiAccessPolicyId. 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 Api Access Policies.

Member Function Documentation

void MixERP.Net.Api.Policy.ApiAccessPolicyController.Add ( MixERP.Net.Entities.Policy.ApiAccessPolicy apiAccessPolicy )

Adds your instance of ApiAccessPolicy class.

Parameters

apiAccessPolicy Your instance of api access policies class to add.

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

Adds or edits your instance of ApiAccessPolicy class.

Parameters

apiAccessPolicy Your instance of api access policies class to add or edit.

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

Adds or edits multiple instances of ApiAccessPolicy class.

Parameters

collection Your collection of ApiAccessPolicy class to bulk import.

Returns: Returns list of imported apiAccessPolicyIds.

Exceptions

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

long MixERP.Net.Api.Policy.ApiAccessPolicyController.Count ( )

Counts the number of api access policies.

Returns: Returns the count of the api access policies.

long MixERP.Net.Api.Policy.ApiAccessPolicyController.CountFiltered ( string filterName )

Counts the number of api access policies using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered api access policies.

long MixERP.Net.Api.Policy.ApiAccessPolicyController.CountWhere ( [FromBody] dynamic filters )

Counts the number of api access policies using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered api access policies.

void MixERP.Net.Api.Policy.ApiAccessPolicyController.Delete ( long apiAccessPolicyId )

Deletes an existing instance of ApiAccessPolicy class via ApiAccessPolicyId.

Parameters

apiAccessPolicyId Enter the value for ApiAccessPolicyId in order to find and delete the existing record.

void MixERP.Net.Api.Policy.ApiAccessPolicyController.Edit	(	long	apiAccessPolicyId,
		[FromBody] MixERP.Net.Entities.Policy.ApiAccessPolicy	apiAccessPolicy
	)

Edits existing record with your instance of ApiAccessPolicy class.

Parameters

apiAccessPolicy	Your instance of ApiAccessPolicy class to edit.
apiAccessPolicyId	Enter the value for ApiAccessPolicyId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Policy.ApiAccessPolicy> MixERP.Net.Api.Policy.ApiAccessPolicyController.Get ( )

Returns collection of api access policy for export.

Returns

MixERP.Net.Entities.Policy.ApiAccessPolicy MixERP.Net.Api.Policy.ApiAccessPolicyController.Get ( long apiAccessPolicyId )

Returns an instance of api access policy.

Parameters

apiAccessPolicyId Enter ApiAccessPolicyId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.ApiAccessPolicyController.GetCustomFields ( )

A custom field is a user defined field for api access policies.

Returns: Returns an enumerable custom field collection of api access policies.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.ApiAccessPolicyController.GetCustomFields ( string resourceId )

A custom field is a user defined field for api access policies.

Returns: Returns an enumerable custom field collection of api access policies.

IEnumerable<DisplayField> MixERP.Net.Api.Policy.ApiAccessPolicyController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of api access policies.

Returns: Returns an enumerable key/value collection of api access policies.

EntityView MixERP.Net.Api.Policy.ApiAccessPolicyController.GetEntityView ( )

Creates meta information of "api access policy" entity.

Returns: Returns the "api access policy" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Policy.ApiAccessPolicy> MixERP.Net.Api.Policy.ApiAccessPolicyController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 api access policies on each page, sorted by the property ApiAccessPolicyId.

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

Creates a paginated collection containing 25 api access policies on each page, sorted by the property ApiAccessPolicyId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.ApiAccessPolicy> MixERP.Net.Api.Policy.ApiAccessPolicyController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 api access policies on each page, sorted by the property ApiAccessPolicyId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.ApiAccessPolicy> MixERP.Net.Api.Policy.ApiAccessPolicyController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 api access policies on each page, sorted by the property ApiAccessPolicyId.

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/Policy/ApiAccessPolicyController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation