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

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

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

long	Count ()
	Counts the number of shipping addresses. More...

IEnumerable< MixERP.Net.Entities.Core.ShippingAddress >	Get ()
	Returns collection of shipping address for export. More...

MixERP.Net.Entities.Core.ShippingAddress	Get (long shippingAddressId)
	Returns an instance of shipping address. More...

IEnumerable< MixERP.Net.Entities.Core.ShippingAddress >	Get ([FromUri] long[] shippingAddressIds)

IEnumerable< MixERP.Net.Entities.Core.ShippingAddress >	GetPagedResult ()
	Creates a paginated collection containing 25 shipping addresses on each page, sorted by the property ShippingAddressId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.ShippingAddress shippingAddress)
	Adds your instance of ShippingAddress class. More...

void	Edit (long shippingAddressId, [FromBody] MixERP.Net.Entities.Core.ShippingAddress shippingAddress)
	Edits existing record with your instance of ShippingAddress class. More...

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

void	Delete (long shippingAddressId)
	Deletes an existing instance of ShippingAddress class via ShippingAddressId. 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 Addresses.

Member Function Documentation

void MixERP.Net.Api.Core.ShippingAddressController.Add ( MixERP.Net.Entities.Core.ShippingAddress shippingAddress )

Adds your instance of ShippingAddress class.

Parameters

shippingAddress Your instance of shipping addresses class to add.

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

Adds or edits your instance of ShippingAddress class.

Parameters

shippingAddress Your instance of shipping addresses class to add or edit.

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

Adds or edits multiple instances of ShippingAddress class.

Parameters

collection Your collection of ShippingAddress class to bulk import.

Returns: Returns list of imported shippingAddressIds.

Exceptions

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

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

Counts the number of shipping addresses.

Returns: Returns the count of the shipping addresses.

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

Counts the number of shipping addresses using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered shipping addresses.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered shipping addresses.

void MixERP.Net.Api.Core.ShippingAddressController.Delete ( long shippingAddressId )

Deletes an existing instance of ShippingAddress class via ShippingAddressId.

Parameters

shippingAddressId Enter the value for ShippingAddressId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ShippingAddressController.Edit	(	long	shippingAddressId,
		[FromBody] MixERP.Net.Entities.Core.ShippingAddress	shippingAddress
	)

Edits existing record with your instance of ShippingAddress class.

Parameters

shippingAddress	Your instance of ShippingAddress class to edit.
shippingAddressId	Enter the value for ShippingAddressId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.ShippingAddress> MixERP.Net.Api.Core.ShippingAddressController.Get ( )

Returns collection of shipping address for export.

Returns

MixERP.Net.Entities.Core.ShippingAddress MixERP.Net.Api.Core.ShippingAddressController.Get ( long shippingAddressId )

Returns an instance of shipping address.

Parameters

shippingAddressId Enter ShippingAddressId to search for.

Returns

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

A custom field is a user defined field for shipping addresses.

Returns: Returns an enumerable custom field collection of shipping addresses.

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

A custom field is a user defined field for shipping addresses.

Returns: Returns an enumerable custom field collection of shipping addresses.

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

Displayfield is a lightweight key/value collection of shipping addresses.

Returns: Returns an enumerable key/value collection of shipping addresses.

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

Creates meta information of "shipping address" entity.

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

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

Creates a filtered and paginated collection containing 25 shipping addresses on each page, sorted by the property ShippingAddressId.

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

Creates a paginated collection containing 25 shipping addresses on each page, sorted by the property ShippingAddressId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.ShippingAddress> MixERP.Net.Api.Core.ShippingAddressController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 shipping addresses on each page, sorted by the property ShippingAddressId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 shipping addresses on each page, sorted by the property ShippingAddressId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation