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

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

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

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

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

MixERP.Net.Entities.Core.Flag	Get (long flagId)
	Returns an instance of flag. More...

IEnumerable< MixERP.Net.Entities.Core.Flag >	Get ([FromUri] long[] flagIds)

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

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

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

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

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

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

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

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

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

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

void	Delete (long flagId)
	Deletes an existing instance of Flag class via FlagId. More...

void	AddOrEdit ([FromBody]MixERP.Net.Entities.Core.Flag flag)
	Adds or edits your instance of Flag class. More...

void	Add (MixERP.Net.Entities.Core.Flag flag)
	Adds your instance of Account class. More...

void	Edit (long flagId, [FromBody] MixERP.Net.Entities.Core.Flag flag)
	Edits existing record with your instance of Account class. 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 Flags.

Member Function Documentation

void MixERP.Net.Api.Core.FlagController.Add ( MixERP.Net.Entities.Core.Flag flag )

Adds your instance of Account class.

Parameters

flag	Your instance of flags class to add.

void MixERP.Net.Api.Core.FlagController.AddOrEdit ( [FromBody] MixERP.Net.Entities.Core.Flag flag )

Adds or edits your instance of Flag class.

Parameters

flag	Your instance of flags class to add or edit.

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

Adds or edits multiple instances of Flag class.

Parameters

collection Your collection of Flag class to bulk import.

Returns: Returns list of imported flagIds.

Exceptions

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

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

Counts the number of flags.

Returns: Returns the count of the flags.

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

Counts the number of flags using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered flags.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered flags.

void MixERP.Net.Api.Core.FlagController.Delete ( long flagId )

Deletes an existing instance of Flag class via FlagId.

Parameters

flagId Enter the value for FlagId in order to find and delete the existing record.

void MixERP.Net.Api.Core.FlagController.Edit	(	long	flagId,
		[FromBody] MixERP.Net.Entities.Core.Flag	flag
	)

Edits existing record with your instance of Account class.

Parameters

flag	Your instance of Account class to edit.
flagId	Enter the value for FlagId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Flag> MixERP.Net.Api.Core.FlagController.Get ( )

Returns collection of flag for export.

Returns

MixERP.Net.Entities.Core.Flag MixERP.Net.Api.Core.FlagController.Get ( long flagId )

Returns an instance of flag.

Parameters

flagId Enter FlagId to search for.

Returns

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

A custom field is a user defined field for flags.

Returns: Returns an enumerable custom field collection of flags.

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

A custom field is a user defined field for flags.

Returns: Returns an enumerable custom field collection of flags.

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

Displayfield is a lightweight key/value collection of flags.

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

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

Creates meta information of "flag" entity.

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

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

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

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

Creates a paginated collection containing 25 flags on each page, sorted by the property FlagId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Flag> MixERP.Net.Api.Core.FlagController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 flags on each page, sorted by the property FlagId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation