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

Inheritance diagram for MixERP.Net.Api.Localization.ResourceController:

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

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

IEnumerable< MixERP.Net.Entities.Localization.Resource >	Get ()
	Returns collection of resource for export. More...

MixERP.Net.Entities.Localization.Resource	Get (int resourceId)
	Returns an instance of resource. More...

IEnumerable< MixERP.Net.Entities.Localization.Resource >	Get ([FromUri] int[] resourceIds)

IEnumerable< MixERP.Net.Entities.Localization.Resource >	GetPagedResult ()
	Creates a paginated collection containing 25 resources on each page, sorted by the property ResourceId. More...

IEnumerable< MixERP.Net.Entities.Localization.Resource >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 resources on each page, sorted by the property ResourceId. More...

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

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

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

IEnumerable< MixERP.Net.Entities.Localization.Resource >	GetFiltered (long pageNumber, string filterName)
	Creates a filtered and paginated collection containing 25 resources on each page, sorted by the property ResourceId. More...

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

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

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

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

void	Add (MixERP.Net.Entities.Localization.Resource resource)
	Adds your instance of Resource class. More...

void	Edit (int resourceId, [FromBody] MixERP.Net.Entities.Localization.Resource resource)
	Edits existing record with your instance of Resource class. More...

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

void	Delete (int resourceId)
	Deletes an existing instance of Resource class via ResourceId. 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 Resources.

Member Function Documentation

void MixERP.Net.Api.Localization.ResourceController.Add ( MixERP.Net.Entities.Localization.Resource resource )

Adds your instance of Resource class.

Parameters

resource Your instance of resources class to add.

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

Adds or edits your instance of Resource class.

Parameters

resource Your instance of resources class to add or edit.

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

Adds or edits multiple instances of Resource class.

Parameters

collection Your collection of Resource class to bulk import.

Returns: Returns list of imported resourceIds.

Exceptions

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

long MixERP.Net.Api.Localization.ResourceController.Count ( )

Counts the number of resources.

Returns: Returns the count of the resources.

long MixERP.Net.Api.Localization.ResourceController.CountFiltered ( string filterName )

Counts the number of resources using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered resources.

long MixERP.Net.Api.Localization.ResourceController.CountWhere ( [FromBody] dynamic filters )

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered resources.

void MixERP.Net.Api.Localization.ResourceController.Delete ( int resourceId )

Deletes an existing instance of Resource class via ResourceId.

Parameters

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

void MixERP.Net.Api.Localization.ResourceController.Edit	(	int	resourceId,
		[FromBody] MixERP.Net.Entities.Localization.Resource	resource
	)

Edits existing record with your instance of Resource class.

Parameters

resource	Your instance of Resource class to edit.
resourceId	Enter the value for ResourceId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Localization.Resource> MixERP.Net.Api.Localization.ResourceController.Get ( )

Returns collection of resource for export.

Returns

MixERP.Net.Entities.Localization.Resource MixERP.Net.Api.Localization.ResourceController.Get ( int resourceId )

Returns an instance of resource.

Parameters

resourceId Enter ResourceId to search for.

Returns

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Localization.ResourceController.GetCustomFields ( )

A custom field is a user defined field for resources.

Returns: Returns an enumerable custom field collection of resources.

IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Localization.ResourceController.GetCustomFields ( string resourceId )

A custom field is a user defined field for resources.

Returns: Returns an enumerable custom field collection of resources.

IEnumerable<DisplayField> MixERP.Net.Api.Localization.ResourceController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of resources.

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

EntityView MixERP.Net.Api.Localization.ResourceController.GetEntityView ( )

Creates meta information of "resource" entity.

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

IEnumerable<MixERP.Net.Entities.Localization.Resource> MixERP.Net.Api.Localization.ResourceController.GetFiltered	(	long	pageNumber,
		string	filterName
	)

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

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.Localization.Resource> MixERP.Net.Api.Localization.ResourceController.GetPagedResult ( )

Creates a paginated collection containing 25 resources on each page, sorted by the property ResourceId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Localization.Resource> MixERP.Net.Api.Localization.ResourceController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 resources on each page, sorted by the property ResourceId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

IEnumerable<MixERP.Net.Entities.Localization.Resource> MixERP.Net.Api.Localization.ResourceController.GetWhere	(	long	pageNumber,
		[FromBody] dynamic	filters
	)

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

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/Localization/ResourceController.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation