MixERP.Net.Api.Audit.LoginController Class Reference

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

Inheritance diagram for MixERP.Net.Api.Audit.LoginController:

Public Member Functions

EntityView GetEntityView ()
 Creates meta information of "login" entity. More...
 
long Count ()
 Counts the number of logins. More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoginGet ()
 Returns collection of login for export. More...
 
MixERP.Net.Entities.Audit.Login Get (long loginIdParameter)
 Returns an instance of login. More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoginGet ([FromUri] long[] loginIds)
 
IEnumerable< MixERP.Net.Entities.Audit.LoginGetPagedResult ()
 Creates a paginated collection containing 25 logins on each page, sorted by the property LoginIdParameter. More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoginGetPagedResult (long pageNumber)
 Creates a paginated collection containing 25 logins on each page, sorted by the property LoginIdParameter. More...
 
long CountWhere ([FromBody]dynamic filters)
 Counts the number of logins using the supplied filter(s). More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoginGetWhere (long pageNumber, [FromBody]dynamic filters)
 Creates a filtered and paginated collection containing 25 logins on each page, sorted by the property LoginIdParameter. More...
 
long CountFiltered (string filterName)
 Counts the number of logins using the supplied filter name. More...
 
IEnumerable< MixERP.Net.Entities.Audit.LoginGetFiltered (long pageNumber, string filterName)
 Creates a filtered and paginated collection containing 25 logins on each page, sorted by the property LoginIdParameter. More...
 
IEnumerable< DisplayFieldGetDisplayFields ()
 Displayfield is a lightweight key/value collection of logins. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields ()
 A custom field is a user defined field for logins. More...
 
IEnumerable< PetaPoco.CustomFieldGetCustomFields (string resourceId)
 A custom field is a user defined field for logins. More...
 
void AddOrEdit ([FromBody]Newtonsoft.Json.Linq.JArray form)
 Adds or edits your instance of Login class. More...
 
void Add (MixERP.Net.Entities.Audit.Login login)
 Adds your instance of Login class. More...
 
void Edit (long loginIdParameter, [FromBody] MixERP.Net.Entities.Audit.Login login)
 Edits existing record with your instance of Login class. More...
 
List< object > BulkImport ([FromBody]dynamic collection)
 Adds or edits multiple instances of Login class. More...
 
void Delete (long loginIdParameter)
 Deletes an existing instance of Login class via LoginIdParameter. 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 Logins.

Member Function Documentation

void MixERP.Net.Api.Audit.LoginController.Add ( MixERP.Net.Entities.Audit.Login  login)

Adds your instance of Login class.

Parameters
loginYour instance of logins class to add.
void MixERP.Net.Api.Audit.LoginController.AddOrEdit ( [FromBody] Newtonsoft.Json.Linq.JArray  form)

Adds or edits your instance of Login class.

Parameters
loginYour instance of logins class to add or edit.
List<object> MixERP.Net.Api.Audit.LoginController.BulkImport ( [FromBody] dynamic  collection)

Adds or edits multiple instances of Login class.

Parameters
collectionYour collection of Login class to bulk import.
Returns
Returns list of imported loginIds.
Exceptions
MixERPExceptionThrown when your any Login class in the collection is invalid or malformed.
long MixERP.Net.Api.Audit.LoginController.Count ( )

Counts the number of logins.

Returns
Returns the count of the logins.
long MixERP.Net.Api.Audit.LoginController.CountFiltered ( string  filterName)

Counts the number of logins using the supplied filter name.

Parameters
filterNameThe named filter.
Returns
Returns the count of filtered logins.
long MixERP.Net.Api.Audit.LoginController.CountWhere ( [FromBody] dynamic  filters)

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

Parameters
filtersThe list of filter conditions.
Returns
Returns the count of filtered logins.
void MixERP.Net.Api.Audit.LoginController.Delete ( long  loginIdParameter)

Deletes an existing instance of Login class via LoginIdParameter.

Parameters
loginIdParameterEnter the value for LoginIdParameter in order to find and delete the existing record.
void MixERP.Net.Api.Audit.LoginController.Edit ( long  loginIdParameter,
[FromBody] MixERP.Net.Entities.Audit.Login  login 
)

Edits existing record with your instance of Login class.

Parameters
loginYour instance of Login class to edit.
loginIdParameterEnter the value for LoginIdParameter in order to find and edit the existing record.
IEnumerable<MixERP.Net.Entities.Audit.Login> MixERP.Net.Api.Audit.LoginController.Get ( )

Returns collection of login for export.

Returns
MixERP.Net.Entities.Audit.Login MixERP.Net.Api.Audit.LoginController.Get ( long  loginIdParameter)

Returns an instance of login.

Parameters
loginIdParameterEnter LoginIdParameter to search for.
Returns
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Audit.LoginController.GetCustomFields ( )

A custom field is a user defined field for logins.

Returns
Returns an enumerable custom field collection of logins.
IEnumerable<PetaPoco.CustomField> MixERP.Net.Api.Audit.LoginController.GetCustomFields ( string  resourceId)

A custom field is a user defined field for logins.

Returns
Returns an enumerable custom field collection of logins.
IEnumerable<DisplayField> MixERP.Net.Api.Audit.LoginController.GetDisplayFields ( )

Displayfield is a lightweight key/value collection of logins.

Returns
Returns an enumerable key/value collection of logins.
EntityView MixERP.Net.Api.Audit.LoginController.GetEntityView ( )

Creates meta information of "login" entity.

Returns
Returns the "login" meta information to perform CRUD operation.
IEnumerable<MixERP.Net.Entities.Audit.Login> MixERP.Net.Api.Audit.LoginController.GetFiltered ( long  pageNumber,
string  filterName 
)

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

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.Audit.Login> MixERP.Net.Api.Audit.LoginController.GetPagedResult ( )

Creates a paginated collection containing 25 logins on each page, sorted by the property LoginIdParameter.

Returns
Returns the first page from the collection.
IEnumerable<MixERP.Net.Entities.Audit.Login> MixERP.Net.Api.Audit.LoginController.GetPagedResult ( long  pageNumber)

Creates a paginated collection containing 25 logins on each page, sorted by the property LoginIdParameter.

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

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

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: