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

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

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

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

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

MixERP.Net.Entities.Core.PartyType	Get (int partyTypeId)
	Returns an instance of party type. More...

IEnumerable< MixERP.Net.Entities.Core.PartyType >	Get ([FromUri] int[] partyTypeIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.PartyType partyType)
	Adds your instance of PartyType class. More...

void	Edit (int partyTypeId, [FromBody] MixERP.Net.Entities.Core.PartyType partyType)
	Edits existing record with your instance of PartyType class. More...

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

void	Delete (int partyTypeId)
	Deletes an existing instance of PartyType class via PartyTypeId. 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 Party Types.

Member Function Documentation

void MixERP.Net.Api.Core.PartyTypeController.Add ( MixERP.Net.Entities.Core.PartyType partyType )

Adds your instance of PartyType class.

Parameters

partyType Your instance of party types class to add.

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

Adds or edits your instance of PartyType class.

Parameters

partyType Your instance of party types class to add or edit.

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

Adds or edits multiple instances of PartyType class.

Parameters

collection Your collection of PartyType class to bulk import.

Returns: Returns list of imported partyTypeIds.

Exceptions

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

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

Counts the number of party types.

Returns: Returns the count of the party types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered party types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered party types.

void MixERP.Net.Api.Core.PartyTypeController.Delete ( int partyTypeId )

Deletes an existing instance of PartyType class via PartyTypeId.

Parameters

partyTypeId Enter the value for PartyTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.PartyTypeController.Edit	(	int	partyTypeId,
		[FromBody] MixERP.Net.Entities.Core.PartyType	partyType
	)

Edits existing record with your instance of PartyType class.

Parameters

partyType	Your instance of PartyType class to edit.
partyTypeId	Enter the value for PartyTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.PartyType> MixERP.Net.Api.Core.PartyTypeController.Get ( )

Returns collection of party type for export.

Returns

MixERP.Net.Entities.Core.PartyType MixERP.Net.Api.Core.PartyTypeController.Get ( int partyTypeId )

Returns an instance of party type.

Parameters

partyTypeId Enter PartyTypeId to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "party type" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.PartyType> MixERP.Net.Api.Core.PartyTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation