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

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

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

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

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

MixERP.Net.Entities.Core.Gender	Get (string genderCode)
	Returns an instance of gender. More...

IEnumerable< MixERP.Net.Entities.Core.Gender >	Get ([FromUri] string[] genderCodes)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Gender gender)
	Adds your instance of Gender class. More...

void	Edit (string genderCode, [FromBody] MixERP.Net.Entities.Core.Gender gender)
	Edits existing record with your instance of Gender class. More...

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

void	Delete (string genderCode)
	Deletes an existing instance of Gender class via GenderCode. 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 Genders.

Member Function Documentation

void MixERP.Net.Api.Core.GenderController.Add ( MixERP.Net.Entities.Core.Gender gender )

Adds your instance of Gender class.

Parameters

gender Your instance of genders class to add.

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

Adds or edits your instance of Gender class.

Parameters

gender Your instance of genders class to add or edit.

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

Adds or edits multiple instances of Gender class.

Parameters

collection Your collection of Gender class to bulk import.

Returns: Returns list of imported genderCodes.

Exceptions

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

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

Counts the number of genders.

Returns: Returns the count of the genders.

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

Counts the number of genders using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered genders.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered genders.

void MixERP.Net.Api.Core.GenderController.Delete ( string genderCode )

Deletes an existing instance of Gender class via GenderCode.

Parameters

genderCode Enter the value for GenderCode in order to find and delete the existing record.

void MixERP.Net.Api.Core.GenderController.Edit	(	string	genderCode,
		[FromBody] MixERP.Net.Entities.Core.Gender	gender
	)

Edits existing record with your instance of Gender class.

Parameters

gender	Your instance of Gender class to edit.
genderCode	Enter the value for GenderCode in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Gender> MixERP.Net.Api.Core.GenderController.Get ( )

Returns collection of gender for export.

Returns

MixERP.Net.Entities.Core.Gender MixERP.Net.Api.Core.GenderController.Get ( string genderCode )

Returns an instance of gender.

Parameters

genderCode Enter GenderCode to search for.

Returns

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

A custom field is a user defined field for genders.

Returns: Returns an enumerable custom field collection of genders.

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

A custom field is a user defined field for genders.

Returns: Returns an enumerable custom field collection of genders.

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

Displayfield is a lightweight key/value collection of genders.

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

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

Creates meta information of "gender" entity.

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

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

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

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

Creates a paginated collection containing 25 genders on each page, sorted by the property GenderCode.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Gender> MixERP.Net.Api.Core.GenderController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 genders on each page, sorted by the property GenderCode.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation