CitizenDocumentWsService (Conteúdo Público)

Owned by Sérgio Cabaço
Last updated: 18 Dec 2024
1 min read

1. Introdução

  • Este serviço disponibiliza operações para agir sobre documentos na área reservada da entidade no sistema Bolsa de Documentos.

  • Porta de Entrada: Plataforma de Integração (PI)

  • Porta de Saída: ePortugal

  • Clientes Conhecidos (entidades e internos): Vários

  • Equipa Responsável: Arquitetura, Engenharia e Conformidade: Núcleo de Engenharia de Software

2. Autenticação

IAPAuthorizationSystem

3. Especificações da API

Formato da Informação

Dados Estruturados. Fonte: WSDL.

Especificações técnicas

Consulte o WSDL na Área dos Programadores. (Rede interna ou VPN)

4. Message Types

  • acceptSend

  • acceptShare

  • addDocument (PI)

  • addDocumentLink (PI)

  • generateDocumentQRCode

  • getDocument

  • getDocumentFile

  • getDocumentLink

  • getDocumentLinkList

  • getDocumentList

  • getDownloadAuthorization

  • getProcessDownloadAuthorizationList

  • getProcessSendList

  • getProcessShareList

  • getQRCodeDocumentFile

  • sendDocumentToCitizen (PI)

  • sendDocumentToEntity

  • sendDocumentToLawyer

  • sendDocumentToNotary

  • sendDocumentToSolicitor

  • shareDocumentWithCitizen

  • shareDocumentWithEntity

  • shareDocumentWithLawyer

  • shareDocumentWithNotary

  • shareDocumentWithSolicitor

  • shareFolderWithCitizen

  • shareFolderWithEntity

  • shareFolderWithLawyer

  • shareFolderWithNotary

  • shareFolderWithSolicitor

5. Casos de Uso

  • <Não disponivel. Aguarda partilha por parte da equipa>

6. Relação com o Catálogo de Dados

<Aguarda disponibilização das estruturas de metadados associadas ao serviço>