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

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

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

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

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

MixERP.Net.Entities.Office.Department	Get (int departmentId)
	Returns an instance of department. More...

IEnumerable< MixERP.Net.Entities.Office.Department >	Get ([FromUri] int[] departmentIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Office.Department department)
	Adds your instance of Department class. More...

void	Edit (int departmentId, [FromBody] MixERP.Net.Entities.Office.Department department)
	Edits existing record with your instance of Department class. More...

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

void	Delete (int departmentId)
	Deletes an existing instance of Department class via DepartmentId. 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 Departments.

Member Function Documentation

void MixERP.Net.Api.Office.DepartmentController.Add ( MixERP.Net.Entities.Office.Department department )

Adds your instance of Department class.

Parameters

department Your instance of departments class to add.

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

Adds or edits your instance of Department class.

Parameters

department Your instance of departments class to add or edit.

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

Adds or edits multiple instances of Department class.

Parameters

collection Your collection of Department class to bulk import.

Returns: Returns list of imported departmentIds.

Exceptions

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

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

Counts the number of departments.

Returns: Returns the count of the departments.

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

Counts the number of departments using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered departments.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered departments.

void MixERP.Net.Api.Office.DepartmentController.Delete ( int departmentId )

Deletes an existing instance of Department class via DepartmentId.

Parameters

departmentId Enter the value for DepartmentId in order to find and delete the existing record.

void MixERP.Net.Api.Office.DepartmentController.Edit	(	int	departmentId,
		[FromBody] MixERP.Net.Entities.Office.Department	department
	)

Edits existing record with your instance of Department class.

Parameters

department	Your instance of Department class to edit.
departmentId	Enter the value for DepartmentId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.Department> MixERP.Net.Api.Office.DepartmentController.Get ( )

Returns collection of department for export.

Returns

MixERP.Net.Entities.Office.Department MixERP.Net.Api.Office.DepartmentController.Get ( int departmentId )

Returns an instance of department.

Parameters

departmentId Enter DepartmentId to search for.

Returns

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

A custom field is a user defined field for departments.

Returns: Returns an enumerable custom field collection of departments.

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

A custom field is a user defined field for departments.

Returns: Returns an enumerable custom field collection of departments.

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

Displayfield is a lightweight key/value collection of departments.

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

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

Creates meta information of "department" entity.

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

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

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

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

Creates a paginated collection containing 25 departments on each page, sorted by the property DepartmentId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Department> MixERP.Net.Api.Office.DepartmentController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 departments on each page, sorted by the property DepartmentId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation