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

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

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

long	Count ()
	Counts the number of shipping package shapes. More...

IEnumerable< MixERP.Net.Entities.Core.ShippingPackageShape >	Get ()
	Returns collection of shipping package shape for export. More...

MixERP.Net.Entities.Core.ShippingPackageShape	Get (int shippingPackageShapeId)
	Returns an instance of shipping package shape. More...

IEnumerable< MixERP.Net.Entities.Core.ShippingPackageShape >	Get ([FromUri] int[] shippingPackageShapeIds)

IEnumerable< MixERP.Net.Entities.Core.ShippingPackageShape >	GetPagedResult ()
	Creates a paginated collection containing 25 shipping package shapes on each page, sorted by the property ShippingPackageShapeId. More...

IEnumerable< MixERP.Net.Entities.Core.ShippingPackageShape >	GetPagedResult (long pageNumber)
	Creates a paginated collection containing 25 shipping package shapes on each page, sorted by the property ShippingPackageShapeId. More...

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.ShippingPackageShape shippingPackageShape)
	Adds your instance of ShippingPackageShape class. More...

void	Edit (int shippingPackageShapeId, [FromBody] MixERP.Net.Entities.Core.ShippingPackageShape shippingPackageShape)
	Edits existing record with your instance of ShippingPackageShape class. More...

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

void	Delete (int shippingPackageShapeId)
	Deletes an existing instance of ShippingPackageShape class via ShippingPackageShapeId. 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 Package Shapes.

Member Function Documentation

void MixERP.Net.Api.Core.ShippingPackageShapeController.Add ( MixERP.Net.Entities.Core.ShippingPackageShape shippingPackageShape )

Adds your instance of ShippingPackageShape class.

Parameters

shippingPackageShape Your instance of shipping package shapes class to add.

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

Adds or edits your instance of ShippingPackageShape class.

Parameters

shippingPackageShape Your instance of shipping package shapes class to add or edit.

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

Adds or edits multiple instances of ShippingPackageShape class.

Parameters

collection Your collection of ShippingPackageShape class to bulk import.

Returns: Returns list of imported shippingPackageShapeIds.

Exceptions

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

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

Counts the number of shipping package shapes.

Returns: Returns the count of the shipping package shapes.

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

Counts the number of shipping package shapes using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered shipping package shapes.

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

Counts the number of shipping package shapes using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered shipping package shapes.

void MixERP.Net.Api.Core.ShippingPackageShapeController.Delete ( int shippingPackageShapeId )

Deletes an existing instance of ShippingPackageShape class via ShippingPackageShapeId.

Parameters

shippingPackageShapeId Enter the value for ShippingPackageShapeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ShippingPackageShapeController.Edit	(	int	shippingPackageShapeId,
		[FromBody] MixERP.Net.Entities.Core.ShippingPackageShape	shippingPackageShape
	)

Edits existing record with your instance of ShippingPackageShape class.

Parameters

shippingPackageShape	Your instance of ShippingPackageShape class to edit.
shippingPackageShapeId	Enter the value for ShippingPackageShapeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.ShippingPackageShape> MixERP.Net.Api.Core.ShippingPackageShapeController.Get ( )

Returns collection of shipping package shape for export.

Returns

MixERP.Net.Entities.Core.ShippingPackageShape MixERP.Net.Api.Core.ShippingPackageShapeController.Get ( int shippingPackageShapeId )

Returns an instance of shipping package shape.

Parameters

shippingPackageShapeId Enter ShippingPackageShapeId to search for.

Returns

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

A custom field is a user defined field for shipping package shapes.

Returns: Returns an enumerable custom field collection of shipping package shapes.

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

A custom field is a user defined field for shipping package shapes.

Returns: Returns an enumerable custom field collection of shipping package shapes.

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

Displayfield is a lightweight key/value collection of shipping package shapes.

Returns: Returns an enumerable key/value collection of shipping package shapes.

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

Creates meta information of "shipping package shape" entity.

Returns: Returns the "shipping package shape" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 shipping package shapes on each page, sorted by the property ShippingPackageShapeId.

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

Creates a paginated collection containing 25 shipping package shapes on each page, sorted by the property ShippingPackageShapeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.ShippingPackageShape> MixERP.Net.Api.Core.ShippingPackageShapeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 shipping package shapes on each page, sorted by the property ShippingPackageShapeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 shipping package shapes on each page, sorted by the property ShippingPackageShapeId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation