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

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

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

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

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

MixERP.Net.Entities.Core.State	Get (int stateId)
	Returns an instance of state. More...

IEnumerable< MixERP.Net.Entities.Core.State >	Get ([FromUri] int[] stateIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.State state)
	Adds your instance of State class. More...

void	Edit (int stateId, [FromBody] MixERP.Net.Entities.Core.State state)
	Edits existing record with your instance of State class. More...

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

void	Delete (int stateId)
	Deletes an existing instance of State class via StateId. 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 States.

Member Function Documentation

void MixERP.Net.Api.Core.StateController.Add ( MixERP.Net.Entities.Core.State state )

Adds your instance of State class.

Parameters

state Your instance of states class to add.

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

Adds or edits your instance of State class.

Parameters

state Your instance of states class to add or edit.

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

Adds or edits multiple instances of State class.

Parameters

collection Your collection of State class to bulk import.

Returns: Returns list of imported stateIds.

Exceptions

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

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

Counts the number of states.

Returns: Returns the count of the states.

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

Counts the number of states using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered states.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered states.

void MixERP.Net.Api.Core.StateController.Delete ( int stateId )

Deletes an existing instance of State class via StateId.

Parameters

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

void MixERP.Net.Api.Core.StateController.Edit	(	int	stateId,
		[FromBody] MixERP.Net.Entities.Core.State	state
	)

Edits existing record with your instance of State class.

Parameters

state	Your instance of State class to edit.
stateId	Enter the value for StateId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.State> MixERP.Net.Api.Core.StateController.Get ( )

Returns collection of state for export.

Returns

MixERP.Net.Entities.Core.State MixERP.Net.Api.Core.StateController.Get ( int stateId )

Returns an instance of state.

Parameters

stateId Enter StateId to search for.

Returns

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

A custom field is a user defined field for states.

Returns: Returns an enumerable custom field collection of states.

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

A custom field is a user defined field for states.

Returns: Returns an enumerable custom field collection of states.

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

Displayfield is a lightweight key/value collection of states.

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

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

Creates meta information of "state" entity.

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

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

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

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

Creates a paginated collection containing 25 states on each page, sorted by the property StateId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.State> MixERP.Net.Api.Core.StateController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 states on each page, sorted by the property StateId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation