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

Inheritance diagram for MixERP.Net.Api.Office.RoleController:

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

long	Count ()
	Counts the number of roles. More...

IEnumerable< MixERP.Net.Entities.Office.Role >	Get ()
	Returns collection of role for export. More...

MixERP.Net.Entities.Office.Role	Get (int roleId)
	Returns an instance of role. More...

IEnumerable< MixERP.Net.Entities.Office.Role >	Get ([FromUri] int[] roleIds)

IEnumerable< MixERP.Net.Entities.Office.Role >	GetPagedResult ()
	Creates a paginated collection containing 25 roles on each page, sorted by the property RoleId. More...

IEnumerable< MixERP.Net.Entities.Office.Role >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 roles on each page, sorted by the property RoleId. More...

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

IEnumerable< MixERP.Net.Entities.Office.Role >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 roles on each page, sorted by the property RoleId. More...

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

IEnumerable< MixERP.Net.Entities.Office.Role >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 roles on each page, sorted by the property RoleId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Office.Role role)
	Adds your instance of Role class. More...

void	Edit (int roleId, [FromBody] MixERP.Net.Entities.Office.Role role)
	Edits existing record with your instance of Role class. More...

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

void	Delete (int roleId)
	Deletes an existing instance of Role class via RoleId. 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 Roles.

Member Function Documentation

void MixERP.Net.Api.Office.RoleController.Add ( MixERP.Net.Entities.Office.Role role )

Adds your instance of Role class.

Parameters

role	Your instance of roles class to add.

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

Adds or edits your instance of Role class.

Parameters

role	Your instance of roles class to add or edit.

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

Adds or edits multiple instances of Role class.

Parameters

collection Your collection of Role class to bulk import.

Returns: Returns list of imported roleIds.

Exceptions

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

long MixERP.Net.Api.Office.RoleController.Count ( )

Counts the number of roles.

Returns: Returns the count of the roles.

long MixERP.Net.Api.Office.RoleController.CountFiltered ( string filterName )

Counts the number of roles using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered roles.

long MixERP.Net.Api.Office.RoleController.CountWhere ( [FromBody] dynamic filters )

Counts the number of roles using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered roles.

void MixERP.Net.Api.Office.RoleController.Delete ( int roleId )

Deletes an existing instance of Role class via RoleId.

Parameters

roleId Enter the value for RoleId in order to find and delete the existing record.

void MixERP.Net.Api.Office.RoleController.Edit	(	int	roleId,
		[FromBody] MixERP.Net.Entities.Office.Role	role
	)

Edits existing record with your instance of Role class.

Parameters

role	Your instance of Role class to edit.
roleId	Enter the value for RoleId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.Role> MixERP.Net.Api.Office.RoleController.Get ( )

Returns collection of role for export.

Returns

MixERP.Net.Entities.Office.Role MixERP.Net.Api.Office.RoleController.Get ( int roleId )

Returns an instance of role.

Parameters

roleId Enter RoleId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.RoleController.GetCustomFields ( )

A custom field is a user defined field for roles.

Returns: Returns an enumerable custom field collection of roles.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.RoleController.GetCustomFields ( string resourceId )

A custom field is a user defined field for roles.

Returns: Returns an enumerable custom field collection of roles.

IEnumerable<DisplayField> MixERP.Net.Api.Office.RoleController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of roles.

Returns: Returns an enumerable key/value collection of roles.

EntityView MixERP.Net.Api.Office.RoleController.GetEntityView ( )

Creates meta information of "role" entity.

Returns: Returns the "role" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Office.Role> MixERP.Net.Api.Office.RoleController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 roles on each page, sorted by the property RoleId.

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.Office.Role> MixERP.Net.Api.Office.RoleController.GetPagedResult ( )

Creates a paginated collection containing 25 roles on each page, sorted by the property RoleId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Role> MixERP.Net.Api.Office.RoleController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 roles on each page, sorted by the property RoleId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Role> MixERP.Net.Api.Office.RoleController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 roles on each page, sorted by the property RoleId.

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/Office/RoleController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation