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

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

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

long	Count ()
	Counts the number of zip codes. More...

IEnumerable< MixERP.Net.Entities.Core.ZipCode >	Get ()
	Returns collection of zip code for export. More...

MixERP.Net.Entities.Core.ZipCode	Get (long zipCodeId)
	Returns an instance of zip code. More...

IEnumerable< MixERP.Net.Entities.Core.ZipCode >	Get ([FromUri] long[] zipCodeIds)

IEnumerable< MixERP.Net.Entities.Core.ZipCode >	GetPagedResult ()
	Creates a paginated collection containing 25 zip codes on each page, sorted by the property ZipCodeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.ZipCode zipCode)
	Adds your instance of ZipCode class. More...

void	Edit (long zipCodeId, [FromBody] MixERP.Net.Entities.Core.ZipCode zipCode)
	Edits existing record with your instance of ZipCode class. More...

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

void	Delete (long zipCodeId)
	Deletes an existing instance of ZipCode class via ZipCodeId. 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 Zip Codes.

Member Function Documentation

void MixERP.Net.Api.Core.ZipCodeController.Add ( MixERP.Net.Entities.Core.ZipCode zipCode )

Adds your instance of ZipCode class.

Parameters

zipCode Your instance of zip codes class to add.

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

Adds or edits your instance of ZipCode class.

Parameters

zipCode Your instance of zip codes class to add or edit.

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

Adds or edits multiple instances of ZipCode class.

Parameters

collection Your collection of ZipCode class to bulk import.

Returns: Returns list of imported zipCodeIds.

Exceptions

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

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

Counts the number of zip codes.

Returns: Returns the count of the zip codes.

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

Counts the number of zip codes using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered zip codes.

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

Counts the number of zip codes using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered zip codes.

void MixERP.Net.Api.Core.ZipCodeController.Delete ( long zipCodeId )

Deletes an existing instance of ZipCode class via ZipCodeId.

Parameters

zipCodeId Enter the value for ZipCodeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ZipCodeController.Edit	(	long	zipCodeId,
		[FromBody] MixERP.Net.Entities.Core.ZipCode	zipCode
	)

Edits existing record with your instance of ZipCode class.

Parameters

zipCode	Your instance of ZipCode class to edit.
zipCodeId	Enter the value for ZipCodeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.ZipCode> MixERP.Net.Api.Core.ZipCodeController.Get ( )

Returns collection of zip code for export.

Returns

MixERP.Net.Entities.Core.ZipCode MixERP.Net.Api.Core.ZipCodeController.Get ( long zipCodeId )

Returns an instance of zip code.

Parameters

zipCodeId Enter ZipCodeId to search for.

Returns

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

A custom field is a user defined field for zip codes.

Returns: Returns an enumerable custom field collection of zip codes.

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

A custom field is a user defined field for zip codes.

Returns: Returns an enumerable custom field collection of zip codes.

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

Displayfield is a lightweight key/value collection of zip codes.

Returns: Returns an enumerable key/value collection of zip codes.

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

Creates meta information of "zip code" entity.

Returns: Returns the "zip code" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 zip codes on each page, sorted by the property ZipCodeId.

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

Creates a paginated collection containing 25 zip codes on each page, sorted by the property ZipCodeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.ZipCode> MixERP.Net.Api.Core.ZipCodeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 zip codes on each page, sorted by the property ZipCodeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 zip codes on each page, sorted by the property ZipCodeId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation