Table of Contents

Class MapDefWS

Namespace
PHCWS
Assembly
PHCWS.dll

entity management services MapDefCabVO that represents Listings.

[WebService(Namespace = "http://www.phcgo.net/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[DesignerGenerated]
public class MapDefWS : PHCTypedWS<MapDefCabVO>, IComponent, IDisposable, IServiceProvider
Inheritance
MapDefWS

Methods

emailExportListingsRecords(EmailExportMapDefCabVO)

Send an analysis file exportation to e-mail

[WebMethod]
public PHCResult emailExportListingsRecords(EmailExportMapDefCabVO emailExportMapDefCabVO)

Parameters

Nome Tipo Descrição
emailExportMapDefCabVO EmailExportMapDefCabVO

In this parameter we have the necessary info to execute and send to e-mail the analysis

Returns

PHCResult

executeMapDef(MapDefCabVO) 

[WebMethod]
public PHCResult executeMapDef(MapDefCabVO mapdefcab)

Parameters

Nome Tipo Descrição
mapdefcab MapDefCabVO

Returns

PHCResult

executeMapDefByStamp(string, List<FilterItem>, bool, string, decimal) 

[WebMethod]
public PHCResult executeMapDefByStamp(string mapdefcabstamp, List<FilterItem> filterItems, bool preview, string contentType, decimal orientationType)

Parameters

Nome Tipo Descrição
mapdefcabstamp string
filterItems List<FilterItem>
preview bool
contentType string
orientationType decimal

Returns

PHCResult

executeMapDefByStampTable(string, List<FilterItem>, bool, string) 

[WebMethod]
public PHCResult executeMapDefByStampTable(string mapdefcabstamp, List<FilterItem> filterItems, bool preview, string contentType)

Parameters

Nome Tipo Descrição
mapdefcabstamp string
filterItems List<FilterItem>
preview bool
contentType string

Returns

PHCResult

exportMapDefByContentType(string, string, List<string>, List<string>, List<string>, List<int>, List<List<string>>, string)

Export to file a list of data similar to the execution of a listing in the format specified by the parameter contentType.

[WebMethod]
public PHCResult exportMapDefByContentType(string title, string subtitle, List<string> fields, List<string> fieldsTypes, List<string> titles, List<int> sizes, List<List<string>> data, string contentType)

Parameters

Nome Tipo Descrição
title string

Report title
subtitle string

Report Subtitle
fields List<string>

List of field names in the data list to be included in the export
fieldsTypes List<string>
titles List<string>

List the titles of the fields in the data list to be included in the export
sizes List<int>

List of Lengths of the width of the columns to be included in the export
data List<List<string>>

Data to be exported to the listing
contentType string

Indicates the file format to produce.

This value can be:.

"pdf", "csv", "rtf", "mht" ou "png".

Returns

PHCResult

PHCResult with aStringVO containing the path of the file produced, or error messages produced by this process, or the following type of message:.

errors.Business.Report.NotFound.

Remarks

Produces a list in the format specified by the parameter contentType.

getFields(string)

Consult a list of listings for a given entity.

[WebMethod]
public PHCResult getFields(string entidade)

Parameters

Nome Tipo Descrição
entidade string

Indicates the entity name.

Returns

PHCResult

PHCResult containing a list of GenericVO.

getFieldsTot(string)

Consult a list of fields of numeric type for an entity.

[WebMethod]
public PHCResult getFieldsTot(string entidade)

Parameters

Nome Tipo Descrição
entidade string

Indicates the entity name.

Returns

PHCResult

PHCResult containing a list of GenericVO.

getListings(string) 

[WebMethod]
public PHCResult getListings(string mapDefCabStamp)

Parameters

Nome Tipo Descrição
mapDefCabStamp string

Returns

PHCResult

getMapDef(string, int)

Consult a list of listings for a given entity.

[WebMethod]
public PHCResult getMapDef(string entidade, int numdoc)

Parameters

Nome Tipo Descrição
entidade string

Indicates the entity name.
numdoc int

Indicates the number of a document type for organizations with multiple document types to entities that do not have this specificity this value is expected to zero. Indicates the corresponding internal number to type of invoicing document or type of internal document, when the entity is different from BO or FT should be filled with zero.

Returns

PHCResult

PHCResult containing a list of MapDefCabVO.

Remarks

Only returns the corresonding listing header data to MapDefCabVO.

runMapDef(string, List<StringTranslatedVO>)

Produces a listing in PDF format.

[WebMethod]
public PHCResult runMapDef(string mapdefcabstamp, List<StringTranslatedVO> textosTraduzidos)

Parameters

Nome Tipo Descrição
mapdefcabstamp string

Identifies the record that you want to see, corresponds to the value stored in the field mapdefcabstamp of MapDefCabVO.
textosTraduzidos List<StringTranslatedVO>

It is a list that contains StringTranslatedVO having the structure:.

key - key text used in Listings, corresponds to the field key.

stringtranslated - translated text corresponds to the field stringtranslated.

This list contains the translated texts that are used in Listing, such as "Page".

Returns

PHCResult

PHCResult with a StringVO containing the path of the produced PDF, or error messages produced by this process, or the following type of message:.

errors.Business.Report.NotFound.

Remarks

Produces a list in PDF format, based on the template set indicated mapdefcabstamp.

runMapDefByContentType(string, List<StringTranslatedVO>, string, bool, bool)

Produces a list in the format specified by the parameter contentType.

[WebMethod]
public PHCResult runMapDefByContentType(string mapdefcabstamp, List<StringTranslatedVO> textosTraduzidos, string contentType, bool signDocument, bool runWarnings)

Parameters

Nome Tipo Descrição
mapdefcabstamp string

Identifies the record that you want to see, corresponds to the value stored in the field mapdefcabstamp of MapDefCabVO.
textosTraduzidos List<StringTranslatedVO>

It is a list that contains StringTranslatedVO having the structure:.

key - key text used in Listings, corresponds to the field key.

stringtranslated - translated text corresponds to the field stringtranslated.

This list contains the translated texts that are used in Listing, such as "Page".

contentType string

Indicates the file format to produce.

This value can be:.

"pdf", "csv", "rtf", "mht" ou "png".

signDocument bool

Indicates whether the document is to be digitally signed, if contentType="pdf".
runWarnings bool

Returns

PHCResult

PHCResult with a StringVO containing the path of the file produced, or error messages produced by this process, or the following type of message:.

errors.Business.Report.NotFound.

Remarks

Produces a list in the format specified by the parameter contentType, based on the template set indicated mapdefcabstamp.

runMapDefPreview(string, List<StringTranslatedVO>)

Produces a listing in png format without return warnings and with a limit of 500 entries.

[WebMethod]
public PHCResult runMapDefPreview(string mapdefcabstamp, List<StringTranslatedVO> textosTraduzidos)

Parameters

Nome Tipo Descrição
mapdefcabstamp string

Identifies the record that you want to see, corresponds to the value stored in the field mapdefcabstamp of MapDefCabVO.
textosTraduzidos List<StringTranslatedVO>

It is a list that contains StringTranslatedVO having the structure:.

key - key text used in Listings, corresponds to the field key.

stringtranslated - translated text corresponds to the field stringtranslated.

This list contains the translated texts that are used in Listing, such as "Page".

Returns

PHCResult

PHCResult with aStringVO containing the path of the file produced, or error messages produced by this process, or the following type of message:.

errors.Business.Report.NotFound.

Remarks

Produces a list in PNG format, based on the template set indicated mapdefcabstamp.

runMapDefTable(string) 

[WebMethod]
public PHCResult runMapDefTable(string mapdefcabstamp)

Parameters

Nome Tipo Descrição
mapdefcabstamp string

Returns

PHCResult

sendMapdefEmail(MapdefcabEmailVO, bool)

Send a listing by email.

[WebMethod]
public PHCResult sendMapdefEmail(MapdefcabEmailVO mapdefEmailVO, bool runWarnings)

Parameters

Nome Tipo Descrição
mapdefEmailVO MapdefcabEmailVO

Identify the e-mail recipients and which the list to send.
runWarnings bool

Returns

PHCResult

PHCResult with messages indicating that an error occurred, or empty if it has been submitted successfully.

Remarks

Send by email an identified list the fields mapdefcabstamp, which corresponds to the field mapdefcabstamp and identifies a MapDefCabVO.

This email is sent to recipients who are entered in the fields:.

sendTo, cc and bcc. .

The listing will be sent in the format the field contentType.

This may be "pdf", "pdfsign", "csv", "rtf", "mht" ou "png".