From e97917255a293387aba2d656fe47953555172a6a Mon Sep 17 00:00:00 2001 From: andre.guimaraes Date: Mon, 1 Oct 2018 10:43:23 -0300 Subject: [PATCH] Cria arquivos para a documentação --- src/main/java/br/gov/ans/integracao/sei/rest/ArquivoResource.java | 96 +----------------------------------------------------------------------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/BlocoResource.java | 367 +++++++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ src/main/java/br/gov/ans/integracao/sei/rest/CargoResource.java | 30 ------------------------------ src/main/java/br/gov/ans/integracao/sei/rest/ContatoResource.java | 367 +++++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/DocumentoResource.java | 391 +++++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/ExtensoesResource.java | 31 +------------------------------ src/main/java/br/gov/ans/integracao/sei/rest/HipoteseLegalResource.java | 30 ------------------------------ src/main/java/br/gov/ans/integracao/sei/rest/InfoResource.java | 114 ++++-------------------------------------------------------------------------------------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/InfraResource.java | 210 ++++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/MarcadorResource.java | 62 ++------------------------------------------------------------ src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java | 927 +++++++++++++++++++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/SeriesResource.java | 63 ++------------------------------------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java | 87 ++------------------------------------------------------------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/TarefaResource.java | 33 --------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/TipoConferenciaResource.java | 26 -------------------------- src/main/java/br/gov/ans/integracao/sei/rest/UnidadeResource.java | 51 +-------------------------------------------------- src/main/java/br/gov/ans/integracao/sei/rest/UsuarioResource.java | 230 +++++--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- src/main/resources/apidoc/arquivo.apidoc | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/bloco.apidoc | 360 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/cargo.apidoc | 30 ++++++++++++++++++++++++++++++ src/main/resources/apidoc/contato.apidoc | 361 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/documento.apidoc | 379 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/extensao.apidoc | 29 +++++++++++++++++++++++++++++ src/main/resources/apidoc/hipoteseLegal.apidoc | 30 ++++++++++++++++++++++++++++++ src/main/resources/apidoc/info.apidoc | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/infra.apidoc | 206 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/marcador.apidoc | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/processo.apidoc | 906 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/serie.apidoc | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/sipar.apidoc | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/tarefa.apidoc | 32 ++++++++++++++++++++++++++++++++ src/main/resources/apidoc/tipoConferencia.apidoc | 26 ++++++++++++++++++++++++++ src/main/resources/apidoc/unidade.apidoc | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ src/main/resources/apidoc/usuario.apidoc | 224 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 34 files changed, 3101 insertions(+), 3057 deletions(-) create mode 100644 src/main/resources/apidoc/arquivo.apidoc create mode 100644 src/main/resources/apidoc/bloco.apidoc create mode 100644 src/main/resources/apidoc/cargo.apidoc create mode 100644 src/main/resources/apidoc/contato.apidoc create mode 100644 src/main/resources/apidoc/documento.apidoc create mode 100644 src/main/resources/apidoc/extensao.apidoc create mode 100644 src/main/resources/apidoc/hipoteseLegal.apidoc create mode 100644 src/main/resources/apidoc/info.apidoc create mode 100644 src/main/resources/apidoc/infra.apidoc create mode 100644 src/main/resources/apidoc/marcador.apidoc create mode 100644 src/main/resources/apidoc/processo.apidoc create mode 100644 src/main/resources/apidoc/serie.apidoc create mode 100644 src/main/resources/apidoc/sipar.apidoc create mode 100644 src/main/resources/apidoc/tarefa.apidoc create mode 100644 src/main/resources/apidoc/tipoConferencia.apidoc create mode 100644 src/main/resources/apidoc/unidade.apidoc create mode 100644 src/main/resources/apidoc/usuario.apidoc diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/ArquivoResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/ArquivoResource.java index ca84a4b..bcd77b2 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/ArquivoResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/ArquivoResource.java @@ -39,56 +39,7 @@ public class ArquivoResource { @Context private UriInfo uriInfo; - - /** - * @api {post} /:unidade/arquivos Adicionar arquivo - * @apiName adicionarArquivo - * @apiGroup Arquivo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription O serviço criará um arquivo no repositório de documentos e retornará seu identificador. O envio do arquivo poderá ser particionado com chamadas - * posteriores ao serviço de Adicionar Conteúdo Arquivo. Após todo o conteúdo ser transferido o arquivo será ativado e poderá ser associado com um documento externo - * no serviço de inclusão de documento. Serão excluídos em 24 horas os arquivos não completados e não associados a um documento. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Request Body) {Arquivo} arquivo Objeto representando um arquivo. - * @apiParam (Request Body) {String} arquivo.nome Nome do arquivo. - * @apiParam (Request Body) {String} arquivo.tamanho Tamanho total do arquivo em bytes. - * @apiParam (Request Body) {String} arquivo.hash MD5 do conteúdo total do arquivo. - * @apiParam (Request Body) {String} arquivo.conteudo Conteúdo total ou parcial codificado em Base64, máximo de 15MB. - * - * @apiExample Exemplo de requisição: - * endpoint: https:///sei-broker/service/COSAP/arquivos - * - * body: - * { - * "nome":"documentos-sei-broker.pdf", - * "tamanho":"2048", - * "hash":"45F1DEFFB45A5F6C2380A4CEE9B3E452", - * "conteudo":"Conteúdo total ou parcial do arquivo" - * } - * - * @apiSuccess (Sucesso - 201) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo - * @apiSuccess (Sucesso - 201) {String} arquivo.identificador Identificador do arquivo criado. - * - * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 201 Created - * { - * "identificador":"123456" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/arquivos") @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -102,51 +53,6 @@ public class ArquivoResource { return Response.created(getResourcePath(identificador)).entity(new ArquivoCriado(identificador)).build(); } - /** - * @api {put} /:unidade/arquivos/:arquivo Adicionar conteúdo arquivo - * @apiName adicionarConteudoArquivo - * @apiGroup Arquivo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Adiciona conteúdo a um arquivo criado, o sistema identificará automaticamente quando o conteúdo foi completado validando o tamanho em bytes - * e o hash do conteúdo. Quando as condições forem satisfeitas o arquivo será ativado e poderá ser utilizado nas chamadas de inclusão de documento. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} arquivo Identificador do arquivo que receberá o conteúdo. - * - * @apiParam (Request Body) {ParteArquivo} parte Objeto representando uma parte do arquivo. - * @apiParam (Request Body) {String} parte.arquivo Identificador do arquivo que receberá o conteúdo. - * @apiParam (Request Body) {String} parte.conteudo Conteúdo parcial codificado em Base64, máximo de 15MB. - * - * @apiExample Exemplo de requisição: - * endpoint: https:///sei-broker/service/COSAP/arquivos/123456 - * - * body: - * { - * "arquivo":"123456", - * "conteudo":"Conteúdo parcial do arquivo" - * } - * - * @apiSuccess (Sucesso - 200) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo - * @apiSuccess (Sucesso - 200) {String} arquivo.identificador Identificador do arquivo criado. - * - * @apiSuccess (Sucesso Response Header - 200) {header} Location URL de acesso ao recurso alterado. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 Created - * { - * "identificador":"123456" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @PUT @Path("{unidade}/arquivos/{arquivo}") @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/BlocoResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/BlocoResource.java index c9333e6..ccb2633 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/BlocoResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/BlocoResource.java @@ -47,60 +47,6 @@ public class BlocoResource { @Context private UriInfo uriInfo; - /** - * @api {get} /:unidade/blocos/:bloco Consultar bloco - * @apiName consultarBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Recupera as informações do bloco informado. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja consultar - * - * @apiParam (Query Parameters) {String} [protocolos=N] S ou N para exibir os protocolos do bloco - * - * @apiExample {curl} Exemplo de requisição: - * curl -i http:///sei-broker/service/COSAP/blocos/12 - * - * @apiSuccess (Sucesso - 200) {RetornoConsultaBloco} bloco Objeto representando o bloco encontrado - * @apiSuccess (Sucesso - 200) {String} bloco.idBloco Número do bloco - * @apiSuccess (Sucesso - 200) {Unidade} bloco.unidade Dados das unidade que gerou o bloco - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.idUnidade Identificador da Unidade - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sigla Sigla da unidade - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.descricao Descrição do unidade - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinProtocolo :TODO pendente - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinArquivamento :TODO pendente - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinOuvidoria :TODO pendente - * @apiSuccess (Sucesso - 200) {Usuario} bloco.usuario Dados das unidade que gerou o bloco - * @apiSuccess (Sucesso - 200) {String} bloco.usuario.idUsuario Identificador do suário - * @apiSuccess (Sucesso - 200) {String} bloco.usuario.sigla Sigla do usuário - * @apiSuccess (Sucesso - 200) {String} bloco.usuario.nome Nome do usuário - * @apiSuccess (Sucesso - 200) {String} bloco.descricao Descrição do bloco - * @apiSuccess (Sucesso - 200) {String} bloco.tipo Tipo do bloco (A=Assinatura, R=Reunião ou I=Interno) - * @apiSuccess (Sucesso - 200) {String} bloco.estado Estado do bloco (A=Aberto, D=Disponibilizado, R=Retornado ou C=Concluído) - * @apiSuccess (Sucesso - 200) {Unidade[]} bloco.unidadesDisponibilizacao Dados das unidades configuradas para disponibilização (ver estrutura Unidade) - * @apiSuccess (Sucesso - 200) {ProtocoloBloco[]} bloco.protocolos Processos ou documentos do bloco - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.protocoloFormatado Número de protocolo formatado - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.identificacao :TODO pendente - * @apiSuccess (Sucesso - 200) {Assinatura[]} bloco.protocolos.assinaturas Conjunto de assinaturas dos documentos. Será um conjunto vazio caso não existam informações ou se o protocolo representa um processo - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.nome Nome do assinante - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.cargoFuncao Cargo ou função utilizado no momento da assinatura - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.dataHora Data/hora em que ocorreu a assinatura - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idUsuario Identificador do usuário - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idOrigem :TODO pendente - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idOrgao :TODO pendente - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.sigla Login do usuário responsável pela assinatura - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Path("{unidade}/blocos/{bloco}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -109,36 +55,6 @@ public class BlocoResource { return seiNativeService.consultarBloco(Constantes.SEI_BROKER, Operacao.CONSULTAR_BLOCO, unidadeResource.consultarCodigo(unidade), bloco, getSOuN(exibirProtocolos)); } - - /** - * @api {post} /:unidade/blocos/disponibilizados Disponibilizar bloco - * @apiName disponibilizarBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Disponibiliza um determinado bloco. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Request Body) {String} bloco Numero do bloco que deseja disponibilizar - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] http:///sei-broker/service/COSAP/blocos/disponibilizados - * - * body: - * 12 - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @POST @Path("{unidade}/blocos/disponibilizados") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -148,32 +64,6 @@ public class BlocoResource { return trueOrFalse(resultado) + ""; } - - /** - * @api {delete} /:unidade/blocos/disponibilizados/12 Indisponibilizar bloco - * @apiName cancelarDisponibilizacaoBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Cancela a disponibilização de blocos. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja indisponibilizar - * - * @apiExample Exemplo de requisição: - * curl -X DELETE http:///sei-broker/service/COSAP/blocos/disponibilizados/12 - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @DELETE @Path("{unidade}/blocos/disponibilizados/{bloco}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -184,32 +74,6 @@ public class BlocoResource { return trueOrFalse(resultado) + ""; } - - /** - * @api {delete} /:unidade/blocos/:bloco Excluir bloco - * @apiName excluirBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Exclui um bloco criado. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja excluir - * - * @apiExample Exemplo de requisição: - * curl -X DELETE http:///sei-broker/service/COSAP/blocos/12 - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @DELETE @Path("{unidade}/blocos/{bloco}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -218,49 +82,7 @@ public class BlocoResource { return trueOrFalse(resultado) + ""; } - - /** - * @api {post} /:unidade/blocos Gerar bloco - * @apiName gerarBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Gera um novo bloco. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Request Body) {NovoBloco} novoBloco Objeto de criação de bloco - * @apiParam (Request Body) {String="ASSINATURA","INTERNO","REUNIAO"} novoBloco.tipo Tipo do bloco a ser criado - * @apiParam (Request Body) {String} novoBloco.descricao Descrição do bloco - * @apiParam (Request Body) {String[]} novoBloco.unidades Códigos das unidades onde o bloco deve ser disponibilizado, ou vazio para não disponibilizar - * @apiParam (Request Body) {String[]} novoBloco.documentos Código dos documentos que serão incluídos no bloco - * @apiParam (Request Body) {Boolean} novoBloco.disponibilizar=false Informa se o bloco criado deve ser disponibilizado automaticamente - * - * @apiExample Exemplo de requisição: - * endpoint: http:///sei-broker/service/COSAP/blocos - * - * body: - * { - * "tipo":"ASSINATURA", - * "descricao":"Bloco demonstrativo.", - * "unidades":["110000935"], - * "documentos":["0000131"], - * "disponibilizar":true - * } - * - * @apiSuccess (Sucesso Response Body - 201) {String} resultado Código do bloco criado - * - * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @Path("{unidade}/blocos") @POST @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -271,39 +93,7 @@ public class BlocoResource { return Response.created(getResourcePath(retorno)).entity(retorno).build(); } - - /** - * @api {POST} /:unidade/blocos/:bloco/documentos Incluir documento - * @apiName incluirDocumentoNoBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Inclui um documento no bloco. - * - * @apiParam (Header Parameters) {String} Content-Type Informar text/plain - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} bloco Número do bloco onde o documento será incluído - * - * @apiParam (Request Body) {String} documento Número do documento que será incluído do bloco - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] http:///sei-broker/service/COSAP/blocos/12/documentos - * - * body: - * 0000050 - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/blocos/{bloco}/documentos") @Consumes({MediaType.TEXT_PLAIN}) @@ -315,37 +105,7 @@ public class BlocoResource { return trueOrFalse(resultado) + ""; } - - /** - * @api {POST} /:unidade/blocos/:bloco/documentos Incluir documento anotado - * @apiName incluirDocumentoComAnotacaoNoBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Inclui um documento no bloco. - * - * @apiParam (Header Parameters) {String} Content-Type Informar application/json - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} bloco Número do bloco onde o documento será incluído - * - * @apiParam (Request Body) {InclusaoDocumentoBloco} inclusao Objeto com os dados do documento a ser incluído - * @apiParam (Request Body) {String} bloco Número do bloco onde o documento será inserido - * @apiParam (Request Body) {String} documento Número do documento - * @apiParam (Request Body) {String} [anotacao] Texto de anotação associado com o documento no bloco - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] http:///sei-broker/service/COSAP/blocos/12/documentos - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/blocos/{bloco}/documentos") @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -361,33 +121,7 @@ public class BlocoResource { throw new Exception(messages.getMessage("erro.documento.incluir.bloco")); } } - - /** - * @api {delete} /:unidade/:bloco/documentos/:documento Remover documento - * @apiName retirarDocumentoDoBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Remove o documento do bloco. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o documento será retirado - * @apiParam (Path Parameters) {String} documento Numero do documento que será retirado do bloco - * - * @apiExample Exemplo de requisição: - * curl -X DELETE http:///sei-broker/service/COSAP/blocos/12/documentos/0000050 - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @DELETE @Path("{unidade}/blocos/{bloco}/documentos/{documento}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -396,36 +130,7 @@ public class BlocoResource { return trueOrFalse(resultado) + ""; } - - /** - * @api {post} /:unidade/blocos/:bloco/processos Incluir processo - * @apiName incluirProcessoNoBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Inclui um processo no bloco. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [auto-formatacao=S] O broker utilizará a mascara padrão para formatar o número do processo - * - * @apiParam (Request Body) {String} processo Numero do processo que será incluído no bloco - * - * @apiExample Exemplo de requisição: - * curl -X PUT http:///sei-broker/service/COSAP/blocos/12/processos - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/blocos/{bloco}/processos") @Consumes({MediaType.TEXT_PLAIN}) @@ -441,37 +146,7 @@ public class BlocoResource { return trueOrFalse(resultado) + ""; } - - /** - * @api {post} /:unidade/blocos/:bloco/processos Incluir processo anotado - * @apiName incluirProcessoComAnotacaoNoBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Inclui um processo no bloco, junto com uma anotação. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [auto-formatacao=S] O broker utilizará a mascara padrão para formatar o número do processo - * - * @apiParam (Request Body) {InclusaoProcessoBloco} inclusao Objeto com os dados do processo a ser incluído - * @apiParam (Request Body) {String} bloco Número do bloco onde o processo será inserido - * @apiParam (Request Body) {String} processo Número do processo - * @apiParam (Request Body) {String} [anotacao] Texto de anotação associado com o processo no bloco - * - * @apiExample Exemplo de requisição: - * curl -X PUT http:///sei-broker/service/COSAP/blocos/12/processos - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/blocos/{bloco}/processos") @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -492,35 +167,7 @@ public class BlocoResource { throw new Exception(messages.getMessage("erro.processo.incluir.bloco")); } } - - /** - * @api {delete} /:unidade/blocos/:bloco/processos/:processo Remover processo - * @apiName retirarProcessoDoBloco - * @apiGroup Bloco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Este método remove o processo do bloco. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o processo será retirado - * @apiParam (Path Parameters) {String} processo Numero do processo que será retirado do bloco - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [auto-formatacao=S] O broker utilizará a mascara padrão para formatar o número do processo - * - * @apiExample Exemplo de requisição: - * curl -X DELETE http:///sei-broker/service/COSAP/blocos/12/processos/33910000029201653 - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @DELETE @Path("{unidade}/blocos/{bloco}/processos/{processo}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/CargoResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/CargoResource.java index a66dd94..d0f71ef 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/CargoResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/CargoResource.java @@ -24,36 +24,6 @@ public class CargoResource { @Inject private UnidadeResource unidadeResource; - /** - * @api {get} /:unidade/cargos Listar cargos - * @apiName listarCargos - * @apiGroup Cargo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Lista os cargos. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Query Parameters) {String} [idCargo] Identificador do cargo - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/COSAP/cargos - * - * @apiSuccess (Sucesso - 200) {Cargo[]} resultado Lista com os cargos encontrados - * @apiSuccess (Sucesso - 200) {String} resultado.idCargo Identificador do cargo no SEI - * @apiSuccess (Sucesso - 200) {String} resultado.expressaoCargo Descrição do cargo (Ex.: Governador) - * @apiSuccess (Sucesso - 200) {String} resultado.expressaoTratamento Tratamento para o cargo (Ex.: A Sua Excelência o Senhor) - * @apiSuccess (Sucesso - 200) {String} resultado.expressaoVocativo Vocativo para o cargo (Ex.: Senhor Governador) - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Path("{unidade}/cargos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/ContatoResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/ContatoResource.java index a7a1df3..e0df4b1 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/ContatoResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/ContatoResource.java @@ -65,126 +65,14 @@ public class ContatoResource { @PersistenceContext(unitName = "sei_pu", type = PersistenceContextType.EXTENDED) private EntityManager em; - - /** - * @api {get} /:unidade/contatos/tipos Tipos de contato - * @apiName listarTipos - * @apiGroup Contato - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta os tipos de contato. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/cosap/contatos/tipos - * - * @apiSuccess (Sucesso - 200) {TipoContato[]} resultado Lista com os tipos de contato, representados por uma Enum TipoContato. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/contatos/tipos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) public TipoContato[] listarTipos(@PathParam("unidade") String unidade){ return TipoContato.values(); } - - /** - * @api {get} /:unidade/contatos/:tipo Listar contatos - * @apiName listarContatos - * @apiGroup Contato - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta os contatos de determinado tipo, o retorno pode ser PessoaFisica ou PessoaJuridica é recomendado utilizar a ans-commons-sei. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} tipo Tipo do contato - * - * @apiParam (Query Parameters) {String} [nome] Nome do contato - * @apiParam (Query Parameters) {String} [cpf] CPF do contato - * @apiParam (Query Parameters) {String} [cnpj] CNPJ do contato - * @apiParam (Query Parameters) {String} [sigla] Sigla(login) do contato - * @apiParam (Query Parameters) {String} [matricula] Matricula do contato - * @apiParam (Query Parameters) {String} [qtdRegistros = 1] Quantidade de contatos que serão exibidos - * @apiParam (Query Parameters) {String} [pagina = 1] Número da página - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/cosap/contatos/operadoras?qtdRegistros=20 - * - * @apiSuccess (Sucesso - 200) {List} resultado Lista com os contatos encontrados. - * @apiSuccess (Sucesso - 200) {Pessoa} resultado.pessoa Pessoa que representa o contato. - * @apiSuccess (Sucesso - 200) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa. - * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.nome Nome do contato. - * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.sigla Sigla(login) do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.celular] Celular do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observações sobre o contato. - * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situação do contato. - * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereço do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Número do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.uf] Sigla do estado. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] País do endereço. - * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado. - * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado. - * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "@type": "Juridica", - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA", - * "endereco": { - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274", - * "complemento": "Teste de complemento", - * "numero": null, - * "uf": "MG", - * "pais": "Brasil", - * "cidade": "3101508", - * "bairro": "PRAÇA DA BANDEIRA", - * "cep": "36660000" - * }, - * "email": "teste@email.com", - * "celular": "(32)982538993", - * "telefone": "(32)34624649", - * "observacao": "Observado via SEI-Broker", - * "ativo": true, - * "associado": null, - * "cnpj": "19541931000125", - * "website": "sitiodopicapauamarelo.com.br" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/contatos/{tipo}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -199,88 +87,7 @@ public class ContatoResource { return pessoas; } - - /** - * @api {get} /:unidade/contatos/:tipo/:sigla Consultar contato - * @apiName getContato - * @apiGroup Contato - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta contato pela sigla(login) - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} tipo Tipo do contato - * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/cosap/contatos/operadoras/419761 - * - * @apiSuccess (Sucesso - 200) {Pessoa} resultado.pessoa Pessoa que representa o contato. - * @apiSuccess (Sucesso - 200) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa. - * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.nome Nome do contato. - * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.sigla Sigla(login) do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.celular] Celular do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observações sobre o contato. - * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situação do contato. - * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereço do contato. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Número do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.uf] Sigla do estado. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] País do endereço. - * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado. - * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado. - * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica. - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "@type": "Juridica", - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA", - * "sigla": "419761", - * "endereco": { - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274", - * "complemento": "Teste de complemento", - * "numero": null, - * "uf": "MG", - * "pais": "Brasil", - * "cidade": "3101508", - * "bairro": "PRAÇA DA BANDEIRA", - * "cep": "36660000" - * }, - * "email": "teste@email.com", - * "celular": "(32)982538993", - * "telefone": "(32)34624649", - * "observacao": "Observado via SEI-Broker", - * "ativo": true, - * "associado": null, - * "cnpj": "19541931000125", - * "website": "sitiodopicapauamarelo.com.br" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/contatos/{tipo}/{sigla}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -294,88 +101,7 @@ public class ContatoResource { return pessoaHelper.buildPessoa(contatos[0]); } - - /** - * @api {post} /:unidade/contatos/:tipo Incluir contato - * @apiName criarContato - * @apiGroup Contato - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Incluir contato - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} tipo Tipo do contato - * - * @apiParam (Request Body) {Pessoa} resultado.pessoa Pessoa que representa o contato. - * @apiParam (Request Body) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa. - * @apiParam (Request Body) {String} resultado.pessoa.nome Nome do contato. - * @apiParam (Request Body) {String} resultado.pessoa.sigla Sigla(login) do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.celular] Celular do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observações sobre o contato. - * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situação do contato. - * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereço do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Número do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.uf] Sigla do estado. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] País do endereço. - * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado. - * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica. - * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado. - * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica. - * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica. - * - * @apiExample Exemplo de requisição: - * endpoint: http:///sei-broker/service/cosap/contatos/operadoras - * - * body: - * { - * "@type": "Juridica", - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA", - * "sigla": "419761", - * "endereco": { - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274", - * "complemento": "Teste de complemento", - * "numero": null, - * "uf": "MG", - * "pais": "Brasil", - * "cidade": "3101508", - * "bairro": "PRAÇA DA BANDEIRA", - * "cep": "36660000" - * }, - * "email": "teste@email.com", - * "celular": "(32)982538993", - * "telefone": "(32)34624649", - * "observacao": "Observado via SEI-Broker", - * "ativo": true, - * "associado": null, - * "cnpj": "19541931000125", - * "website": "sitiodopicapauamarelo.com.br" - * } - * - * @apiSuccess (Criado - 201) {header} Location URL de acesso ao recurso criado. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/contatos/{tipo}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -391,90 +117,7 @@ public class ContatoResource { return Response.status(Status.BAD_REQUEST).build(); } } - - /** - * @api {put} /:unidade/contatos/:tipo/:sigla Atualizar contato - * @apiName atualizarContato - * @apiGroup Contato - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Atualizar contato - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} tipo Tipo do contato - * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato - * - * @apiParam (Request Body) {Pessoa} resultado.pessoa Pessoa que representa o contato. - * @apiParam (Request Body) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa. - * @apiParam (Request Body) {String} resultado.pessoa.nome Nome do contato. - * @apiParam (Request Body) {String} resultado.pessoa.sigla Sigla(login) do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.celular] Celular do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observações sobre o contato. - * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situação do contato. - * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereço do contato. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Número do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.uf] Sigla do estado. - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] País do endereço. - * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado. - * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica. - * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado. - * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica. - * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica. - * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica. - * - * @apiExample Exemplo de requisição: - * endpoint: http:///sei-broker/service/cosap/contatos/operadoras - * - * body: - * { - * "@type": "Juridica", - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA", - * "sigla": "419761", - * "endereco": { - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274", - * "complemento": "Teste de complemento", - * "numero": null, - * "uf": "MG", - * "pais": "Brasil", - * "cidade": "3101508", - * "bairro": "PRAÇA DA BANDEIRA", - * "cep": "36660000" - * }, - * "email": "teste@email.com", - * "celular": "(32)982538993", - * "telefone": "(32)34624649", - * "observacao": "Observado via SEI-Broker", - * "ativo": true, - * "associado": null, - * "cnpj": "19541931000125", - * "website": "sitiodopicapauamarelo.com.br" - * } - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @PUT @Path("{unidade}/contatos/{tipo}/{sigla}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/DocumentoResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/DocumentoResource.java index 29871f9..46ef7a7 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/DocumentoResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/DocumentoResource.java @@ -1,20 +1,16 @@ package br.gov.ans.integracao.sei.rest; -import static br.gov.ans.integracao.sei.utils.Util.decodeConteudoMustache; -import static br.gov.ans.integracao.sei.utils.Util.encodeBase64; import static br.gov.ans.integracao.sei.utils.Util.getSOuN; import static br.gov.ans.integracao.sei.utils.Util.parseInt; import static br.gov.ans.integracao.sei.utils.Util.trueOrFalse; import static br.gov.ans.utils.PDFUtil.getPDF; import java.io.InputStream; -import java.io.StringWriter; import java.net.URI; import java.net.URL; import java.net.URLConnection; import java.rmi.RemoteException; import java.util.List; -import java.util.Map; import javax.inject.Inject; import javax.transaction.HeuristicMixedException; @@ -40,11 +36,8 @@ import javax.ws.rs.core.UriInfo; import org.apache.commons.io.IOUtils; import org.apache.commons.lang3.StringUtils; -import org.codehaus.jackson.JsonParseException; import org.jboss.logging.Logger; -import com.github.mustachejava.Mustache; - import br.gov.ans.commons.security.crypt.HashUtils; import br.gov.ans.dao.DAO; import br.gov.ans.integracao.sei.client.Documento; @@ -65,7 +58,6 @@ import br.gov.ans.integracao.sei.modelo.Operacao; import br.gov.ans.integracao.sei.utils.Constantes; import br.gov.ans.integracao.sei.utils.MessagesKeys; import br.gov.ans.utils.MessageUtils; -import br.gov.ans.utils.MustacheUtils; @Path("/") public class DocumentoResource { @@ -105,118 +97,7 @@ public class DocumentoResource { @Inject private UserTransaction userTransaction; - - /** - * @api {get} /:unidade/documentos/:documento Consultar documento - * @apiName consultarDocumento - * @apiGroup Documento - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta documento cadastrado no SEI. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informações - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento = N] exibir o andamento do processo - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [assinaturas = N] exibir as assinaturas presentes no documento - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [publicacao = N] exibir detalhes da publicação - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [campos = N] exibir campos do formulário - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/COSAP/documentos/0000050?assinaturas=S&andamento=S - * - * @apiSuccess (Sucesso - 200) {RetornoConsultaDocumento} retornoConsultaDocumento Informações do documento encontrado no SEI - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.idProcedimento Id interno do processo no SEI - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.procedimentoFormatado Número do processo visível para o usuário - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.idDocumento Id interno do documento no SEI - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.documentoFormatado Número do documento visível para o usuário - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.linkAcesso Link para acesso ao documento - * @apiSuccess (Sucesso - 200) {Serie} retornoConsultaDocumento.serie Dados do tipo do documento - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.idSerie Identificador do tipo de documento - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.nome Nome do tipo de documento - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.aplicabilidade :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.numero Número do documento - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.data Data de geração para documentos internos e para documentos externos é a data informada na tela de cadastro - * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.unidadeElaboradora Dados da unidade que gerou o documento - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.descricao Nome da unidade - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.idUnidade Código da unidade - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sigla Sigla da unidade - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinProtocolo :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinArquivamento :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinOuvidoria :TODO pendente - * @apiSuccess (Sucesso - 200) {Andamento} retornoConsultaDocumento.andamentoGeracao Informações do andamento de geração (opcional) - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idAndamento Identificador do andamento - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefa :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefaModulo :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.descricao Descrição do andamento - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.dataHora Data e hora do registro de andamento - * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.andamentoGeracao.unidade Unidade responsável pelo andamento (ver estrutura Unidade) - * @apiSuccess (Sucesso - 200) {Usuario} retornoConsultaDocumento.andamentoGeracao.usuario Usuário responsável pela ação - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.idUsuario Código do usuário - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.nome Nome do usuário - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.sigla Login do usuário - * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} retornoConsultaDocumento.andamentoGeracao.atributos Lista com os atributos relacionados ao andamento - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.nome Nome do atributo - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.valor Valor do atributo - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.idOrigem :TODO pendente - * @apiSuccess (Sucesso - 200) {Assinatura[]} retornoConsultaDocumento.assinaturas Conjunto de assinaturas do documento - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.nome Nome do assinante - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.cargoFuncao Cargo ou função utilizado no momento da assinatura - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.dataHora Data/hora em que ocorreu a assinatura - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idUsuario Identificador do usuário - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idOrigem :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idOrgao :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.sigla Login do usuário responsável pela assinatura - * @apiSuccess (Sucesso - 200) {Publicacao} retornoConsultaDocumento.publicacao :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.nomeVeiculo :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.numero :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.dataDisponibilizacao :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.dataPublicacao :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.estado :TODO pendente - * @apiSuccess (Sucesso - 200) {PublicacaoImprensaNacional} retornoConsultaDocumento.publicacao.imprensaNacional :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.siglaVeiculo :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.descricaoVeiculo :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.pagina :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.secao :TODO pendente - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.data :TODO pendente - * @apiSuccess (Sucesso - 200) {Campo[]} retornoConsultaDocumento.campos Conjunto de campos do formulário - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.nome Nome do campo - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.valor Valor do campo - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "idProcedimento":"52", - * "procedimentoFormatado":"16.0.000000005-5", - * "idDocumento":"152", - * "documentoFormatado":"0000123", - * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=procedimento_trabalhar&id_procedimento=52&id_documento=152", - * "serie":{ - * "idSerie":"12", - * "nome":"Memorando" - * }, - * "numero":"6", - * "data":"05/04/2016", - * "unidadeElaboradora":{ - * "idUnidade":"110000934", - * "sigla":"COSAP", - * "descricao":"Coordenadoria de Sistemas e Aplicativos" - * }, - * "andamentoGeracao":null, - * "assinaturas":[], - * "publicacao":null, - * "campos":[] - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/documentos/{documento:\\d+}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -225,91 +106,7 @@ public class DocumentoResource { return seiNativeService.consultarDocumento(Constantes.SEI_BROKER, Operacao.CONSULTAR_DOCUMENTO, unidadeResource.consultarCodigo(unidade), documento, getSOuN(andamento), getSOuN(assinaturas), getSOuN(publicacao), getSOuN(campos)); } - - /** - * @api {post} /:unidade/documentos Incluir documento - * @apiName incluirDocumento - * @apiGroup Documento - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Inclui um documento no SEI, podem ser incluídos documentos internos e externos, para documentos externo o tamanho máximo é 20MB. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Query Parameters) {String} [template] Identificador do template que será utilizado na transformação do conteudo para HTML, o template precisa ser previamente cadastrado no templates-broker. (Este atributo exige que o atributo conteudo seja enviado em formato JSon e codificado em Base64) - * - * @apiParam (Request Body) {String = "G (Gerado)","R (Recebido)"} tipo Tipo de documento - * @apiParam (Request Body) {String} idSerie Identificador do tipo de documento no SEI (Consultar serviço Listar Séries) - * @apiParam (Request Body) {String} idProcedimento Identificador do processo onde o documento deve ser inserido. Opcional se protocoloProcedimento informado - * @apiParam (Request Body) {String} [protocoloProcedimento] Número do processo onde o documento deve ser inserido, visível para o usuário. Opcional se IdProcedimento informado. - * @apiParam (Request Body) {String} [idTipoConferencia] Identificador do tipo de conferência associada com o documento externo - * @apiParam (Request Body) {String{50}} [numero] Número do documento, passar null para documentos gerados com numeração controlada pelo SEI.Para documentos externos informar o número ou nome complementar a ser exibido na árvore de documentos do processo (o SEI não controla numeração de documentos externos). - * @apiParam (Request Body) {String} [data] Data do documento (dd/MM/yyyy), obrigatório para documentos externos. Passar null para documentos gerados. - * @apiParam (Request Body) {String} [descricao] Descrição do documento para documentos gerados. Passar null para documentos externos - * @apiParam (Request Body) {Remetente} [remetente] Obrigatório para documentos externos, passar null para documentos gerados. - * @apiParam (Request Body) {String} [remetente.nome] Nome do remetente - * @apiParam (Request Body) {String} [remetente.sigla] Login do remetente - * @apiParam (Request Body) {Interessado[]} [interessados] Informar um conjunto com os dados de interessados. Se não existirem interessados deve ser informado um conjunto vazio - * @apiParam (Request Body) {String} [interessados.nome] Nome do interessado - * @apiParam (Request Body) {String} [interessados.sigla] Login do interessado - * @apiParam (Request Body) {Destinatario[]} [destinatarios] Informar um conjunto com os dados de destinatários. Se não existirem destinatários deve ser informado um conjunto vazio - * @apiParam (Request Body) {String} [destinatarios.nome] Nome do destinatário - * @apiParam (Request Body) {String} [destinatarios.sigla] Login do destinatário - * @apiParam (Request Body) {String} [observacao] Texto da observação da unidade, passar null se não existir - * @apiParam (Request Body) {String{200}} [nomeArquivo] Nome do arquivo, obrigatório para documentos externos. Passar null para documentos gerados. - * @apiParam (Request Body) {String} conteudo Conteúdo do arquivo codificado em Base64. Para documentos gerados será o conteúdo da seção principal do editor HTML e para documentos externos será o conteúdo do anexo. Para documentos com template cadastrado, enviar Base64 do JSon referente ao conteúdo a ser preenchido no template. - * @apiParam (Request Body) {String = "0 (público)","1 (restrito)", "2 (sigiloso)", "null (herda do tipo de processo)"} [nivelAcesso] Nível de acesso do documento - * @apiParam (Request Body) {String} [idHipoteseLegal] Identificador da hipótese legal associada - * @apiParam (Request Body) {String} [idArquivo] Identificador do arquivo enviado pelo serviço de Incluir Arquivo - * @apiParam (Request Body) {String = "S (Sim)","N (Não)"} [sinBloqueado] Bloquear o documento, não permite excluí-lo ou alterar seu conteúdo - * @apiParam (Request Body) {Campo} [campos] Conjunto de campos associados com o formulário - * @apiParam (Request Body) {String} [campos.nome] Nome do campo - * @apiParam (Request Body) {String} [campos.valor] Valor do campo - * - * @apiExample Exemplo de requisição: - * endpoint: https:///sei-broker/service/COSAP/documentos - * - * body: - * { - * "tipo":"G", - * "idProcedimento":"33910000173201771", - * "protocoloProcedimento":null, - * "idSerie":null, - * "numero":null, - * "data":null, - * "descricao":"Documento demonstrativo", - * "remetente":null, - * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}], - * "destinatarios":[], - * "observacao":null, - * "nomeArquivo":null, - * "conteudo":"Conteúdo Base64", - * "nivelAcesso":"0" - * } - * - * @apiSuccess (Sucesso Response Body - 201) {String} idDocumento número interno do documento - * @apiSuccess (Sucesso Response Body - 201) {String} documentoFormatado número do documento visível para o usuário - * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso link para acesso ao documento - * - * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 201 Created - * { - * "idDocumento":"1140000000872", - * "documentoFormatado":"0003934", - * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=arvore_visualizar&acao_origem=procedimento_visualizar&id_procedimento=267&id_documento=1017&sta_editor=I&infra_sistema=100000100&infra_unidade_atual=110000934&infra_hash=3d798777382d6ac455317f3a87ad9bd1f9650315e019ef922f388b829902a95b" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/documentos") @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -340,41 +137,7 @@ public class DocumentoResource { return Response.created(getResourcePath(retorno.getDocumentoFormatado())).entity(retorno).build(); } - - /** - * @api {post} /:unidade/documentos/cancelados Cancelar documento - * @apiName cancelarDocumento - * @apiGroup Documento - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Cancela um documento. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Request Body) {String} documento Numero do documento que será cancelado - * @apiParam (Request Body) {String} motivo Motivo do cancelamento - * - * @apiExample Exemplo de requisição: - * endpoint: https:///sei-broker/service/COSAP/documentos/cancelados - * - * body: - * { - * "documento":"0000050", - * "motivo":"Motivo do cancelamento." - * } - * - * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/documentos/cancelados") @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -391,62 +154,7 @@ public class DocumentoResource { return trueOrFalse(resultado) + ""; } - - /** - * @api {get} /:unidade/documentos/enviados-broker Listar documentos enviados - * @apiName consultarDocumentosIncluidosBroker - * @apiGroup Documento - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta documentos inclusos pelo SEI-Broker. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Query Parameters) {String} [hash] Hash SHA-256 gerado a partir do conteúdo enviado ao Broker - * @apiParam (Query Parameters) {String} [processo] Número do processo onde o documento foi inserido - * @apiParam (Query Parameters) {String} [numeroInformado] Número informado na inclusão do documento, exibido na árvore do processo. - * @apiParam (Query Parameters) {String} [pagina=1] Número da página - * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que serão exibidos por página - * - * @apiExample Exemplo de requisição: - * curl -i https:///sei-broker/service/COSAP/documentos/enviados-broker?pagina=1&qtdRegsitros=30 - * - * @apiSuccess (Sucesso Response Body - 200) {InclusaoDocumento} resultado Objeto com dados sobre o documento - * @apiSuccess (Sucesso Response Body - 200) {Date} resultado.data Data do envio (padrão ISO-8601) - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.hash Hash SHA-256 gerado a partir do conteúdo enviado ao Broker - * @apiSuccess (Sucesso Response Body - 200) {Integer} resultado.id Identificação da inclusão de documento - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.nome Nome do documento incluído - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numero Número retonado pelo SEI, NULL caso tenha ocorrido algum problema. - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.processo Número do processo - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.sistema Sistema responsável pela inclusão - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.unidade Unidade onde foi incluído o documento - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numeroInformado Valor opcional informado na inclusão do documento - * - * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "id": 1717, - * "data": "2016-10-31T11:59:56.016+0000", - * "nome": "Doc Homologação.pdf", - * "numero": "0003312", - * "hash": "ca7ebe0c37419db14ffd4f09485a1ebed8e8deeed594e15720da185ee32e9d19", - * "sistema": "desenv_integracao_sei", - * "unidade": "COAI", - * "processo": "33910000097201612", - * "numeroInformado":"2016ans45875" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/documentos/enviados-broker") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -464,33 +172,6 @@ public class DocumentoResource { .header("total_registros", totalRegistros).build(); } - /** - * @api {get} /:unidade/documentos/:documento Exportar documento - * @apiName exportarDocumento - * @apiGroup Documento - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Exporta documentos do SEI em PDF. - * - * @apiParam (Header Parameters) {String} Accept Utilize application/pdf - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informações - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/COSIT/documentos/0003322 - * - * @apiSuccess (Sucesso - 200) {PDF} binario Arquivo no formato PDF. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Path("{unidade}/documentos/{documento}") @Produces("application/pdf") @@ -527,69 +208,7 @@ public class DocumentoResource { return Response.ok(bytes).header("Content-Disposition", "attachment; filename=" +documento+ ".pdf").build(); } - - /** - * @api {get} /interessados/:interessado/documentos Consultar por interessado - * @apiName consultarDocumentoInteressado - * @apiGroup Documento - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Retorna os documentos de um determinado interessado. - * - * @apiParam (Path Parameters) {String} interessado Identificador do interessado - * - * @apiParam (Query Parameters) {String} [tipo] Tipo/Série do documento - * @apiParam (Query Parameters) {boolean} [somenteAssinados=false] Exibir somente documentos assinados - * @apiParam (Query Parameters) {boolean} [orderByProcesso=false] Ordenar pelo número do processo, por padrão o retorno é ordenado pela dataGeracao - * @apiParam (Query Parameters) {boolean} [crescente=false] Ordenar em ordem crescente - * @apiParam (Query Parameters) {String} [pagina=1] Número da página - * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por página - * - * @apiExample Exemplo de requisição: - * curl -i https:///sei-broker/service/interessados/005711/documentos - * - * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados. - * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentos.documentoResumido Resumo do documento encontrado no SEI. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Número do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numeroInformado Número informado na inclusão do documento, também conhecido como número de árvore. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.unidade Unidade responsável pelo documento. - * @apiSuccess (Sucesso Response Body - 200) {String="GERADO","RECEBIDO"} documentos.documentoResumido.origem Origem do documento, se o mesmo é um documento "GERADO" internamente ou "RECEBIDO" de uma fonte externa. - * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de geração do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.processo Processo onde o documento está incluído. - * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentos.documentoResumido.tipo Objeto representando o tipo do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.nome Nome do tipo do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferência do documento. - * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado. - * - * @apiSuccess (Sucesso Response Header - 200) {header} total_registros Quantidade de registros que existem para essa consulta - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "numero": "0670949", - * "numeroInformado": "594", - * "unidade": "COSAP", - * "origem": "RECEBIDO", - * "dataGeracao": "2015-08-10T00:00:00-03:00", - * "processo": "33910.000002/2017-41", - * "tipo": { - * "codigo": "629", - * "nome": "Relatório de Arquivamento-SIF" - * } - * "tipoConferencia": "4", - * "assinado": true - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("interessados/{interessado}/documentos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/ExtensoesResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/ExtensoesResource.java index 74cb83d..cc21f3f 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/ExtensoesResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/ExtensoesResource.java @@ -21,36 +21,7 @@ public class ExtensoesResource { @Inject private UnidadeResource unidadeResource; - - /** - * @api {get} /:unidade/extensoes Listar extensões - * @apiName listarExtensoesPermitidas - * @apiGroup Extensao - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Este método realiza uma busca pelas extensões de arquivos permitidas. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * - * @apiParam (Query Parameters) {String} [extensao=null] Para filtrar por uma determinada extensão. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i http:///sei-broker/service/COSAP/extensoes/ - * - * @apiSuccess (Sucesso - 200) {ArquivoExtensao[]} extensoes Lista de extensões permitidas. - * @apiSuccess (Sucesso - 200) {String} extensoes.idArquivoExtensao Identificador interno do SEI relativo a extensão - * @apiSuccess (Sucesso - 200) {String} extensoes.extensao Texto da extensão (ex.: pdf, ods, doc, ppt,...) - * @apiSuccess (Sucesso - 200) {String} extensoes.descricao Descrição da extensão - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @Path("{unidade}/extensoes") @GET @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/HipoteseLegalResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/HipoteseLegalResource.java index 69bbe0c..15d16a1 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/HipoteseLegalResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/HipoteseLegalResource.java @@ -25,36 +25,6 @@ public class HipoteseLegalResource { @Inject private UnidadeResource unidadeResource; - /** - * @api {get} /:unidade/hipoteses-legais Listar hipóteses legais - * @apiName listarHipoteses - * @apiGroup Hipotese Legal - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Lista as hipóteses legais. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Query Parameters) {String} [nivelAcesso] Filtra hipóteses pelo nível de acesso associado (1 - restrito, 2 - sigiloso) - * - * @apiExample Exemplo de requisição: - * curl -i https:///sei-broker/service/COSAP/hipoteses-legais - * - * @apiSuccess (Sucesso - 200) {HipoteseLegal[]} resultado Lista com as hipóteses legais encontrados - * @apiSuccess (Sucesso - 200) {String} resultado.idHipoteseLegal Identificador da hipótese legal no SEI - * @apiSuccess (Sucesso - 200) {String} resultado.nome Nome da hipótese legal - * @apiSuccess (Sucesso - 200) {String} resultado.baseLegal Descrição da base legal - * @apiSuccess (Sucesso - 200) {String} resultado.nivelAcesso Nivel de acesso associado a hipótese legal - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Path("{unidade}/hipoteses-legais") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/InfoResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/InfoResource.java index 621b0f0..ba4a7c8 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/InfoResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/InfoResource.java @@ -47,54 +47,14 @@ public class InfoResource { @Inject private LogIntegracaoSistemicaDAO dao; - - /** - * @api {get} /info/versao Consultar versão - * @apiName getNumeroVersao - * @apiGroup Info - * @apiVersion 2.0.0 - * - * @apiDescription Este método realiza uma consulta para saber a versão do sei-broker que está disponível. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i http:///sei-broker/service/info/versao - * - * @apiSuccess {String} versao Número da versão. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/versao") @Produces(MediaType.TEXT_PLAIN) public String getNumeroVersao(){ return messages.getMessage("sei.broker.versao"); } - - /** - * @api {get} /info/conexoes/mysql Testar conexão MySQL - * @apiName testMySQLConnection - * @apiGroup Info - * @apiVersion 2.0.0 - * - * @apiDescription Testa a conexão com o MySQL e retorna o número de versão do banco. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i http:///sei-broker/service/info/conexoes/mysql - * - * @apiSuccess {String} versao Número de versão do MySQL. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/conexoes/mysql") @Produces(MediaType.TEXT_PLAIN) @@ -108,27 +68,7 @@ public class InfoResource { throw new Exception(messages.getMessage("erro.testar.mysql")); } } - - /** - * @api {get} /info/conexoes/oracle Testar conexão Oracle - * @apiName testOracleConnection - * @apiGroup Info - * @apiVersion 2.0.0 - * - * @apiDescription Testa a conexão com o Oracle e retorna o número de versão do banco. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i http:///sei-broker/service/info/conexoes/oracle - * - * @apiSuccess {String} versao Número de versão do Oracle. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/conexoes/oracle") @Produces(MediaType.TEXT_PLAIN) @@ -143,26 +83,6 @@ public class InfoResource { } } - /** - * @api {get} /info/conexoes/sei Testar conexão SEI - * @apiName testSEIConnection - * @apiGroup Info - * @apiVersion 2.0.0 - * - * @apiDescription Testa a conexão com o SEI fazendo uma consulta ao serviço listar unidades. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i http:///sei-broker/service/info/conexoes/sei - * - * @apiSuccess {String} mensagem Mensagem de sucesso. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Path("/conexoes/sei") @Produces(MediaType.TEXT_PLAIN) @@ -176,33 +96,7 @@ public class InfoResource { throw new Exception(messages.getMessage("erro.testar.sei")); } } - - /** - * @api {get} /info/requests Listar Requests - * @apiName getUltimosRequests - * @apiGroup Info - * @apiVersion 2.0.0 - * - * @apiDescription Lista os requests recebidos pelo broker. - * - * - * @apiParam (Query Parameters) {String} [operacao] nome do método acessado - * @apiParam (Query Parameters) {String} [origem] usuário que originou a requisição - * @apiParam (Query Parameters) {int} [pag=1] número da página - * @apiParam (Query Parameters) {int} [itens=50] quantidade de itens listados por página - * - * @apiExample {curl} Exemplo de requisição: - * curl -i http:///sei-broker/service/info/requests - * - * @apiSuccess {String} mensagem Mensagem de sucesso. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/requests") @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/InfraResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/InfraResource.java index d7d0247..ed663b0 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/InfraResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/InfraResource.java @@ -39,41 +39,7 @@ public class InfraResource { @Inject private CidadeDAO cidadeDAO; - - /** - * @api {get} /:unidade/paises Listar países - * @apiName getPaises - * @apiGroup Endereco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta países cadastrados. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/cosap/paises - * - * @apiSuccess (Sucesso - 200) {List} resultado Lista com os países. - * @apiSuccess (Sucesso - 200) {Pais} resultado.pais Objeto representando o país. - * @apiSuccess (Sucesso - 200) {String} resultado.pais.idPais Identificador do país no SEI. - * @apiSuccess (Sucesso - 200) {String} resultado.pais.nome Nome do país. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "idPais": "4", - * "nome": "Afeganistão" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/paises") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -81,46 +47,6 @@ public class InfraResource { return seiNativeService.listarPaises(Constantes.SEI_BROKER, Operacao.LISTAR_ESTADOS, unidadeResource.consultarCodigo(unidade)); } - /** - * @api {get} /:unidade/estados Listar estados - * @apiName getEstados - * @apiGroup Endereco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta estados cadastrados. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/cosap/estados - * - * @apiSuccess (Sucesso - 200) {List} resultado Lista com os estados. - * @apiSuccess (Sucesso - 200) {Estado} resultado.estado Objeto representando um estado. - * @apiSuccess (Sucesso - 200) {String} resultado.estado.idEstado Identificador do estado no SEI. - * @apiSuccess (Sucesso - 200) {String} resultado.estado.idPais Identificador do país no SEI. - * @apiSuccess (Sucesso - 200) {String} resultado.estado.sigla Sigla do estado. - * @apiSuccess (Sucesso - 200) {String} resultado.estado.nome Nome do estado. - * @apiSuccess (Sucesso - 200) {String} resultado.estado.codigoIbge Código do IBGE. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "idEstado": "2", - * "idPais": "76", - * "sigla": "AC", - * "nome": "Acre", - * "codigoIbge": "12" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Path("{unidade}/estados") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -131,49 +57,7 @@ public class InfraResource { return seiNativeService.listarEstados(Constantes.SEI_BROKER, Operacao.LISTAR_ESTADOS, unidadeResource.consultarCodigo(unidade), pais); } - - /** - * @api {get} /:unidade/estados Consultar estado - * @apiName getEstado - * @apiGroup Endereco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta o estado pela sigla. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} sigla Sigla do estado - * - * @apiParam (Query Parameters) {String} [pais="76 (Brasil)"] Identificador do pais que deseja listar os estados. - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/cosap/estados/AC - * - * @apiSuccess (Sucesso - 200) {Estado} estado Objeto representando um estado. - * @apiSuccess (Sucesso - 200) {String} estado.idEstado Identificador do estado no SEI. - * @apiSuccess (Sucesso - 200) {String} estado.idPais Identificador do país no SEI. - * @apiSuccess (Sucesso - 200) {String} estado.sigla Sigla do estado. - * @apiSuccess (Sucesso - 200) {String} estado.nome Nome do estado. - * @apiSuccess (Sucesso - 200) {String} estado.codigoIbge Código do IBGE. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "idEstado": "2", - * "idPais": "76", - * "sigla": "AC", - * "nome": "Acre", - * "codigoIbge": "12" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/estados/{uf}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -191,100 +75,14 @@ public class InfraResource { return estados[indexOf]; } - - /** - * @api {get} /:unidade/estados/:estado/cidades Listar cidades - * @apiName getCidades - * @apiGroup Endereco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta as cidades de um determinado estado. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} estado Sigla do estado. - * - * @apiParam (Query Parameters) {String} [filtro] String utilizada para filtrar as cidades. - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/cosap/estados/rj/cidades?filtro=paraiba - * - * @apiSuccess (Sucesso - 200) {List} resultado Lista com os cidades encontradas. - * @apiSuccess (Sucesso - 200) {Cidade} resultado.cidade Objeto representando uma cidade. - * @apiSuccess (Sucesso - 200) {String} resultado.cidade.nome Nome da cidade. - * @apiSuccess (Sucesso - 200) {String} resultado.cidade.codigoIbge Código do IBGE. - * @apiSuccess (Sucesso - 200) {Estado} resultado.cidade.estado Objeto representando um estado. - * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.nome Nome do estado. - * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.sigla Sigla do estado. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "estado": { - * "sigla": "RJ", - * "nome": "Rio de Janeiro" - * }, - * "nome": "Paraíba do Sul", - * "codigoIbge": "3303708" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/estados/{uf}/cidades") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) public List getCidades(@PathParam("unidade") String unidade,@PathParam("uf") String uf, @QueryParam("filtro") String filtro) throws RemoteException,BusinessException,Exception{ return cidadeDAO.getCidades(uf, filtro); } - - /** - * @api {get} /:unidade/estados/:estado/cidades/:cidade Consultar cidade - * @apiName getCidade - * @apiGroup Endereco - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta a cidade pelo código do IBGE. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} estado Sigla do estado. - * @apiParam (Path Parameters) {String} cidade Código do IBGE. - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/cosap/estados/rj/cidades/3303708 - * - * @apiSuccess (Sucesso - 200) {Cidade} cidade Objeto representando uma cidade. - * @apiSuccess (Sucesso - 200) {String} cidade.nome Nome da cidade. - * @apiSuccess (Sucesso - 200) {String} cidade.codigoIbge Código do IBGE. - * @apiSuccess (Sucesso - 200) {Estado} cidade.estado Objeto representando um estado. - * @apiSuccess (Sucesso - 200) {String} cidade.estado.nome Nome do estado. - * @apiSuccess (Sucesso - 200) {String} cidade.estado.sigla Sigla do estado. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "estado": { - * "sigla": "RJ", - * "nome": "Rio de Janeiro" - * }, - * "nome": "Paraíba do Sul", - * "codigoIbge": "3303708" - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/estados/{uf}/cidades/{ibge}") @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/MarcadorResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/MarcadorResource.java index abde284..dc52577 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/MarcadorResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/MarcadorResource.java @@ -36,72 +36,14 @@ public class MarcadorResource { @Inject private MessageUtils messages; - - /** - * @api {get} /:unidade/marcadores Listar marcadores - * @apiName listarMarcadores - * @apiGroup Marcador - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Lista os marcadores de uma unidade. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/cosap/marcadores - * - * @apiSuccess (Sucesso - 200) {Marcador[]} marcadores Lista de marcadores - * @apiSuccess (Sucesso - 200) {String} marcadores.id Identificador do marcador. - * @apiSuccess (Sucesso - 200) {String} marcadores.nome Nome do marcador. - * @apiSuccess (Sucesso - 200) {String} marcadores.icone Ícone do marcador em formato PNG codificado em Base64. - * @apiSuccess (Sucesso - 200) {String} marcadores.sinAtivo S/N - Sinalizador indica se o marcador está ativo. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/marcadores") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) public Marcador[] listarMarcadores(@PathParam("unidade") String unidade) throws RemoteException, Exception{ return seiNativeService.listarMarcadoresUnidade(Constantes.SEI_BROKER, Operacao.LISTAR_MARCADORES_UNIDADE, unidadeResource.consultarCodigo(unidade)); } - - /** - * @api {post} /:unidade/marcadores/:identificador/processos Adicionar Processo - * @apiName marcarProcesso - * @apiGroup Marcador - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Adiciona um processo ao marcador. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} identificador Identificador do marcador no SEI. - * - * @apiParam (Request Body) {MarcacaoProcesso} marcacaoProcesso Objeto de com as definições da marcação. - * @apiParam (Request Body) {String} marcacaoProcesso.processo Número do processo no SEI. - * @apiParam (Request Body) {String} marcacaoProcesso.texto Texto para associação. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/cosap/marcadores/3/processos - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 201 Created - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/marcadores/{marcador}/processos") @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java index 243f835..f357b46 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java @@ -100,124 +100,7 @@ public class ProcessoResource { @Context private UriInfo uriInfo; - - /** - * @api {get} /:unidade/processos/:processo Consultar processo - * @apiName consultarProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Este método realiza uma consulta a processos no SEI e no SIPAR. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} processo Número do processo que deseja consultar - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [assuntos=N] Exibir assuntos do processo - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [interessados=N] Exibir interessados no processo - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [observacoes=N] Exibir observações feitas no processo - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento=N] Exibir andamento do processo - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento-conclusao=N] Exibir o andamento da conclusão do processo - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [ultimo-andamento=N] Exibir o último andamento dado ao processo - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [unidades=N] Exibir unidades onde o processo está aberto - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [relacionados=N] Exibir processos relacionados - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [anexados=N] Exibir processos anexados - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [auto-formatacao=S] O broker utilizará a mascara padrão para formatar o número do processo - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/COSAP/processos/33910000029201653 - * - * @apiSuccess (Sucesso - 200) {ResultadoConsultaProcesso} resultadoConsultaProcesso Objeto de retorno da consulta aos processos, pode um conter processo do SEI ou do SIPAR - * @apiSuccess (Sucesso - 200) {RetornoConsultaProcedimento} resultadoConsultaProcesso.sei Resultado de processo do SEI - * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoConclusao Andamento da conclusão do processo (opcional) - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.andamentoConclusao.dataHora Data e hora do registro de andamento - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.descricao Descrição do andamento - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoConclusao.unidade Unidade responsável pelo andamento - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.descricao Nome da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.idUnidade Código da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.sigla Sigla da unidade - * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoConclusao.usuario Usuário responsável pela ação - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.idUsuario Código do usuário - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.nome Nome do usuário - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.sigla Login do usuário - * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoGeracao Andamento da geração do processo (opcional) - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.andamentoGeracao.dataHora Data e hora do registro de andamento - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.descricao Descrição do andamento - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoGeracao.unidade Unidade responsável pelo andamento - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.descricao Nome da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.idUnidade Código da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.sigla Sigla da unidade - * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoGeracao.usuario Usuário responsável pela ação - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.idUsuario Código do usuário - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.nome Nome do usuário - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.sigla Login do usuário - * @apiSuccess (Sucesso - 200) {Assunto} resultadoConsultaProcesso.sei.assuntos Lista de assuntos - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.assuntos.codigoEstruturado Código do assunto - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.descricao Descrição do assunto - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.dataAutuacao Data de autuação do processo - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.especificacao Especificação do processo - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI - * @apiSuccess (Sucesso - 200) {Interessado} resultadoConsultaProcesso.sei.interessados Lista de interessados no processo (opcional) - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.nome Nome do interessado - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.sigla Login do interessado - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.linkAcesso Link para acesso ao processo - * @apiSuccess (Sucesso - 200) {Observacao} resultadoConsultaProcesso.sei.observacoes Observações feitas sobre o processo (opcional) - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.descricao Descrição da obsevação - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.observacoes.unidade Unidade responsável pela observação - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.descricao Nome da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.idUnidade Código da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.sigla Sigla da unidade - * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosAnexados Lista com os processos anexados - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.idProcedimento Identificador do processo - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.procedimentoFormatado Número do processo visível para o usuário - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.tipoProcedimento Tipo do processo - * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosRelacionados Lista com os processos relacionados - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.idProcedimento Identificador do processo - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.procedimentoFormatado Número do processo visível para o usuário - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.tipoProcedimento Tipo do processo - * - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentoFormatado Número do processo visível para o usuário - * @apiSuccess (Sucesso - 200) {TipoProcedimento} resultadoConsultaProcesso.sei.tipoProcedimento Tipo de procedimento - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.idTipoProcedimento Identificador do tipo de procedimento - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.nome Nome do tipo de procedimento - * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.ultimoAndamento Ultimo andamento do processo (opcional) - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.ultimoAndamento.dataHora Data e hora do registro de andamento - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.descricao Descrição do andamento - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.ultimoAndamento.unidade Unidade responsável pelo andamento - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.descricao Nome da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.idUnidade Código da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.sigla Sigla da unidade - * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.ultimoAndamento.usuario Usuário responsável pela ação - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.idUsuario Código do usuário - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.nome Nome do usuário - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.sigla Login do usuário - * @apiSuccess (Sucesso - 200) {UnidadeProcedimentoAberto} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto Unidades onde o processo está aberto (opcional) - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade Unidade onde o processo está aberto - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.descricao Nome da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.idUnidade Código da unidade - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.sigla Sigla da unidade - * - * @apiSuccess (Sucesso - 200) {DocumentoSIPAR} resultadoConsultaProcesso.sipar Resultado de processo do SIPAR - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.digito Digito do processo - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.operadora Operadora relacionada ao processo - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.emissao Data de emissão - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.registro Data de registro - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.tipo Tipo do processo - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.resumo Resumo sobre o processo - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoPosse Código do orgão que tem a posse do processo - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoOrigem Código do orgão de origem do processo - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoRegistro Código do orgão de registro do processo - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.assunto Código do assunto - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/processos/{processo:\\d+}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -277,38 +160,7 @@ public class ProcessoResource { return documentoSiparDAO.getDocumento(documento, ano, digito); } - - /** - * @api {post} /:unidade/processos/concluidos Concluir processo - * @apiName concluirProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Conclui o processo informado. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [auto-formatacao=S] O broker utilizará a mascara padrão para formatar o número do processo - * - * @apiParam (Request Body) {String} processo Numero do processo a ser concluído - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] https:///sei-broker/service/COSAP/processos/concluidos - * - * body: - * 33910000029201653 - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/processos/concluidos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -321,56 +173,7 @@ public class ProcessoResource { return trueOrFalse(resultado) + ""; } - - - /** - * @api {post} /:unidade/processos/enviados Enviar processo - * @apiName enviarProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Envia processos a outras unidades. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. Representa a unidade de localização atual do processo. - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [reabir=N] Reabrir automaticamente caso esteja concluído na unidade - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [auto-formatacao=S] O broker utilizará a mascara padrão para formatar o número do processo - * - * @apiParam (Request Body) {String} processo Numero do processo a ser enviado. Em caso de processo apensado, o processo a ser enviado deve ser o processo PAI. Não é possível tramitar através do processo FILHO. - * @apiParam (Request Body) {String[]} unidadesDestino Lista com os identificadores das unidades de destino do processo, código ou nome da unidade. - * @apiParam (Request Body) {Boolean} manterAbertoOrigem=false Informa se o processo deve continuar aberto na unidade de origem . - * @apiParam (Request Body) {Boolean} removerAnotacoes=false Informa se as anotações do processo devem ser removidas. - * @apiParam (Request Body) {Boolean} enviarEmailNotificacao=false Informa se deve ser enviado um e-mail de notificação. - * @apiParam (Request Body) {Date} dataRetornoProgramado=null Data para retorno programado do processo a unidade (padrão ISO-8601). - * @apiParam (Request Body) {Integer} qtdDiasAteRetorno=null Quantidade de dias até o retorno do processo. - * @apiParam (Request Body) {Boolean} somenteDiasUteis=false Informa se só serão contabilizados dias úteis. - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] https:///sei-broker/service/COSAP/processos/enviados - * - * body: - * { - * "numeroDoProcesso":"1600000000098", - * "unidadesDestino":["110000934","110000934"], - * "manterAbertoOrigem":false, - * "removerAnotacoes":false, - * "enviarEmailNotificacao":true, - * "dataRetornoProgramado":2016-04-14T19:39:22.292+0000, - * "qtdDiasAteRetorno":5, - * "somenteDiasUteis":true} - * } - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("{unidade}/processos/enviados") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -391,35 +194,7 @@ public class ProcessoResource { return trueOrFalse(resultado) + ""; } - - - /** - * @api {delete} /:unidade/processos/concluidos/:processo Reabrir processo - * @apiName reabrirProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Reabre um processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} processo Numero do processo a ser reaberto - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [auto-formatacao=S] O broker utilizará a mascara padrão para formatar o número do processo - * - * @apiExample Exemplo de requisição: - * curl -X DELETE https:///sei-broker/service/COSAP/processos/concluidos/33910000029201653 - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @DELETE @Path("{unidade}/processos/concluidos/{processo:\\d+}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -432,33 +207,7 @@ public class ProcessoResource { return trueOrFalse(resultado) + ""; } - - /** - * @api {get} /:unidade/processos/tipos Tipos de processo - * @apiName listarTiposProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta os tipos de processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiParam (Query Parameters) {String} [serie] Tipo do documento cadastrado no serviço - * - * @apiExample Exemplo de requisição: - * curl -i https:///sei-broker/service/COSAP/processos/tipos - * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/processos/tipos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -466,94 +215,6 @@ public class ProcessoResource { return seiNativeService.listarTiposProcedimento(Constantes.SEI_BROKER, Operacao.LISTAR_TIPOS_PROCESSO, unidadeResource.consultarCodigo(unidade), serie); } - /** - * @api {post} /:unidade/processos Abrir processo - * @apiName abrirProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Abre um processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [auto-formatacao=S] O broker utilizará a mascara padrão para formatar o número do processo - * - * @apiParam (Request Body) {NovoProcesso} novoProcesso Objeto de representação de novo processo. - * @apiParam (Request Body) {Procedimento} novoProcesso.dadosProcesso Dados do processo. - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.idTipoProcedimento Identificador do tipo de processo no SEI (Consultar tipos de processo). - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.numeroProtocolo] Número do processo, se não for informado o sistema irá gerar um novo número automaticamente. - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.dataAutuacao] Data de autuação do processo, se não for informada o sistema utilizará a data atual. - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.especificacao Especificação do processo. - * @apiParam (Request Body) {Assunto[]} [novoProcesso.dadosProcesso.assuntos] Assuntos do processo, os assuntos informados serão adicionados aos assuntos sugeridos para o tipo de processo. Passar um array vazio caso nenhum outro assunto seja necessário(caso apenas os sugeridos para o tipo bastem para classificação). - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.codigoEstruturado Código do assunto - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.descricao Descrição do assunto - * @apiParam (Request Body) {Interessado[]} [novoProcesso.dadosProcesso.interessados] Informar um conjunto com os dados de interessados. Se não existirem interessados deve ser informado um conjunto vazio. - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.interessados.nome Nome do interessado - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.interessados.sigla Login do interessado - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.observacao] Texto da observação, passar null se não existir. - * @apiParam (Request Body) {String = "0 (público)","1 (restrito)", "2 (sigiloso)", "null (herda do tipo do processo)"} [novoProcesso.dadosProcesso.nivelAcesso] Nível de acesso do processo. - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.idHipoteseLegal] Identificador da hipótese legal associada. * - * @apiParam (Request Body) {Documento[]} [novoProcesso.documentos] Informar os documentos que devem ser gerados em conjunto com o processo (ver serviço de incluir documento para instruções de preenchimento). Se nenhum documento for gerado informar um conjunto vazio. - * @apiParam (Request Body) {String[]} [novoProcesso.processosRelacionados] Lista com os identificadores dos processos(idProcedimento) que devem ser relacionados automaticamente com o novo processo, atenção, não passar o número do processo formatado. - * @apiParam (Request Body) {String[]} [novoProcesso.unidadesDestino] Lista com os identificadores das unidades de destino do processo, código ou nome da unidade. - * @apiParam (Request Body) {Boolean} [novoProcesso.manterAbertoOrigem=false] Indica se o processo deve ser mantido aberto na unidade de origem. - * @apiParam (Request Body) {Boolean} [novoProcesso.enviarEmailNotificacao=false] Indica se deve ser enviado email de aviso para as unidades destinatárias. - * @apiParam (Request Body) {Date} [novoProcesso.dataRetornoProgramado] Data para definição de Retorno Programado. - * @apiParam (Request Body) {Integer} [novoProcesso.qtdDiasAteRetorno] Número de dias para o Retorno Programado. - * @apiParam (Request Body) {Boolean} [novoProcesso.somenteDiasUteis=false] Indica se o valor passado no parâmetro qtdDiasAteRetorno corresponde a dias úteis ou não. - * @apiParam (Request Body) {String} [novoProcesso.idMarcador] Identificador de um marcador da unidade para associação. - * @apiParam (Request Body) {String} [novoProcesso.textoMarcador] Texto do marcador. - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] https:///sei-broker/service/COSAP/processos - * - * body: - * { - * "dadosProcesso":{ - * "idTipoProcedimento":"100000375", - * "especificacao":"Documentação REST", - * "assuntos":[], - * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}], - * "observacao":"Exemplo de requisição", - * "nivelAcesso":0 - * }, - * "documentos":[], - * "processosRelacionados":["186649"], - * "unidadesDestino":["COTEC","110000935","COSAP"], - * "manterAbertoOrigem":true, - * "enviarEmailNotificacao":true, - * "qtdDiasAteRetorno":null, - * "somenteDiasUteis":false - * } - * - * @apiSuccess (Sucesso Response Body - 201) {String} idProcedimento Número do processo gerado - * @apiSuccess (Sucesso Response Body - 201) {String} procedimentoFormatado Número formatado do processo gerado - * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso Link de acesso ao processo - * @apiSuccess (Sucesso Response Body - 201) {RetornoInclusaoDocumento} retornoInclusaoDocumentos Retorno dos documentos inseridos no processo (opcional) - * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.idDocumento Número interno do documento - * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.documentoFormatado Número do documento visível para o usuário - * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.linkAcesso Link para acesso ao documento - * - * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "idProcedimento":"33910000056201626", - * "procedimentoFormatado":"33910.000056/2016-26", - * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=arvore_visualizar&acao_origem=procedimento_visualizar&id_procedimento=267&infra_sistema=100000100&infra_unidade_atual=110000934&infra_hash=7a6a75f6b8ec6b43aaffc6616159a85e35e444b9b32da54108e467bc9f3bdfab", - * "retornoInclusaoDocumentos":[] - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @POST @Path("{unidade}/processos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -573,61 +234,7 @@ public class ProcessoResource { return Response.created(getResourcePath(getOnlyNumbers(retorno.getProcedimentoFormatado()))).entity(retorno).build(); } - - /** - * @api {get} /processos Listar processos - * @apiName consultarProcessos - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Lista os processos conforme os filtros informados. - * - * @apiParam (Query Parameters) {Boolean} [crescente=false] Ordenar em ordem crescente, processos mais antigos primeiro - * @apiParam (Query Parameters) {String} [interessado] Identificador do interessado - * @apiParam (Query Parameters) {String} [unidade] Unidade da qual deseja filtrar os processos - * @apiParam (Query Parameters) {String} [pagina=1] Número da página - * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por página - * @apiParam (Query Parameters) {String} [tipo] Identificador do tipo de processo que deseja filtrar - * - * @apiExample Exemplo de requisição: - * curl -i https:///sei-broker/service/processos - * - * @apiSuccess (Sucesso Response Body - 200) {List} processos Lista com os processos encontrados - * @apiSuccess (Sucesso Response Body - 200) {ProcessoResumido} processos.processoResumido Resumo do processo encontrado no SEI - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numero Número do processo - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numeroFormatado Número do processo formatado - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.descricao Descrição do processo - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.unidade Unidade responsável pelo processo - * @apiSuccess (Sucesso Response Body - 200) {Data} processos.processoResumido.dataGeracao Data de geração do processo - * @apiSuccess (Sucesso Response Body - 200) {Tipo} processos.processoResumido.tipo Objeto com os dados do tipo de processo - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.codigo Código do tipo - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.nome Nome do tipo - * - * @apiSuccess (Sucesso Response Header - 200) {header} total_registros quantidade de registros que existem para essa consulta. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "numero": "33910007118201710", - * "numeroFormatado": "33910.007118/2017-10", - * "descricao": "D:2237021 - SUL AMÉRICA SEGURO SAÚDE S/A", - * "unidade": "NÚCLEO-RJ", - * "dataGeracao": "2017-10-09T03:00:00.000+0000", - * "tipo": { - * "codigo": "100000882", - * "nome": "Fiscalização: Sancionador" - * } - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/processos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -663,53 +270,7 @@ public class ProcessoResource { return consultarProcessos(interessado, unidade, tipoProcesso, crescente, pagina, qtdRegistros); } - - /** - * @api {get} /:unidade/processos/:processo/andamentos Listar andamentos - * @apiName listarAndamentos - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Lista as andamentos do processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Número do processo. - * - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [exibir-atributos="N"] Sinalizador para retorno dos atributos associados. - * @apiParam (Query Parameters) {String[]} [andamento] Filtra andamentos pelos identificadores informados. - * @apiParam (Query Parameters) {String[]} [tarefa="1,48,65"] Filtra andamentos pelos identificadores de tarefas informados (consultar lista de tarefas). - * @apiParam (Query Parameters) {String[]} [tarefa-modulo] Filtra andamentos pelos identificadores de tarefas de módulo informados. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/cosap/processos/33910003114201754/andamentos - * - * @apiSuccess (Sucesso - 200) {Andamento[]} andamentos Lista dos andamentos do processo. - * @apiSuccess (Sucesso - 200) {String} andamentos.idAndamento Identificador do andamento. - * @apiSuccess (Sucesso - 200) {String} andamentos.idTarefa Identificador da tarefa. - * @apiSuccess (Sucesso - 200) {String} andamentos.descricao Descrição do andamento. - * @apiSuccess (Sucesso - 200) {String} andamentos.dataHora Data e hora do andamento. - * @apiSuccess (Sucesso - 200) {Unidade} andamentos.unidade Unidade onde o andamento ocorreu. - * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.idUnidade Identificador da unidade. - * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.sigla Sigla da unidade. - * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.descricao Descrição da unidade. - * @apiSuccess (Sucesso - 200) {Usuario} andamentos.usuario Usuário responsável pelo andamento. - * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.idUsuario Identificador do usuário. - * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.sigla Login do usuário. - * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.nome Nome do usuário. - * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} andamentos.atributos Lista com os atributos relacionados ao andamento. - * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.nome Nome do atributo. - * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.valor Valor do atributo. - * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.idOrigem Identificador de origem do atributo. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/{unidade}/processos/{processo:\\d+}/andamentos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -723,59 +284,7 @@ public class ProcessoResource { return seiNativeService.listarAndamentos(Constantes.SEI_BROKER, Operacao.LISTAR_ANDAMENTOS, unidadeResource.consultarCodigo(unidade), formatarNumeroProcesso(processo), getSOuN(retornarAtributos), andamentos, tarefas, tarefasModulos); } - - /** - * @api {post} /:unidade/processos/:processo/andamentos Lançar andamento - * @apiName lancarAndamento - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Lança um andamento ao processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Número do processo. - * - * @apiParam (Request Body) {NovoAndamento} novoAndamento Objeto representando o novo andamento. - * @apiParam (Request Body) {String} novoAndamento.tarefa Identificador da tarefa a qual o andamento se refere (consultar lista de tarefas). - * @apiParam (Request Body) {String} [novoAndamento.tarefaModulo] Identificadoe da tarefa módulo a qual o andamento se refere. - * @apiParam (Request Body) {HashMap} novoAndamento.atributos Mapa chave-valor, identificando como serão preenchidos os atributos da tarefa. - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] https:///sei-broker/service/COSAP/processos/33910003114201754/andamentos - * - * body: - * { - * "tarefa":"65", - * "atributos":{"DESCRICAO":"Novo andamento adicionado pelo SEI-Broker"} - * } - * - * @apiSuccess (Sucesso - 201) {Andamento} andamento Andamento criado. - * @apiSuccess (Sucesso - 201) {String} andamento.idAndamento Identificador do andamento. - * @apiSuccess (Sucesso - 201) {String} andamento.idTarefa Identificador da tarefa. - * @apiSuccess (Sucesso - 201) {String} andamento.descricao Descrição do andamento. - * @apiSuccess (Sucesso - 201) {String} andamento.dataHora Data e hora do andamento. - * @apiSuccess (Sucesso - 201) {Unidade} andamento.unidade Unidade onde o andamento ocorreu. - * @apiSuccess (Sucesso - 201) {String} andamento.unidade.idUnidade Identificador da unidade. - * @apiSuccess (Sucesso - 201) {String} andamento.unidade.sigla Sigla da unidade. - * @apiSuccess (Sucesso - 201) {String} andamento.unidade.descricao Descrição da unidade. - * @apiSuccess (Sucesso - 201) {Usuario} andamento.usuario Usuário responsável pelo andamento. - * @apiSuccess (Sucesso - 201) {String} andamento.usuario.idUsuario Identificador do usuário. - * @apiSuccess (Sucesso - 201) {String} andamento.usuario.sigla Login do usuário. - * @apiSuccess (Sucesso - 201) {String} andamento.usuario.nome Nome do usuário. - * @apiSuccess (Sucesso - 201) {AtributoAndamento[]} andamento.atributos Lista com os atributos relacionados ao andamento. - * @apiSuccess (Sucesso - 201) {String} andamento.atributos.nome Nome do atributo. - * @apiSuccess (Sucesso - 201) {String} andamento.atributos.valor Valor do atributo. - * @apiSuccess (Sucesso - 201) {String} andamento.atributos.idOrigem Identificador de origem do atributo. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("/{unidade}/processos/{processo:\\d+}/andamentos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -786,41 +295,7 @@ public class ProcessoResource { return Response.status(Status.CREATED).entity(andamentoLancado).build(); } - - /** - * @api {post} /:unidade/processos/:processo/anexados Anexar processo - * @apiName anexarProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Anexar um processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Número do processo. - * - * @apiParam (Request Body) {ProcessoAnexado} processoAnexado Objeto representando o processo a ser anexado. - * @apiParam (Request Body) {String} processoAnexado.numero Número do processo a ser anexado. - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] https:///sei-broker/service/COSAP/processos/33910003114201754/anexados - * - * body: - * { - * "numero":"33910003093201777" - * } - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("/{unidade}/processos/{processo:\\d+}/anexados") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -838,37 +313,7 @@ public class ProcessoResource { throw new Exception(messages.getMessage("erro.anexar.processo")); } } - - /** - * @api {delete} /:unidade/processos/:processo/anexados/:processoAnexado Desanexar processo - * @apiName desanexarProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Remove um processo anexado. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Número do processo. - * @apiParam (Path Parameters) {String} processo Número do processo anexado. - * - * @apiExample Exemplo de requisição: - * curl -X DELETE https:///sei-broker/service/COSAP/processos/33910003114201754/anexados/33910003093201777 - * - * @apiParam (Request Body) {Motivo} motivo Objeto com o motivo. - * @apiParam (Request Body) {String} motivo.motivo Descrição do motivo para remoção do processo em anexo. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @DELETE @Path("/{unidade}/processos/{processo:\\d+}/anexados/{processoAnexado:\\d+}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -887,40 +332,7 @@ public class ProcessoResource { throw new Exception(messages.getMessage("erro.desanexar.processo")); } } - - /** - * @api {post} /:unidade/processos/bloqueados Bloquear processo - * @apiName bloquearProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Bloquear um processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * - * @apiParam (Request Body) {ProcessoBloqueado} processoBloqueado Objeto com o número do processo a ser bloqueado. - * @apiParam (Request Body) {String} processoBloqueado.numero Número do processo a ser bloqueado. - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] https:///sei-broker/service/COSAP/processos/bloqueados - * - * body: - * { - * "numero":"33910003093201777" - * } - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("/{unidade}/processos/bloqueados") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -939,33 +351,7 @@ public class ProcessoResource { throw new Exception(messages.getMessage("erro.bloquear.processo")); } } - - /** - * @api {delete} /:unidade/processos/bloqueados/:processo Desbloquear processo - * @apiName desbloquearProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Desbloquear um processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Número do processo. - * - * @apiExample Exemplo de requisição: - * endpoint: [DELETE] https:///sei-broker/service/COSAP/processos/bloqueados/33910003093201777 - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @DELETE @Path("/{unidade}/processos/bloqueados/{processo:\\d+}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -979,41 +365,7 @@ public class ProcessoResource { throw new Exception(messages.getMessage("erro.desbloquear.processo")); } } - - /** - * @api {post} /:unidade/processos/:processo/relacionados Relacionar processo - * @apiName relacionarProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Relacionar processos. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Número do processo. - * - * @apiParam (Request Body) {ProcessoRelacionado} processoRelacionado Objeto com o número do processo a ser relacionado. - * @apiParam (Request Body) {String} processoRelacionado.numero Número do processo a ser relacionado. - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] https:///sei-broker/service/COSAP/processos/33910003093201777/relacionados - * - * body: - * { - * "numero":"33910000086201632" - * } - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("/{unidade}/processos/{processo:\\d+}/relacionados") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -1031,34 +383,7 @@ public class ProcessoResource { throw new Exception(messages.getMessage("erro.relacionar.processo")); } } - - /** - * @api {delete} /:unidade/processos/:processo/relacionados/:processoRelacionado Desrelacionar processo - * @apiName desrelacionarProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Desrelacionar processos. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Número do processo. - * @apiParam (Path Parameters) {String} processoRelacionado Número do processo relacionado. - * - * @apiExample Exemplo de requisição: - * endpoint: [DELETE] https:///sei-broker/service/COSAP/processos/33910000086201632/relacionados/33910003107201752 - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @DELETE @Path("/{unidade}/processos/{processo:\\d+}/relacionados/{processoRelacionado:\\d+}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -1074,43 +399,7 @@ public class ProcessoResource { throw new Exception(messages.getMessage("erro.desrelacionar.processo")); } } - - /** - * @api {post} /:unidade/processos/sobrestados Sobrestar processo - * @apiName sobrestarProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Sobrestar processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * - * @apiParam (Request Body) {SobrestamentoProcesso} sobrestamento Objeto com o motivo do sobrestamento. - * @apiParam (Request Body) {String} sobrestamento.processo Número do processo a ser sobrestado. - * @apiParam (Request Body) {String} sobrestamento.motivo Motivo do sobrestamento. - * @apiParam (Request Body) {String} [sobrestamento.processoVinculado] Número do processo vinculado. - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] https:///sei-broker/service/COSAP/processos/sobrestados - * - * body: - * { - * "processo":"33910003093201777", - * "motivo":"Sobrestando através da camada de serviços." - * } - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("/{unidade}/processos/sobrestados") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -1129,33 +418,7 @@ public class ProcessoResource { throw new Exception(messages.getMessage("erro.sobrestar.processo")); } } - - /** - * @api {delete} /:unidade/processos/sobrestados/:processo Remover sobrestamento - * @apiName removerSobrestamentoProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Remover sobrestamento de processo. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Número do processo. - * - * @apiExample Exemplo de requisição: - * endpoint: [DELETE] https:///sei-broker/service/COSAP/processos/sobrestados/33910003093201777 - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @DELETE @Path("/{unidade}/processos/sobrestados/{processo:\\d+}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -1170,66 +433,7 @@ public class ProcessoResource { throw new Exception(messages.getMessage("erro.remover.sobrestamento.processo")); } } - - /** - * @api {get} /processos/:processo/documentos Listar documentos - * @apiName listarDocumentosPorProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Retorna os documentos de um determinado processo. - * - * @apiParam (Path Parameters) {String} processo Número do processo. - * - * @apiParam (Query Parameters) {String} [tipo=null] Identificador do tipo do documento, caso seja necessário filtrar pelo tipo - * @apiParam (Query Parameters) {String = "G (gerado/interno), R (recebido/externo)"} [origem=null] Filtra os documentos por gerados ou recebidos - * @apiParam (Query Parameters) {boolean} [somenteAssinados=false] Exibir somente documentos assinados - * @apiParam (Query Parameters) {String} [numeroInformado] Filtrar pelo número informado - * @apiParam (Query Parameters) {String} [pagina=1] Número da página - * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que serão exibidos por página - * - * @apiExample Exemplo de requisição: - * curl -i https:///sei-broker/service/processos/33910003149201793/documentos - * - * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados. - * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentos.documentoResumido Resumo do documento encontrado no SEI. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Número do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numeroInformado Número informado na inclusão do documento, também conhecido como número de árvore. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.nome Nome do arquivo que foi enviado para o SEI. (Somente para documentos cujo a origem é "RECEBIDO", também conhecidos como documentos externos) - * @apiSuccess (Sucesso Response Body - 200) {String="GERADO","RECEBIDO"} documentos.documentoResumido.origem Origem do documento, se o mesmo é um documento "GERADO" internamente ou "RECEBIDO" de uma fonte externa. - * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de geração do documento. - * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentos.documentoResumido.tipo Objeto representando o tipo do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.nome Nome do tipo do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferência do documento. - * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado. - * - * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "numero": "0670949", - * "numeroInformado": "594", - * "origem": "RECEBIDO", - * "dataGeracao": "2015-08-10T00:00:00-03:00", - * "tipo": { - * "codigo": "629", - * "nome": "Relatório de Arquivamento-SIF" - * } - * "tipoConferencia": "4", - * "assinado": true - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/processos/{processo:\\d+}/documentos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -1253,56 +457,7 @@ public class ProcessoResource { return Response.status(getStatus(totalDocumentosProcesso.intValue(), tamanhoPagina)).header("total_registros", totalDocumentosProcesso) .entity(new GenericEntity>(documentosProcesso){}).build(); } - - /** - * @api {get} /processos/:processo/documentos/:documento Consultar documento - * @apiName consultarDocumentoDoProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta um documento de determinado processo. - * - * @apiParam (Path Parameters) {String} processo Número do processo. - * @apiParam (Path Parameters) {String} documento Número do documento. - * - * @apiExample Exemplo de requisição: - * curl -i https:///sei-broker/service/processos/33910002924201874/documentos/55737058 - * - * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentoResumido Resumo do documento encontrado no SEI. - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numero Número do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numeroInformado Número informado na inclusão do documento, também conhecido como número de árvore. - * @apiSuccess (Sucesso Response Body - 200) {String="GERADO","RECEBIDO"} documentoResumido.origem Origem do documento, se o mesmo é um documento "GERADO" internamente ou "RECEBIDO" de uma fonte externa. - * @apiSuccess (Sucesso Response Body - 200) {Data} documentoResumido.dataGeracao Data de geração do documento. - * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentoResumido.tipo Objeto representando o tipo do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série. - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipo.nome Nome do tipo do documento. - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipoConferencia Tipo de conferência do documento. - * @apiSuccess (Sucesso Response Body - 200) {boolean} documentoResumido.assinado Boolean indicando se o documento foi assinado. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * { - * "numero": "0670949", - * "numeroInformado": "594", - * "origem": "RECEBIDO", - * "dataGeracao": "2015-08-10T00:00:00-03:00", - * "tipo": { - * "codigo": "629", - * "nome": "Relatório de Arquivamento-SIF" - * } - * "tipoConferencia": "4", - * "assinado": true - * } - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/processos/{processo:\\d+}/documentos/{documento:\\d+}") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -1316,51 +471,7 @@ public class ProcessoResource { throw new ResourceNotFoundException(messages.getMessage("erro.documento.nao.encontrado", documento, formatarNumeroProcesso(processo))); } } - - /** - * @api {get} /processos/:processo/unidades Consultar unidades - * @apiName consultarUnidadesProcesso - * @apiGroup Processo - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Consulta as unidades onde o processo está aberto. - * - * @apiParam (Path Parameters) {String} processo Número do processo. - * - * @apiExample Exemplo de requisição: - * curl -i https:///sei-broker/service/processos/33910002924201874/unidades - * - * @apiSuccess (Sucesso Response Body - 200) {List} unidades Lista da unidades onde o processo está aberto. - * @apiSuccess (Sucesso Response Body - 200) {Unidade} unidades.unidade Objeto Unidade. - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.idUnidade Identificador da unidade. - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sigla Sigla de unidade. - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.descricao Descrição da unidade. - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinProtocolo Descrição pendente da área de negócio. - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinArquivamento Descrição pendente da área de negócio. - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinOuvidoria Descrição pendente da área de negócio. - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 200 OK - * [ - * { - * "idUnidade": "110000934", - * "sigla": "COSAP", - * "descricao": "Coordenadoria de Sistemas e Aplicativos", - * "sinProtocolo": "S", - * "sinArquivamento": "N", - * "sinOuvidoria": "N" - * } - * ] - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/processos/{processo:\\d+}/unidades") @Produces(MediaType.APPLICATION_JSON) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/SeriesResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/SeriesResource.java index 95b9040..08e4db9 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/SeriesResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/SeriesResource.java @@ -37,37 +37,7 @@ public class SeriesResource { @Inject private MessageUtils messages; - - /** - * @api {get} /:unidade/series Listar séries - * @apiName listarSeries - * @apiGroup Serie - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Este método realiza uma consulta às séries. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * - * @apiParam (Query Parameters) {String} [filtro] Para filtrar por series que contenham o trecho no nome. - * @apiParam (Query Parameters) {String} [tipo-processo=null] Para filtrar por determinado tipo de processo. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/COSAP/series - * - * @apiSuccess (Sucesso - 200) {Serie[]} series Lista de séries. - * @apiSuccess (Sucesso - 200) {String} series.idSerie Identificador do tipo de documento - * @apiSuccess (Sucesso - 200) {String} series.nome Nome do tipo de documento - * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/series") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -88,36 +58,7 @@ public class SeriesResource { return series; } - - /** - * @api {get} /:unidade/tipos-documentos Listar tipos documentos - * @apiName listarTiposDocumentos - * @apiGroup Documento - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Lista os tipos de documentos do SEI. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * - * @apiParam (Query Parameters) {String} [filtro] Para filtrar por documentos que contenham o trecho no nome. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/COSAP/tipos-documentos - * - * @apiSuccess (Sucesso - 200) {List} tipos Lista com os tipos de documentos - * @apiSuccess (Sucesso - 200) {String} tipos.identificador Identificador do tipo de documento - * @apiSuccess (Sucesso - 200) {String} tipos.nome Nome do tipo de documento - * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("{unidade}/tipos-documentos") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java index 6ee020b..c1a4048 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java @@ -12,7 +12,6 @@ import javax.ws.rs.PathParam; import javax.ws.rs.core.Context; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; -import javax.ws.rs.core.Response.Status; import javax.ws.rs.core.UriBuilder; import javax.ws.rs.core.UriInfo; @@ -43,50 +42,7 @@ public class SiparResource { private static int TRUE = 1; private static int FALSE = 0; - - /** - * @api {post} /sipar/importados Importar Processo - * @apiName importarProcesso - * @apiGroup SIPAR - * @apiVersion 2.0.0 - * - * @apiDescription Marca um processo físico (SIPAR) como importado para um processo eletrônico (SEI). - * - * @apiParam (Header Parameters) {String} content-type Informar text/plain - * @apiParam (Request Body) {String} processo Número do processo a ser importado - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] http:///sei-broker/service/sipar/importados - * - * body: - * 33902112492200241 - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 201 Created - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - * - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 400 Bad Request - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - * - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 409 Conflict - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("/importados") @Consumes({MediaType.TEXT_PLAIN}) @@ -119,46 +75,7 @@ public class SiparResource { return Response.created(getResourcePath(processo)).build(); } - - /** - * @api {delete} /sipar/importados/:processo Cancelar Importação Processo - * @apiName cancelarImportacaoProcesso - * @apiGroup SIPAR - * @apiVersion 2.0.0 - * - * @apiDescription Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI). - * - * @apiParam (Path Parameter) {String} processo Número do processo físico existente no SIPAR contendo 17 dígitos e iniciado com 33902. Ex. 33902111111111111 - * - * @apiExample {curl} Exemplo de requisição: - * curl -X DELETE http:///sei-broker/service/sipar/importados/33902112492200241 - * - * @apiSuccessExample {json} Success-Response: - * HTTP/1.1 204 No Content - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - * - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 400 Bad Request - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - * - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 404 Not Found - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @DELETE @Path("/importados/{processo:\\d+}") public Response cancelarImportacaoProcesso(@PathParam("processo") String processo) throws Exception{ diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/TarefaResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/TarefaResource.java index b668942..61ae819 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/TarefaResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/TarefaResource.java @@ -23,39 +23,6 @@ public class TarefaResource { @Inject private MessageUtils messages; - - /** - * @api {get} /tarefas Listar tarefas - * @apiName listarTarefas - * @apiGroup Tarefa - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Lista os tipos de tarefas existentes no SEI. - * - * @apiParam (Query Parameters) {String} [nome] Filtro para o nome da tarefa. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/tarefas - * - * @apiSuccess (Sucesso - 200) {List} tarefas Lista com as tarefas - * @apiSuccess (Sucesso - 200) {String} tarefas.identificados Identificador da tarefa. - * @apiSuccess (Sucesso - 200) {String} tarefas.nome Nome da tarefa. - * @apiSuccess (Sucesso - 200) {String} tarefas.historicoResumido S/N - Sinalizador indica se a tarefa aparecerá no histórico resumido. - * @apiSuccess (Sucesso - 200) {String} tarefas.historicoCompleto S/N - Sinalizador indica se a tarefa aparecerá no histórico completo. - * @apiSuccess (Sucesso - 200) {String} tarefas.fecharAndamentosAbertos S/N - Sinalizador indica se a tarefa fecha andamentos abertos. - * @apiSuccess (Sucesso - 200) {String} tarefas.lancarAndamentoFechado S/N - Sinalizador indica que a tarefa encerra o andamento. - * @apiSuccess (Sucesso - 200) {String} tarefas.permiteProcessoFechado S/N - Sinalizador indica se é permitida essa tarefa em processo fechado. - * @apiSuccess (Sucesso - 200) {String} tarefas.identicadorTarefaModulo Identificador de tarefa módulo. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) public List listarTarefas(@QueryParam("nome") String filtroNome) throws ResourceNotFoundException{ diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/TipoConferenciaResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/TipoConferenciaResource.java index efc7cfb..c8c124a 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/TipoConferenciaResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/TipoConferenciaResource.java @@ -23,32 +23,6 @@ public class TipoConferenciaResource { @Inject private UnidadeResource unidadeResource; - /** - * @api {get} /:unidade/tipos-conferencia Listar tipos de conferência - * @apiName listarTiposConferencia - * @apiGroup Tipos Conferência - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Lista os tipos de conferência. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/cosap/tipos-conferencia - * - * @apiSuccess (Sucesso - 200) {TipoConferencia[]} tipos Lista de tipos de conferência. - * @apiSuccess (Sucesso - 200) {String} tipos.idTipoConferencia Identificador do tipo de conferência. - * @apiSuccess (Sucesso - 200) {String} tipos.descricao Descrição do tipo de conferência. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Path("{unidade}/tipos-conferencia") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/UnidadeResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/UnidadeResource.java index e8708e1..dc77c3f 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/UnidadeResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/UnidadeResource.java @@ -38,31 +38,6 @@ public class UnidadeResource { private static Date dataCarregamentoUnidades = new Date(); - /** - * @api {get} /unidades Listar unidades - * @apiName listarUnidades - * @apiGroup Unidade - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Retorna as Unidades cadastradas no SEI. - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/unidades/ - * - * @apiSuccess (Sucesso - 200) {Unidade[]} unidades Lista de unidades - * @apiSuccess (Sucesso - 200) {String} unidades.idUnidade Identificador da unidade - * @apiSuccess (Sucesso - 200) {String} unidades.sigla Sigla da unidade - * @apiSuccess (Sucesso - 200) {String} unidades.descricao Descrição da unidade - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) public br.gov.ans.integracao.sei.client.Unidade[] listarUnidades() throws Exception{ @@ -74,31 +49,7 @@ public class UnidadeResource { return lista; } - - /** - * @api {get} /unidades/{unidade}/codigo Consultar código - * @apiName consultarCodigo - * @apiGroup Unidade - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Retorna o código da Unidade pesquisada. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade que deseja consultar o código - * - * @apiExample {curl} Exemplo de requisição: - * curl -i https:///sei-broker/service/unidades/COSAP/codigo - * - * @apiSuccess (Sucesso - 200) {String} codigo Código da unidade. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/{chave}/codigo") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) diff --git a/src/main/java/br/gov/ans/integracao/sei/rest/UsuarioResource.java b/src/main/java/br/gov/ans/integracao/sei/rest/UsuarioResource.java index 4dc9e34..1f98c8a 100644 --- a/src/main/java/br/gov/ans/integracao/sei/rest/UsuarioResource.java +++ b/src/main/java/br/gov/ans/integracao/sei/rest/UsuarioResource.java @@ -44,106 +44,20 @@ public class UsuarioResource { @Inject private MessageUtils messages; - /** - * @api {get} /:unidade/usuarios Listar usuários - * @apiName listarUsuarios - * @apiGroup Usuario - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Este método realiza uma consulta aos usuários cadastrados que possuem o perfil "Básico". - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * - * @apiParam (Query Parameters) {String} [usuario=null] Id do usuário que deseja recuperar as informações - * - * @apiExample {curl} Exemplo de requisição: - * curl -i http:///sei-broker/service/usuarios/COSAP - * - * @apiSuccess {Usuario[]} usuarios Lista de usuários - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @GET @Path("/{unidade}/usuarios") @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) public br.gov.ans.integracao.sei.client.Usuario[] listarUsuarios(@PathParam("unidade") String unidade, @QueryParam("usuario") String usuario) throws RemoteException, Exception{ return seiNativeService.listarUsuarios(Constantes.SEI_BROKER, Operacao.LISTAR_USUARIOS, unidadeResource.consultarCodigo(unidade), usuario); } - - - /** - * @api {get} :unidade/usuarios/:usuario Buscar usuário - * @apiName buscarUsuario - * @apiGroup Usuario - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA - * - * @apiDescription Este método realiza a uma busca pelo login do usuário. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} usuario Login do usuário - * - * @apiExample Exemplo de requisição: - * curl -i http:///sei-broker/service/cosap/usuarios/andre.guimaraes - * - * @apiSuccess {Usuario} usuario Informações do usuário encontrado. - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @GET @Path("/{unidade}/usuarios/{usuario}") @Produces(MediaType.APPLICATION_JSON) public br.gov.ans.integracao.sei.client.Usuario buscarUsuario(@PathParam("unidade") String unidade, @PathParam("usuario") String usuario) throws Exception{ return getUsuario(usuario, unidade); } - - /** - * @api {post} /:unidade/:usuario/processos Atribuir processo - * @apiName atribuirProcesso - * @apiGroup Usuario - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER - * - * @apiDescription Este método atribui o processo a um usuário. - * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI - * @apiParam (Path Parameters) {String} usuario Login do usuário a quem deseja atribuir o processo - * - * @apiParam (Request Body) {String} processo Numero do processo a ser atribuído - * @apiParam (Request Body) {String} [reabrir-processo=N] S ou N para reabrir o processo - * - * @apiExample Exemplo de requisição: - * endpoint: [POST] http:///sei-broker/service/COSAP/usuarios/andre.guimaraes/processos - * - * body: - * { - * "processo":"33910000029201653", - * "reabrir":false - * } - * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("/{unidade}/usuarios/{usuario}/processos") @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @@ -155,40 +69,7 @@ public class UsuarioResource { return trueOrFalse(resultado) + ""; } - - /** - * @api {post} /usuarios Incluir usuário - * @apiName incluirUsuario - * @apiGroup Usuario - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER_ADM - * - * @apiDescription Este método realiza a inclusão de novos usuários ou alterarações nos usuários existentes. - * - * @apiParam (Request Body) {String} codigo Código que deseja atribuir ao usuário - * @apiParam (Request Body) {String} nome Nome do usuário - * @apiParam (Request Body) {String} login Login que será atribuído ao usuário - * - * @apiExample Exemplo de requisição: - * endpoint: http:///sei-broker/service/usuarios - * - * body: - * { - * "codigo":"1234", - * "nome":"André Luís Fernandes Guimarães", - * "login":"andre.guimaraes" - * } - * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("/usuarios") @Consumes({MediaType.APPLICATION_JSON}) @@ -197,40 +78,6 @@ public class UsuarioResource { return manterUsuario(Acao.ALTERAR_INCLUIR, usuario); } - - /** - * @api {delete} /usuarios/:login Excluir usuário - * @apiName excluirUsuario - * @apiGroup Usuario - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER_ADM - * - * @apiDescription Este método realiza a exclusão de usuários. - * - * @apiParam {String} codigo Código que deseja atribuir ao usuário - * @apiParam {String} nome Nome do usuário - * @apiParam {String} login Login que será atribuído ao usuário - * - * @apiExample Exemplo de requisição: - * endpoint: [DELETE] http:///sei-broker/service/usuarios/andre.guimaraes - * - * body: - * { - * "codigo":"1234", - * "nome":"André Luís Fernandes Guimarães", - * "login":"andre.guimaraes" - * } - * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ @DELETE @Path("/usuarios/{login}") @Consumes({MediaType.APPLICATION_JSON}) @@ -238,41 +85,7 @@ public class UsuarioResource { public Boolean excluirUsuario(@PathParam("login") String login,Usuario usuario) throws Exception{ return manterUsuario(Acao.EXCLUIR, usuario); } - - - /** - * @api {delete} /usuarios/ativos Desativar usuário - * @apiName desativarUsuario - * @apiGroup Usuario - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER_ADM - * - * @apiDescription Este método desativa usuários. - * - * @apiParam {String} codigo Código que deseja atribuir ao usuário - * @apiParam {String} nome Nome do usuário - * @apiParam {String} login Login que será atribuído ao usuário - * - * @apiExample Exemplo de requisição: - * endpoint: [DELETE] http:///sei-broker/service/usuarios/ativos/andre.guimaraes - * - * body: - * { - * "codigo":"1234", - * "nome":"André Luís Fernandes Guimarães", - * "login":"andre.guimaraes" - * } - * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @DELETE @Path("/usuarios/ativos/{login}") @Consumes({MediaType.APPLICATION_JSON}) @@ -280,40 +93,7 @@ public class UsuarioResource { public Boolean desativarUsuario(@PathParam("login") String login,Usuario usuario) throws Exception{ return manterUsuario(Acao.DESATIVAR, usuario); } - - /** - * @api {post} /usuarios/ativos Ativar usuário - * @apiName ativarUsuario - * @apiGroup Usuario - * @apiVersion 2.0.0 - * - * @apiPermission RO_SEI_BROKER_ADM - * - * @apiDescription Este método reativa usuários. - * - * @apiParam {String} codigo Código que deseja atribuir ao usuário - * @apiParam {String} nome Nome do usuário - * @apiParam {String} login Login que será atribuído ao usuário - * - * @apiExample Exemplo de requisição: - * endpoint: http:///sei-broker/service/usuarios/ativos - * - * body: - * { - * "codigo":"1234", - * "nome":"André Luís Fernandes Guimarães", - * "login":"andre.guimaraes" - * } - * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição - * - * @apiErrorExample {json} Error-Response: - * HTTP/1.1 500 Internal Server Error - * { - * "error":"Mensagem de erro." - * "code":"código do erro" - * } - */ + @POST @Path("/usuarios/ativos") @Consumes({MediaType.APPLICATION_JSON}) diff --git a/src/main/resources/apidoc/arquivo.apidoc b/src/main/resources/apidoc/arquivo.apidoc new file mode 100644 index 0000000..161e50e --- /dev/null +++ b/src/main/resources/apidoc/arquivo.apidoc @@ -0,0 +1,96 @@ + /** + * @api {post} /:unidade/arquivos Adicionar arquivo + * @apiName adicionarArquivo + * @apiGroup Arquivo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription O servio criar um arquivo no repositrio de documentos e retornar seu identificador. O envio do arquivo poder ser particionado com chamadas + * posteriores ao servio de Adicionar Contedo Arquivo. Aps todo o contedo ser transferido o arquivo ser ativado e poder ser associado com um documento externo + * no servio de incluso de documento. Sero excludos em 24 horas os arquivos no completados e no associados a um documento. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Request Body) {Arquivo} arquivo Objeto representando um arquivo. + * @apiParam (Request Body) {String} arquivo.nome Nome do arquivo. + * @apiParam (Request Body) {String} arquivo.tamanho Tamanho total do arquivo em bytes. + * @apiParam (Request Body) {String} arquivo.hash MD5 do contedo total do arquivo. + * @apiParam (Request Body) {String} arquivo.conteudo Contedo total ou parcial codificado em Base64, mximo de 15MB. + * + * @apiExample Exemplo de requisio: + * endpoint: https:///sei-broker/service/COSAP/arquivos + * + * body: + * { + * "nome":"documentos-sei-broker.pdf", + * "tamanho":"2048", + * "hash":"45F1DEFFB45A5F6C2380A4CEE9B3E452", + * "conteudo":"Contedo total ou parcial do arquivo" + * } + * + * @apiSuccess (Sucesso - 201) {ArquivoCriado} arquivo Objeto de retorno da criao do arquivo + * @apiSuccess (Sucesso - 201) {String} arquivo.identificador Identificador do arquivo criado. + * + * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 201 Created + * { + * "identificador":"123456" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {put} /:unidade/arquivos/:arquivo Adicionar contedo arquivo + * @apiName adicionarConteudoArquivo + * @apiGroup Arquivo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Adiciona contedo a um arquivo criado, o sistema identificar automaticamente quando o contedo foi completado validando o tamanho em bytes + * e o hash do contedo. Quando as condies forem satisfeitas o arquivo ser ativado e poder ser utilizado nas chamadas de incluso de documento. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} arquivo Identificador do arquivo que receber o contedo. + * + * @apiParam (Request Body) {ParteArquivo} parte Objeto representando uma parte do arquivo. + * @apiParam (Request Body) {String} parte.arquivo Identificador do arquivo que receber o contedo. + * @apiParam (Request Body) {String} parte.conteudo Contedo parcial codificado em Base64, mximo de 15MB. + * + * @apiExample Exemplo de requisio: + * endpoint: https:///sei-broker/service/COSAP/arquivos/123456 + * + * body: + * { + * "arquivo":"123456", + * "conteudo":"Contedo parcial do arquivo" + * } + * + * @apiSuccess (Sucesso - 200) {ArquivoCriado} arquivo Objeto de retorno da criao do arquivo + * @apiSuccess (Sucesso - 200) {String} arquivo.identificador Identificador do arquivo criado. + * + * @apiSuccess (Sucesso Response Header - 200) {header} Location URL de acesso ao recurso alterado. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 Created + * { + * "identificador":"123456" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + diff --git a/src/main/resources/apidoc/bloco.apidoc b/src/main/resources/apidoc/bloco.apidoc new file mode 100644 index 0000000..1db16a9 --- /dev/null +++ b/src/main/resources/apidoc/bloco.apidoc @@ -0,0 +1,360 @@ + /** + * @api {get} /:unidade/blocos/:bloco Consultar bloco + * @apiName consultarBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Recupera as informaes do bloco informado. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja consultar + * + * @apiParam (Query Parameters) {String} [protocolos=N] S ou N para exibir os protocolos do bloco + * + * @apiExample {curl} Exemplo de requisio: + * curl -i http:///sei-broker/service/COSAP/blocos/12 + * + * @apiSuccess (Sucesso - 200) {RetornoConsultaBloco} bloco Objeto representando o bloco encontrado + * @apiSuccess (Sucesso - 200) {String} bloco.idBloco Nmero do bloco + * @apiSuccess (Sucesso - 200) {Unidade} bloco.unidade Dados das unidade que gerou o bloco + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.idUnidade Identificador da Unidade + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sigla Sigla da unidade + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.descricao Descrio do unidade + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinProtocolo :TODO pendente + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinArquivamento :TODO pendente + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinOuvidoria :TODO pendente + * @apiSuccess (Sucesso - 200) {Usuario} bloco.usuario Dados das unidade que gerou o bloco + * @apiSuccess (Sucesso - 200) {String} bloco.usuario.idUsuario Identificador do surio + * @apiSuccess (Sucesso - 200) {String} bloco.usuario.sigla Sigla do usurio + * @apiSuccess (Sucesso - 200) {String} bloco.usuario.nome Nome do usurio + * @apiSuccess (Sucesso - 200) {String} bloco.descricao Descrio do bloco + * @apiSuccess (Sucesso - 200) {String} bloco.tipo Tipo do bloco (A=Assinatura, R=Reunio ou I=Interno) + * @apiSuccess (Sucesso - 200) {String} bloco.estado Estado do bloco (A=Aberto, D=Disponibilizado, R=Retornado ou C=Concludo) + * @apiSuccess (Sucesso - 200) {Unidade[]} bloco.unidadesDisponibilizacao Dados das unidades configuradas para disponibilizao (ver estrutura Unidade) + * @apiSuccess (Sucesso - 200) {ProtocoloBloco[]} bloco.protocolos Processos ou documentos do bloco + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.protocoloFormatado Nmero de protocolo formatado + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.identificacao :TODO pendente + * @apiSuccess (Sucesso - 200) {Assinatura[]} bloco.protocolos.assinaturas Conjunto de assinaturas dos documentos. Ser um conjunto vazio caso no existam informaes ou se o protocolo representa um processo + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.nome Nome do assinante + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.cargoFuncao Cargo ou funo utilizado no momento da assinatura + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.dataHora Data/hora em que ocorreu a assinatura + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idUsuario Identificador do usurio + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idOrigem :TODO pendente + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idOrgao :TODO pendente + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.sigla Login do usurio responsvel pela assinatura + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/blocos/disponibilizados Disponibilizar bloco + * @apiName disponibilizarBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Disponibiliza um determinado bloco. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Request Body) {String} bloco Numero do bloco que deseja disponibilizar + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] http:///sei-broker/service/COSAP/blocos/disponibilizados + * + * body: + * 12 + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /:unidade/blocos/disponibilizados/12 Indisponibilizar bloco + * @apiName cancelarDisponibilizacaoBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Cancela a disponibilizao de blocos. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja indisponibilizar + * + * @apiExample Exemplo de requisio: + * curl -X DELETE http:///sei-broker/service/COSAP/blocos/disponibilizados/12 + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /:unidade/blocos/:bloco Excluir bloco + * @apiName excluirBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Exclui um bloco criado. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja excluir + * + * @apiExample Exemplo de requisio: + * curl -X DELETE http:///sei-broker/service/COSAP/blocos/12 + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/blocos Gerar bloco + * @apiName gerarBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Gera um novo bloco. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Request Body) {NovoBloco} novoBloco Objeto de criao de bloco + * @apiParam (Request Body) {String="ASSINATURA","INTERNO","REUNIAO"} novoBloco.tipo Tipo do bloco a ser criado + * @apiParam (Request Body) {String} novoBloco.descricao Descrio do bloco + * @apiParam (Request Body) {String[]} novoBloco.unidades Cdigos das unidades onde o bloco deve ser disponibilizado, ou vazio para no disponibilizar + * @apiParam (Request Body) {String[]} novoBloco.documentos Cdigo dos documentos que sero includos no bloco + * @apiParam (Request Body) {Boolean} novoBloco.disponibilizar=false Informa se o bloco criado deve ser disponibilizado automaticamente + * + * @apiExample Exemplo de requisio: + * endpoint: http:///sei-broker/service/COSAP/blocos + * + * body: + * { + * "tipo":"ASSINATURA", + * "descricao":"Bloco demonstrativo.", + * "unidades":["110000935"], + * "documentos":["0000131"], + * "disponibilizar":true + * } + * + * @apiSuccess (Sucesso Response Body - 201) {String} resultado Cdigo do bloco criado + * + * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {POST} /:unidade/blocos/:bloco/documentos Incluir documento + * @apiName incluirDocumentoNoBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Inclui um documento no bloco. + * + * @apiParam (Header Parameters) {String} Content-Type Informar text/plain + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} bloco Nmero do bloco onde o documento ser includo + * + * @apiParam (Request Body) {String} documento Nmero do documento que ser includo do bloco + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] http:///sei-broker/service/COSAP/blocos/12/documentos + * + * body: + * 0000050 + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {POST} /:unidade/blocos/:bloco/documentos Incluir documento anotado + * @apiName incluirDocumentoComAnotacaoNoBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Inclui um documento no bloco. + * + * @apiParam (Header Parameters) {String} Content-Type Informar application/json + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} bloco Nmero do bloco onde o documento ser includo + * + * @apiParam (Request Body) {InclusaoDocumentoBloco} inclusao Objeto com os dados do documento a ser includo + * @apiParam (Request Body) {String} bloco Nmero do bloco onde o documento ser inserido + * @apiParam (Request Body) {String} documento Nmero do documento + * @apiParam (Request Body) {String} [anotacao] Texto de anotao associado com o documento no bloco + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] http:///sei-broker/service/COSAP/blocos/12/documentos + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /:unidade/:bloco/documentos/:documento Remover documento + * @apiName retirarDocumentoDoBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Remove o documento do bloco. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o documento ser retirado + * @apiParam (Path Parameters) {String} documento Numero do documento que ser retirado do bloco + * + * @apiExample Exemplo de requisio: + * curl -X DELETE http:///sei-broker/service/COSAP/blocos/12/documentos/0000050 + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/blocos/:bloco/processos Incluir processo + * @apiName incluirProcessoNoBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Inclui um processo no bloco. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo ser includo + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * + * @apiParam (Request Body) {String} processo Numero do processo que ser includo no bloco + * + * @apiExample Exemplo de requisio: + * curl -X PUT http:///sei-broker/service/COSAP/blocos/12/processos + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/blocos/:bloco/processos Incluir processo anotado + * @apiName incluirProcessoComAnotacaoNoBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Inclui um processo no bloco, junto com uma anotao. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo ser includo + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * + * @apiParam (Request Body) {InclusaoProcessoBloco} inclusao Objeto com os dados do processo a ser includo + * @apiParam (Request Body) {String} bloco Nmero do bloco onde o processo ser inserido + * @apiParam (Request Body) {String} processo Nmero do processo + * @apiParam (Request Body) {String} [anotacao] Texto de anotao associado com o processo no bloco + * + * @apiExample Exemplo de requisio: + * curl -X PUT http:///sei-broker/service/COSAP/blocos/12/processos + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /:unidade/blocos/:bloco/processos/:processo Remover processo + * @apiName retirarProcessoDoBloco + * @apiGroup Bloco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Este mtodo remove o processo do bloco. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o processo ser retirado + * @apiParam (Path Parameters) {String} processo Numero do processo que ser retirado do bloco + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * + * @apiExample Exemplo de requisio: + * curl -X DELETE http:///sei-broker/service/COSAP/blocos/12/processos/33910000029201653 + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ diff --git a/src/main/resources/apidoc/cargo.apidoc b/src/main/resources/apidoc/cargo.apidoc new file mode 100644 index 0000000..506794f --- /dev/null +++ b/src/main/resources/apidoc/cargo.apidoc @@ -0,0 +1,30 @@ + /** + * @api {get} /:unidade/cargos Listar cargos + * @apiName listarCargos + * @apiGroup Cargo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Lista os cargos. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Query Parameters) {String} [idCargo] Identificador do cargo + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/COSAP/cargos + * + * @apiSuccess (Sucesso - 200) {Cargo[]} resultado Lista com os cargos encontrados + * @apiSuccess (Sucesso - 200) {String} resultado.idCargo Identificador do cargo no SEI + * @apiSuccess (Sucesso - 200) {String} resultado.expressaoCargo Descrio do cargo (Ex.: Governador) + * @apiSuccess (Sucesso - 200) {String} resultado.expressaoTratamento Tratamento para o cargo (Ex.: A Sua Excelncia o Senhor) + * @apiSuccess (Sucesso - 200) {String} resultado.expressaoVocativo Vocativo para o cargo (Ex.: Senhor Governador) + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/contato.apidoc b/src/main/resources/apidoc/contato.apidoc new file mode 100644 index 0000000..1d473b9 --- /dev/null +++ b/src/main/resources/apidoc/contato.apidoc @@ -0,0 +1,361 @@ + /** + * @api {get} /:unidade/contatos/tipos Tipos de contato + * @apiName listarTipos + * @apiGroup Contato + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta os tipos de contato. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/cosap/contatos/tipos + * + * @apiSuccess (Sucesso - 200) {TipoContato[]} resultado Lista com os tipos de contato, representados por uma Enum TipoContato. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/contatos/:tipo Listar contatos + * @apiName listarContatos + * @apiGroup Contato + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta os contatos de determinado tipo, o retorno pode ser PessoaFisica ou PessoaJuridica recomendado utilizar a ans-commons-sei. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} tipo Tipo do contato + * + * @apiParam (Query Parameters) {String} [nome] Nome do contato + * @apiParam (Query Parameters) {String} [cpf] CPF do contato + * @apiParam (Query Parameters) {String} [cnpj] CNPJ do contato + * @apiParam (Query Parameters) {String} [sigla] Sigla(login) do contato + * @apiParam (Query Parameters) {String} [matricula] Matricula do contato + * @apiParam (Query Parameters) {String} [qtdRegistros = 1] Quantidade de contatos que sero exibidos + * @apiParam (Query Parameters) {String} [pagina = 1] Nmero da pgina + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/cosap/contatos/operadoras?qtdRegistros=20 + * + * @apiSuccess (Sucesso - 200) {List} resultado Lista com os contatos encontrados. + * @apiSuccess (Sucesso - 200) {Pessoa} resultado.pessoa Pessoa que representa o contato. + * @apiSuccess (Sucesso - 200) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa. + * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.nome Nome do contato. + * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.sigla Sigla(login) do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.celular] Celular do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observaes sobre o contato. + * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situao do contato. + * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereo do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Nmero do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Cdigo do IBGE da cidade. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.uf] Sigla do estado. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] Pas do endereo. + * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurdica a qual o contato est associado. + * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado. + * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgo emissor do RG, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Nmero de registro do OAB, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "@type": "Juridica", + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFCIOS LTDA", + * "endereco": { + * "logradouro": "RUA CAPITO MEDEIROS DE REZENDE 274", + * "complemento": "Teste de complemento", + * "numero": null, + * "uf": "MG", + * "pais": "Brasil", + * "cidade": "3101508", + * "bairro": "PRAA DA BANDEIRA", + * "cep": "36660000" + * }, + * "email": "teste@email.com", + * "celular": "(32)982538993", + * "telefone": "(32)34624649", + * "observacao": "Observado via SEI-Broker", + * "ativo": true, + * "associado": null, + * "cnpj": "19541931000125", + * "website": "sitiodopicapauamarelo.com.br" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/contatos/:tipo/:sigla Consultar contato + * @apiName getContato + * @apiGroup Contato + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta contato pela sigla(login) + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} tipo Tipo do contato + * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/cosap/contatos/operadoras/419761 + * + * @apiSuccess (Sucesso - 200) {Pessoa} resultado.pessoa Pessoa que representa o contato. + * @apiSuccess (Sucesso - 200) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa. + * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.nome Nome do contato. + * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.sigla Sigla(login) do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.celular] Celular do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observaes sobre o contato. + * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situao do contato. + * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereo do contato. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Nmero do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereo. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Cdigo do IBGE da cidade. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.uf] Sigla do estado. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] Pas do endereo. + * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurdica a qual o contato est associado. + * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado. + * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgo emissor do RG, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Nmero de registro do OAB, presente em contatos do tipo PessoaFisica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica. + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "@type": "Juridica", + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFCIOS LTDA", + * "sigla": "419761", + * "endereco": { + * "logradouro": "RUA CAPITO MEDEIROS DE REZENDE 274", + * "complemento": "Teste de complemento", + * "numero": null, + * "uf": "MG", + * "pais": "Brasil", + * "cidade": "3101508", + * "bairro": "PRAA DA BANDEIRA", + * "cep": "36660000" + * }, + * "email": "teste@email.com", + * "celular": "(32)982538993", + * "telefone": "(32)34624649", + * "observacao": "Observado via SEI-Broker", + * "ativo": true, + * "associado": null, + * "cnpj": "19541931000125", + * "website": "sitiodopicapauamarelo.com.br" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/contatos/:tipo Incluir contato + * @apiName criarContato + * @apiGroup Contato + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Incluir contato + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} tipo Tipo do contato + * + * @apiParam (Request Body) {Pessoa} resultado.pessoa Pessoa que representa o contato. + * @apiParam (Request Body) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa. + * @apiParam (Request Body) {String} resultado.pessoa.nome Nome do contato. + * @apiParam (Request Body) {String} resultado.pessoa.sigla Sigla(login) do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.celular] Celular do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observaes sobre o contato. + * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situao do contato. + * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereo do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Nmero do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Cdigo do IBGE da cidade. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.uf] Sigla do estado. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] Pas do endereo. + * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurdica a qual o contato est associado. + * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica. + * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado. + * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgo emissor do RG, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Nmero de registro do OAB, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica. + * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica. + * + * @apiExample Exemplo de requisio: + * endpoint: http:///sei-broker/service/cosap/contatos/operadoras + * + * body: + * { + * "@type": "Juridica", + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFCIOS LTDA", + * "sigla": "419761", + * "endereco": { + * "logradouro": "RUA CAPITO MEDEIROS DE REZENDE 274", + * "complemento": "Teste de complemento", + * "numero": null, + * "uf": "MG", + * "pais": "Brasil", + * "cidade": "3101508", + * "bairro": "PRAA DA BANDEIRA", + * "cep": "36660000" + * }, + * "email": "teste@email.com", + * "celular": "(32)982538993", + * "telefone": "(32)34624649", + * "observacao": "Observado via SEI-Broker", + * "ativo": true, + * "associado": null, + * "cnpj": "19541931000125", + * "website": "sitiodopicapauamarelo.com.br" + * } + * + * @apiSuccess (Criado - 201) {header} Location URL de acesso ao recurso criado. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {put} /:unidade/contatos/:tipo/:sigla Atualizar contato + * @apiName atualizarContato + * @apiGroup Contato + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Atualizar contato + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} tipo Tipo do contato + * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato + * + * @apiParam (Request Body) {Pessoa} resultado.pessoa Pessoa que representa o contato. + * @apiParam (Request Body) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa. + * @apiParam (Request Body) {String} resultado.pessoa.nome Nome do contato. + * @apiParam (Request Body) {String} resultado.pessoa.sigla Sigla(login) do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.celular] Celular do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observaes sobre o contato. + * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situao do contato. + * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereo do contato. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Nmero do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereo. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Cdigo do IBGE da cidade. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.uf] Sigla do estado. + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] Pas do endereo. + * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurdica a qual o contato est associado. + * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica. + * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado. + * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgo emissor do RG, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Nmero de registro do OAB, presente em contatos do tipo PessoaFisica. + * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica. + * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica. + * + * @apiExample Exemplo de requisio: + * endpoint: http:///sei-broker/service/cosap/contatos/operadoras + * + * body: + * { + * "@type": "Juridica", + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFCIOS LTDA", + * "sigla": "419761", + * "endereco": { + * "logradouro": "RUA CAPITO MEDEIROS DE REZENDE 274", + * "complemento": "Teste de complemento", + * "numero": null, + * "uf": "MG", + * "pais": "Brasil", + * "cidade": "3101508", + * "bairro": "PRAA DA BANDEIRA", + * "cep": "36660000" + * }, + * "email": "teste@email.com", + * "celular": "(32)982538993", + * "telefone": "(32)34624649", + * "observacao": "Observado via SEI-Broker", + * "ativo": true, + * "associado": null, + * "cnpj": "19541931000125", + * "website": "sitiodopicapauamarelo.com.br" + * } + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/documento.apidoc b/src/main/resources/apidoc/documento.apidoc new file mode 100644 index 0000000..28a4e5b --- /dev/null +++ b/src/main/resources/apidoc/documento.apidoc @@ -0,0 +1,379 @@ + /** + * @api {get} /:unidade/documentos/:documento Consultar documento + * @apiName consultarDocumento + * @apiGroup Documento + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta documento cadastrado no SEI. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informaes + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [andamento = N] exibir o andamento do processo + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [assinaturas = N] exibir as assinaturas presentes no documento + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [publicacao = N] exibir detalhes da publicao + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [campos = N] exibir campos do formulrio + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/COSAP/documentos/0000050?assinaturas=S&andamento=S + * + * @apiSuccess (Sucesso - 200) {RetornoConsultaDocumento} retornoConsultaDocumento Informaes do documento encontrado no SEI + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.idProcedimento Id interno do processo no SEI + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.procedimentoFormatado Nmero do processo visvel para o usurio + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.idDocumento Id interno do documento no SEI + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.documentoFormatado Nmero do documento visvel para o usurio + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.linkAcesso Link para acesso ao documento + * @apiSuccess (Sucesso - 200) {Serie} retornoConsultaDocumento.serie Dados do tipo do documento + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.idSerie Identificador do tipo de documento + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.nome Nome do tipo de documento + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.aplicabilidade :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.numero Nmero do documento + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.data Data de gerao para documentos internos e para documentos externos a data informada na tela de cadastro + * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.unidadeElaboradora Dados da unidade que gerou o documento + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.descricao Nome da unidade + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.idUnidade Cdigo da unidade + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sigla Sigla da unidade + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinProtocolo :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinArquivamento :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinOuvidoria :TODO pendente + * @apiSuccess (Sucesso - 200) {Andamento} retornoConsultaDocumento.andamentoGeracao Informaes do andamento de gerao (opcional) + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idAndamento Identificador do andamento + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefa :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefaModulo :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.descricao Descrio do andamento + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.dataHora Data e hora do registro de andamento + * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.andamentoGeracao.unidade Unidade responsvel pelo andamento (ver estrutura Unidade) + * @apiSuccess (Sucesso - 200) {Usuario} retornoConsultaDocumento.andamentoGeracao.usuario Usurio responsvel pela ao + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.idUsuario Cdigo do usurio + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.nome Nome do usurio + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.sigla Login do usurio + * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} retornoConsultaDocumento.andamentoGeracao.atributos Lista com os atributos relacionados ao andamento + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.nome Nome do atributo + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.valor Valor do atributo + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.idOrigem :TODO pendente + * @apiSuccess (Sucesso - 200) {Assinatura[]} retornoConsultaDocumento.assinaturas Conjunto de assinaturas do documento + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.nome Nome do assinante + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.cargoFuncao Cargo ou funo utilizado no momento da assinatura + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.dataHora Data/hora em que ocorreu a assinatura + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idUsuario Identificador do usurio + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idOrigem :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idOrgao :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.sigla Login do usurio responsvel pela assinatura + * @apiSuccess (Sucesso - 200) {Publicacao} retornoConsultaDocumento.publicacao :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.nomeVeiculo :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.numero :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.dataDisponibilizacao :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.dataPublicacao :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.estado :TODO pendente + * @apiSuccess (Sucesso - 200) {PublicacaoImprensaNacional} retornoConsultaDocumento.publicacao.imprensaNacional :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.siglaVeiculo :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.descricaoVeiculo :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.pagina :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.secao :TODO pendente + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.data :TODO pendente + * @apiSuccess (Sucesso - 200) {Campo[]} retornoConsultaDocumento.campos Conjunto de campos do formulrio + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.nome Nome do campo + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.valor Valor do campo + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "idProcedimento":"52", + * "procedimentoFormatado":"16.0.000000005-5", + * "idDocumento":"152", + * "documentoFormatado":"0000123", + * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=procedimento_trabalhar&id_procedimento=52&id_documento=152", + * "serie":{ + * "idSerie":"12", + * "nome":"Memorando" + * }, + * "numero":"6", + * "data":"05/04/2016", + * "unidadeElaboradora":{ + * "idUnidade":"110000934", + * "sigla":"COSAP", + * "descricao":"Coordenadoria de Sistemas e Aplicativos" + * }, + * "andamentoGeracao":null, + * "assinaturas":[], + * "publicacao":null, + * "campos":[] + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/documentos Incluir documento + * @apiName incluirDocumento + * @apiGroup Documento + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Inclui um documento no SEI, podem ser includos documentos internos e externos, para documentos externo o tamanho mximo 20MB. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Query Parameters) {String} [template] Identificador do template que ser utilizado na transformao do conteudo para HTML, o template precisa ser previamente cadastrado no templates-broker. (Este atributo exige que o atributo conteudo seja enviado em formato JSon e codificado em Base64) + * + * @apiParam (Request Body) {String = "G (Gerado)","R (Recebido)"} tipo Tipo de documento + * @apiParam (Request Body) {String} idSerie Identificador do tipo de documento no SEI (Consultar servio Listar Sries) + * @apiParam (Request Body) {String} idProcedimento Identificador do processo onde o documento deve ser inserido. Opcional se protocoloProcedimento informado + * @apiParam (Request Body) {String} [protocoloProcedimento] Nmero do processo onde o documento deve ser inserido, visvel para o usurio. Opcional se IdProcedimento informado. + * @apiParam (Request Body) {String} [idTipoConferencia] Identificador do tipo de conferncia associada com o documento externo + * @apiParam (Request Body) {String{50}} [numero] Nmero do documento, passar null para documentos gerados com numerao controlada pelo SEI.Para documentos externos informar o nmero ou nome complementar a ser exibido na rvore de documentos do processo (o SEI no controla numerao de documentos externos). + * @apiParam (Request Body) {String} [data] Data do documento (dd/MM/yyyy), obrigatrio para documentos externos. Passar null para documentos gerados. + * @apiParam (Request Body) {String} [descricao] Descrio do documento para documentos gerados. Passar null para documentos externos + * @apiParam (Request Body) {Remetente} [remetente] Obrigatrio para documentos externos, passar null para documentos gerados. + * @apiParam (Request Body) {String} [remetente.nome] Nome do remetente + * @apiParam (Request Body) {String} [remetente.sigla] Login do remetente + * @apiParam (Request Body) {Interessado[]} [interessados] Informar um conjunto com os dados de interessados. Se no existirem interessados deve ser informado um conjunto vazio + * @apiParam (Request Body) {String} [interessados.nome] Nome do interessado + * @apiParam (Request Body) {String} [interessados.sigla] Login do interessado + * @apiParam (Request Body) {Destinatario[]} [destinatarios] Informar um conjunto com os dados de destinatrios. Se no existirem destinatrios deve ser informado um conjunto vazio + * @apiParam (Request Body) {String} [destinatarios.nome] Nome do destinatrio + * @apiParam (Request Body) {String} [destinatarios.sigla] Login do destinatrio + * @apiParam (Request Body) {String} [observacao] Texto da observao da unidade, passar null se no existir + * @apiParam (Request Body) {String{200}} [nomeArquivo] Nome do arquivo, obrigatrio para documentos externos. Passar null para documentos gerados. + * @apiParam (Request Body) {String} conteudo Contedo do arquivo codificado em Base64. Para documentos gerados ser o contedo da seo principal do editor HTML e para documentos externos ser o contedo do anexo. Para documentos com template cadastrado, enviar Base64 do JSon referente ao contedo a ser preenchido no template. + * @apiParam (Request Body) {String = "0 (pblico)","1 (restrito)", "2 (sigiloso)", "null (herda do tipo de processo)"} [nivelAcesso] Nvel de acesso do documento + * @apiParam (Request Body) {String} [idHipoteseLegal] Identificador da hiptese legal associada + * @apiParam (Request Body) {String} [idArquivo] Identificador do arquivo enviado pelo servio de Incluir Arquivo + * @apiParam (Request Body) {String = "S (Sim)","N (No)"} [sinBloqueado] Bloquear o documento, no permite exclu-lo ou alterar seu contedo + * @apiParam (Request Body) {Campo} [campos] Conjunto de campos associados com o formulrio + * @apiParam (Request Body) {String} [campos.nome] Nome do campo + * @apiParam (Request Body) {String} [campos.valor] Valor do campo + * + * @apiExample Exemplo de requisio: + * endpoint: https:///sei-broker/service/COSAP/documentos + * + * body: + * { + * "tipo":"G", + * "idProcedimento":"33910000173201771", + * "protocoloProcedimento":null, + * "idSerie":null, + * "numero":null, + * "data":null, + * "descricao":"Documento demonstrativo", + * "remetente":null, + * "interessados":[{"sigla":"andre.guimaraes","nome":"Andr Lus Fernandes Guimares"}], + * "destinatarios":[], + * "observacao":null, + * "nomeArquivo":null, + * "conteudo":"Contedo Base64", + * "nivelAcesso":"0" + * } + * + * @apiSuccess (Sucesso Response Body - 201) {String} idDocumento nmero interno do documento + * @apiSuccess (Sucesso Response Body - 201) {String} documentoFormatado nmero do documento visvel para o usurio + * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso link para acesso ao documento + * + * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 201 Created + * { + * "idDocumento":"1140000000872", + * "documentoFormatado":"0003934", + * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=arvore_visualizar&acao_origem=procedimento_visualizar&id_procedimento=267&id_documento=1017&sta_editor=I&infra_sistema=100000100&infra_unidade_atual=110000934&infra_hash=3d798777382d6ac455317f3a87ad9bd1f9650315e019ef922f388b829902a95b" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/documentos/cancelados Cancelar documento + * @apiName cancelarDocumento + * @apiGroup Documento + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Cancela um documento. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Request Body) {String} documento Numero do documento que ser cancelado + * @apiParam (Request Body) {String} motivo Motivo do cancelamento + * + * @apiExample Exemplo de requisio: + * endpoint: https:///sei-broker/service/COSAP/documentos/cancelados + * + * body: + * { + * "documento":"0000050", + * "motivo":"Motivo do cancelamento." + * } + * + * + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/documentos/enviados-broker Listar documentos enviados + * @apiName consultarDocumentosIncluidosBroker + * @apiGroup Documento + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta documentos inclusos pelo SEI-Broker. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Query Parameters) {String} [hash] Hash SHA-256 gerado a partir do contedo enviado ao Broker + * @apiParam (Query Parameters) {String} [processo] Nmero do processo onde o documento foi inserido + * @apiParam (Query Parameters) {String} [numeroInformado] Nmero informado na incluso do documento, exibido na rvore do processo. + * @apiParam (Query Parameters) {String} [pagina=1] Nmero da pgina + * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que sero exibidos por pgina + * + * @apiExample Exemplo de requisio: + * curl -i https:///sei-broker/service/COSAP/documentos/enviados-broker?pagina=1&qtdRegsitros=30 + * + * @apiSuccess (Sucesso Response Body - 200) {InclusaoDocumento} resultado Objeto com dados sobre o documento + * @apiSuccess (Sucesso Response Body - 200) {Date} resultado.data Data do envio (padro ISO-8601) + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.hash Hash SHA-256 gerado a partir do contedo enviado ao Broker + * @apiSuccess (Sucesso Response Body - 200) {Integer} resultado.id Identificao da incluso de documento + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.nome Nome do documento includo + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numero Nmero retonado pelo SEI, NULL caso tenha ocorrido algum problema. + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.processo Nmero do processo + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.sistema Sistema responsvel pela incluso + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.unidade Unidade onde foi includo o documento + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numeroInformado Valor opcional informado na incluso do documento + * + * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "id": 1717, + * "data": "2016-10-31T11:59:56.016+0000", + * "nome": "Doc Homologao.pdf", + * "numero": "0003312", + * "hash": "ca7ebe0c37419db14ffd4f09485a1ebed8e8deeed594e15720da185ee32e9d19", + * "sistema": "desenv_integracao_sei", + * "unidade": "COAI", + * "processo": "33910000097201612", + * "numeroInformado":"2016ans45875" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/documentos/:documento Exportar documento + * @apiName exportarDocumento + * @apiGroup Documento + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Exporta documentos do SEI em PDF. + * + * @apiParam (Header Parameters) {String} Accept Utilize application/pdf + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informaes + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/COSIT/documentos/0003322 + * + * @apiSuccess (Sucesso - 200) {PDF} binario Arquivo no formato PDF. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /interessados/:interessado/documentos Consultar por interessado + * @apiName consultarDocumentoInteressado + * @apiGroup Documento + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Retorna os documentos de um determinado interessado. + * + * @apiParam (Path Parameters) {String} interessado Identificador do interessado + * + * @apiParam (Query Parameters) {String} [tipo] Tipo/Srie do documento + * @apiParam (Query Parameters) {boolean} [somenteAssinados=false] Exibir somente documentos assinados + * @apiParam (Query Parameters) {boolean} [orderByProcesso=false] Ordenar pelo nmero do processo, por padro o retorno ordenado pela dataGeracao + * @apiParam (Query Parameters) {boolean} [crescente=false] Ordenar em ordem crescente + * @apiParam (Query Parameters) {String} [pagina=1] Nmero da pgina + * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por pgina + * + * @apiExample Exemplo de requisio: + * curl -i https:///sei-broker/service/interessados/005711/documentos + * + * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados. + * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentos.documentoResumido Resumo do documento encontrado no SEI. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Nmero do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numeroInformado Nmero informado na incluso do documento, tambm conhecido como nmero de rvore. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.unidade Unidade responsvel pelo documento. + * @apiSuccess (Sucesso Response Body - 200) {String="GERADO","RECEBIDO"} documentos.documentoResumido.origem Origem do documento, se o mesmo um documento "GERADO" internamente ou "RECEBIDO" de uma fonte externa. + * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de gerao do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.processo Processo onde o documento est includo. + * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentos.documentoResumido.tipo Objeto representando o tipo do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, tambm conhecido como srie. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.nome Nome do tipo do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferncia do documento. + * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado. + * + * @apiSuccess (Sucesso Response Header - 200) {header} total_registros Quantidade de registros que existem para essa consulta + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "numero": "0670949", + * "numeroInformado": "594", + * "unidade": "COSAP", + * "origem": "RECEBIDO", + * "dataGeracao": "2015-08-10T00:00:00-03:00", + * "processo": "33910.000002/2017-41", + * "tipo": { + * "codigo": "629", + * "nome": "Relatrio de Arquivamento-SIF" + * } + * "tipoConferencia": "4", + * "assinado": true + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + diff --git a/src/main/resources/apidoc/extensao.apidoc b/src/main/resources/apidoc/extensao.apidoc new file mode 100644 index 0000000..a36ccab --- /dev/null +++ b/src/main/resources/apidoc/extensao.apidoc @@ -0,0 +1,29 @@ + /** + * @api {get} /:unidade/extensoes Listar extenses + * @apiName listarExtensoesPermitidas + * @apiGroup Extensao + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Este mtodo realiza uma busca pelas extenses de arquivos permitidas. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * + * @apiParam (Query Parameters) {String} [extensao=null] Para filtrar por uma determinada extenso. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i http:///sei-broker/service/COSAP/extensoes/ + * + * @apiSuccess (Sucesso - 200) {ArquivoExtensao[]} extensoes Lista de extenses permitidas. + * @apiSuccess (Sucesso - 200) {String} extensoes.idArquivoExtensao Identificador interno do SEI relativo a extenso + * @apiSuccess (Sucesso - 200) {String} extensoes.extensao Texto da extenso (ex.: pdf, ods, doc, ppt,...) + * @apiSuccess (Sucesso - 200) {String} extensoes.descricao Descrio da extenso + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/hipoteseLegal.apidoc b/src/main/resources/apidoc/hipoteseLegal.apidoc new file mode 100644 index 0000000..7484735 --- /dev/null +++ b/src/main/resources/apidoc/hipoteseLegal.apidoc @@ -0,0 +1,30 @@ + /** + * @api {get} /:unidade/hipoteses-legais Listar hipteses legais + * @apiName listarHipoteses + * @apiGroup Hipotese Legal + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Lista as hipteses legais. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Query Parameters) {String} [nivelAcesso] Filtra hipteses pelo nvel de acesso associado (1 - restrito, 2 - sigiloso) + * + * @apiExample Exemplo de requisio: + * curl -i https:///sei-broker/service/COSAP/hipoteses-legais + * + * @apiSuccess (Sucesso - 200) {HipoteseLegal[]} resultado Lista com as hipteses legais encontrados + * @apiSuccess (Sucesso - 200) {String} resultado.idHipoteseLegal Identificador da hiptese legal no SEI + * @apiSuccess (Sucesso - 200) {String} resultado.nome Nome da hiptese legal + * @apiSuccess (Sucesso - 200) {String} resultado.baseLegal Descrio da base legal + * @apiSuccess (Sucesso - 200) {String} resultado.nivelAcesso Nivel de acesso associado a hiptese legal + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/info.apidoc b/src/main/resources/apidoc/info.apidoc new file mode 100644 index 0000000..9f2afef --- /dev/null +++ b/src/main/resources/apidoc/info.apidoc @@ -0,0 +1,110 @@ + /** + * @api {get} /info/versao Consultar verso + * @apiName getNumeroVersao + * @apiGroup Info + * @apiVersion 2.0.0 + * + * @apiDescription Este mtodo realiza uma consulta para saber a verso do sei-broker que est disponvel. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i http:///sei-broker/service/info/versao + * + * @apiSuccess {String} versao Nmero da verso. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /info/conexoes/mysql Testar conexo MySQL + * @apiName testMySQLConnection + * @apiGroup Info + * @apiVersion 2.0.0 + * + * @apiDescription Testa a conexo com o MySQL e retorna o nmero de verso do banco. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i http:///sei-broker/service/info/conexoes/mysql + * + * @apiSuccess {String} versao Nmero de verso do MySQL. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /info/conexoes/oracle Testar conexo Oracle + * @apiName testOracleConnection + * @apiGroup Info + * @apiVersion 2.0.0 + * + * @apiDescription Testa a conexo com o Oracle e retorna o nmero de verso do banco. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i http:///sei-broker/service/info/conexoes/oracle + * + * @apiSuccess {String} versao Nmero de verso do Oracle. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /info/conexoes/sei Testar conexo SEI + * @apiName testSEIConnection + * @apiGroup Info + * @apiVersion 2.0.0 + * + * @apiDescription Testa a conexo com o SEI fazendo uma consulta ao servio listar unidades. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i http:///sei-broker/service/info/conexoes/sei + * + * @apiSuccess {String} mensagem Mensagem de sucesso. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /info/requests Listar Requests + * @apiName getUltimosRequests + * @apiGroup Info + * @apiVersion 2.0.0 + * + * @apiDescription Lista os requests recebidos pelo broker. + * + * + * @apiParam (Query Parameters) {String} [operacao] nome do mtodo acessado + * @apiParam (Query Parameters) {String} [origem] usurio que originou a requisio + * @apiParam (Query Parameters) {int} [pag=1] nmero da pgina + * @apiParam (Query Parameters) {int} [itens=50] quantidade de itens listados por pgina + * + * @apiExample {curl} Exemplo de requisio: + * curl -i http:///sei-broker/service/info/requests + * + * @apiSuccess {String} mensagem Mensagem de sucesso. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/infra.apidoc b/src/main/resources/apidoc/infra.apidoc new file mode 100644 index 0000000..44048bc --- /dev/null +++ b/src/main/resources/apidoc/infra.apidoc @@ -0,0 +1,206 @@ + /** + * @api {get} /:unidade/paises Listar pases + * @apiName getPaises + * @apiGroup Endereco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta pases cadastrados. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/cosap/paises + * + * @apiSuccess (Sucesso - 200) {List} resultado Lista com os pases. + * @apiSuccess (Sucesso - 200) {Pais} resultado.pais Objeto representando o pas. + * @apiSuccess (Sucesso - 200) {String} resultado.pais.idPais Identificador do pas no SEI. + * @apiSuccess (Sucesso - 200) {String} resultado.pais.nome Nome do pas. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "idPais": "4", + * "nome": "Afeganisto" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/estados Listar estados + * @apiName getEstados + * @apiGroup Endereco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta estados cadastrados. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/cosap/estados + * + * @apiSuccess (Sucesso - 200) {List} resultado Lista com os estados. + * @apiSuccess (Sucesso - 200) {Estado} resultado.estado Objeto representando um estado. + * @apiSuccess (Sucesso - 200) {String} resultado.estado.idEstado Identificador do estado no SEI. + * @apiSuccess (Sucesso - 200) {String} resultado.estado.idPais Identificador do pas no SEI. + * @apiSuccess (Sucesso - 200) {String} resultado.estado.sigla Sigla do estado. + * @apiSuccess (Sucesso - 200) {String} resultado.estado.nome Nome do estado. + * @apiSuccess (Sucesso - 200) {String} resultado.estado.codigoIbge Cdigo do IBGE. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "idEstado": "2", + * "idPais": "76", + * "sigla": "AC", + * "nome": "Acre", + * "codigoIbge": "12" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/estados Consultar estado + * @apiName getEstado + * @apiGroup Endereco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta o estado pela sigla. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} sigla Sigla do estado + * + * @apiParam (Query Parameters) {String} [pais="76 (Brasil)"] Identificador do pais que deseja listar os estados. + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/cosap/estados/AC + * + * @apiSuccess (Sucesso - 200) {Estado} estado Objeto representando um estado. + * @apiSuccess (Sucesso - 200) {String} estado.idEstado Identificador do estado no SEI. + * @apiSuccess (Sucesso - 200) {String} estado.idPais Identificador do pas no SEI. + * @apiSuccess (Sucesso - 200) {String} estado.sigla Sigla do estado. + * @apiSuccess (Sucesso - 200) {String} estado.nome Nome do estado. + * @apiSuccess (Sucesso - 200) {String} estado.codigoIbge Cdigo do IBGE. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "idEstado": "2", + * "idPais": "76", + * "sigla": "AC", + * "nome": "Acre", + * "codigoIbge": "12" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/estados/:estado/cidades Listar cidades + * @apiName getCidades + * @apiGroup Endereco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta as cidades de um determinado estado. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} estado Sigla do estado. + * + * @apiParam (Query Parameters) {String} [filtro] String utilizada para filtrar as cidades. + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/cosap/estados/rj/cidades?filtro=paraiba + * + * @apiSuccess (Sucesso - 200) {List} resultado Lista com os cidades encontradas. + * @apiSuccess (Sucesso - 200) {Cidade} resultado.cidade Objeto representando uma cidade. + * @apiSuccess (Sucesso - 200) {String} resultado.cidade.nome Nome da cidade. + * @apiSuccess (Sucesso - 200) {String} resultado.cidade.codigoIbge Cdigo do IBGE. + * @apiSuccess (Sucesso - 200) {Estado} resultado.cidade.estado Objeto representando um estado. + * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.nome Nome do estado. + * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.sigla Sigla do estado. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "estado": { + * "sigla": "RJ", + * "nome": "Rio de Janeiro" + * }, + * "nome": "Paraba do Sul", + * "codigoIbge": "3303708" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/estados/:estado/cidades/:cidade Consultar cidade + * @apiName getCidade + * @apiGroup Endereco + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta a cidade pelo cdigo do IBGE. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} estado Sigla do estado. + * @apiParam (Path Parameters) {String} cidade Cdigo do IBGE. + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/cosap/estados/rj/cidades/3303708 + * + * @apiSuccess (Sucesso - 200) {Cidade} cidade Objeto representando uma cidade. + * @apiSuccess (Sucesso - 200) {String} cidade.nome Nome da cidade. + * @apiSuccess (Sucesso - 200) {String} cidade.codigoIbge Cdigo do IBGE. + * @apiSuccess (Sucesso - 200) {Estado} cidade.estado Objeto representando um estado. + * @apiSuccess (Sucesso - 200) {String} cidade.estado.nome Nome do estado. + * @apiSuccess (Sucesso - 200) {String} cidade.estado.sigla Sigla do estado. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "estado": { + * "sigla": "RJ", + * "nome": "Rio de Janeiro" + * }, + * "nome": "Paraba do Sul", + * "codigoIbge": "3303708" + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/marcador.apidoc b/src/main/resources/apidoc/marcador.apidoc new file mode 100644 index 0000000..8dc7854 --- /dev/null +++ b/src/main/resources/apidoc/marcador.apidoc @@ -0,0 +1,60 @@ + /** + * @api {get} /:unidade/marcadores Listar marcadores + * @apiName listarMarcadores + * @apiGroup Marcador + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Lista os marcadores de uma unidade. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/cosap/marcadores + * + * @apiSuccess (Sucesso - 200) {Marcador[]} marcadores Lista de marcadores + * @apiSuccess (Sucesso - 200) {String} marcadores.id Identificador do marcador. + * @apiSuccess (Sucesso - 200) {String} marcadores.nome Nome do marcador. + * @apiSuccess (Sucesso - 200) {String} marcadores.icone cone do marcador em formato PNG codificado em Base64. + * @apiSuccess (Sucesso - 200) {String} marcadores.sinAtivo S/N - Sinalizador indica se o marcador est ativo. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/marcadores/:identificador/processos Adicionar Processo + * @apiName marcarProcesso + * @apiGroup Marcador + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Adiciona um processo ao marcador. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} identificador Identificador do marcador no SEI. + * + * @apiParam (Request Body) {MarcacaoProcesso} marcacaoProcesso Objeto de com as definies da marcao. + * @apiParam (Request Body) {String} marcacaoProcesso.processo Nmero do processo no SEI. + * @apiParam (Request Body) {String} marcacaoProcesso.texto Texto para associao. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/cosap/marcadores/3/processos + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 201 Created + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + diff --git a/src/main/resources/apidoc/processo.apidoc b/src/main/resources/apidoc/processo.apidoc new file mode 100644 index 0000000..9b98c6e --- /dev/null +++ b/src/main/resources/apidoc/processo.apidoc @@ -0,0 +1,906 @@ + /** + * @api {get} /:unidade/processos/:processo Consultar processo + * @apiName consultarProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Este mtodo realiza uma consulta a processos no SEI e no SIPAR. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} processo Nmero do processo que deseja consultar + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [assuntos=N] Exibir assuntos do processo + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [interessados=N] Exibir interessados no processo + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [observacoes=N] Exibir observaes feitas no processo + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [andamento=N] Exibir andamento do processo + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [andamento-conclusao=N] Exibir o andamento da concluso do processo + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [ultimo-andamento=N] Exibir o ltimo andamento dado ao processo + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [unidades=N] Exibir unidades onde o processo est aberto + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [relacionados=N] Exibir processos relacionados + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [anexados=N] Exibir processos anexados + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/COSAP/processos/33910000029201653 + * + * @apiSuccess (Sucesso - 200) {ResultadoConsultaProcesso} resultadoConsultaProcesso Objeto de retorno da consulta aos processos, pode um conter processo do SEI ou do SIPAR + * @apiSuccess (Sucesso - 200) {RetornoConsultaProcedimento} resultadoConsultaProcesso.sei Resultado de processo do SEI + * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoConclusao Andamento da concluso do processo (opcional) + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.andamentoConclusao.dataHora Data e hora do registro de andamento + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.descricao Descrio do andamento + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoConclusao.unidade Unidade responsvel pelo andamento + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.descricao Nome da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.idUnidade Cdigo da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.sigla Sigla da unidade + * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoConclusao.usuario Usurio responsvel pela ao + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.idUsuario Cdigo do usurio + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.nome Nome do usurio + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.sigla Login do usurio + * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoGeracao Andamento da gerao do processo (opcional) + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.andamentoGeracao.dataHora Data e hora do registro de andamento + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.descricao Descrio do andamento + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoGeracao.unidade Unidade responsvel pelo andamento + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.descricao Nome da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.idUnidade Cdigo da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.sigla Sigla da unidade + * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoGeracao.usuario Usurio responsvel pela ao + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.idUsuario Cdigo do usurio + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.nome Nome do usurio + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.sigla Login do usurio + * @apiSuccess (Sucesso - 200) {Assunto} resultadoConsultaProcesso.sei.assuntos Lista de assuntos + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.assuntos.codigoEstruturado Cdigo do assunto + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.descricao Descrio do assunto + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.dataAutuacao Data de autuao do processo + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.especificacao Especificao do processo + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI + * @apiSuccess (Sucesso - 200) {Interessado} resultadoConsultaProcesso.sei.interessados Lista de interessados no processo (opcional) + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.nome Nome do interessado + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.sigla Login do interessado + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.linkAcesso Link para acesso ao processo + * @apiSuccess (Sucesso - 200) {Observacao} resultadoConsultaProcesso.sei.observacoes Observaes feitas sobre o processo (opcional) + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.descricao Descrio da obsevao + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.observacoes.unidade Unidade responsvel pela observao + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.descricao Nome da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.idUnidade Cdigo da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.sigla Sigla da unidade + * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosAnexados Lista com os processos anexados + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.idProcedimento Identificador do processo + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.procedimentoFormatado Nmero do processo visvel para o usurio + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.tipoProcedimento Tipo do processo + * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosRelacionados Lista com os processos relacionados + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.idProcedimento Identificador do processo + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.procedimentoFormatado Nmero do processo visvel para o usurio + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.tipoProcedimento Tipo do processo + * + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentoFormatado Nmero do processo visvel para o usurio + * @apiSuccess (Sucesso - 200) {TipoProcedimento} resultadoConsultaProcesso.sei.tipoProcedimento Tipo de procedimento + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.idTipoProcedimento Identificador do tipo de procedimento + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.nome Nome do tipo de procedimento + * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.ultimoAndamento Ultimo andamento do processo (opcional) + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.ultimoAndamento.dataHora Data e hora do registro de andamento + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.descricao Descrio do andamento + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.ultimoAndamento.unidade Unidade responsvel pelo andamento + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.descricao Nome da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.idUnidade Cdigo da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.sigla Sigla da unidade + * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.ultimoAndamento.usuario Usurio responsvel pela ao + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.idUsuario Cdigo do usurio + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.nome Nome do usurio + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.sigla Login do usurio + * @apiSuccess (Sucesso - 200) {UnidadeProcedimentoAberto} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto Unidades onde o processo est aberto (opcional) + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade Unidade onde o processo est aberto + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.descricao Nome da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.idUnidade Cdigo da unidade + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.sigla Sigla da unidade + * + * @apiSuccess (Sucesso - 200) {DocumentoSIPAR} resultadoConsultaProcesso.sipar Resultado de processo do SIPAR + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.digito Digito do processo + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.operadora Operadora relacionada ao processo + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.emissao Data de emisso + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.registro Data de registro + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.tipo Tipo do processo + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.resumo Resumo sobre o processo + * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoPosse Cdigo do orgo que tem a posse do processo + * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoOrigem Cdigo do orgo de origem do processo + * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoRegistro Cdigo do orgo de registro do processo + * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.assunto Cdigo do assunto + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/processos/concluidos Concluir processo + * @apiName concluirProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Conclui o processo informado. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * + * @apiParam (Request Body) {String} processo Numero do processo a ser concludo + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] https:///sei-broker/service/COSAP/processos/concluidos + * + * body: + * 33910000029201653 + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/processos/enviados Enviar processo + * @apiName enviarProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Envia processos a outras unidades. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. Representa a unidade de localizao atual do processo. + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [reabir=N] Reabrir automaticamente caso esteja concludo na unidade + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * + * @apiParam (Request Body) {String} processo Numero do processo a ser enviado. Em caso de processo apensado, o processo a ser enviado deve ser o processo PAI. No possvel tramitar atravs do processo FILHO. + * @apiParam (Request Body) {String[]} unidadesDestino Lista com os identificadores das unidades de destino do processo, cdigo ou nome da unidade. + * @apiParam (Request Body) {Boolean} manterAbertoOrigem=false Informa se o processo deve continuar aberto na unidade de origem . + * @apiParam (Request Body) {Boolean} removerAnotacoes=false Informa se as anotaes do processo devem ser removidas. + * @apiParam (Request Body) {Boolean} enviarEmailNotificacao=false Informa se deve ser enviado um e-mail de notificao. + * @apiParam (Request Body) {Date} dataRetornoProgramado=null Data para retorno programado do processo a unidade (padro ISO-8601). + * @apiParam (Request Body) {Integer} qtdDiasAteRetorno=null Quantidade de dias at o retorno do processo. + * @apiParam (Request Body) {Boolean} somenteDiasUteis=false Informa se s sero contabilizados dias teis. + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] https:///sei-broker/service/COSAP/processos/enviados + * + * body: + * { + * "numeroDoProcesso":"1600000000098", + * "unidadesDestino":["110000934","110000934"], + * "manterAbertoOrigem":false, + * "removerAnotacoes":false, + * "enviarEmailNotificacao":true, + * "dataRetornoProgramado":2016-04-14T19:39:22.292+0000, + * "qtdDiasAteRetorno":5, + * "somenteDiasUteis":true} + * } + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /:unidade/processos/concluidos/:processo Reabrir processo + * @apiName reabrirProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Reabre um processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} processo Numero do processo a ser reaberto + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * + * @apiExample Exemplo de requisio: + * curl -X DELETE https:///sei-broker/service/COSAP/processos/concluidos/33910000029201653 + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/processos/tipos Tipos de processo + * @apiName listarTiposProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta os tipos de processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiParam (Query Parameters) {String} [serie] Tipo do documento cadastrado no servio + * + * @apiExample Exemplo de requisio: + * curl -i https:///sei-broker/service/COSAP/processos/tipos + * + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/processos Abrir processo + * @apiName abrirProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Abre um processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * + * @apiParam (Request Body) {NovoProcesso} novoProcesso Objeto de representao de novo processo. + * @apiParam (Request Body) {Procedimento} novoProcesso.dadosProcesso Dados do processo. + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.idTipoProcedimento Identificador do tipo de processo no SEI (Consultar tipos de processo). + * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.numeroProtocolo] Nmero do processo, se no for informado o sistema ir gerar um novo nmero automaticamente. + * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.dataAutuacao] Data de autuao do processo, se no for informada o sistema utilizar a data atual. + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.especificacao Especificao do processo. + * @apiParam (Request Body) {Assunto[]} [novoProcesso.dadosProcesso.assuntos] Assuntos do processo, os assuntos informados sero adicionados aos assuntos sugeridos para o tipo de processo. Passar um array vazio caso nenhum outro assunto seja necessrio(caso apenas os sugeridos para o tipo bastem para classificao). + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.codigoEstruturado Cdigo do assunto + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.descricao Descrio do assunto + * @apiParam (Request Body) {Interessado[]} [novoProcesso.dadosProcesso.interessados] Informar um conjunto com os dados de interessados. Se no existirem interessados deve ser informado um conjunto vazio. + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.interessados.nome Nome do interessado + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.interessados.sigla Login do interessado + * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.observacao] Texto da observao, passar null se no existir. + * @apiParam (Request Body) {String = "0 (pblico)","1 (restrito)", "2 (sigiloso)", "null (herda do tipo do processo)"} [novoProcesso.dadosProcesso.nivelAcesso] Nvel de acesso do processo. + * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.idHipoteseLegal] Identificador da hiptese legal associada. * + * @apiParam (Request Body) {Documento[]} [novoProcesso.documentos] Informar os documentos que devem ser gerados em conjunto com o processo (ver servio de incluir documento para instrues de preenchimento). Se nenhum documento for gerado informar um conjunto vazio. + * @apiParam (Request Body) {String[]} [novoProcesso.processosRelacionados] Lista com os identificadores dos processos(idProcedimento) que devem ser relacionados automaticamente com o novo processo, ateno, no passar o nmero do processo formatado. + * @apiParam (Request Body) {String[]} [novoProcesso.unidadesDestino] Lista com os identificadores das unidades de destino do processo, cdigo ou nome da unidade. + * @apiParam (Request Body) {Boolean} [novoProcesso.manterAbertoOrigem=false] Indica se o processo deve ser mantido aberto na unidade de origem. + * @apiParam (Request Body) {Boolean} [novoProcesso.enviarEmailNotificacao=false] Indica se deve ser enviado email de aviso para as unidades destinatrias. + * @apiParam (Request Body) {Date} [novoProcesso.dataRetornoProgramado] Data para definio de Retorno Programado. + * @apiParam (Request Body) {Integer} [novoProcesso.qtdDiasAteRetorno] Nmero de dias para o Retorno Programado. + * @apiParam (Request Body) {Boolean} [novoProcesso.somenteDiasUteis=false] Indica se o valor passado no parmetro qtdDiasAteRetorno corresponde a dias teis ou no. + * @apiParam (Request Body) {String} [novoProcesso.idMarcador] Identificador de um marcador da unidade para associao. + * @apiParam (Request Body) {String} [novoProcesso.textoMarcador] Texto do marcador. + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] https:///sei-broker/service/COSAP/processos + * + * body: + * { + * "dadosProcesso":{ + * "idTipoProcedimento":"100000375", + * "especificacao":"Documentao REST", + * "assuntos":[], + * "interessados":[{"sigla":"andre.guimaraes","nome":"Andr Lus Fernandes Guimares"}], + * "observacao":"Exemplo de requisio", + * "nivelAcesso":0 + * }, + * "documentos":[], + * "processosRelacionados":["186649"], + * "unidadesDestino":["COTEC","110000935","COSAP"], + * "manterAbertoOrigem":true, + * "enviarEmailNotificacao":true, + * "qtdDiasAteRetorno":null, + * "somenteDiasUteis":false + * } + * + * @apiSuccess (Sucesso Response Body - 201) {String} idProcedimento Nmero do processo gerado + * @apiSuccess (Sucesso Response Body - 201) {String} procedimentoFormatado Nmero formatado do processo gerado + * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso Link de acesso ao processo + * @apiSuccess (Sucesso Response Body - 201) {RetornoInclusaoDocumento} retornoInclusaoDocumentos Retorno dos documentos inseridos no processo (opcional) + * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.idDocumento Nmero interno do documento + * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.documentoFormatado Nmero do documento visvel para o usurio + * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.linkAcesso Link para acesso ao documento + * + * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "idProcedimento":"33910000056201626", + * "procedimentoFormatado":"33910.000056/2016-26", + * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=arvore_visualizar&acao_origem=procedimento_visualizar&id_procedimento=267&infra_sistema=100000100&infra_unidade_atual=110000934&infra_hash=7a6a75f6b8ec6b43aaffc6616159a85e35e444b9b32da54108e467bc9f3bdfab", + * "retornoInclusaoDocumentos":[] + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /processos Listar processos + * @apiName consultarProcessos + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Lista os processos conforme os filtros informados. + * + * @apiParam (Query Parameters) {Boolean} [crescente=false] Ordenar em ordem crescente, processos mais antigos primeiro + * @apiParam (Query Parameters) {String} [interessado] Identificador do interessado + * @apiParam (Query Parameters) {String} [unidade] Unidade da qual deseja filtrar os processos + * @apiParam (Query Parameters) {String} [pagina=1] Nmero da pgina + * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por pgina + * @apiParam (Query Parameters) {String} [tipo] Identificador do tipo de processo que deseja filtrar + * + * @apiExample Exemplo de requisio: + * curl -i https:///sei-broker/service/processos + * + * @apiSuccess (Sucesso Response Body - 200) {List} processos Lista com os processos encontrados + * @apiSuccess (Sucesso Response Body - 200) {ProcessoResumido} processos.processoResumido Resumo do processo encontrado no SEI + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numero Nmero do processo + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numeroFormatado Nmero do processo formatado + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.descricao Descrio do processo + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.unidade Unidade responsvel pelo processo + * @apiSuccess (Sucesso Response Body - 200) {Data} processos.processoResumido.dataGeracao Data de gerao do processo + * @apiSuccess (Sucesso Response Body - 200) {Tipo} processos.processoResumido.tipo Objeto com os dados do tipo de processo + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.codigo Cdigo do tipo + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.nome Nome do tipo + * + * @apiSuccess (Sucesso Response Header - 200) {header} total_registros quantidade de registros que existem para essa consulta. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "numero": "33910007118201710", + * "numeroFormatado": "33910.007118/2017-10", + * "descricao": "D:2237021 - SUL AMRICA SEGURO SADE S/A", + * "unidade": "NCLEO-RJ", + * "dataGeracao": "2017-10-09T03:00:00.000+0000", + * "tipo": { + * "codigo": "100000882", + * "nome": "Fiscalizao: Sancionador" + * } + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/processos/:processo/andamentos Listar andamentos + * @apiName listarAndamentos + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Lista as andamentos do processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * + * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [exibir-atributos="N"] Sinalizador para retorno dos atributos associados. + * @apiParam (Query Parameters) {String[]} [andamento] Filtra andamentos pelos identificadores informados. + * @apiParam (Query Parameters) {String[]} [tarefa="1,48,65"] Filtra andamentos pelos identificadores de tarefas informados (consultar lista de tarefas). + * @apiParam (Query Parameters) {String[]} [tarefa-modulo] Filtra andamentos pelos identificadores de tarefas de mdulo informados. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/cosap/processos/33910003114201754/andamentos + * + * @apiSuccess (Sucesso - 200) {Andamento[]} andamentos Lista dos andamentos do processo. + * @apiSuccess (Sucesso - 200) {String} andamentos.idAndamento Identificador do andamento. + * @apiSuccess (Sucesso - 200) {String} andamentos.idTarefa Identificador da tarefa. + * @apiSuccess (Sucesso - 200) {String} andamentos.descricao Descrio do andamento. + * @apiSuccess (Sucesso - 200) {String} andamentos.dataHora Data e hora do andamento. + * @apiSuccess (Sucesso - 200) {Unidade} andamentos.unidade Unidade onde o andamento ocorreu. + * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.idUnidade Identificador da unidade. + * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.sigla Sigla da unidade. + * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.descricao Descrio da unidade. + * @apiSuccess (Sucesso - 200) {Usuario} andamentos.usuario Usurio responsvel pelo andamento. + * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.idUsuario Identificador do usurio. + * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.sigla Login do usurio. + * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.nome Nome do usurio. + * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} andamentos.atributos Lista com os atributos relacionados ao andamento. + * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.nome Nome do atributo. + * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.valor Valor do atributo. + * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.idOrigem Identificador de origem do atributo. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/processos/:processo/andamentos Lanar andamento + * @apiName lancarAndamento + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Lana um andamento ao processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * + * @apiParam (Request Body) {NovoAndamento} novoAndamento Objeto representando o novo andamento. + * @apiParam (Request Body) {String} novoAndamento.tarefa Identificador da tarefa a qual o andamento se refere (consultar lista de tarefas). + * @apiParam (Request Body) {String} [novoAndamento.tarefaModulo] Identificadoe da tarefa mdulo a qual o andamento se refere. + * @apiParam (Request Body) {HashMap} novoAndamento.atributos Mapa chave-valor, identificando como sero preenchidos os atributos da tarefa. + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] https:///sei-broker/service/COSAP/processos/33910003114201754/andamentos + * + * body: + * { + * "tarefa":"65", + * "atributos":{"DESCRICAO":"Novo andamento adicionado pelo SEI-Broker"} + * } + * + * @apiSuccess (Sucesso - 201) {Andamento} andamento Andamento criado. + * @apiSuccess (Sucesso - 201) {String} andamento.idAndamento Identificador do andamento. + * @apiSuccess (Sucesso - 201) {String} andamento.idTarefa Identificador da tarefa. + * @apiSuccess (Sucesso - 201) {String} andamento.descricao Descrio do andamento. + * @apiSuccess (Sucesso - 201) {String} andamento.dataHora Data e hora do andamento. + * @apiSuccess (Sucesso - 201) {Unidade} andamento.unidade Unidade onde o andamento ocorreu. + * @apiSuccess (Sucesso - 201) {String} andamento.unidade.idUnidade Identificador da unidade. + * @apiSuccess (Sucesso - 201) {String} andamento.unidade.sigla Sigla da unidade. + * @apiSuccess (Sucesso - 201) {String} andamento.unidade.descricao Descrio da unidade. + * @apiSuccess (Sucesso - 201) {Usuario} andamento.usuario Usurio responsvel pelo andamento. + * @apiSuccess (Sucesso - 201) {String} andamento.usuario.idUsuario Identificador do usurio. + * @apiSuccess (Sucesso - 201) {String} andamento.usuario.sigla Login do usurio. + * @apiSuccess (Sucesso - 201) {String} andamento.usuario.nome Nome do usurio. + * @apiSuccess (Sucesso - 201) {AtributoAndamento[]} andamento.atributos Lista com os atributos relacionados ao andamento. + * @apiSuccess (Sucesso - 201) {String} andamento.atributos.nome Nome do atributo. + * @apiSuccess (Sucesso - 201) {String} andamento.atributos.valor Valor do atributo. + * @apiSuccess (Sucesso - 201) {String} andamento.atributos.idOrigem Identificador de origem do atributo. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/processos/:processo/anexados Anexar processo + * @apiName anexarProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Anexar um processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * + * @apiParam (Request Body) {ProcessoAnexado} processoAnexado Objeto representando o processo a ser anexado. + * @apiParam (Request Body) {String} processoAnexado.numero Nmero do processo a ser anexado. + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] https:///sei-broker/service/COSAP/processos/33910003114201754/anexados + * + * body: + * { + * "numero":"33910003093201777" + * } + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /:unidade/processos/:processo/anexados/:processoAnexado Desanexar processo + * @apiName desanexarProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Remove um processo anexado. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @apiParam (Path Parameters) {String} processo Nmero do processo anexado. + * + * @apiExample Exemplo de requisio: + * curl -X DELETE https:///sei-broker/service/COSAP/processos/33910003114201754/anexados/33910003093201777 + * + * @apiParam (Request Body) {Motivo} motivo Objeto com o motivo. + * @apiParam (Request Body) {String} motivo.motivo Descrio do motivo para remoo do processo em anexo. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/processos/bloqueados Bloquear processo + * @apiName bloquearProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Bloquear um processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * + * @apiParam (Request Body) {ProcessoBloqueado} processoBloqueado Objeto com o nmero do processo a ser bloqueado. + * @apiParam (Request Body) {String} processoBloqueado.numero Nmero do processo a ser bloqueado. + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] https:///sei-broker/service/COSAP/processos/bloqueados + * + * body: + * { + * "numero":"33910003093201777" + * } + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /:unidade/processos/bloqueados/:processo Desbloquear processo + * @apiName desbloquearProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Desbloquear um processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * + * @apiExample Exemplo de requisio: + * endpoint: [DELETE] https:///sei-broker/service/COSAP/processos/bloqueados/33910003093201777 + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/processos/:processo/relacionados Relacionar processo + * @apiName relacionarProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Relacionar processos. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * + * @apiParam (Request Body) {ProcessoRelacionado} processoRelacionado Objeto com o nmero do processo a ser relacionado. + * @apiParam (Request Body) {String} processoRelacionado.numero Nmero do processo a ser relacionado. + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] https:///sei-broker/service/COSAP/processos/33910003093201777/relacionados + * + * body: + * { + * "numero":"33910000086201632" + * } + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /:unidade/processos/:processo/relacionados/:processoRelacionado Desrelacionar processo + * @apiName desrelacionarProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Desrelacionar processos. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @apiParam (Path Parameters) {String} processoRelacionado Nmero do processo relacionado. + * + * @apiExample Exemplo de requisio: + * endpoint: [DELETE] https:///sei-broker/service/COSAP/processos/33910000086201632/relacionados/33910003107201752 + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/processos/sobrestados Sobrestar processo + * @apiName sobrestarProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Sobrestar processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * + * @apiParam (Request Body) {SobrestamentoProcesso} sobrestamento Objeto com o motivo do sobrestamento. + * @apiParam (Request Body) {String} sobrestamento.processo Nmero do processo a ser sobrestado. + * @apiParam (Request Body) {String} sobrestamento.motivo Motivo do sobrestamento. + * @apiParam (Request Body) {String} [sobrestamento.processoVinculado] Nmero do processo vinculado. + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] https:///sei-broker/service/COSAP/processos/sobrestados + * + * body: + * { + * "processo":"33910003093201777", + * "motivo":"Sobrestando atravs da camada de servios." + * } + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /:unidade/processos/sobrestados/:processo Remover sobrestamento + * @apiName removerSobrestamentoProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Remover sobrestamento de processo. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * + * @apiExample Exemplo de requisio: + * endpoint: [DELETE] https:///sei-broker/service/COSAP/processos/sobrestados/33910003093201777 + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /processos/:processo/documentos Listar documentos + * @apiName listarDocumentosPorProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Retorna os documentos de um determinado processo. + * + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * + * @apiParam (Query Parameters) {String} [tipo=null] Identificador do tipo do documento, caso seja necessrio filtrar pelo tipo + * @apiParam (Query Parameters) {String = "G (gerado/interno), R (recebido/externo)"} [origem=null] Filtra os documentos por gerados ou recebidos + * @apiParam (Query Parameters) {boolean} [somenteAssinados=false] Exibir somente documentos assinados + * @apiParam (Query Parameters) {String} [numeroInformado] Filtrar pelo nmero informado + * @apiParam (Query Parameters) {String} [pagina=1] Nmero da pgina + * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que sero exibidos por pgina + * + * @apiExample Exemplo de requisio: + * curl -i https:///sei-broker/service/processos/33910003149201793/documentos + * + * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados. + * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentos.documentoResumido Resumo do documento encontrado no SEI. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Nmero do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numeroInformado Nmero informado na incluso do documento, tambm conhecido como nmero de rvore. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.nome Nome do arquivo que foi enviado para o SEI. (Somente para documentos cujo a origem "RECEBIDO", tambm conhecidos como documentos externos) + * @apiSuccess (Sucesso Response Body - 200) {String="GERADO","RECEBIDO"} documentos.documentoResumido.origem Origem do documento, se o mesmo um documento "GERADO" internamente ou "RECEBIDO" de uma fonte externa. + * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de gerao do documento. + * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentos.documentoResumido.tipo Objeto representando o tipo do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, tambm conhecido como srie. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.nome Nome do tipo do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferncia do documento. + * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado. + * + * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "numero": "0670949", + * "numeroInformado": "594", + * "origem": "RECEBIDO", + * "dataGeracao": "2015-08-10T00:00:00-03:00", + * "tipo": { + * "codigo": "629", + * "nome": "Relatrio de Arquivamento-SIF" + * } + * "tipoConferencia": "4", + * "assinado": true + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /processos/:processo/documentos/:documento Consultar documento + * @apiName consultarDocumentoDoProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta um documento de determinado processo. + * + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @apiParam (Path Parameters) {String} documento Nmero do documento. + * + * @apiExample Exemplo de requisio: + * curl -i https:///sei-broker/service/processos/33910002924201874/documentos/55737058 + * + * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentoResumido Resumo do documento encontrado no SEI. + * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numero Nmero do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numeroInformado Nmero informado na incluso do documento, tambm conhecido como nmero de rvore. + * @apiSuccess (Sucesso Response Body - 200) {String="GERADO","RECEBIDO"} documentoResumido.origem Origem do documento, se o mesmo um documento "GERADO" internamente ou "RECEBIDO" de uma fonte externa. + * @apiSuccess (Sucesso Response Body - 200) {Data} documentoResumido.dataGeracao Data de gerao do documento. + * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentoResumido.tipo Objeto representando o tipo do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipo.codigo Identificados do tipo do documento, tambm conhecido como srie. + * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipo.nome Nome do tipo do documento. + * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipoConferencia Tipo de conferncia do documento. + * @apiSuccess (Sucesso Response Body - 200) {boolean} documentoResumido.assinado Boolean indicando se o documento foi assinado. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * { + * "numero": "0670949", + * "numeroInformado": "594", + * "origem": "RECEBIDO", + * "dataGeracao": "2015-08-10T00:00:00-03:00", + * "tipo": { + * "codigo": "629", + * "nome": "Relatrio de Arquivamento-SIF" + * } + * "tipoConferencia": "4", + * "assinado": true + * } + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /processos/:processo/unidades Consultar unidades + * @apiName consultarUnidadesProcesso + * @apiGroup Processo + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Consulta as unidades onde o processo est aberto. + * + * @apiParam (Path Parameters) {String} processo Nmero do processo. + * + * @apiExample Exemplo de requisio: + * curl -i https:///sei-broker/service/processos/33910002924201874/unidades + * + * @apiSuccess (Sucesso Response Body - 200) {List} unidades Lista da unidades onde o processo est aberto. + * @apiSuccess (Sucesso Response Body - 200) {Unidade} unidades.unidade Objeto Unidade. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.idUnidade Identificador da unidade. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sigla Sigla de unidade. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.descricao Descrio da unidade. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinProtocolo Descrio pendente da rea de negcio. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinArquivamento Descrio pendente da rea de negcio. + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinOuvidoria Descrio pendente da rea de negcio. + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 200 OK + * [ + * { + * "idUnidade": "110000934", + * "sigla": "COSAP", + * "descricao": "Coordenadoria de Sistemas e Aplicativos", + * "sinProtocolo": "S", + * "sinArquivamento": "N", + * "sinOuvidoria": "N" + * } + * ] + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/serie.apidoc b/src/main/resources/apidoc/serie.apidoc new file mode 100644 index 0000000..b2028c9 --- /dev/null +++ b/src/main/resources/apidoc/serie.apidoc @@ -0,0 +1,61 @@ + /** + * @api {get} /:unidade/series Listar sries + * @apiName listarSeries + * @apiGroup Serie + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Este mtodo realiza uma consulta s sries. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * + * @apiParam (Query Parameters) {String} [filtro] Para filtrar por series que contenham o trecho no nome. + * @apiParam (Query Parameters) {String} [tipo-processo=null] Para filtrar por determinado tipo de processo. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/COSAP/series + * + * @apiSuccess (Sucesso - 200) {Serie[]} series Lista de sries. + * @apiSuccess (Sucesso - 200) {String} series.idSerie Identificador do tipo de documento + * @apiSuccess (Sucesso - 200) {String} series.nome Nome do tipo de documento + * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulrios + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /:unidade/tipos-documentos Listar tipos documentos + * @apiName listarTiposDocumentos + * @apiGroup Documento + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Lista os tipos de documentos do SEI. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * + * @apiParam (Query Parameters) {String} [filtro] Para filtrar por documentos que contenham o trecho no nome. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/COSAP/tipos-documentos + * + * @apiSuccess (Sucesso - 200) {List} tipos Lista com os tipos de documentos + * @apiSuccess (Sucesso - 200) {String} tipos.identificador Identificador do tipo de documento + * @apiSuccess (Sucesso - 200) {String} tipos.nome Nome do tipo de documento + * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulrios + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + diff --git a/src/main/resources/apidoc/sipar.apidoc b/src/main/resources/apidoc/sipar.apidoc new file mode 100644 index 0000000..5c0ebaa --- /dev/null +++ b/src/main/resources/apidoc/sipar.apidoc @@ -0,0 +1,83 @@ + /** + * @api {post} /sipar/importados Importar Processo + * @apiName importarProcesso + * @apiGroup SIPAR + * @apiVersion 2.0.0 + * + * @apiDescription Marca um processo fsico (SIPAR) como importado para um processo eletrnico (SEI). + * + * @apiParam (Header Parameters) {String} content-type Informar text/plain + * @apiParam (Request Body) {String} processo Nmero do processo a ser importado + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] http:///sei-broker/service/sipar/importados + * + * body: + * 33902112492200241 + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 201 Created + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + * + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 400 Bad Request + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + * + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 409 Conflict + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /sipar/importados/:processo Cancelar Importao Processo + * @apiName cancelarImportacaoProcesso + * @apiGroup SIPAR + * @apiVersion 2.0.0 + * + * @apiDescription Desmarca um processo fsico (SIPAR) como importado para um processo eletrnico (SEI). + * + * @apiParam (Path Parameter) {String} processo Nmero do processo fsico existente no SIPAR contendo 17 dgitos e iniciado com 33902. Ex. 33902111111111111 + * + * @apiExample {curl} Exemplo de requisio: + * curl -X DELETE http:///sei-broker/service/sipar/importados/33902112492200241 + * + * @apiSuccessExample {json} Success-Response: + * HTTP/1.1 204 No Content + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + * + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 400 Bad Request + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + * + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 404 Not Found + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/tarefa.apidoc b/src/main/resources/apidoc/tarefa.apidoc new file mode 100644 index 0000000..eea9dbd --- /dev/null +++ b/src/main/resources/apidoc/tarefa.apidoc @@ -0,0 +1,32 @@ + /** + * @api {get} /tarefas Listar tarefas + * @apiName listarTarefas + * @apiGroup Tarefa + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Lista os tipos de tarefas existentes no SEI. + * + * @apiParam (Query Parameters) {String} [nome] Filtro para o nome da tarefa. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/tarefas + * + * @apiSuccess (Sucesso - 200) {List} tarefas Lista com as tarefas + * @apiSuccess (Sucesso - 200) {String} tarefas.identificados Identificador da tarefa. + * @apiSuccess (Sucesso - 200) {String} tarefas.nome Nome da tarefa. + * @apiSuccess (Sucesso - 200) {String} tarefas.historicoResumido S/N - Sinalizador indica se a tarefa aparecer no histrico resumido. + * @apiSuccess (Sucesso - 200) {String} tarefas.historicoCompleto S/N - Sinalizador indica se a tarefa aparecer no histrico completo. + * @apiSuccess (Sucesso - 200) {String} tarefas.fecharAndamentosAbertos S/N - Sinalizador indica se a tarefa fecha andamentos abertos. + * @apiSuccess (Sucesso - 200) {String} tarefas.lancarAndamentoFechado S/N - Sinalizador indica que a tarefa encerra o andamento. + * @apiSuccess (Sucesso - 200) {String} tarefas.permiteProcessoFechado S/N - Sinalizador indica se permitida essa tarefa em processo fechado. + * @apiSuccess (Sucesso - 200) {String} tarefas.identicadorTarefaModulo Identificador de tarefa mdulo. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/tipoConferencia.apidoc b/src/main/resources/apidoc/tipoConferencia.apidoc new file mode 100644 index 0000000..8fef2d5 --- /dev/null +++ b/src/main/resources/apidoc/tipoConferencia.apidoc @@ -0,0 +1,26 @@ + /** + * @api {get} /:unidade/tipos-conferencia Listar tipos de conferncia + * @apiName listarTiposConferencia + * @apiGroup Tipos Conferncia + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Lista os tipos de conferncia. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/cosap/tipos-conferencia + * + * @apiSuccess (Sucesso - 200) {TipoConferencia[]} tipos Lista de tipos de conferncia. + * @apiSuccess (Sucesso - 200) {String} tipos.idTipoConferencia Identificador do tipo de conferncia. + * @apiSuccess (Sucesso - 200) {String} tipos.descricao Descrio do tipo de conferncia. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ diff --git a/src/main/resources/apidoc/unidade.apidoc b/src/main/resources/apidoc/unidade.apidoc new file mode 100644 index 0000000..e1144c8 --- /dev/null +++ b/src/main/resources/apidoc/unidade.apidoc @@ -0,0 +1,50 @@ + /** + * @api {get} /unidades Listar unidades + * @apiName listarUnidades + * @apiGroup Unidade + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Retorna as Unidades cadastradas no SEI. + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/unidades/ + * + * @apiSuccess (Sucesso - 200) {Unidade[]} unidades Lista de unidades + * @apiSuccess (Sucesso - 200) {String} unidades.idUnidade Identificador da unidade + * @apiSuccess (Sucesso - 200) {String} unidades.sigla Sigla da unidade + * @apiSuccess (Sucesso - 200) {String} unidades.descricao Descrio da unidade + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} /unidades/{unidade}/codigo Consultar cdigo + * @apiName consultarCodigo + * @apiGroup Unidade + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Retorna o cdigo da Unidade pesquisada. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade que deseja consultar o cdigo + * + * @apiExample {curl} Exemplo de requisio: + * curl -i https:///sei-broker/service/unidades/COSAP/codigo + * + * @apiSuccess (Sucesso - 200) {String} codigo Cdigo da unidade. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ diff --git a/src/main/resources/apidoc/usuario.apidoc b/src/main/resources/apidoc/usuario.apidoc new file mode 100644 index 0000000..a658d0a --- /dev/null +++ b/src/main/resources/apidoc/usuario.apidoc @@ -0,0 +1,224 @@ + /** + * @api {get} /:unidade/usuarios Listar usurios + * @apiName listarUsuarios + * @apiGroup Usuario + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Este mtodo realiza uma consulta aos usurios cadastrados que possuem o perfil "Bsico". + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * + * @apiParam (Query Parameters) {String} [usuario=null] Id do usurio que deseja recuperar as informaes + * + * @apiExample {curl} Exemplo de requisio: + * curl -i http:///sei-broker/service/usuarios/COSAP + * + * @apiSuccess {Usuario[]} usuarios Lista de usurios + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {get} :unidade/usuarios/:usuario Buscar usurio + * @apiName buscarUsuario + * @apiGroup Usuario + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA + * + * @apiDescription Este mtodo realiza a uma busca pelo login do usurio. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. + * @apiParam (Path Parameters) {String} usuario Login do usurio + * + * @apiExample Exemplo de requisio: + * curl -i http:///sei-broker/service/cosap/usuarios/andre.guimaraes + * + * @apiSuccess {Usuario} usuario Informaes do usurio encontrado. + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /:unidade/:usuario/processos Atribuir processo + * @apiName atribuirProcesso + * @apiGroup Usuario + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER + * + * @apiDescription Este mtodo atribui o processo a um usurio. + * + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI + * @apiParam (Path Parameters) {String} usuario Login do usurio a quem deseja atribuir o processo + * + * @apiParam (Request Body) {String} processo Numero do processo a ser atribudo + * @apiParam (Request Body) {String} [reabrir-processo=N] S ou N para reabrir o processo + * + * @apiExample Exemplo de requisio: + * endpoint: [POST] http:///sei-broker/service/COSAP/usuarios/andre.guimaraes/processos + * + * body: + * { + * "processo":"33910000029201653", + * "reabrir":false + * } + * + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /usuarios Incluir usurio + * @apiName incluirUsuario + * @apiGroup Usuario + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER_ADM + * + * @apiDescription Este mtodo realiza a incluso de novos usurios ou alteraraes nos usurios existentes. + * + * @apiParam (Request Body) {String} codigo Cdigo que deseja atribuir ao usurio + * @apiParam (Request Body) {String} nome Nome do usurio + * @apiParam (Request Body) {String} login Login que ser atribudo ao usurio + * + * @apiExample Exemplo de requisio: + * endpoint: http:///sei-broker/service/usuarios + * + * body: + * { + * "codigo":"1234", + * "nome":"Andr Lus Fernandes Guimares", + * "login":"andre.guimaraes" + * } + * + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /usuarios/:login Excluir usurio + * @apiName excluirUsuario + * @apiGroup Usuario + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER_ADM + * + * @apiDescription Este mtodo realiza a excluso de usurios. + * + * @apiParam {String} codigo Cdigo que deseja atribuir ao usurio + * @apiParam {String} nome Nome do usurio + * @apiParam {String} login Login que ser atribudo ao usurio + * + * @apiExample Exemplo de requisio: + * endpoint: [DELETE] http:///sei-broker/service/usuarios/andre.guimaraes + * + * body: + * { + * "codigo":"1234", + * "nome":"Andr Lus Fernandes Guimares", + * "login":"andre.guimaraes" + * } + * + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {delete} /usuarios/ativos Desativar usurio + * @apiName desativarUsuario + * @apiGroup Usuario + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER_ADM + * + * @apiDescription Este mtodo desativa usurios. + * + * @apiParam {String} codigo Cdigo que deseja atribuir ao usurio + * @apiParam {String} nome Nome do usurio + * @apiParam {String} login Login que ser atribudo ao usurio + * + * @apiExample Exemplo de requisio: + * endpoint: [DELETE] http:///sei-broker/service/usuarios/ativos/andre.guimaraes + * + * body: + * { + * "codigo":"1234", + * "nome":"Andr Lus Fernandes Guimares", + * "login":"andre.guimaraes" + * } + * + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + + /** + * @api {post} /usuarios/ativos Ativar usurio + * @apiName ativarUsuario + * @apiGroup Usuario + * @apiVersion 2.0.0 + * + * @apiPermission RO_SEI_BROKER_ADM + * + * @apiDescription Este mtodo reativa usurios. + * + * @apiParam {String} codigo Cdigo que deseja atribuir ao usurio + * @apiParam {String} nome Nome do usurio + * @apiParam {String} login Login que ser atribudo ao usurio + * + * @apiExample Exemplo de requisio: + * endpoint: http:///sei-broker/service/usuarios/ativos + * + * body: + * { + * "codigo":"1234", + * "nome":"Andr Lus Fernandes Guimares", + * "login":"andre.guimaraes" + * } + * + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * + * @apiErrorExample {json} Error-Response: + * HTTP/1.1 500 Internal Server Error + * { + * "error":"Mensagem de erro." + * "code":"cdigo do erro" + * } + */ + -- libgit2 0.21.2