MixERP.Net.Api.Office.OfficeController Class Reference

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

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

Public Member Functions
EntityView	GetEntityView ()
	Creates meta information of "office" entity. More...
long	Count ()
	Counts the number of offices. More...
IEnumerable< MixERP.Net.Entities.Office.Office >	Get ()
	Returns collection of office for export. More...
MixERP.Net.Entities.Office.Office	Get (int officeId)
	Returns an instance of office. More...
IEnumerable< MixERP.Net.Entities.Office.Office >	Get ([FromUri] int[] officeIds)
IEnumerable< MixERP.Net.Entities.Office.Office >	GetPagedResult ()
	Creates a paginated collection containing 25 offices on each page, sorted by the property OfficeId. More...
IEnumerable< MixERP.Net.Entities.Office.Office >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 offices on each page, sorted by the property OfficeId. More...
long	CountWhere ([FromBody]dynamic filters)
	Counts the number of offices using the supplied filter(s). More...
IEnumerable< MixERP.Net.Entities.Office.Office >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 offices on each page, sorted by the property OfficeId. More...
long	CountFiltered (string filterName)
	Counts the number of offices using the supplied filter name. More...
IEnumerable< MixERP.Net.Entities.Office.Office >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 offices on each page, sorted by the property OfficeId. More...
IEnumerable< DisplayField >	GetDisplayFields ()
	Displayfield is a lightweight key/value collection of offices. More...
IEnumerable< PetaPoco.CustomField >	GetCustomFields ()
	A custom field is a user defined field for offices. More...
IEnumerable< PetaPoco.CustomField >	GetCustomFields (string resourceId)
	A custom field is a user defined field for offices. More...
void	AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
	Adds or edits your instance of Office class. More...
void	Add (MixERP.Net.Entities.Office.Office office)
	Adds your instance of Office class. More...
void	Edit (int officeId, [FromBody] MixERP.Net.Entities.Office.Office office)
	Edits existing record with your instance of Office class. More...
List< object >	BulkImport ([FromBody]dynamic collection)
	Adds or edits multiple instances of Office class. More...
void	Delete (int officeId)
	Deletes an existing instance of Office class via OfficeId. 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 Offices.

Member Function Documentation

void MixERP.Net.Api.Office.OfficeController.Add

(

MixERP.Net.Entities.Office.Office

office

)

Adds your instance of Office class.

Parameters

office

Your instance of offices class to add.

void MixERP.Net.Api.Office.OfficeController.AddOrEdit

(

[FromBody] Newtonsoft.Json.Linq.JArray

form

)

Adds or edits your instance of Office class.

Parameters

office

Your instance of offices class to add or edit.

List<object> MixERP.Net.Api.Office.OfficeController.BulkImport

(

[FromBody] dynamic

collection

)

Adds or edits multiple instances of Office class.

Parameters

collection

Your collection of Office class to bulk import.

Returns

Returns list of imported officeIds.

Exceptions

MixERPException

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

long MixERP.Net.Api.Office.OfficeController.Count

(

)

Counts the number of offices.

Returns

Returns the count of the offices.

long MixERP.Net.Api.Office.OfficeController.CountFiltered

(

string

filterName

)

Counts the number of offices using the supplied filter name.

Parameters

filterName

The named filter.

Returns

Returns the count of filtered offices.

long MixERP.Net.Api.Office.OfficeController.CountWhere

(

[FromBody] dynamic

filters

)

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

Parameters

filters

The list of filter conditions.

Returns

Returns the count of filtered offices.

void MixERP.Net.Api.Office.OfficeController.Delete

(

int

officeId

)

Deletes an existing instance of Office class via OfficeId.

Parameters

officeId

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

void MixERP.Net.Api.Office.OfficeController.Edit	(	int	officeId,
		[FromBody] MixERP.Net.Entities.Office.Office	office
	)

Edits existing record with your instance of Office class.

Parameters

office	Your instance of Office class to edit.
officeId	Enter the value for OfficeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Office.Office> MixERP.Net.Api.Office.OfficeController.Get

(

)

Returns collection of office for export.

Returns

MixERP.Net.Entities.Office.Office MixERP.Net.Api.Office.OfficeController.Get

(

int

officeId

)

Returns an instance of office.

Parameters

officeId

Enter OfficeId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.OfficeController.GetCustomFields

(

)

A custom field is a user defined field for offices.

Returns

Returns an enumerable custom field collection of offices.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Office.OfficeController.GetCustomFields

(

string

resourceId

)

A custom field is a user defined field for offices.

Returns

Returns an enumerable custom field collection of offices.

IEnumerable<DisplayField> MixERP.Net.Api.Office.OfficeController.GetDisplayFields

(

)

Displayfield is a lightweight key/value collection of offices.

Returns

Returns an enumerable key/value collection of offices.

EntityView MixERP.Net.Api.Office.OfficeController.GetEntityView

(

)

Creates meta information of "office" entity.

Returns

Returns the "office" meta information to perform CRUD operation.

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

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

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.Office> MixERP.Net.Api.Office.OfficeController.GetPagedResult

(

)

Creates a paginated collection containing 25 offices on each page, sorted by the property OfficeId.

Returns

Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Office.Office> MixERP.Net.Api.Office.OfficeController.GetPagedResult

(

long

pageNumber

)

Creates a paginated collection containing 25 offices on each page, sorted by the property OfficeId.

Parameters

pageNumber

Enter the page number to produce the resultset.

Returns

Returns the requested page from the collection.

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

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

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