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

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

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

long	Count ()
	Counts the number of week days. More...

IEnumerable< MixERP.Net.Entities.Core.WeekDay >	Get ()
	Returns collection of week day for export. More...

MixERP.Net.Entities.Core.WeekDay	Get (int weekDayId)
	Returns an instance of week day. More...

IEnumerable< MixERP.Net.Entities.Core.WeekDay >	Get ([FromUri] int[] weekDayIds)

IEnumerable< MixERP.Net.Entities.Core.WeekDay >	GetPagedResult ()
	Creates a paginated collection containing 25 week days on each page, sorted by the property WeekDayId. More...

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.WeekDay weekDay)
	Adds your instance of WeekDay class. More...

void	Edit (int weekDayId, [FromBody] MixERP.Net.Entities.Core.WeekDay weekDay)
	Edits existing record with your instance of WeekDay class. More...

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

void	Delete (int weekDayId)
	Deletes an existing instance of WeekDay class via WeekDayId. 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 Week Days.

Member Function Documentation

void MixERP.Net.Api.Core.WeekDayController.Add ( MixERP.Net.Entities.Core.WeekDay weekDay )

Adds your instance of WeekDay class.

Parameters

weekDay Your instance of week days class to add.

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

Adds or edits your instance of WeekDay class.

Parameters

weekDay Your instance of week days class to add or edit.

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

Adds or edits multiple instances of WeekDay class.

Parameters

collection Your collection of WeekDay class to bulk import.

Returns: Returns list of imported weekDayIds.

Exceptions

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

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

Counts the number of week days.

Returns: Returns the count of the week days.

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

Counts the number of week days using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered week days.

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

Counts the number of week days using the supplied filter(s).

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered week days.

void MixERP.Net.Api.Core.WeekDayController.Delete ( int weekDayId )

Deletes an existing instance of WeekDay class via WeekDayId.

Parameters

weekDayId Enter the value for WeekDayId in order to find and delete the existing record.

void MixERP.Net.Api.Core.WeekDayController.Edit	(	int	weekDayId,
		[FromBody] MixERP.Net.Entities.Core.WeekDay	weekDay
	)

Edits existing record with your instance of WeekDay class.

Parameters

weekDay	Your instance of WeekDay class to edit.
weekDayId	Enter the value for WeekDayId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.WeekDay> MixERP.Net.Api.Core.WeekDayController.Get ( )

Returns collection of week day for export.

Returns

MixERP.Net.Entities.Core.WeekDay MixERP.Net.Api.Core.WeekDayController.Get ( int weekDayId )

Returns an instance of week day.

Parameters

weekDayId Enter WeekDayId to search for.

Returns

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

A custom field is a user defined field for week days.

Returns: Returns an enumerable custom field collection of week days.

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

A custom field is a user defined field for week days.

Returns: Returns an enumerable custom field collection of week days.

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

Displayfield is a lightweight key/value collection of week days.

Returns: Returns an enumerable key/value collection of week days.

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

Creates meta information of "week day" entity.

Returns: Returns the "week day" meta information to perform CRUD operation.

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

Creates a filtered and paginated collection containing 25 week days on each page, sorted by the property WeekDayId.

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

Creates a paginated collection containing 25 week days on each page, sorted by the property WeekDayId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.WeekDay> MixERP.Net.Api.Core.WeekDayController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 week days on each page, sorted by the property WeekDayId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

Creates a filtered and paginated collection containing 25 week days on each page, sorted by the property WeekDayId.

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation