Versão: Next

viewDocumentData

Este método possibilita recuperar os dados de um documento. Para utilizá-lo, é necessário seguir o padrão abaixo documentado.

Classe Java
Requisição	web/wwwroot/ws/java/document/ViewDocumentDataRequestType.java
Retorno	web/wwwroot/ws/java/document/ViewDocumentDataResponseType.java

Requisição:

Identificador	Requerido	Descrição
IDDOCUMENT	X	Identificador do documento.
IDREVISION		Identificador da revisão.
IDUSER		A partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco.
IDCATEGORY		Identificador da categoria do documento.

Estrutura da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:viewDocumentData>
         <!--You may enter the following 4 items in any order-->
         <urn:iddocument>?</urn:iddocument>
         <urn:idrevision>?</urn:idrevision>
         <urn:iduser>?</urn:iduser>
         <urn:idcategory>?</urn:idcategory>
      </urn:viewDocumentData>
   </soapenv:Body>
</soapenv:Envelope>

Retorno:

Identificador Descrição

return SUCESSO: retorna um vetor com os metadados:
▪ IDDOCUMENT: String; Identificador do documento.
▪ NMTITLE: String; Título do documento.
▪ IDCATEGORY: String; Identificador da categoria.
▪ NMCATEGORY: String; Nome da categoria.
▪ STATUS: String; Situação do documento; 1: Emissão; 2: Homologado; 3: Revisão; 4: Cancelado; 5: Indexação, 6: Aprovação, 7: Contrato encerrado.
▪ NMAUTHOR: String; Nome do autor do documento.
▪ IDREVISION: String; Identificador da revisão.
▪ DTDOCUMENT: String; Data do documento.
▪ QTVALIDITY: Integer; Validade.
▪ FGMEASVALID: String; Tipo da validade; 1: Dias; 2: Meses; 3: Anos.
▪ REVALIDATION: String; Revalidação.
▪ DTVALIDITY: String; Data da validade.
▪ RESUME: String; Resumo do documento.
▪ CANCELREASON: String; Descrição do cancelamento.
▪ URL: String; URL para a API de visualização do documento.
▪ LINKSHARE: Link de compartilhamento de documento.
▪ ATTRIBUTTES: Matriz; Atributos do documento:
• ATTRIBUTTENAME: String; Identificador do atributo.
• ATTRIBUTTEVALUE: vetor; Valores do atributo.
▪ ELECTRONICFILE: Matriz; Arquivo eletrônico
• FILENAME: String; Nome do arquivo
FALHA: 0: Mensagem com o erro ocorrido.

Identificador	Descrição
return	SUCESSO: retorna um vetor com os metadados: ▪ `IDDOCUMENT`: `String`; Identificador do documento. ▪ `NMTITLE`: `String`; Título do documento. ▪ `IDCATEGORY`: `String`; Identificador da categoria. ▪ `NMCATEGORY`: `String`; Nome da categoria. ▪ `STATUS`: `String`; Situação do documento; 1: Emissão; 2: Homologado; 3: Revisão; 4: Cancelado; 5: Indexação, 6: Aprovação, 7: Contrato encerrado. ▪ `NMAUTHOR`: `String`; Nome do autor do documento. ▪ `IDREVISION`: `String`; Identificador da revisão. ▪ `DTDOCUMENT`: `String`; Data do documento. ▪ `QTVALIDITY`: `Integer`; Validade. ▪ `FGMEASVALID`: `String`; Tipo da validade; 1: Dias; 2: Meses; 3: Anos. ▪ `REVALIDATION`: `String`; Revalidação. ▪ `DTVALIDITY`: `String`; Data da validade. ▪ `RESUME`: `String`; Resumo do documento. ▪ `CANCELREASON`: `String`; Descrição do cancelamento. ▪ `URL`: `String`; URL para a API de visualização do documento. ▪ `LINKSHARE`: Link de compartilhamento de documento. ▪ `ATTRIBUTTES`: Matriz; Atributos do documento: • `ATTRIBUTTENAME`: `String`; Identificador do atributo. • `ATTRIBUTTEVALUE`: vetor; Valores do atributo. ▪ `ELECTRONICFILE`: Matriz; Arquivo eletrônico • `FILENAME`: `String`; Nome do arquivo FALHA: 0: Mensagem com o erro ocorrido.