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

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

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

long	Count ()
	Counts the number of shippers. More...

IEnumerable< MixERP.Net.Entities.Core.Shipper >	Get ()
	Returns collection of shipper for export. More...

MixERP.Net.Entities.Core.Shipper	Get (int shipperId)
	Returns an instance of shipper. More...

IEnumerable< MixERP.Net.Entities.Core.Shipper >	Get ([FromUri] int[] shipperIds)

IEnumerable< MixERP.Net.Entities.Core.Shipper >	GetPagedResult ()
	Creates a paginated collection containing 25 shippers on each page, sorted by the property ShipperId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Shipper shipper)
	Adds your instance of Shipper class. More...

void	Edit (int shipperId, [FromBody] MixERP.Net.Entities.Core.Shipper shipper)
	Edits existing record with your instance of Shipper class. More...

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

void	Delete (int shipperId)
	Deletes an existing instance of Shipper class via ShipperId. 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 Shippers.

Member Function Documentation

void MixERP.Net.Api.Core.ShipperController.Add ( MixERP.Net.Entities.Core.Shipper shipper )

Adds your instance of Shipper class.

Parameters

shipper Your instance of shippers class to add.

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

Adds or edits your instance of Shipper class.

Parameters

shipper Your instance of shippers class to add or edit.

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

Adds or edits multiple instances of Shipper class.

Parameters

collection Your collection of Shipper class to bulk import.

Returns: Returns list of imported shipperIds.

Exceptions

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

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

Counts the number of shippers.

Returns: Returns the count of the shippers.

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

Counts the number of shippers using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered shippers.

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

Counts the number of shippers using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered shippers.

void MixERP.Net.Api.Core.ShipperController.Delete ( int shipperId )

Deletes an existing instance of Shipper class via ShipperId.

Parameters

shipperId Enter the value for ShipperId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ShipperController.Edit	(	int	shipperId,
		[FromBody] MixERP.Net.Entities.Core.Shipper	shipper
	)

Edits existing record with your instance of Shipper class.

Parameters

shipper	Your instance of Shipper class to edit.
shipperId	Enter the value for ShipperId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Shipper> MixERP.Net.Api.Core.ShipperController.Get ( )

Returns collection of shipper for export.

Returns

MixERP.Net.Entities.Core.Shipper MixERP.Net.Api.Core.ShipperController.Get ( int shipperId )

Returns an instance of shipper.

Parameters

shipperId Enter ShipperId to search for.

Returns

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

A custom field is a user defined field for shippers.

Returns: Returns an enumerable custom field collection of shippers.

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

A custom field is a user defined field for shippers.

Returns: Returns an enumerable custom field collection of shippers.

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

Displayfield is a lightweight key/value collection of shippers.

Returns: Returns an enumerable key/value collection of shippers.

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

Creates meta information of "shipper" entity.

Returns: Returns the "shipper" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 shippers on each page, sorted by the property ShipperId.

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

Creates a paginated collection containing 25 shippers on each page, sorted by the property ShipperId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Shipper> MixERP.Net.Api.Core.ShipperController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 shippers on each page, sorted by the property ShipperId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 shippers on each page, sorted by the property ShipperId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation