shareDocument
Este método possibilita adicionar/editar/recriar o link de compartilhamento do documento.
Para a sua utilização, é necessário seguir o padrão abaixo documentado.
Classe Java | |
---|---|
Requisição | web/wwwroot/ws/java/document/ShareDocumentRequestType.java |
Retorno | web/wwwroot/ws/java/document/ShareDocumentResponseType.java |
Requisição:
Identificador | Requerido | Descrição |
---|---|---|
DocumentID | X | Identificador do documento |
CategoryID | Identificador da categoria do documento | |
Recreate | X | Recriar link de compartilhamento: 1 - Sim; 2 - Não. |
Public | X | Link de compartilhamento público: 1 - Sim; 2 - Não. |
Download | X¹ | Salvar localmente: 1 - Sim; 2 - Não. |
Original | Utilizar arquivo original: 1 - Sim; 2 - Não. | |
ValidityDate | Data de validade do link público. O formato deve ser Y-M-D (Ano-Mês-Dia). |
info
- X¹ - Será requerido caso o Public seja 1.
Estrutura da requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:shareDocument>
<!--You may enter the following 7 items in any order-->
<urn:DocumentID>?</urn:DocumentID>
<urn:CategoryID>?</urn:CategoryID>
<urn:Recreate>?</urn:Recreate>
<urn:Public>?</urn:Public>
<urn:Download>?</urn:Download>
<urn:Original>?</urn:Original>
<urn:ValidityDate>?</urn:ValidityDate>
</urn:shareDocument>
</soapenv:Body>
</soapenv:Envelope>
Retorno:
Identificador | Descrição |
---|---|
Status | SUCESSO: SUCCESS FALHA: FAILURE |
Code | Código apresentado: ▪ 1 - Nenhum erro (operação realizada com sucesso); ▪ -1 - Faltam dados obrigatórios; ▪ -2 - Valor inválido; ▪ -3 - Categoria não encontrada; ▪ -4 - Documento não encontrado; ▪ -5 - Há mais de um documento com o identificador informado; ▪ -6 - A categoria do documento não permite links públicos; ▪ -7 - O sistema não permite o download do arquivo original; ▪ -8 - Data inválida; ▪ -9 - A data não pode ser anterior à data atual; ▪ -10 - Erro ao gerar o link de compartilhamento. |
Detail | Mensagem detalhando o erro ou sucesso na execução do método. |
RecordID | SUCESSO: Link de compartilhamento do documento FALHA: Vazio |