Ir para o conteúdo principal

[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 tem como sua principal funcionalidade permitir que o documento possa ser assinado por um ou mais usuários, assim como permite que o usuário assine 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 
{
  "id": "8db0864d-4472-4ac1-a82e-a71643bc412a",
  "titulo": "Bloco de assinatura",
  "documentos": [],
  "dataDeCriacao": "2021-09-08T11:01:31.7264862",
  "criador": null,
  "sistemaCriadorId": "ac4bec90-cbe0-4460-8c40-860e6ba5e60b",
  "cpfDoAssinante": "00000000000",
  "justificativaDeRecusa": null,
  "dataDeRecusa": "0001-01-01T00:00:00",
  "status": 2
}
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 
{
  "id": "a84ed15c-d197-4042-9171-599f56b43e00",
  "titulo": "string",
  "documentos": [
    {
      "id": "e82014a4-958a-4a0f-8da7-b8742e609ec7",
      "titulo": "teste",
      "sequencial": 102,
      "modeloId": 1,
      "numeracao": "001.000102/2022-20",
      "cpfDoCriador": "00000000000",
      "dataDeCriacao": "2022-08-24T09:39:18.2583907",
      "tipoDeDocumento": "Parecer",
      "unidadeOrcamentariaId": 20,
      "departamento": "string",
      "historicoDeEdicoes": [],
      "compartilhamentos": [],
      "assinaturas": [],
      "historicos": [],
      "emMinuta": true,
      "blocoDeAssinaturaId": "a84ed15c-d197-4042-9171-599f56b43e00",
      "imagens": [],
      "excluido": false,
      "restrito": false,
      "sistemaOrigemId": "ac4bec90-cbe0-4460-8c40-860e6ba5e60b",
      "arquivado": false,
      "codigoCrc": null,
      "somenteLeitura": false
    }
  ],
  "dataDeCriacao": "2022-08-24T09:41:55.8515836-04:00",
  "criador": "01154865266",
  "sistemaCriadorId": "00000000-0000-0000-0000-000000000000",
  "cpfDoAssinante": null,
  "justificativaDeRecusa": null,
  "dataDeRecusa": "0001-01-01T00:00:00",
  "status": 1
}
Rota POST • /BlocoDeAssinatura/CriarPorSistema
Descrição Rota para criar bloco de assinatura pelo SISTEMA de origem.
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 que criará o bloco de assinaturas.
Response 
{
  "id": "15dfaf88-850d-4672-bed8-994221c710bb",
  "titulo": "tsesset",
  "documentos": [
    {
      "id": "e82014a4-958a-4a0f-8da7-b8742e609ec7",
      "titulo": "teste",
      "sequencial": 102,
      "modeloId": 1,
      "numeracao": "001.000102/2022-20",
      "cpfDoCriador": "00000000000",
      "dataDeCriacao": "2022-08-24T09:39:18.2583907",
      "tipoDeDocumento": "Parecer",
      "unidadeOrcamentariaId": 20,
      "departamento": "string",
      "historicoDeEdicoes": [],
      "compartilhamentos": [],
      "assinaturas": [],
      "historicos": [],
      "emMinuta": true,
      "blocoDeAssinaturaId": "15dfaf88-850d-4672-bed8-994221c710bb",
      "imagens": [],
      "excluido": false,
      "restrito": false,
      "sistemaOrigemId": "ac4bec90-cbe0-4460-8c40-860e6ba5e60b",
      "arquivado": false,
      "codigoCrc": null,
      "somenteLeitura": false
    }
  ],
  "dataDeCriacao": "2022-08-24T10:38:00.6220451-04:00",
  "criador": null,
  "sistemaCriadorId": "ac4bec90-cbe0-4460-8c40-860e6ba5e60b",
  "cpfDoAssinante": null,
  "justificativaDeRecusa": null,
  "dataDeRecusa": "0001-01-01T00:00:00",
  "status": 1
}
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 editar);

• dataDeCriacao : dateTime → data de criação do bloco de assinaturas;

• blocoId : Guid → Guid do bloco de assinaturas.
Response 
{
  "id": "a84ed15c-d197-4042-9171-599f56b43e00",
  "titulo": "string",
  "documentos": [
    {
      "id": "e82014a4-958a-4a0f-8da7-b8742e609ec7",
      "titulo": "teste",
      "sequencial": 102,
      "modeloId": 1,
      "numeracao": "001.000102/2022-20",
      "cpfDoCriador": "00000000000",
      "dataDeCriacao": "2022-08-24T09:39:18.2583907",
      "tipoDeDocumento": "Parecer",
      "unidadeOrcamentariaId": 20,
      "departamento": "string",
      "historicoDeEdicoes": [],
      "compartilhamentos": [],
      "assinaturas": [],
      "historicos": [],
      "emMinuta": true,
      "blocoDeAssinaturaId": "a84ed15c-d197-4042-9171-599f56b43e00",
      "imagens": [],
      "excluido": false,
      "restrito": false,
      "sistemaOrigemId": "ac4bec90-cbe0-4460-8c40-860e6ba5e60b",
      "arquivado": false,
      "codigoCrc": null,
      "somenteLeitura": false
    }
  ],
  "dataDeCriacao": "2022-08-24T09:41:55.8515836",
  "criador": "00000000000",
  "sistemaCriadorId": "00000000-0000-0000-0000-000000000000",
  "cpfDoAssinante": null,
  "justificativaDeRecusa": null,
  "dataDeRecusa": "0001-01-01T00:00:00",
  "status": 1
}
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 que serão adicionados 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 
{
  "status": "Ok",
  "message": "Documento adicionado ao Bloco com sucesso! "
}
Rota PUT • /BlocoDeAssinatura/AdicionarDocumentoPorSistema
Descrição Rota para adicionar documentos ao bloco de assinatura pelo SISTEMA de origem.
Parâmetros -
Request Body

• documentosIds : List<Guid>→ lista com os Guids dos documentos que serão adicionados no bloco;

• sistemaDeOrigemId : Guid → Guid do sistema que irá adicionar o documento no bloco de assinaturas (somente o sistema de origem criador do bloco pode adicionar documento).

• blocoId : Guid → Guid do bloco de assinaturas.
Response 
{
  "status": "Ok",
  "message": "Documento adicionado ao Bloco com sucesso! "
}
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 que serão removidos do bloco;

• cpfDoUsuarioLogado : string→ CPF do usuário que irá remover o documento do bloco de assinaturas (apenas o criador do bloco pode excluir documento);

• blocoId : Guid → Guid do bloco de assinaturas.
Response 
{
  "status": "Ok",
  "message": "Documento removido ao Bloco com sucesso! "
}
Rota PUT • /BlocoDeAssinatura/RemoverDocumentoPorSistema
Descrição Rota para remover documentos do bloco de assinatura pelo SISTEMA de origem.
Parâmetros -
Request Body

• documentosIds : List<Guid>→ lista com os Guids dos documentos que serão removidos do bloco;

• sistemaDeOrigemId : Guid → Guid do sistema que removerá o documento do bloco de assinaturas (somente o sistema de origem criador do bloco pode adicionar documento).

• blocoId : Guid → Guid do bloco de assinaturas. 
Response 
{
  "status": "Ok",
  "message": "Documento removido ao Bloco com sucesso! "
}
Rota POST • /BlocoDeAssinatura/DisponibilizarParaAssinatura
Descrição Rota para disponibilizar os blocos para assinatura.
Parâmetros -
Request Body

• cpfDoCriadorDoBloco : string→ CPF do usuário que irá disponibilizar o bloco para assinatura;

• sistemaDeOrigemId : Guid → Guid do sistema que irá disponibilizar o bloco para assinatura;

• idDoBloco : Guid → Guid do bloco de assinaturas;

• assinante : → nome e cpf do usuário que irá assinar; 

    • nome : string;

    • cpf : string.

OBS: deve ser informado ao menos o cpfDoCriadorDoBloco OU sistemaDeOrigemId que criou o bloco. 
Response 
{
  "status": "Ok",
  "message": "Bloco de assinatura disponibilizado com sucesso! "
}
Rota POST • /BlocoDeAssinatura/AssinarBloco
Descrição Rota para assinar o bloco de assinaturas.
Parâmetros -
Request Body

• idDoBloco : Guid → Guid do bloco de assinaturas;

• cpf : string→ CPF do usuário que irá assinar o documento;

• senha : string → senha do usuário que irá assinar o documento;

• aceitouTermo : boolean → termo para assinar o documento.
Response 
{
  "status": "Ok",
  "message": "Bloco de assinatura assinado com sucesso! "
}
Rota DELETE • /BlocoDeAssinatura/Excluir
Descrição Rota para excluir bloco de assinatura pelo CPF do usuário.
Parâmetros -
Request Body

• cpfDoCriadorDoBloco : string→ CPF do usuário que irá excluir o bloco de assinaturas (somente o criador do bloco pode excluir);

•idDoBloco : Guid → Guid do bloco de assinaturas.
Response


Rota DELETE • /BlocoDeAssinatura/ExcluirPorSistema
Descrição Rota para excluir bloco de assinatura pelo SISTEMA de origem.
Parâmetros -
Request Body

• sistemaDeOrigemId : Guid → Guid do sistema onde o bloco de assinatura será excluido (somente o sistema de origem criador do bloco pode excluir).

•idDoBloco : Guid → Guid do bloco de assinaturas.
Response


Rota POST • /BlocoDeAssinatura/Cancelar
Descrição Rota para cancelar bloco de assinatura pelo CPF do usuário.
Parâmetros -
Request Body


• cpf : string→ CPF do usuário que irá cancelar a disponibilização do bloco de assinaturas (somente o criador do bloco pode cancelar);

•idDoBloco : Guid → Guid do bloco de assinaturas.
Response 


{
  "status": "Ok",
  "message": "Bloco de assinatura cancelado com sucesso! "
}
Rota POST • /BlocoDeAssinatura/CancelarPorSistema
Descrição Rota para cancelar bloco de assinatura pelo CPF do usuário.
Parâmetros -
Request Body

• sistemaDeOrigemId : Guid → Guid que irá cancelar a disponibilização do sistema onde o bloco de assinatura será cancelado (somente o sistema de origem criador do bloco pode cancelar).

•idDoBloco : Guid → Guid do bloco de assinaturas.
Response 


{
  "status": "Ok",
  "message": "Bloco de assinatura cancelado com sucesso! "
}

Documentos

O bloco de assinatura tem como sua principal funcionalidade permitir 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 dos Documentos
Voltar ao topo