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

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

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

long	Count ()
	Counts the number of access types. More...

IEnumerable< MixERP.Net.Entities.Policy.AccessType >	Get ()
	Returns collection of access type for export. More...

MixERP.Net.Entities.Policy.AccessType	Get (int accessTypeId)
	Returns an instance of access type. More...

IEnumerable< MixERP.Net.Entities.Policy.AccessType >	Get ([FromUri] int[] accessTypeIds)

IEnumerable< MixERP.Net.Entities.Policy.AccessType >	GetPagedResult ()
	Creates a paginated collection containing 25 access types on each page, sorted by the property AccessTypeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Policy.AccessType accessType)
	Adds your instance of AccessType class. More...

void	Edit (int accessTypeId, [FromBody] MixERP.Net.Entities.Policy.AccessType accessType)
	Edits existing record with your instance of AccessType class. More...

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

void	Delete (int accessTypeId)
	Deletes an existing instance of AccessType class via AccessTypeId. 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 Access Types.

Member Function Documentation

void MixERP.Net.Api.Policy.AccessTypeController.Add ( MixERP.Net.Entities.Policy.AccessType accessType )

Adds your instance of AccessType class.

Parameters

accessType Your instance of access types class to add.

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

Adds or edits your instance of AccessType class.

Parameters

accessType Your instance of access types class to add or edit.

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

Adds or edits multiple instances of AccessType class.

Parameters

collection Your collection of AccessType class to bulk import.

Returns: Returns list of imported accessTypeIds.

Exceptions

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

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

Counts the number of access types.

Returns: Returns the count of the access types.

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

Counts the number of access types using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered access types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered access types.

void MixERP.Net.Api.Policy.AccessTypeController.Delete ( int accessTypeId )

Deletes an existing instance of AccessType class via AccessTypeId.

Parameters

accessTypeId Enter the value for AccessTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Policy.AccessTypeController.Edit	(	int	accessTypeId,
		[FromBody] MixERP.Net.Entities.Policy.AccessType	accessType
	)

Edits existing record with your instance of AccessType class.

Parameters

accessType	Your instance of AccessType class to edit.
accessTypeId	Enter the value for AccessTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Policy.AccessType> MixERP.Net.Api.Policy.AccessTypeController.Get ( )

Returns collection of access type for export.

Returns

MixERP.Net.Entities.Policy.AccessType MixERP.Net.Api.Policy.AccessTypeController.Get ( int accessTypeId )

Returns an instance of access type.

Parameters

accessTypeId Enter AccessTypeId to search for.

Returns

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

A custom field is a user defined field for access types.

Returns: Returns an enumerable custom field collection of access types.

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

A custom field is a user defined field for access types.

Returns: Returns an enumerable custom field collection of access types.

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

Displayfield is a lightweight key/value collection of access types.

Returns: Returns an enumerable key/value collection of access types.

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

Creates meta information of "access type" entity.

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

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

Creates a filtered and paginated collection containing 25 access types on each page, sorted by the property AccessTypeId.

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

Creates a paginated collection containing 25 access types on each page, sorted by the property AccessTypeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.AccessType> MixERP.Net.Api.Policy.AccessTypeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 access types on each page, sorted by the property AccessTypeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 access types on each page, sorted by the property AccessTypeId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation