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

Inheritance diagram for MixERP.Net.Api.Policy.HttpActionController:

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

long	Count ()
	Counts the number of http actions. More...

IEnumerable< MixERP.Net.Entities.Policy.HttpAction >	Get ()
	Returns collection of http action for export. More...

MixERP.Net.Entities.Policy.HttpAction	Get (string httpActionCode)
	Returns an instance of http action. More...

IEnumerable< MixERP.Net.Entities.Policy.HttpAction >	Get ([FromUri] string[] httpActionCodes)

IEnumerable< MixERP.Net.Entities.Policy.HttpAction >	GetPagedResult ()
	Creates a paginated collection containing 25 http actions on each page, sorted by the property HttpActionCode. More...

IEnumerable< MixERP.Net.Entities.Policy.HttpAction >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 http actions on each page, sorted by the property HttpActionCode. More...

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

IEnumerable< MixERP.Net.Entities.Policy.HttpAction >	GetWhere (long pageNumber, [FromBody]dynamic filters)
	Creates a filtered and paginated collection containing 25 http actions on each page, sorted by the property HttpActionCode. More...

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

IEnumerable< MixERP.Net.Entities.Policy.HttpAction >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 http actions on each page, sorted by the property HttpActionCode. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Policy.HttpAction httpAction)
	Adds your instance of HttpAction class. More...

void	Edit (string httpActionCode, [FromBody] MixERP.Net.Entities.Policy.HttpAction httpAction)
	Edits existing record with your instance of HttpAction class. More...

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

void	Delete (string httpActionCode)
	Deletes an existing instance of HttpAction class via HttpActionCode. 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 Http Actions.

Member Function Documentation

void MixERP.Net.Api.Policy.HttpActionController.Add ( MixERP.Net.Entities.Policy.HttpAction httpAction )

Adds your instance of HttpAction class.

Parameters

httpAction Your instance of http actions class to add.

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

Adds or edits your instance of HttpAction class.

Parameters

httpAction Your instance of http actions class to add or edit.

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

Adds or edits multiple instances of HttpAction class.

Parameters

collection Your collection of HttpAction class to bulk import.

Returns: Returns list of imported httpActionCodes.

Exceptions

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

long MixERP.Net.Api.Policy.HttpActionController.Count ( )

Counts the number of http actions.

Returns: Returns the count of the http actions.

long MixERP.Net.Api.Policy.HttpActionController.CountFiltered ( string filterName )

Counts the number of http actions using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered http actions.

long MixERP.Net.Api.Policy.HttpActionController.CountWhere ( [FromBody] dynamic filters )

Counts the number of http actions using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered http actions.

void MixERP.Net.Api.Policy.HttpActionController.Delete ( string httpActionCode )

Deletes an existing instance of HttpAction class via HttpActionCode.

Parameters

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

void MixERP.Net.Api.Policy.HttpActionController.Edit	(	string	httpActionCode,
		[FromBody] MixERP.Net.Entities.Policy.HttpAction	httpAction
	)

Edits existing record with your instance of HttpAction class.

Parameters

httpAction	Your instance of HttpAction class to edit.
httpActionCode	Enter the value for HttpActionCode in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Policy.HttpAction> MixERP.Net.Api.Policy.HttpActionController.Get ( )

Returns collection of http action for export.

Returns

MixERP.Net.Entities.Policy.HttpAction MixERP.Net.Api.Policy.HttpActionController.Get ( string httpActionCode )

Returns an instance of http action.

Parameters

httpActionCode Enter HttpActionCode to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.HttpActionController.GetCustomFields ( )

A custom field is a user defined field for http actions.

Returns: Returns an enumerable custom field collection of http actions.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Policy.HttpActionController.GetCustomFields ( string resourceId )

A custom field is a user defined field for http actions.

Returns: Returns an enumerable custom field collection of http actions.

IEnumerable<DisplayField> MixERP.Net.Api.Policy.HttpActionController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of http actions.

Returns: Returns an enumerable key/value collection of http actions.

EntityView MixERP.Net.Api.Policy.HttpActionController.GetEntityView ( )

Creates meta information of "http action" entity.

Returns: Returns the "http action" meta information to perform CRUD operation.

IEnumerable<MixERP.Net.Entities.Policy.HttpAction> MixERP.Net.Api.Policy.HttpActionController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

Creates a filtered and paginated collection containing 25 http actions on each page, sorted by the property HttpActionCode.

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.Policy.HttpAction> MixERP.Net.Api.Policy.HttpActionController.GetPagedResult ( )

Creates a paginated collection containing 25 http actions on each page, sorted by the property HttpActionCode.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.HttpAction> MixERP.Net.Api.Policy.HttpActionController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 http actions on each page, sorted by the property HttpActionCode.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Policy.HttpAction> MixERP.Net.Api.Policy.HttpActionController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

Creates a filtered and paginated collection containing 25 http actions on each page, sorted by the property HttpActionCode.

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/Policy/HttpActionController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation