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

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

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

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

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

MixERP.Net.Entities.Office.User	Get (int userId)
	Returns an instance of user. More...

IEnumerable< MixERP.Net.Entities.Office.User >	Get ([FromUri] int[] userIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Office.User user)
	Adds your instance of User class. More...

void	Edit (int userId, [FromBody] MixERP.Net.Entities.Office.User user)
	Edits existing record with your instance of User class. More...

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

void	Delete (int userId)
	Deletes an existing instance of User class via UserId. 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 Users.

Member Function Documentation

void MixERP.Net.Api.Office.UserController.Add ( MixERP.Net.Entities.Office.User user )

Adds your instance of User class.

Parameters

user	Your instance of users class to add.

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

Adds or edits your instance of User class.

Parameters

user	Your instance of users class to add or edit.

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

Adds or edits multiple instances of User class.

Parameters

collection Your collection of User class to bulk import.

Returns: Returns list of imported userIds.

Exceptions

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

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

Counts the number of users.

Returns: Returns the count of the users.

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

Counts the number of users using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered users.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered users.

void MixERP.Net.Api.Office.UserController.Delete ( int userId )

Deletes an existing instance of User class via UserId.

Parameters

userId Enter the value for UserId in order to find and delete the existing record.

void MixERP.Net.Api.Office.UserController.Edit	(	int	userId,
		[FromBody] MixERP.Net.Entities.Office.User	user
	)

Edits existing record with your instance of User class.

Parameters

user	Your instance of User class to edit.
userId	Enter the value for UserId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.User> MixERP.Net.Api.Office.UserController.Get ( )

Returns collection of user for export.

Returns

MixERP.Net.Entities.Office.User MixERP.Net.Api.Office.UserController.Get ( int userId )

Returns an instance of user.

Parameters

userId Enter UserId to search for.

Returns

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

A custom field is a user defined field for users.

Returns: Returns an enumerable custom field collection of users.

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

A custom field is a user defined field for users.

Returns: Returns an enumerable custom field collection of users.

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

Displayfield is a lightweight key/value collection of users.

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

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

Creates meta information of "user" entity.

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

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

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

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

Creates a paginated collection containing 25 users on each page, sorted by the property UserId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.User> MixERP.Net.Api.Office.UserController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 users on each page, sorted by the property UserId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation