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

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

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

long	Count ()
	Counts the number of shipping mail types. More...

IEnumerable< MixERP.Net.Entities.Core.ShippingMailType >	Get ()
	Returns collection of shipping mail type for export. More...

MixERP.Net.Entities.Core.ShippingMailType	Get (int shippingMailTypeId)
	Returns an instance of shipping mail type. More...

IEnumerable< MixERP.Net.Entities.Core.ShippingMailType >	Get ([FromUri] int[] shippingMailTypeIds)

IEnumerable< MixERP.Net.Entities.Core.ShippingMailType >	GetPagedResult ()
	Creates a paginated collection containing 25 shipping mail types on each page, sorted by the property ShippingMailTypeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.ShippingMailType shippingMailType)
	Adds your instance of ShippingMailType class. More...

void	Edit (int shippingMailTypeId, [FromBody] MixERP.Net.Entities.Core.ShippingMailType shippingMailType)
	Edits existing record with your instance of ShippingMailType class. More...

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

void	Delete (int shippingMailTypeId)
	Deletes an existing instance of ShippingMailType class via ShippingMailTypeId. 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 Shipping Mail Types.

Member Function Documentation

void MixERP.Net.Api.Core.ShippingMailTypeController.Add ( MixERP.Net.Entities.Core.ShippingMailType shippingMailType )

Adds your instance of ShippingMailType class.

Parameters

shippingMailType Your instance of shipping mail types class to add.

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

Adds or edits your instance of ShippingMailType class.

Parameters

shippingMailType Your instance of shipping mail types class to add or edit.

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

Adds or edits multiple instances of ShippingMailType class.

Parameters

collection Your collection of ShippingMailType class to bulk import.

Returns: Returns list of imported shippingMailTypeIds.

Exceptions

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

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

Counts the number of shipping mail types.

Returns: Returns the count of the shipping mail types.

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

Counts the number of shipping mail types using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered shipping mail types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered shipping mail types.

void MixERP.Net.Api.Core.ShippingMailTypeController.Delete ( int shippingMailTypeId )

Deletes an existing instance of ShippingMailType class via ShippingMailTypeId.

Parameters

shippingMailTypeId Enter the value for ShippingMailTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ShippingMailTypeController.Edit	(	int	shippingMailTypeId,
		[FromBody] MixERP.Net.Entities.Core.ShippingMailType	shippingMailType
	)

Edits existing record with your instance of ShippingMailType class.

Parameters

shippingMailType	Your instance of ShippingMailType class to edit.
shippingMailTypeId	Enter the value for ShippingMailTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.ShippingMailType> MixERP.Net.Api.Core.ShippingMailTypeController.Get ( )

Returns collection of shipping mail type for export.

Returns

MixERP.Net.Entities.Core.ShippingMailType MixERP.Net.Api.Core.ShippingMailTypeController.Get ( int shippingMailTypeId )

Returns an instance of shipping mail type.

Parameters

shippingMailTypeId Enter ShippingMailTypeId to search for.

Returns

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

A custom field is a user defined field for shipping mail types.

Returns: Returns an enumerable custom field collection of shipping mail types.

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

A custom field is a user defined field for shipping mail types.

Returns: Returns an enumerable custom field collection of shipping mail types.

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

Displayfield is a lightweight key/value collection of shipping mail types.

Returns: Returns an enumerable key/value collection of shipping mail types.

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

Creates meta information of "shipping mail type" entity.

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

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

Creates a filtered and paginated collection containing 25 shipping mail types on each page, sorted by the property ShippingMailTypeId.

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

Creates a paginated collection containing 25 shipping mail types on each page, sorted by the property ShippingMailTypeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.ShippingMailType> MixERP.Net.Api.Core.ShippingMailTypeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 shipping mail types on each page, sorted by the property ShippingMailTypeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 shipping mail types on each page, sorted by the property ShippingMailTypeId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation