Table of Contents

Class SearchWS

Namespace
PHCWS
Assembly
PHCWS.dll

url = urlBase."REST/SearchWS/"

[WebService(Namespace = "http://www.phcgo.net/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[DesignerGenerated]
public class SearchWS : PHCGenericWS, IComponent, IDisposable, IServiceProvider
Inheritance
SearchWS

Methods

Delete(string)

Delete a record in the database.

[WebMethod]
public PHCResult Delete(string searchstamp)

Parameters

Nome Tipo Descrição
searchstamp string

dentifies the record to be deleted, matches the value stored in the field searchstamp of SearchVO.

Returns

PHCResult

PHCResult empty or error messages produced by this process of erasing.

Remarks

Deletes the database the record identified by the parameter searchstamp.

EntityListSearch(QueryVO) 

[WebMethod]
public PHCResult EntityListSearch(QueryVO itemQuery)

Parameters

Nome Tipo Descrição
itemQuery QueryVO

Returns

PHCResult

Query(QueryVO)

Consult multiple records of one or more entities.

[WebMethod]
public PHCResult Query(QueryVO itemQuery)

Parameters

Nome Tipo Descrição
itemQuery QueryVO

Indicates the query to run in the database

Returns

PHCResult

PHCResult with the query result or error messages produced by this process.

QueryAsDynamic(QueryVO) 

[WebMethod]
public PHCResult QueryAsDynamic(QueryVO itemQuery)

Parameters

Nome Tipo Descrição
itemQuery QueryVO

Returns

PHCResult

QueryAsEntities(QueryVO)

Consult multiple records of one or more entities.

[WebMethod]
public PHCResult QueryAsEntities(QueryVO itemQuery)

Parameters

Nome Tipo Descrição
itemQuery QueryVO

Indicates the query to run in the database

Returns

PHCResult

PHCResult with the query result or error messages produced by this process.

Remarks

This service returns a similar result to Querybut returns a list of typed entities instead of a dataset.

QuickLook(string, string)

Full Text Search

[WebMethod]
public PHCResult QuickLook(string searchExpression, string filterEntity)

Parameters

Nome Tipo Descrição
searchExpression string
filterEntity string

Returns

PHCResult

Requery(string, bool)

Consult a record of the database.

[WebMethod]
public PHCResult Requery(string searchstamp, bool runValidations)

Parameters

Nome Tipo Descrição
searchstamp string

Identifies the record that you want to see, matches the value stored in the field searchstamp of SearchVO.
runValidations bool

Indicates that before the request entity manager registry, it is checked the query access and other operations are performed, such as, for example, registering the user determined that activity log consulted this record.

Returns

PHCResult

PHCResult containg SearchVO request or error messages produced by this query process.

Remarks

Consult the register identified by parameter searchstamp.

Save(SearchVO)

Save a record in the database.

[WebMethod]
public PHCResult Save(SearchVO search)

Parameters

Nome Tipo Descrição
search SearchVO

SearchVO corresponding to the record you want to record in the database.

Returns

PHCResult

PHCResult empty or error messages produced by this recording process.

Remarks

It is necessary that the SearchVO has its property SearchVO.Operation diferent 0 is produced for any recording instruction to the database.

getEntityFromLog(string)

Consulting a database of a particular log record.

[WebMethod]
public PHCResult getEntityFromLog(string fxlogstamp)

Parameters

Nome Tipo Descrição
fxlogstamp string

Indicates where the log that contains the desired entity.

If empty returns the following message:.

errors.Business.GenericEntities.VOEmptyStamp.

Returns

PHCResult

PHCResult containing the entity's application for registration or error messages produced by this query process.

Remarks

Consult the database a particular log identified by parameter fxlogstamp.

getSavedSearches(string)

Consult your saved searches.

[WebMethod]
public PHCResult getSavedSearches(string formid)

Parameters

Nome Tipo Descrição
formid string

Specifies the unique value that identifies the saved searches to a particular entity, corresponds to the field formid of SearchVO.

Returns

PHCResult

PHCResult containing a list of SearchVO with the requested searches or error messages produced by this query process.

Remarks

Consult research previously saved for a given entity.