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

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

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

long	Count ()
	Counts the number of default entity accesses. More...

IEnumerable< MixERP.Net.Entities.Policy.DefaultEntityAccess >	Get ()
	Returns collection of default entity access for export. More...

MixERP.Net.Entities.Policy.DefaultEntityAccess	Get (int defaultEntityAccessId)
	Returns an instance of default entity access. More...

IEnumerable< MixERP.Net.Entities.Policy.DefaultEntityAccess >	Get ([FromUri] int[] defaultEntityAccessIds)

IEnumerable< MixERP.Net.Entities.Policy.DefaultEntityAccess >	GetPagedResult ()
	Creates a paginated collection containing 25 default entity accesses on each page, sorted by the property DefaultEntityAccessId. More...

IEnumerable< MixERP.Net.Entities.Policy.DefaultEntityAccess >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 default entity accesses on each page, sorted by the property DefaultEntityAccessId. More...

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

IEnumerable< MixERP.Net.Entities.Policy.DefaultEntityAccess >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 default entity accesses on each page, sorted by the property DefaultEntityAccessId. More...

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

IEnumerable< MixERP.Net.Entities.Policy.DefaultEntityAccess >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 default entity accesses on each page, sorted by the property DefaultEntityAccessId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Policy.DefaultEntityAccess defaultEntityAccess)
	Adds your instance of DefaultEntityAccess class. More...

void	Edit (int defaultEntityAccessId, [FromBody] MixERP.Net.Entities.Policy.DefaultEntityAccess defaultEntityAccess)
	Edits existing record with your instance of DefaultEntityAccess class. More...

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

void	Delete (int defaultEntityAccessId)
	Deletes an existing instance of DefaultEntityAccess class via DefaultEntityAccessId. 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 Default Entity Accesses.

Member Function Documentation

void MixERP.Net.Api.Policy.DefaultEntityAccessController.Add ( MixERP.Net.Entities.Policy.DefaultEntityAccess defaultEntityAccess )

Adds your instance of DefaultEntityAccess class.

Parameters

defaultEntityAccess Your instance of default entity accesses class to add.

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

Adds or edits your instance of DefaultEntityAccess class.

Parameters

defaultEntityAccess Your instance of default entity accesses class to add or edit.

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

Adds or edits multiple instances of DefaultEntityAccess class.

Parameters

collection Your collection of DefaultEntityAccess class to bulk import.

Returns: Returns list of imported defaultEntityAccessIds.

Exceptions

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

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

Counts the number of default entity accesses.

Returns: Returns the count of the default entity accesses.

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

Counts the number of default entity accesses using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered default entity accesses.

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

Counts the number of default entity accesses using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered default entity accesses.

void MixERP.Net.Api.Policy.DefaultEntityAccessController.Delete ( int defaultEntityAccessId )

Deletes an existing instance of DefaultEntityAccess class via DefaultEntityAccessId.

Parameters

defaultEntityAccessId Enter the value for DefaultEntityAccessId in order to find and delete the existing record.

void MixERP.Net.Api.Policy.DefaultEntityAccessController.Edit	(	int	defaultEntityAccessId,
		[FromBody] MixERP.Net.Entities.Policy.DefaultEntityAccess	defaultEntityAccess
	)

Edits existing record with your instance of DefaultEntityAccess class.

Parameters

defaultEntityAccess	Your instance of DefaultEntityAccess class to edit.
defaultEntityAccessId	Enter the value for DefaultEntityAccessId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Policy.DefaultEntityAccess> MixERP.Net.Api.Policy.DefaultEntityAccessController.Get ( )

Returns collection of default entity access for export.

Returns

MixERP.Net.Entities.Policy.DefaultEntityAccess MixERP.Net.Api.Policy.DefaultEntityAccessController.Get ( int defaultEntityAccessId )

Returns an instance of default entity access.

Parameters

defaultEntityAccessId Enter DefaultEntityAccessId to search for.

Returns

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

A custom field is a user defined field for default entity accesses.

Returns: Returns an enumerable custom field collection of default entity accesses.

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

A custom field is a user defined field for default entity accesses.

Returns: Returns an enumerable custom field collection of default entity accesses.

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

Displayfield is a lightweight key/value collection of default entity accesses.

Returns: Returns an enumerable key/value collection of default entity accesses.

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

Creates meta information of "default entity access" entity.

Returns: Returns the "default entity access" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 default entity accesses on each page, sorted by the property DefaultEntityAccessId.

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

Creates a paginated collection containing 25 default entity accesses on each page, sorted by the property DefaultEntityAccessId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.DefaultEntityAccess> MixERP.Net.Api.Policy.DefaultEntityAccessController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 default entity accesses on each page, sorted by the property DefaultEntityAccessId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 default entity accesses on each page, sorted by the property DefaultEntityAccessId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation