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

Inheritance diagram for MixERP.Net.Api.Core.CountyController:

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

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

IEnumerable< MixERP.Net.Entities.Core.County >	Get ()
	Returns collection of county for export. More...

MixERP.Net.Entities.Core.County	Get (int countyId)
	Returns an instance of county. More...

IEnumerable< MixERP.Net.Entities.Core.County >	Get ([FromUri] int[] countyIds)

IEnumerable< MixERP.Net.Entities.Core.County >	GetPagedResult ()
	Creates a paginated collection containing 25 counties on each page, sorted by the property CountyId. More...

IEnumerable< MixERP.Net.Entities.Core.County >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 counties on each page, sorted by the property CountyId. More...

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

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

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

IEnumerable< MixERP.Net.Entities.Core.County >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 counties on each page, sorted by the property CountyId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Core.County county)
	Adds your instance of County class. More...

void	Edit (int countyId, [FromBody] MixERP.Net.Entities.Core.County county)
	Edits existing record with your instance of County class. More...

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

void	Delete (int countyId)
	Deletes an existing instance of County class via CountyId. 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 Counties.

Member Function Documentation

void MixERP.Net.Api.Core.CountyController.Add ( MixERP.Net.Entities.Core.County county )

Adds your instance of County class.

Parameters

county Your instance of counties class to add.

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

Adds or edits your instance of County class.

Parameters

county Your instance of counties class to add or edit.

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

Adds or edits multiple instances of County class.

Parameters

collection Your collection of County class to bulk import.

Returns: Returns list of imported countyIds.

Exceptions

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

long MixERP.Net.Api.Core.CountyController.Count ( )

Counts the number of counties.

Returns: Returns the count of the counties.

long MixERP.Net.Api.Core.CountyController.CountFiltered ( string filterName )

Counts the number of counties using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered counties.

long MixERP.Net.Api.Core.CountyController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered counties.

void MixERP.Net.Api.Core.CountyController.Delete ( int countyId )

Deletes an existing instance of County class via CountyId.

Parameters

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

void MixERP.Net.Api.Core.CountyController.Edit	(	int	countyId,
		[FromBody] MixERP.Net.Entities.Core.County	county
	)

Edits existing record with your instance of County class.

Parameters

county	Your instance of County class to edit.
countyId	Enter the value for CountyId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.County> MixERP.Net.Api.Core.CountyController.Get ( )

Returns collection of county for export.

Returns

MixERP.Net.Entities.Core.County MixERP.Net.Api.Core.CountyController.Get ( int countyId )

Returns an instance of county.

Parameters

countyId Enter CountyId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.CountyController.GetCustomFields ( )

A custom field is a user defined field for counties.

Returns: Returns an enumerable custom field collection of counties.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.CountyController.GetCustomFields ( string resourceId )

A custom field is a user defined field for counties.

Returns: Returns an enumerable custom field collection of counties.

IEnumerable<DisplayField> MixERP.Net.Api.Core.CountyController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of counties.

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

EntityView MixERP.Net.Api.Core.CountyController.GetEntityView ( )

Creates meta information of "county" entity.

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

IEnumerable<MixERP.Net.Entities.Core.County> MixERP.Net.Api.Core.CountyController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Core.County> MixERP.Net.Api.Core.CountyController.GetPagedResult ( )

Creates a paginated collection containing 25 counties on each page, sorted by the property CountyId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.County> MixERP.Net.Api.Core.CountyController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 counties on each page, sorted by the property CountyId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Core.County> MixERP.Net.Api.Core.CountyController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Core/CountyController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation