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

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

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

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

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

MixERP.Net.Entities.Core.RecurrenceType	Get (int recurrenceTypeId)
	Returns an instance of recurrence type. More...

IEnumerable< MixERP.Net.Entities.Core.RecurrenceType >	Get ([FromUri] int[] recurrenceTypeIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.RecurrenceType recurrenceType)
	Adds your instance of RecurrenceType class. More...

void	Edit (int recurrenceTypeId, [FromBody] MixERP.Net.Entities.Core.RecurrenceType recurrenceType)
	Edits existing record with your instance of RecurrenceType class. More...

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

void	Delete (int recurrenceTypeId)
	Deletes an existing instance of RecurrenceType class via RecurrenceTypeId. 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 Recurrence Types.

Member Function Documentation

void MixERP.Net.Api.Core.RecurrenceTypeController.Add ( MixERP.Net.Entities.Core.RecurrenceType recurrenceType )

Adds your instance of RecurrenceType class.

Parameters

recurrenceType Your instance of recurrence types class to add.

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

Adds or edits your instance of RecurrenceType class.

Parameters

recurrenceType Your instance of recurrence types class to add or edit.

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

Adds or edits multiple instances of RecurrenceType class.

Parameters

collection Your collection of RecurrenceType class to bulk import.

Returns: Returns list of imported recurrenceTypeIds.

Exceptions

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

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

Counts the number of recurrence types.

Returns: Returns the count of the recurrence types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered recurrence types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered recurrence types.

void MixERP.Net.Api.Core.RecurrenceTypeController.Delete ( int recurrenceTypeId )

Deletes an existing instance of RecurrenceType class via RecurrenceTypeId.

Parameters

recurrenceTypeId Enter the value for RecurrenceTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.RecurrenceTypeController.Edit	(	int	recurrenceTypeId,
		[FromBody] MixERP.Net.Entities.Core.RecurrenceType	recurrenceType
	)

Edits existing record with your instance of RecurrenceType class.

Parameters

recurrenceType	Your instance of RecurrenceType class to edit.
recurrenceTypeId	Enter the value for RecurrenceTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.RecurrenceType> MixERP.Net.Api.Core.RecurrenceTypeController.Get ( )

Returns collection of recurrence type for export.

Returns

MixERP.Net.Entities.Core.RecurrenceType MixERP.Net.Api.Core.RecurrenceTypeController.Get ( int recurrenceTypeId )

Returns an instance of recurrence type.

Parameters

recurrenceTypeId Enter RecurrenceTypeId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "recurrence type" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.RecurrenceType> MixERP.Net.Api.Core.RecurrenceTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation