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

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

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

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

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

MixERP.Net.Entities.Core.Nationality	Get (string nationalityCode)
	Returns an instance of nationality. More...

IEnumerable< MixERP.Net.Entities.Core.Nationality >	Get ([FromUri] string[] nationalityCodes)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Nationality nationality)
	Adds your instance of Nationality class. More...

void	Edit (string nationalityCode, [FromBody] MixERP.Net.Entities.Core.Nationality nationality)
	Edits existing record with your instance of Nationality class. More...

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

void	Delete (string nationalityCode)
	Deletes an existing instance of Nationality class via NationalityCode. 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 Nationalities.

Member Function Documentation

void MixERP.Net.Api.Core.NationalityController.Add ( MixERP.Net.Entities.Core.Nationality nationality )

Adds your instance of Nationality class.

Parameters

nationality Your instance of nationalities class to add.

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

Adds or edits your instance of Nationality class.

Parameters

nationality Your instance of nationalities class to add or edit.

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

Adds or edits multiple instances of Nationality class.

Parameters

collection Your collection of Nationality class to bulk import.

Returns: Returns list of imported nationalityCodes.

Exceptions

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

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

Counts the number of nationalities.

Returns: Returns the count of the nationalities.

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

Counts the number of nationalities using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered nationalities.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered nationalities.

void MixERP.Net.Api.Core.NationalityController.Delete ( string nationalityCode )

Deletes an existing instance of Nationality class via NationalityCode.

Parameters

nationalityCode Enter the value for NationalityCode in order to find and delete the existing record.

void MixERP.Net.Api.Core.NationalityController.Edit	(	string	nationalityCode,
		[FromBody] MixERP.Net.Entities.Core.Nationality	nationality
	)

Edits existing record with your instance of Nationality class.

Parameters

nationality	Your instance of Nationality class to edit.
nationalityCode	Enter the value for NationalityCode in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Nationality> MixERP.Net.Api.Core.NationalityController.Get ( )

Returns collection of nationality for export.

Returns

MixERP.Net.Entities.Core.Nationality MixERP.Net.Api.Core.NationalityController.Get ( string nationalityCode )

Returns an instance of nationality.

Parameters

nationalityCode Enter NationalityCode to search for.

Returns

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

A custom field is a user defined field for nationalities.

Returns: Returns an enumerable custom field collection of nationalities.

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

A custom field is a user defined field for nationalities.

Returns: Returns an enumerable custom field collection of nationalities.

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

Displayfield is a lightweight key/value collection of nationalities.

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

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

Creates meta information of "nationality" entity.

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

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

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

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

Creates a paginated collection containing 25 nationalities on each page, sorted by the property NationalityCode.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Nationality> MixERP.Net.Api.Core.NationalityController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 nationalities on each page, sorted by the property NationalityCode.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation