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

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

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

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

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

MixERP.Net.Entities.Core.Country	Get (int countryId)
	Returns an instance of country. More...

IEnumerable< MixERP.Net.Entities.Core.Country >	Get ([FromUri] int[] countryIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Country country)
	Adds your instance of Country class. More...

void	Edit (int countryId, [FromBody] MixERP.Net.Entities.Core.Country country)
	Edits existing record with your instance of Country class. More...

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

void	Delete (int countryId)
	Deletes an existing instance of Country class via CountryId. 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 Countries.

Member Function Documentation

void MixERP.Net.Api.Core.CountryController.Add ( MixERP.Net.Entities.Core.Country country )

Adds your instance of Country class.

Parameters

country Your instance of countries class to add.

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

Adds or edits your instance of Country class.

Parameters

country Your instance of countries class to add or edit.

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

Adds or edits multiple instances of Country class.

Parameters

collection Your collection of Country class to bulk import.

Returns: Returns list of imported countryIds.

Exceptions

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

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

Counts the number of countries.

Returns: Returns the count of the countries.

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

Counts the number of countries using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered countries.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered countries.

void MixERP.Net.Api.Core.CountryController.Delete ( int countryId )

Deletes an existing instance of Country class via CountryId.

Parameters

countryId Enter the value for CountryId in order to find and delete the existing record.

void MixERP.Net.Api.Core.CountryController.Edit	(	int	countryId,
		[FromBody] MixERP.Net.Entities.Core.Country	country
	)

Edits existing record with your instance of Country class.

Parameters

country	Your instance of Country class to edit.
countryId	Enter the value for CountryId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Country> MixERP.Net.Api.Core.CountryController.Get ( )

Returns collection of country for export.

Returns

MixERP.Net.Entities.Core.Country MixERP.Net.Api.Core.CountryController.Get ( int countryId )

Returns an instance of country.

Parameters

countryId Enter CountryId to search for.

Returns

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

A custom field is a user defined field for countries.

Returns: Returns an enumerable custom field collection of countries.

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

A custom field is a user defined field for countries.

Returns: Returns an enumerable custom field collection of countries.

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

Displayfield is a lightweight key/value collection of countries.

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

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

Creates meta information of "country" entity.

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

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

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

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

Creates a paginated collection containing 25 countries on each page, sorted by the property CountryId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Country> MixERP.Net.Api.Core.CountryController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 countries on each page, sorted by the property CountryId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation