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

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

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

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

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

MixERP.Net.Entities.Core.Attachment	Get (long attachmentId)
	Returns an instance of attachment. More...

IEnumerable< MixERP.Net.Entities.Core.Attachment >	Get ([FromUri] long[] attachmentIds)

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

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

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

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

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

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

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

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

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

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

void	Add (MixERP.Net.Entities.Core.Attachment attachment)
	Adds your instance of Attachment class. More...

void	Edit (long attachmentId, [FromBody] MixERP.Net.Entities.Core.Attachment attachment)
	Edits existing record with your instance of Attachment class. More...

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

void	Delete (long attachmentId)
	Deletes an existing instance of Attachment class via AttachmentId. More...

HttpResponseMessage	GetImage (string path, int width=0, int height=0)

HttpResponseMessage	GetRaw (string path)

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 Attachments.

Member Function Documentation

void MixERP.Net.Api.Core.AttachmentController.Add ( MixERP.Net.Entities.Core.Attachment attachment )

Adds your instance of Attachment class.

Parameters

attachment Your instance of attachments class to add.

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

Adds or edits your instance of Attachment class.

Parameters

attachment Your instance of attachments class to add or edit.

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

Adds or edits multiple instances of Attachment class.

Parameters

collection Your collection of Attachment class to bulk import.

Returns: Returns list of imported attachmentIds.

Exceptions

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

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

Counts the number of attachments.

Returns: Returns the count of the attachments.

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

Counts the number of attachments using the supplied filter name.

Parameters

filterName The named filter.

Returns: Returns the count of filtered attachments.

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

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

Parameters

filters The list of filter conditions.

Returns: Returns the count of filtered attachments.

void MixERP.Net.Api.Core.AttachmentController.Delete ( long attachmentId )

Deletes an existing instance of Attachment class via AttachmentId.

Parameters

attachmentId Enter the value for AttachmentId in order to find and delete the existing record.

void MixERP.Net.Api.Core.AttachmentController.Edit	(	long	attachmentId,
		[FromBody] MixERP.Net.Entities.Core.Attachment	attachment
	)

Edits existing record with your instance of Attachment class.

Parameters

attachment	Your instance of Attachment class to edit.
attachmentId	Enter the value for AttachmentId in order to find and edit the existing record.

IEnumerable<MixERP.Net.Entities.Core.Attachment> MixERP.Net.Api.Core.AttachmentController.Get ( )

Returns collection of attachment for export.

Returns

MixERP.Net.Entities.Core.Attachment MixERP.Net.Api.Core.AttachmentController.Get ( long attachmentId )

Returns an instance of attachment.

Parameters

attachmentId Enter AttachmentId to search for.

Returns

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

A custom field is a user defined field for attachments.

Returns: Returns an enumerable custom field collection of attachments.

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

A custom field is a user defined field for attachments.

Returns: Returns an enumerable custom field collection of attachments.

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

Displayfield is a lightweight key/value collection of attachments.

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

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

Creates meta information of "attachment" entity.

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

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

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

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

Creates a paginated collection containing 25 attachments on each page, sorted by the property AttachmentId.

Returns: Returns the first page from the collection.

IEnumerable<MixERP.Net.Entities.Core.Attachment> MixERP.Net.Api.Core.AttachmentController.GetPagedResult ( long pageNumber )

Creates a paginated collection containing 25 attachments on each page, sorted by the property AttachmentId.

Parameters

pageNumber Enter the page number to produce the resultset.

Returns: Returns the requested page from the collection.

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

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

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

Public Member Functions

Properties

Detailed Description

Member Function Documentation