[Gov.Doc] Manual Documental da API do Gov.Doc
Objetivo
O objetivo deste estudo é documentar as rotas da API do Sistema Gov.Doc.
Introdução
O Gov.Doc é o sistema processador de texto do Governo do Estado de Rondônia e a sua API permite que outros sistemas (SOLAR, RegularizaJá, SID, etc) sejam capazes de criar, editar, arquivar documentos de maneira padronizada. Dessa forma, viu-se a necessidade de documentar as rotas para garantir e facilitar o acesso aos dados da API.
Bloco de Assinatura
O bloco de assinatura permite que o documento possa ser assinado por um ou mais usuários, assim como permite que o usuário assine um ou mais documentos simultaneamente, além de outras funcionalidades.
• Rotas do Bloco de Assinatura
| Rota GET • /BlocoDeAssinatura/{idDoBloco} |
|
| Descrição | Rota que busca o bloco de assinatura pelo ID. |
| Parâmetros | Id do bloco : string($uuid) |
| Request Body | - |
| Response | |
| Rota POST • /BlocoDeAssinatura/Criar |
|
| Descrição | Rota para criar bloco de assinatura pelo CPF do usuário. |
| Parâmetros | - |
| Request Body |
• titulo : string → título do bloco de assinatura; • documentosIds : List<Guid>→ lista com os IDs dos documentos inseridos no bloco; • cpfDoCriadorDoBloco : string→ cpf do criador do bloco. |
| Response |
|
| Rota POST • /BlocoDeAssinatura/CriarPorSistema |
|
| Descrição | Rota para criar bloco de assinatura pelo Guid do SISTEMA. |
| Parâmetros | - |
| Request Body |
• titulo : string → título do bloco de assinatura; • documentosIds : List<Guid>→ lista com os Guids dos documentos inseridos no bloco; • sistemaDeOrigemId : Guid→ Guid do sistema onde o bloco de assinatura será criado. |
| Response |
|
| Rota PUT • /BlocoDeAssinatura |
|
| Descrição | Rota para editar o bloco de assinatura. |
| Parâmetros | - |
| Request Body |
• documentosIds : List<Guid>→ lista com os Guids dos documentos inseridos no bloco; • cpfDoCriadorDoBloco : string→ CPF do criador do bloco de assinatura (somente o criador do bloco pode fazer a editar); • dataDeCriacao : dateTime → data de criação do bloco de assinaturas; • blocoId : Guid → Guid do bloco de assinaturas. |
| Response |
|
| Rota PUT • /BlocoDeAssinatura/AdicionarDocumento |
|
| Descrição | Rota para adicionar documentos ao bloco de assinatura pelo CPF do usuário. |
| Parâmetros | - |
| Request Body |
• documentosIds : List<Guid>→ lista com os Guids dos documentos inseridos no bloco; • cpf : string→ CPF do usuário que irá adicionar o documento (apenas o criador do bloco pode adicionar documento); • blocoId : Guid → Guid do bloco de assinaturas. |
| Response |
|
| Rota PUT • /BlocoDeAssinatura/AdicionarDocumentoPorSistema |
|
| Descrição | Rota para adicionar documentos ao bloco de assinatura pelo SISTEMA de origem. |
| Parâmetros | - |
| Request Body |
• titulo : string → título do bloco de assinatura; • sistemaDeOrigemId : Guid → Guid do sistema onde o bloco de assinatura será criado (somente o sistema de origem criador do bloco pode adicionar documento). • blocoId : Guid → Guid do bloco de assinaturas. |
| Response |
|
| Rota PUT • /BlocoDeAssinatura/RemoverDocumento |
|
| Descrição | Rota para remover documentos do bloco de assinatura pelo CPF do usuário. |
| Parâmetros | - |
| Request Body |
• documentosIds : List<Guid>→ lista com os Guids dos documentos inseridos no bloco; • cpfDoUsuarioLogado : string→ CPF do usuário que irá excluir o documento (apenas o criador do bloco pode excluir documento); • blocoId : Guid → Guid do bloco de assinaturas. |
| Response |
|