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

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

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

long	Count ()
	Counts the number of zip code types. More...

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

MixERP.Net.Entities.Core.ZipCodeType	Get (int zipCodeTypeId)
	Returns an instance of zip code type. More...

IEnumerable< MixERP.Net.Entities.Core.ZipCodeType >	Get ([FromUri] int[] zipCodeTypeIds)

IEnumerable< MixERP.Net.Entities.Core.ZipCodeType >	GetPagedResult ()
	Creates a paginated collection containing 25 zip code types on each page, sorted by the property ZipCodeTypeId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.ZipCodeType zipCodeType)
	Adds your instance of ZipCodeType class. More...

void	Edit (int zipCodeTypeId, [FromBody] MixERP.Net.Entities.Core.ZipCodeType zipCodeType)
	Edits existing record with your instance of ZipCodeType class. More...

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

void	Delete (int zipCodeTypeId)
	Deletes an existing instance of ZipCodeType class via ZipCodeTypeId. 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 Code Types.

Member Function Documentation

void MixERP.Net.Api.Core.ZipCodeTypeController.Add ( MixERP.Net.Entities.Core.ZipCodeType zipCodeType )

Adds your instance of ZipCodeType class.

Parameters

zipCodeType Your instance of zip code types class to add.

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

Adds or edits your instance of ZipCodeType class.

Parameters

zipCodeType Your instance of zip code types class to add or edit.

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

Adds or edits multiple instances of ZipCodeType class.

Parameters

collection Your collection of ZipCodeType class to bulk import.

Returns: Returns list of imported zipCodeTypeIds.

Exceptions

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

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

Counts the number of zip code types.

Returns: Returns the count of the zip code types.

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

Counts the number of zip code types using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered zip code types.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered zip code types.

void MixERP.Net.Api.Core.ZipCodeTypeController.Delete ( int zipCodeTypeId )

Deletes an existing instance of ZipCodeType class via ZipCodeTypeId.

Parameters

zipCodeTypeId Enter the value for ZipCodeTypeId in order to find and delete the existing record.

void MixERP.Net.Api.Core.ZipCodeTypeController.Edit	(	int	zipCodeTypeId,
		[FromBody] MixERP.Net.Entities.Core.ZipCodeType	zipCodeType
	)

Edits existing record with your instance of ZipCodeType class.

Parameters

zipCodeType	Your instance of ZipCodeType class to edit.
zipCodeTypeId	Enter the value for ZipCodeTypeId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.ZipCodeType> MixERP.Net.Api.Core.ZipCodeTypeController.Get ( )

Returns collection of zip code type for export.

Returns

MixERP.Net.Entities.Core.ZipCodeType MixERP.Net.Api.Core.ZipCodeTypeController.Get ( int zipCodeTypeId )

Returns an instance of zip code type.

Parameters

zipCodeTypeId Enter ZipCodeTypeId to search for.

Returns

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

A custom field is a user defined field for zip code types.

Returns: Returns an enumerable custom field collection of zip code types.

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

A custom field is a user defined field for zip code types.

Returns: Returns an enumerable custom field collection of zip code types.

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

Displayfield is a lightweight key/value collection of zip code types.

Returns: Returns an enumerable key/value collection of zip code types.

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

Creates meta information of "zip code type" entity.

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

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

Creates a filtered and paginated collection containing 25 zip code types on each page, sorted by the property ZipCodeTypeId.

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

Creates a paginated collection containing 25 zip code types on each page, sorted by the property ZipCodeTypeId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.ZipCodeType> MixERP.Net.Api.Core.ZipCodeTypeController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 zip code types on each page, sorted by the property ZipCodeTypeId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 zip code types on each page, sorted by the property ZipCodeTypeId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation