Class ServicesWS

Namespace: PHCWS

Assembly: PHCWS.dll

Management services of multiple entities.

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

Inheritance: object

MarshalByValueComponent

WebService

PHCGenericWS

ServicesWS

Methods

GetEntityRelations(string, string)

Get entity relations

[WebMethod]
public PHCResult GetEntityRelations(string entityName, string searchTerm)

Parameters

Nome	Tipo	Descrição
`entityName`	string
`searchTerm`	string

Returns

PHCResult

GetTicket(string)

[WebMethod]
public PHCResult GetTicket(string ticket)

Parameters

Nome	Tipo	Descrição
`ticket`	string

Returns

PHCResult

LoadImageGallery(string)

[WebMethod]
public PHCResult LoadImageGallery(string entityName)

Parameters

Nome	Tipo	Descrição
`entityName`	string

Returns

PHCResult

cancelSave(string, string)

Cancels an insert, duplication or update of record.

[WebMethod]
public PHCResult cancelSave(string entityname, string IdStamp)

Parameters

Nome Tipo Descrição

Nome	Tipo	Descrição
`entityname`	string	Identifies the entity name to which we want to perform the operation.
`IdStamp`	string	Identifies the record from which you want to cancel the operation, corresponds to the value stored in the field that identifies the record as unique in its entity is usually always a field with the subject name and the word 'stamp' at the end. For example for the entity FT, would be "ftstamp". .

entityname

string

Identifies the entity name to which we want to perform the operation.

IdStamp

string

Identifies the record from which you want to cancel the operation, corresponds to the value stored in the field that identifies the record as unique in its entity is usually always a field with the subject name and the word 'stamp' at the end.

For example for the entity FT, would be "ftstamp". .

Returns

PHCResult

Remarks

Cancels an insert, duplication or update of record.

Serves to avoid inconsistencies in the data, clearing the temporary data that was in memory waiting for a call to method 'Save'.

downloadEntityListCSV(string, QueryVO)

[WebMethod]
public PHCResult downloadEntityListCSV(string entityName, QueryVO query)

Parameters

Nome	Tipo	Descrição
`entityName`	string
`query`	QueryVO

Returns

PHCResult

emailEntityListCSV(string, QueryVO, EmailVO, bool)

[WebMethod]
public PHCResult emailEntityListCSV(string entityName, QueryVO query, EmailVO emailVO, bool sendToRecordTargets)

Parameters

Nome	Tipo	Descrição
`entityName`	string
`query`	QueryVO
`emailVO`	EmailVO
`sendToRecordTargets`	bool

Returns

PHCResult

emailExportableListLines(EmailExportQueryVO, List<object>, List<string>, string)

[WebMethod]
public PHCResult emailExportableListLines(EmailExportQueryVO item, List<object> records, List<string> fields, string entityName)

Parameters

Nome	Tipo	Descrição
`item`	EmailExportQueryVO
`records`	List<object>
`fields`	List<string>
`entityName`	string

Returns

PHCResult

exportEntity(ExportEntityVO)

Export records relating to an entity to a file.

[WebMethod]
public PHCResult exportEntity(ExportEntityVO entityToExport)

Parameters

Nome	Tipo	Descrição
`entityToExport`	ExportEntityVO	Contains configuration properties for export.

Returns

PHCResult

PHCResult containing StringVO with the location of the file and the file to the records, to the extent indicated.

Or error messages associated with this export process.

exportListLines(List<object>, List<string>, string, ExportFileTypes, string)

[WebMethod]
public PHCResult exportListLines(List<object> records, List<string> fields, string entityName, ExportFileTypes fileType, string exportTemplateStamp)

Parameters

Nome	Tipo	Descrição
`records`	List<object>
`fields`	List<string>
`entityName`	string
`fileType`	ExportFileTypes
`exportTemplateStamp`	string

Returns

PHCResult

exportStructure(StructureInfoConfigVO, string, List<object>, string, int)

[WebMethod]
public PHCResult exportStructure(StructureInfoConfigVO exportStuctureConfig, string contentType, List<object> records, string entityName, int orientationType)

Parameters

Nome	Tipo	Descrição
`exportStuctureConfig`	StructureInfoConfigVO
`contentType`	string
`records`	List<object>
`entityName`	string
`orientationType`	int

Returns

PHCResult

exportStructureTemplate(List<string>, string, string)

[WebMethod]
public PHCResult exportStructureTemplate(List<string> exportStuctureConfig, string contentType, string entityName)

Parameters

Nome	Tipo	Descrição
`exportStuctureConfig`	List<string>
`contentType`	string
`entityName`	string

Returns

PHCResult

generateEANFile()

Creates EAN file (Debit authorizations).

[WebMethod]
public PHCResult generateEANFile()

Returns

PHCResult

PHCResult containing StringVO with the location of the file and the generated authorization file, or error messages associated with this process.

As error messages, can be the following:.

- entity.sdd.adc.ean.no_customers_for_adc.

- entity.sdd.ean.no_file.

- entity.sdd.ean.need_bank_id.

Remarks

Creates EAN file (Debit authorizations).

The EAN file is the file accepted by the bank that contains the data needed to conduct the validation of the ADC codes (Debit Authorization Account) Generated by the application, by the financial institution.

getAllEntityStructure()

Consult all EntityStructures available.

[WebMethod]
public PHCResult getAllEntityStructure()

Returns

PHCResult: PHCResult containing a list of EntityStructureVO.

getDirectResetURL(int)

[WebMethod]
public PHCResult getDirectResetURL(int userno)

Parameters

Nome	Tipo	Descrição
`userno`	int

Returns

PHCResult

getEanFileByName(string)

Consult an EAN file by name.

[WebMethod]
public PHCResult getEanFileByName(string fileName)

Parameters

Nome	Tipo	Descrição
`fileName`	string	Filename EAN to consult.

Returns

PHCResult: PHCResult containing StringVO with the file location, or error messages related to this query process.

Remarks

Consult an EAN file by name, indicated by parameter fileName.

getEntityStructure(string)

Check the structure of an entity.

[WebMethod]
public PHCResult getEntityStructure(string entityName)

Parameters

Nome	Tipo	Descrição
`entityName`	string	Indicates the entity.

Returns

PHCResult

PHCResult containing EntityStructureVO or error messages produced by this query process.

If the parameter entityName comes with no value, is returned the following error message:.

- errors.Business.GenericEntities.VOEmptyEntityName.

If the parameter come filled, but you can not find that type of entity, returns the following error message:.

- errors.Business.GenericEntities.EntityNameUnknown.

Remarks

Check the structure of an entity.

This strutucture contains:.

- The subject name corresponds to entityName.

- The table name in the database of this entity corresponds to tableName.

- The field list this entity corresponds to fields.

- The collections of this entity corresponds to collections.

getGUID()

Service that returns a valid GUID to be used as a record identifier

[WebMethod]
public PHCResult getGUID()

Returns

PHCResult: Returns a GUID with Length 25 to be used as an identifier.

getInstanceFromReference(string, List<KeyValueVO>)

Creates a new record based on reference.

[WebMethod]
public PHCResult getInstanceFromReference(string entity, List<KeyValueVO> parameters)

Parameters

Nome Tipo Descrição

entity string

Nome	Tipo	Descrição
`entity`	string
`parameters`	List<KeyValueVO>	Indicates the internal number corresponding to the document type. For example, in the case of the FtVO this value is written in the field ndoc of FtVO and makes the connection with the field ndoc of TdVO. For example, in the case of ClVO this value is 0

parameters

List<KeyValueVO>

Indicates the internal number corresponding to the document type.

For example, in the case of the FtVO this value is written in the field ndoc of FtVO and makes the connection with the field ndoc of TdVO. For example, in the case of ClVO this value is 0

Returns

PHCResult: PHCResult containing the new registry established, or error messages produced by this process of creation. The returned record will contain default values and / or system rules that may exist for the entity in question.

Remarks

The record is only created and saved in memory, the final recording in the database should be done by the service 'Save'.

getListOfUnprocessedEAN()

Check the EAN file list that are not yet processed.

[WebMethod]
public PHCResult getListOfUnprocessedEAN()

Returns

PHCResult

PHCResult containing the unprocessed EANs list, or error messages associated with this process.

These messages can be:.

- entity.sdd.ean.no_file.

getOutdatedDatabases()

Service to know how many database are to update

[WebMethod]
public PHCResult getOutdatedDatabases()

Returns

PHCResult: Returns the amount of outdated companies in intererResult property

getPasswordResetURL()

Returns current URL where a user redirects to reset the password.

[WebMethod]
public PHCResult getPasswordResetURL()

Returns

PHCResult

getPhcFxHelpUrl(string)

Returns the URL link to the help topic for respective key (can be an entity, generic topic, action, etc...).

[WebMethod]
public PHCResult getPhcFxHelpUrl(string key)

Parameters

Nome	Tipo	Descrição
`key`	string

Returns

PHCResult

getPhcFxSelfService()

Should return the url to the self service part of the Drive FX website

[WebMethod]
public PHCResult getPhcFxSelfService()

Returns

PHCResult

getSddAutListFromClStamp(string)

Check the SDDs list (Direct Debit System) for a customer.

[WebMethod]
public PHCResult getSddAutListFromClStamp(string clstamp)

Parameters

Nome	Tipo	Descrição
`clstamp`	string	Iidentifies the customer to which you want to query the list of SDDs

Returns

PHCResult

PHCResult containing the list SddautVO indicated for the customer, or error messages related to this query process.

These messages can be:.

- entity.sdd.no_adc_history.

Remarks

Check the SDDs list (Direct Debit System) for a customer identified by the parameter clstamp.

getUploadedFile(string)

[WebMethod]
public PHCResult getUploadedFile(string fileName)

Parameters

Nome	Tipo	Descrição
`fileName`	string

Returns

PHCResult

getVIESAddress(string, string)

Service that makes use of the VAT Information Exchange System (VIES) for the corresponding address at par NIF-supplied Country.

[WebMethod]
public PHCResult getVIESAddress(string nif, string countrystamp)

Parameters

Nome	Tipo	Descrição
`nif`	string	Tax Identification Number to search
`countrystamp`	string	Stamp of the country it belongs to the Tax Identification Number

Returns

PHCResult: PHCResult

ping()

Service to maintain session alive

[WebMethod]
public PHCResult ping()

Returns

PHCResult: Returns whether the user is authenticated or not in BooleanResult property

processRadFile(string)

Processes the RAD file.

[WebMethod]
public PHCResult processRadFile(string fileName)

Parameters

Nome	Tipo	Descrição
`fileName`	string	Filename RAD to process.

Returns

PHCResult

PHCResult containing the list of SDDs generated, or error messages associated to this process.

These messages can be:.

- entity.sdd.rad.error_act_sdd.

Remarks

Processes the RAD file.

The RAD file is used by banks to send to companies the status of ADC codes (Debit Authorization Account) of its customers.

saveImage(ImageInfoVO, byte[])

Records in the database a record ImageInfoVO that contains an image Associated with the record identified by the recstamp .

[WebMethod]
public PHCResult saveImage(ImageInfoVO image, byte[] byteArray)

Parameters

Nome	Tipo	Descrição
`image`	ImageInfoVO	Records in the database a record.
`byteArray`	byte[]	Contains the file itself which corresponds to the image.

Returns

PHCResult: PHCResult empty if the operation has been successful, or otherwise error messages.

saveImageHTML(ImageInfoVO, string)

[WebMethod]
public PHCResult saveImageHTML(ImageInfoVO image, string byteArray)

Parameters

Nome	Tipo	Descrição
`image`	ImageInfoVO
`byteArray`	string

Returns

PHCResult

sendXLSXByEmail(List<object>, List<string>, string, List<string>, List<string>, List<int>, EmailVO)

[WebMethod]
public PHCResult sendXLSXByEmail(List<object> records, List<string> columns, string entityName, List<string> fieldsTypes, List<string> titles, List<int> sizes, EmailVO emailConfig)

Parameters

Nome	Tipo	Descrição
`records`	List<object>
`columns`	List<string>
`entityName`	string
`fieldsTypes`	List<string>
`titles`	List<string>
`sizes`	List<int>
`emailConfig`	EmailVO

Returns

PHCResult

Table of Contents

Class ServicesWS

Methods

GetEntityRelations(string, string)

Parameters

Returns

GetTicket(string)

Parameters

Returns

LoadImageGallery(string)

Parameters

Returns

cancelSave(string, string)

Parameters

Returns

Remarks

downloadEntityListCSV(string, QueryVO)

Parameters

Returns

emailEntityListCSV(string, QueryVO, EmailVO, bool)

Parameters

Returns

emailExportableListLines(EmailExportQueryVO, List<object>, List<string>, string)

Parameters

Returns

exportEntity(ExportEntityVO)

Parameters

Returns

exportListLines(List<object>, List<string>, string, ExportFileTypes, string)

Parameters

Returns

exportStructure(StructureInfoConfigVO, string, List<object>, string, int)

Parameters

Returns

exportStructureTemplate(List<string>, string, string)

Parameters

Returns

generateEANFile()

Returns

Remarks

getAllEntityStructure()

Returns

getDirectResetURL(int)

Parameters

Returns

getEanFileByName(string)

Parameters

Returns

Remarks

getEntityStructure(string)

Parameters

Returns

Remarks

getGUID()

Returns

getInstanceFromReference(string, List<KeyValueVO>)

Parameters

Returns

Remarks

getListOfUnprocessedEAN()

Returns

getOutdatedDatabases()

Returns

getPasswordResetURL()

Returns

getPhcFxHelpUrl(string)

Parameters

Returns

getPhcFxSelfService()

Returns

getSddAutListFromClStamp(string)

Parameters

Returns

Remarks

getUploadedFile(string)

Parameters

Returns

getVIESAddress(string, string)

Parameters

Returns