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

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

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

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

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

MixERP.Net.Entities.Localization.Culture	Get (string cultureCode)
	Returns an instance of culture. More...

IEnumerable< MixERP.Net.Entities.Localization.Culture >	Get ([FromUri] string[] cultureCodes)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Localization.Culture culture)
	Adds your instance of Culture class. More...

void	Edit (string cultureCode, [FromBody] MixERP.Net.Entities.Localization.Culture culture)
	Edits existing record with your instance of Culture class. More...

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

void	Delete (string cultureCode)
	Deletes an existing instance of Culture class via CultureCode. 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 Cultures.

Member Function Documentation

void MixERP.Net.Api.Localization.CultureController.Add ( MixERP.Net.Entities.Localization.Culture culture )

Adds your instance of Culture class.

Parameters

culture Your instance of cultures class to add.

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

Adds or edits your instance of Culture class.

Parameters

culture Your instance of cultures class to add or edit.

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

Adds or edits multiple instances of Culture class.

Parameters

collection Your collection of Culture class to bulk import.

Returns: Returns list of imported cultureCodes.

Exceptions

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

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

Counts the number of cultures.

Returns: Returns the count of the cultures.

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

Counts the number of cultures using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered cultures.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered cultures.

void MixERP.Net.Api.Localization.CultureController.Delete ( string cultureCode )

Deletes an existing instance of Culture class via CultureCode.

Parameters

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

void MixERP.Net.Api.Localization.CultureController.Edit	(	string	cultureCode,
		[FromBody] MixERP.Net.Entities.Localization.Culture	culture
	)

Edits existing record with your instance of Culture class.

Parameters

culture	Your instance of Culture class to edit.
cultureCode	Enter the value for CultureCode in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Localization.Culture> MixERP.Net.Api.Localization.CultureController.Get ( )

Returns collection of culture for export.

Returns

MixERP.Net.Entities.Localization.Culture MixERP.Net.Api.Localization.CultureController.Get ( string cultureCode )

Returns an instance of culture.

Parameters

cultureCode Enter CultureCode to search for.

Returns

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

A custom field is a user defined field for cultures.

Returns: Returns an enumerable custom field collection of cultures.

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

A custom field is a user defined field for cultures.

Returns: Returns an enumerable custom field collection of cultures.

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

Displayfield is a lightweight key/value collection of cultures.

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

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

Creates meta information of "culture" entity.

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

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

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

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

Creates a paginated collection containing 25 cultures on each page, sorted by the property CultureCode.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Localization.Culture> MixERP.Net.Api.Localization.CultureController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 cultures on each page, sorted by the property CultureCode.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation