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

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

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

long	Count ()
	Counts the number of flag types. More...

IEnumerable< MixERP.Net.Entities.Core.FlagType >	Get ()
	Returns collection of flag type for export. More...

MixERP.Net.Entities.Core.FlagType	Get (int flagTypeId)
	Returns an instance of flag type. More...

IEnumerable< MixERP.Net.Entities.Core.FlagType >	Get ([FromUri] int[] flagTypeIds)

IEnumerable< MixERP.Net.Entities.Core.FlagType >	GetPagedResult ()
	Creates a paginated collection containing 25 flag types on each page, sorted by the property FlagTypeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.FlagType flagType)
	Adds your instance of FlagType class. More...

void	Edit (int flagTypeId, [FromBody] MixERP.Net.Entities.Core.FlagType flagType)
	Edits existing record with your instance of FlagType class. More...

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

void	Delete (int flagTypeId)
	Deletes an existing instance of FlagType class via FlagTypeId. 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 Flag Types.

Member Function Documentation

void MixERP.Net.Api.Core.FlagTypeController.Add ( MixERP.Net.Entities.Core.FlagType flagType )

Adds your instance of FlagType class.

Parameters

flagType Your instance of flag types class to add.

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

Adds or edits your instance of FlagType class.

Parameters

flagType Your instance of flag types class to add or edit.

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

Adds or edits multiple instances of FlagType class.

Parameters

collection Your collection of FlagType class to bulk import.

Returns: Returns list of imported flagTypeIds.

Exceptions

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

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

Counts the number of flag types.

Returns: Returns the count of the flag types.

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

Counts the number of flag types using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered flag types.

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

Counts the number of flag types using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered flag types.

void MixERP.Net.Api.Core.FlagTypeController.Delete ( int flagTypeId )

Deletes an existing instance of FlagType class via FlagTypeId.

Parameters

flagTypeId Enter the value for FlagTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.FlagTypeController.Edit	(	int	flagTypeId,
		[FromBody] MixERP.Net.Entities.Core.FlagType	flagType
	)

Edits existing record with your instance of FlagType class.

Parameters

flagType	Your instance of FlagType class to edit.
flagTypeId	Enter the value for FlagTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.FlagType> MixERP.Net.Api.Core.FlagTypeController.Get ( )

Returns collection of flag type for export.

Returns

MixERP.Net.Entities.Core.FlagType MixERP.Net.Api.Core.FlagTypeController.Get ( int flagTypeId )

Returns an instance of flag type.

Parameters

flagTypeId Enter FlagTypeId to search for.

Returns

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

A custom field is a user defined field for flag types.

Returns: Returns an enumerable custom field collection of flag types.

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

A custom field is a user defined field for flag types.

Returns: Returns an enumerable custom field collection of flag types.

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

Displayfield is a lightweight key/value collection of flag types.

Returns: Returns an enumerable key/value collection of flag types.

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

Creates meta information of "flag type" entity.

Returns: Returns the "flag type" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 flag types on each page, sorted by the property FlagTypeId.

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

Creates a paginated collection containing 25 flag types on each page, sorted by the property FlagTypeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.FlagType> MixERP.Net.Api.Core.FlagTypeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 flag types on each page, sorted by the property FlagTypeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 flag types on each page, sorted by the property FlagTypeId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation