MixERP.Net.Api.Core.AttachmentLookupController Class Reference

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

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

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "attachment lookup" entity. More...
 
long Count ()
 Counts the number of attachment lookups. More...
 
IEnumerable< MixERP.Net.Entities.Core.AttachmentLookupGet ()
 Returns collection of attachment lookup for export. More...
 
MixERP.Net.Entities.Core.AttachmentLookup Get (int attachmentLookupId)
 Returns an instance of attachment lookup. More...
 
IEnumerable< MixERP.Net.Entities.Core.AttachmentLookupGet ([FromUri] int[] attachmentLookupIds)
 
IEnumerable< MixERP.Net.Entities.Core.AttachmentLookupGetPagedResult ()
 Creates a paginated collection containing 25 attachment lookups on each page, sorted by the property AttachmentLookupId. More...
 
IEnumerable< MixERP.Net.Entities.Core.AttachmentLookupGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 attachment lookups on each page, sorted by the property AttachmentLookupId. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of attachment lookups using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Core.AttachmentLookupGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 attachment lookups on each page, sorted by the property AttachmentLookupId. More...
 
long CountFiltered (string filterName)
 Counts the number of attachment lookups using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Core.AttachmentLookupGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 attachment lookups on each page, sorted by the property AttachmentLookupId. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of attachment lookups. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for attachment lookups. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for attachment lookups. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of AttachmentLookup class. More...
 
void Add (MixERP.Net.Entities.Core.AttachmentLookup attachmentLookup)
 Adds your instance of AttachmentLookup class. More...
 
void Edit (int attachmentLookupId, [FromBody] MixERP.Net.Entities.Core.AttachmentLookup attachmentLookup)
 Edits existing record with your instance of AttachmentLookup class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of AttachmentLookup class. More...
 
void Delete (int attachmentLookupId)
 Deletes an existing instance of AttachmentLookup class via AttachmentLookupId. 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 Attachment Lookups.

Member Function Documentation

void MixERP.Net.Api.Core.AttachmentLookupController.Add ( MixERP.Net.Entities.Core.AttachmentLookup  attachmentLookup)

Adds your instance of AttachmentLookup class.

Parameters
attachmentLookupYour instance of attachment lookups class to add.
void MixERP.Net.Api.Core.AttachmentLookupController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of AttachmentLookup class.

Parameters
attachmentLookupYour instance of attachment lookups class to add or edit.
List<object> MixERP.Net.Api.Core.AttachmentLookupController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of AttachmentLookup class.

Parameters
collectionYour collection of AttachmentLookup class to bulk import.
Returns
Returns list of imported attachmentLookupIds.
Exceptions
MixERPExceptionThrown when your any AttachmentLookup class in the collection is invalid or malformed.
long MixERP.Net.Api.Core.AttachmentLookupController.Count ( )

Counts the number of attachment lookups.

Returns
Returns the count of the attachment lookups.
long MixERP.Net.Api.Core.AttachmentLookupController.CountFiltered ( string  filterName)

Counts the number of attachment lookups using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered attachment lookups.
long MixERP.Net.Api.Core.AttachmentLookupController.CountWhere ( [FromBody] dynamic  filters)

Counts the number of attachment lookups using the supplied filter(s).

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered attachment lookups.
void MixERP.Net.Api.Core.AttachmentLookupController.Delete ( int  attachmentLookupId)

Deletes an existing instance of AttachmentLookup class via AttachmentLookupId.

Parameters
attachmentLookupIdEnter the value for AttachmentLookupId in order to find and delete the existing record.
void MixERP.Net.Api.Core.AttachmentLookupController.Edit ( int  attachmentLookupId,
[FromBody] MixERP.Net.Entities.Core.AttachmentLookup  attachmentLookup 
)

Edits existing record with your instance of AttachmentLookup class.

Parameters
attachmentLookupYour instance of AttachmentLookup class to edit.
attachmentLookupIdEnter the value for AttachmentLookupId in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Core.AttachmentLookup> MixERP.Net.Api.Core.AttachmentLookupController.Get ( )

Returns collection of attachment lookup for export.

Returns
MixERP.Net.Entities.Core.AttachmentLookup MixERP.Net.Api.Core.AttachmentLookupController.Get ( int  attachmentLookupId)

Returns an instance of attachment lookup.

Parameters
attachmentLookupIdEnter AttachmentLookupId to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.AttachmentLookupController.GetCustomFields ( )

A custom field is a user defined field for attachment lookups.

Returns
Returns an enumerable custom field collection of attachment lookups.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Core.AttachmentLookupController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for attachment lookups.

Returns
Returns an enumerable custom field collection of attachment lookups.
IEnumerable<DisplayField> MixERP.Net.Api.Core.AttachmentLookupController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of attachment lookups.

Returns
Returns an enumerable key/value collection of attachment lookups.
EntityView MixERP.Net.Api.Core.AttachmentLookupController.GetEntityView ( )

Creates meta information of "attachment lookup" entity.

Returns
Returns the "attachment lookup" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Core.AttachmentLookup> MixERP.Net.Api.Core.AttachmentLookupController.GetFiltered ( long  pageNumber,
string  filterName 
)

Creates a filtered and paginated collection containing 25 attachment lookups on each page, sorted by the property AttachmentLookupId.

Parameters
pageNumberEnter the page number to produce the resultset.
filterNameThe named filter.
Returns
Returns the requested page from the collection using the supplied filters.
IEnumerable<MixERP.Net.Entities.Core.AttachmentLookup> MixERP.Net.Api.Core.AttachmentLookupController.GetPagedResult ( )

Creates a paginated collection containing 25 attachment lookups on each page, sorted by the property AttachmentLookupId.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Core.AttachmentLookup> MixERP.Net.Api.Core.AttachmentLookupController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 attachment lookups on each page, sorted by the property AttachmentLookupId.

Parameters
pageNumberEnter the page number to produce the resultset.
Returns
Returns the requested page from the collection.
IEnumerable<MixERP.Net.Entities.Core.AttachmentLookup> MixERP.Net.Api.Core.AttachmentLookupController.GetWhere ( long  pageNumber,
[FromBody] dynamic  filters 
)

Creates a filtered and paginated collection containing 25 attachment lookups on each page, sorted by the property AttachmentLookupId.

Parameters
pageNumberEnter the page number to produce the resultset.
filtersThe 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: