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

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

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

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

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

MixERP.Net.Entities.Core.CardType	Get (int cardTypeId)
	Returns an instance of card type. More...

IEnumerable< MixERP.Net.Entities.Core.CardType >	Get ([FromUri] int[] cardTypeIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.CardType cardType)
	Adds your instance of CardType class. More...

void	Edit (int cardTypeId, [FromBody] MixERP.Net.Entities.Core.CardType cardType)
	Edits existing record with your instance of CardType class. More...

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

void	Delete (int cardTypeId)
	Deletes an existing instance of CardType class via CardTypeId. 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 Card Types.

Member Function Documentation

void MixERP.Net.Api.Core.CardTypeController.Add ( MixERP.Net.Entities.Core.CardType cardType )

Adds your instance of CardType class.

Parameters

cardType Your instance of card types class to add.

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

Adds or edits your instance of CardType class.

Parameters

cardType Your instance of card types class to add or edit.

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

Adds or edits multiple instances of CardType class.

Parameters

collection Your collection of CardType class to bulk import.

Returns: Returns list of imported cardTypeIds.

Exceptions

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

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

Counts the number of card types.

Returns: Returns the count of the card types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered card types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered card types.

void MixERP.Net.Api.Core.CardTypeController.Delete ( int cardTypeId )

Deletes an existing instance of CardType class via CardTypeId.

Parameters

cardTypeId Enter the value for CardTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.CardTypeController.Edit	(	int	cardTypeId,
		[FromBody] MixERP.Net.Entities.Core.CardType	cardType
	)

Edits existing record with your instance of CardType class.

Parameters

cardType	Your instance of CardType class to edit.
cardTypeId	Enter the value for CardTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.CardType> MixERP.Net.Api.Core.CardTypeController.Get ( )

Returns collection of card type for export.

Returns

MixERP.Net.Entities.Core.CardType MixERP.Net.Api.Core.CardTypeController.Get ( int cardTypeId )

Returns an instance of card type.

Parameters

cardTypeId Enter CardTypeId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "card type" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.CardType> MixERP.Net.Api.Core.CardTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation