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

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

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

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

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

MixERP.Net.Entities.Core.IdentificationType	Get (string identificationTypeCode)
	Returns an instance of identification type. More...

IEnumerable< MixERP.Net.Entities.Core.IdentificationType >	Get ([FromUri] string[] identificationTypeCodes)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.IdentificationType identificationType)
	Adds your instance of IdentificationType class. More...

void	Edit (string identificationTypeCode, [FromBody] MixERP.Net.Entities.Core.IdentificationType identificationType)
	Edits existing record with your instance of IdentificationType class. More...

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

void	Delete (string identificationTypeCode)
	Deletes an existing instance of IdentificationType class via IdentificationTypeCode. 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 Identification Types.

Member Function Documentation

void MixERP.Net.Api.Core.IdentificationTypeController.Add ( MixERP.Net.Entities.Core.IdentificationType identificationType )

Adds your instance of IdentificationType class.

Parameters

identificationType Your instance of identification types class to add.

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

Adds or edits your instance of IdentificationType class.

Parameters

identificationType Your instance of identification types class to add or edit.

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

Adds or edits multiple instances of IdentificationType class.

Parameters

collection Your collection of IdentificationType class to bulk import.

Returns: Returns list of imported identificationTypeCodes.

Exceptions

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

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

Counts the number of identification types.

Returns: Returns the count of the identification types.

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

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

Parameters

filterName The named filter.

Returns: Returns the count of filtered identification types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered identification types.

void MixERP.Net.Api.Core.IdentificationTypeController.Delete ( string identificationTypeCode )

Deletes an existing instance of IdentificationType class via IdentificationTypeCode.

Parameters

identificationTypeCode Enter the value for IdentificationTypeCode in order to find and delete the existing record.

void MixERP.Net.Api.Core.IdentificationTypeController.Edit	(	string	identificationTypeCode,
		[FromBody] MixERP.Net.Entities.Core.IdentificationType	identificationType
	)

Edits existing record with your instance of IdentificationType class.

Parameters

identificationType	Your instance of IdentificationType class to edit.
identificationTypeCode	Enter the value for IdentificationTypeCode in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.IdentificationType> MixERP.Net.Api.Core.IdentificationTypeController.Get ( )

Returns collection of identification type for export.

Returns

MixERP.Net.Entities.Core.IdentificationType MixERP.Net.Api.Core.IdentificationTypeController.Get ( string identificationTypeCode )

Returns an instance of identification type.

Parameters

identificationTypeCode Enter IdentificationTypeCode to search for.

Returns

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

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

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

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

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

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

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

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

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

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

Creates meta information of "identification type" entity.

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

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

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

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

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

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.IdentificationType> MixERP.Net.Api.Core.IdentificationTypeController.GetPagedResult ( long pageNumber )

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

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation