From 15fb41940f09e92aa23cdb5baac4efed973eccd1 Mon Sep 17 00:00:00 2001 From: Filipe Oliveira Date: Wed, 12 Dec 2018 08:44:07 -0200 Subject: [PATCH] Altera charset da documentação da api para UTF-8 --- .classpath | 37 ------------------------------------- .project | 71 ----------------------------------------------------------------------- .tern-project | 14 -------------- README.md | 2 +- apidoc.json | 2 +- src/main/resources/apidoc/arquivo.apidoc | 38 +++++++++++++++++++------------------- src/main/resources/apidoc/bloco.apidoc | 146 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------------------------------------------------------------- src/main/resources/apidoc/cargo.apidoc | 8 ++++---- src/main/resources/apidoc/contato.apidoc | 154 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------------------- src/main/resources/apidoc/documento.apidoc | 210 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------------------------------------------------------------------------------ src/main/resources/apidoc/extensao.apidoc | 18 +++++++++--------- src/main/resources/apidoc/hipoteseLegal.apidoc | 20 ++++++++++---------- src/main/resources/apidoc/info.apidoc | 50 +++++++++++++++++++++++++------------------------- src/main/resources/apidoc/infra.apidoc | 54 +++++++++++++++++++++++++++--------------------------- src/main/resources/apidoc/marcador.apidoc | 18 +++++++++--------- src/main/resources/apidoc/processo.apidoc | 436 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- src/main/resources/apidoc/serie.apidoc | 48 ++++++++---------------------------------------- src/main/resources/apidoc/sipar.apidoc | 26 +++++++++++++------------- src/main/resources/apidoc/tarefa.apidoc | 12 ++++++------ src/main/resources/apidoc/tipoConferencia.apidoc | 16 ++++++++-------- src/main/resources/apidoc/unidade.apidoc | 18 +++++++++--------- src/main/resources/apidoc/usuario.apidoc | 108 ++++++++++++++++++++++++++++++++++++++++++++++++++++++------------------------------------------------------ 22 files changed, 691 insertions(+), 815 deletions(-) delete mode 100644 .classpath delete mode 100644 .project delete mode 100644 .tern-project diff --git a/.classpath b/.classpath deleted file mode 100644 index ab57a43..0000000 --- a/.classpath +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/.project b/.project deleted file mode 100644 index 76535f0..0000000 --- a/.project +++ /dev/null @@ -1,71 +0,0 @@ - - - sei-broker - - - - - - tern.eclipse.ide.core.ternBuilder - - - - - org.eclipse.wst.jsdt.core.javascriptValidator - - - - - org.eclipse.jdt.core.javabuilder - - - - - org.eclipse.wst.common.project.facet.core.builder - - - - - org.jboss.tools.ws.jaxrs.metamodelBuilder - - - - - org.jboss.tools.jst.web.kb.kbbuilder - - - - - org.jboss.tools.cdi.core.cdibuilder - - - - - org.eclipse.wst.validation.validationbuilder - - - - - org.hibernate.eclipse.console.hibernateBuilder - - - - - org.eclipse.m2e.core.maven2Builder - - - - - - org.eclipse.jem.workbench.JavaEMFNature - org.eclipse.wst.common.modulecore.ModuleCoreNature - org.eclipse.jdt.core.javanature - org.eclipse.m2e.core.maven2Nature - org.eclipse.wst.common.project.facet.core.nature - org.eclipse.wst.jsdt.core.jsNature - org.jboss.tools.ws.jaxrs.nature - org.jboss.tools.jst.web.kb.kbnature - org.jboss.tools.cdi.core.cdinature - org.hibernate.eclipse.console.hibernateNature - - diff --git a/.tern-project b/.tern-project deleted file mode 100644 index adf0341..0000000 --- a/.tern-project +++ /dev/null @@ -1,14 +0,0 @@ -{ - "libs": [ - "ecma5", - "browser" - ], - "plugins": { - "guess-types": { - - }, - "angular": { - - } - } -} \ No newline at end of file diff --git a/README.md b/README.md index 4914ac2..4991ccf 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # SEI-Broker - Camada REST de acesso ao SEI O SEI-Broker é uma camada de integração que foi desenvolvida para integrar os sistemas corporativos da ANS e o SEI, Sistema Eletrônico de Informações do TRF 4. Toda essa camada foi criada utilizando o padrão RESTful de serviços web, sua função é facilitar a integração dos sistemas da ANS com o SEI, utilizando um protocolo mais simples, moderno e performático. A adoção do broker nos permite criar uma camada de abstração para evitar que mudanças no SEI afetem as integrações, isso é possível pelo fato do broker utilizar REST e possuir contrato fraco. -O Broker atualmente está na versão 2.9, essa versão é compatível com o SEI 3.0.13. É importante destacar que é necessário atualizar o SEI-Broker a cada atualização do SEI que altere os serviços web. +O Broker atualmente está na versão 2.9.1, essa versão é compatível com o SEI 3.0.13. É importante destacar que é necessário atualizar o SEI-Broker a cada atualização do SEI que altere os serviços web. Alguns serviços adicionais foram desenvolvidos para extrair dados que não são ofertados pelos serviços nativos do SEI, estes serviços fazem acesso a base de dados do SEI e realizam operações apenas de consulta. A escrita de dados continua a ser exclusividade dos serviços nativos, desta forma a integridade e coerência das inserções é mantida. diff --git a/apidoc.json b/apidoc.json index 2ba1821..a50b7f3 100644 --- a/apidoc.json +++ b/apidoc.json @@ -1,6 +1,6 @@ { "name": "sei-broker", - "version": "2.0.0", + "version": "2.9.1", "description": "Documentação da camada de integração ANS X SEI. Essa documentação serve para apoiar aos consumidores da camada de integração, pode ser necessário consultar a documentação oficial do SEI para melhor entendimento do negócio e seus objetos. Mais informações do SEI-Broker veja o artigo wiki.", "title": "Documentação - sei-broker", "url":"https:///sei-broker/service", diff --git a/src/main/resources/apidoc/arquivo.apidoc b/src/main/resources/apidoc/arquivo.apidoc index 161e50e..88c31ab 100644 --- a/src/main/resources/apidoc/arquivo.apidoc +++ b/src/main/resources/apidoc/arquivo.apidoc @@ -6,19 +6,19 @@ * * @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. + * @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 contedo total do arquivo. - * @apiParam (Request Body) {String} arquivo.conteudo Contedo total ou parcial codificado em Base64, mximo de 15MB. + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: https:///sei-broker/service/COSAP/arquivos * * body: @@ -26,10 +26,10 @@ * "nome":"documentos-sei-broker.pdf", * "tamanho":"2048", * "hash":"45F1DEFFB45A5F6C2380A4CEE9B3E452", - * "conteudo":"Contedo total ou parcial do arquivo" + * "conteudo":"Conteúdo total ou parcial do arquivo" * } * - * @apiSuccess (Sucesso - 201) {ArquivoCriado} arquivo Objeto de retorno da criao 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. @@ -44,38 +44,38 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {put} /:unidade/arquivos/:arquivo Adicionar contedo arquivo + * @api {put} /:unidade/arquivos/:arquivo Adicionar conteúdo 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. + * @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 contedo. + * @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 contedo. - * @apiParam (Request Body) {String} parte.conteudo Contedo parcial codificado em Base64, mximo de 15MB. + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: https:///sei-broker/service/COSAP/arquivos/123456 * * body: * { * "arquivo":"123456", - * "conteudo":"Contedo parcial do arquivo" + * "conteudo":"Conteúdo parcial do arquivo" * } * - * @apiSuccess (Sucesso - 200) {ArquivoCriado} arquivo Objeto de retorno da criao 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. @@ -90,7 +90,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ diff --git a/src/main/resources/apidoc/bloco.apidoc b/src/main/resources/apidoc/bloco.apidoc index 1db16a9..b958c74 100644 --- a/src/main/resources/apidoc/bloco.apidoc +++ b/src/main/resources/apidoc/bloco.apidoc @@ -6,50 +6,50 @@ * * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA * - * @apiDescription Recupera as informaes do bloco informado. + * @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 requisio: + * @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 Nmero do bloco + * @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 Descrio do 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 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) {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 Nmero de protocolo formatado + * @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 no existam informaes ou se o protocolo representa um processo + * @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 funo utilizado no momento da assinatura + * @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 usurio + * @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 usurio responsvel pela assinatura + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -67,19 +67,19 @@ * * @apiParam (Request Body) {String} bloco Numero do bloco que deseja disponibilizar * - * @apiExample Exemplo de requisio: + * @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 requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -91,21 +91,21 @@ * * @apiPermission RO_SEI_BROKER * - * @apiDescription Cancela a disponibilizao de blocos. + * @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 requisio: + * @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 requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -122,16 +122,16 @@ * @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: + * @apiExample Exemplo de requisição: * curl -X DELETE http:///sei-broker/service/COSAP/blocos/12 * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -147,14 +147,14 @@ * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI * - * @apiParam (Request Body) {NovoBloco} novoBloco Objeto de criao de bloco + * @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 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) {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 requisio: + * @apiExample Exemplo de requisição: * endpoint: http:///sei-broker/service/COSAP/blocos * * body: @@ -166,7 +166,7 @@ * "disponibilizar":true * } * - * @apiSuccess (Sucesso Response Body - 201) {String} resultado Cdigo do bloco criado + * @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 * @@ -174,7 +174,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -191,23 +191,23 @@ * @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 (Path Parameters) {String} bloco Número do bloco onde o documento será incluído * - * @apiParam (Request Body) {String} documento Nmero do documento que ser includo do bloco + * @apiParam (Request Body) {String} documento Número do documento que será incluído do bloco * - * @apiExample Exemplo de requisio: + * @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 requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -224,21 +224,21 @@ * @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 (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 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 + * @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 requisio: + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -253,19 +253,19 @@ * @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 + * @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: + * @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 requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -280,22 +280,22 @@ * @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 (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído * - * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * @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 includo no bloco + * @apiParam (Request Body) {String} processo Numero do processo que será incluído no bloco * - * @apiExample Exemplo de requisio: + * @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 requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -307,26 +307,26 @@ * * @apiPermission RO_SEI_BROKER * - * @apiDescription Inclui um processo no bloco, junto com uma anotao. + * @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 includo + * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído * - * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [auto-formatacao=S] O broker utilizar a mascara padro para formatar o nmero do processo + * @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 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 + * @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 requisio: + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -338,23 +338,23 @@ * * @apiPermission RO_SEI_BROKER * - * @apiDescription Este mtodo remove o processo do bloco. + * @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 (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 + * @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 requisio: + * @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 requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ diff --git a/src/main/resources/apidoc/cargo.apidoc b/src/main/resources/apidoc/cargo.apidoc index 506794f..fa341d6 100644 --- a/src/main/resources/apidoc/cargo.apidoc +++ b/src/main/resources/apidoc/cargo.apidoc @@ -12,19 +12,19 @@ * * @apiParam (Query Parameters) {String} [idCargo] Identificador do cargo * - * @apiExample Exemplo de requisio: + * @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 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.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":"cdigo do erro" + * "code":"código do erro" * } */ \ No newline at end of file diff --git a/src/main/resources/apidoc/contato.apidoc b/src/main/resources/apidoc/contato.apidoc index 1d473b9..a737396 100644 --- a/src/main/resources/apidoc/contato.apidoc +++ b/src/main/resources/apidoc/contato.apidoc @@ -10,7 +10,7 @@ * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI * - * @apiExample Exemplo de requisio: + * @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. @@ -19,7 +19,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -31,7 +31,7 @@ * * @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. + * @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 @@ -41,10 +41,10 @@ * @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 + * @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 requisio: + * @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. @@ -55,27 +55,27 @@ * @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.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] Pas do endereo. - * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurdica a qual o contato est associado. + * @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] Orgo emissor do RG, 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] Nmero de registro do OAB, 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. * @@ -83,15 +83,15 @@ * HTTP/1.1 200 OK * { * "@type": "Juridica", - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFCIOS LTDA", + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA", * "endereco": { - * "logradouro": "RUA CAPITO MEDEIROS DE REZENDE 274", + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274", * "complemento": "Teste de complemento", * "numero": null, * "uf": "MG", * "pais": "Brasil", * "cidade": "3101508", - * "bairro": "PRAA DA BANDEIRA", + * "bairro": "PRAÇA DA BANDEIRA", * "cep": "36660000" * }, * "email": "teste@email.com", @@ -108,7 +108,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -126,7 +126,7 @@ * @apiParam (Path Parameters) {String} tipo Tipo do contato * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato * - * @apiExample Exemplo de requisio: + * @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. @@ -136,27 +136,27 @@ * @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.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] Pas do endereo. - * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurdica a qual o contato est associado. + * @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] Orgo emissor do RG, 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] Nmero de registro do OAB, 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. * @@ -164,16 +164,16 @@ * HTTP/1.1 200 OK * { * "@type": "Juridica", - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFCIOS LTDA", + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA", * "sigla": "419761", * "endereco": { - * "logradouro": "RUA CAPITO MEDEIROS DE REZENDE 274", + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274", * "complemento": "Teste de complemento", * "numero": null, * "uf": "MG", * "pais": "Brasil", * "cidade": "3101508", - * "bairro": "PRAA DA BANDEIRA", + * "bairro": "PRAÇA DA BANDEIRA", * "cep": "36660000" * }, * "email": "teste@email.com", @@ -190,7 +190,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -214,46 +214,46 @@ * @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.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] Pas do endereo. - * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurdica a qual o contato est associado. + * @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] Orgo emissor do RG, 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] Nmero de registro do OAB, 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 requisio: + * @apiExample Exemplo de requisição: * endpoint: http:///sei-broker/service/cosap/contatos/operadoras * * body: * { * "@type": "Juridica", - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFCIOS LTDA", + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA", * "sigla": "419761", * "endereco": { - * "logradouro": "RUA CAPITO MEDEIROS DE REZENDE 274", + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274", * "complemento": "Teste de complemento", * "numero": null, * "uf": "MG", * "pais": "Brasil", * "cidade": "3101508", - * "bairro": "PRAA DA BANDEIRA", + * "bairro": "PRAÇA DA BANDEIRA", * "cep": "36660000" * }, * "email": "teste@email.com", @@ -272,7 +272,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -297,46 +297,46 @@ * @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.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] Pas do endereo. - * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurdica a qual o contato est associado. + * @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] Orgo emissor do RG, 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] Nmero de registro do OAB, 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 requisio: + * @apiExample Exemplo de requisição: * endpoint: http:///sei-broker/service/cosap/contatos/operadoras * * body: * { * "@type": "Juridica", - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFCIOS LTDA", + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA", * "sigla": "419761", * "endereco": { - * "logradouro": "RUA CAPITO MEDEIROS DE REZENDE 274", + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274", * "complemento": "Teste de complemento", * "numero": null, * "uf": "MG", * "pais": "Brasil", * "cidade": "3101508", - * "bairro": "PRAA DA BANDEIRA", + * "bairro": "PRAÇA DA BANDEIRA", * "cep": "36660000" * }, * "email": "teste@email.com", @@ -356,6 +356,6 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ \ No newline at end of file diff --git a/src/main/resources/apidoc/documento.apidoc b/src/main/resources/apidoc/documento.apidoc index 28a4e5b..2ab9f70 100644 --- a/src/main/resources/apidoc/documento.apidoc +++ b/src/main/resources/apidoc/documento.apidoc @@ -9,58 +9,58 @@ * @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 (Path Parameters) {String} documento Id do documento que deseja recuperar as informações * - * @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 + * @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 requisio: + * @apiExample {curl} Exemplo de requisição: * 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) {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 Nmero do processo visvel para o usurio + * @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 Nmero do documento visvel para o usurio + * @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 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) {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 Cdigo 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 Informaes do andamento de gerao (opcional) + * @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 Descrio do andamento + * @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 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) {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 funo utilizado no momento da assinatura + * @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 usurio + * @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 usurio responsvel pela assinatura + * @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 @@ -73,7 +73,7 @@ * @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) {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 * @@ -106,7 +106,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -118,41 +118,41 @@ * * @apiPermission RO_SEI_BROKER * - * @apiDescription Inclui um documento no SEI, podem ser includos documentos internos e externos, para documentos externo o tamanho mximo 20MB. + * @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 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 (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 servio Listar Sries) + * @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] 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} [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 no existirem interessados deve ser informado um conjunto vazio + * @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 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) {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 requisio: + * @apiExample Exemplo de requisição: * endpoint: https:///sei-broker/service/COSAP/documentos * * body: @@ -165,16 +165,16 @@ * "data":null, * "descricao":"Documento demonstrativo", * "remetente":null, - * "interessados":[{"sigla":"andre.guimaraes","nome":"Andr Lus Fernandes Guimares"}], + * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}], * "destinatarios":[], * "observacao":null, * "nomeArquivo":null, - * "conteudo":"Contedo Base64", + * "conteudo":"Conteúdo 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} 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. @@ -191,7 +191,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -207,10 +207,10 @@ * * @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} documento Numero do documento que será cancelado * @apiParam (Request Body) {String} motivo Motivo do cancelamento * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * endpoint: https:///sei-broker/service/COSAP/documentos/cancelados * * body: @@ -220,13 +220,13 @@ * } * * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -242,25 +242,25 @@ * * @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 + * @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 requisio: + * @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 (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 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 * @@ -269,7 +269,7 @@ * { * "id": 1717, * "data": "2016-10-31T11:59:56.016+0000", - * "nome": "Doc Homologao.pdf", + * "nome": "Doc Homologação.pdf", * "numero": "0003312", * "hash": "ca7ebe0c37419db14ffd4f09485a1ebed8e8deeed594e15720da185ee32e9d19", * "sistema": "desenv_integracao_sei", @@ -282,7 +282,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -299,9 +299,9 @@ * @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 + * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informações * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i https:///sei-broker/service/COSIT/documentos/0003322 * * @apiSuccess (Sucesso - 200) {PDF} binario Arquivo no formato PDF. @@ -310,7 +310,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -326,28 +326,28 @@ * * @apiParam (Path Parameters) {String} interessado Identificador do interessado * - * @apiParam (Query Parameters) {String} [tipo] Tipo/Srie do documento + * @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 nmero do processo, por padro o retorno ordenado pela dataGeracao + * @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] Nmero da pgina - * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por pgina + * @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 requisio: + * @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 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) {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, tambm conhecido como srie. + * @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 conferncia 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 @@ -363,7 +363,7 @@ * "processo": "33910.000002/2017-41", * "tipo": { * "codigo": "629", - * "nome": "Relatrio de Arquivamento-SIF" + * "nome": "Relatório de Arquivamento-SIF" * } * "tipoConferencia": "4", * "assinado": true @@ -373,7 +373,37 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código 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. + * @apiParam (Query Parameters) {String} [nome] Para selecionar a série que possua nome igual. + * + * @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" + * } + */ \ No newline at end of file diff --git a/src/main/resources/apidoc/extensao.apidoc b/src/main/resources/apidoc/extensao.apidoc index a36ccab..fb2ec7a 100644 --- a/src/main/resources/apidoc/extensao.apidoc +++ b/src/main/resources/apidoc/extensao.apidoc @@ -1,29 +1,29 @@ /** - * @api {get} /:unidade/extensoes Listar extenses + * @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 mtodo realiza uma busca pelas extenses de arquivos permitidas. + * @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 extenso. + * @apiParam (Query Parameters) {String} [extensao=null] Para filtrar por uma determinada extensão. * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * 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 + * @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":"cdigo do erro" + * "code":"código do erro" * } */ \ No newline at end of file diff --git a/src/main/resources/apidoc/hipoteseLegal.apidoc b/src/main/resources/apidoc/hipoteseLegal.apidoc index 7484735..a9ac1b6 100644 --- a/src/main/resources/apidoc/hipoteseLegal.apidoc +++ b/src/main/resources/apidoc/hipoteseLegal.apidoc @@ -1,30 +1,30 @@ /** - * @api {get} /:unidade/hipoteses-legais Listar hipteses legais + * @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 hipteses legais. + * @apiDescription Lista as hipóteses 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) + * @apiParam (Query Parameters) {String} [nivelAcesso] Filtra hipóteses pelo nível de acesso associado (1 - restrito, 2 - sigiloso) * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * 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 + * @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":"cdigo do erro" + * "code":"código do erro" * } */ \ No newline at end of file diff --git a/src/main/resources/apidoc/info.apidoc b/src/main/resources/apidoc/info.apidoc index 9f2afef..2a0c02f 100644 --- a/src/main/resources/apidoc/info.apidoc +++ b/src/main/resources/apidoc/info.apidoc @@ -1,75 +1,75 @@ /** - * @api {get} /info/versao Consultar verso + * @api {get} /info/versao Consultar versão * @apiName getNumeroVersao * @apiGroup Info * @apiVersion 2.0.0 * - * @apiDescription Este mtodo realiza uma consulta para saber a verso do sei-broker que est disponvel. + * @apiDescription Este método realiza uma consulta para saber a versão do sei-broker que está disponível. * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i http:///sei-broker/service/info/versao * - * @apiSuccess {String} versao Nmero da verso. + * @apiSuccess {String} versao Número da versão. * * @apiErrorExample {json} Error-Response: * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {get} /info/conexoes/mysql Testar conexo MySQL + * @api {get} /info/conexoes/mysql Testar conexão MySQL * @apiName testMySQLConnection * @apiGroup Info * @apiVersion 2.0.0 * - * @apiDescription Testa a conexo com o MySQL e retorna o nmero de verso do banco. + * @apiDescription Testa a conexão com o MySQL e retorna o número de versão do banco. * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i http:///sei-broker/service/info/conexoes/mysql * - * @apiSuccess {String} versao Nmero de verso do 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":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {get} /info/conexoes/oracle Testar conexo Oracle + * @api {get} /info/conexoes/oracle Testar conexão Oracle * @apiName testOracleConnection * @apiGroup Info * @apiVersion 2.0.0 * - * @apiDescription Testa a conexo com o Oracle e retorna o nmero de verso do banco. + * @apiDescription Testa a conexão com o Oracle e retorna o número de versão do banco. * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i http:///sei-broker/service/info/conexoes/oracle * - * @apiSuccess {String} versao Nmero de verso do 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":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {get} /info/conexoes/sei Testar conexo SEI + * @api {get} /info/conexoes/sei Testar conexão SEI * @apiName testSEIConnection * @apiGroup Info * @apiVersion 2.0.0 * - * @apiDescription Testa a conexo com o SEI fazendo uma consulta ao servio listar unidades. + * @apiDescription Testa a conexão com o SEI fazendo uma consulta ao serviço listar unidades. * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i http:///sei-broker/service/info/conexoes/sei * * @apiSuccess {String} mensagem Mensagem de sucesso. @@ -78,7 +78,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -91,12 +91,12 @@ * @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 + * @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 requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i http:///sei-broker/service/info/requests * * @apiSuccess {String} mensagem Mensagem de sucesso. @@ -105,6 +105,6 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ \ No newline at end of file diff --git a/src/main/resources/apidoc/infra.apidoc b/src/main/resources/apidoc/infra.apidoc index 44048bc..90a05be 100644 --- a/src/main/resources/apidoc/infra.apidoc +++ b/src/main/resources/apidoc/infra.apidoc @@ -1,35 +1,35 @@ /** - * @api {get} /:unidade/paises Listar pases + * @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 pases cadastrados. + * @apiDescription Consulta países cadastrados. * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * 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. + * @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": "Afeganisto" + * "nome": "Afeganistão" * } * * @apiErrorExample {json} Error-Response: * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -45,16 +45,16 @@ * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI * - * @apiExample Exemplo de requisio: + * @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 pas 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 Cdigo do IBGE. + * @apiSuccess (Sucesso - 200) {String} resultado.estado.codigoIbge Código do IBGE. * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK @@ -70,7 +70,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -89,15 +89,15 @@ * * @apiParam (Query Parameters) {String} [pais="76 (Brasil)"] Identificador do pais que deseja listar os estados. * - * @apiExample Exemplo de requisio: + * @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 pas 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 Cdigo do IBGE. + * @apiSuccess (Sucesso - 200) {String} estado.codigoIbge Código do IBGE. * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK @@ -113,7 +113,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -132,13 +132,13 @@ * * @apiParam (Query Parameters) {String} [filtro] String utilizada para filtrar as cidades. * - * @apiExample Exemplo de requisio: + * @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 Cdigo do IBGE. + * @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. @@ -150,7 +150,7 @@ * "sigla": "RJ", * "nome": "Rio de Janeiro" * }, - * "nome": "Paraba do Sul", + * "nome": "Paraíba do Sul", * "codigoIbge": "3303708" * } * @@ -158,7 +158,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -170,18 +170,18 @@ * * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA * - * @apiDescription Consulta a cidade pelo cdigo do IBGE. + * @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 Cdigo do IBGE. + * @apiParam (Path Parameters) {String} cidade Código do IBGE. * - * @apiExample Exemplo de requisio: + * @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 Cdigo do IBGE. + * @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. @@ -193,7 +193,7 @@ * "sigla": "RJ", * "nome": "Rio de Janeiro" * }, - * "nome": "Paraba do Sul", + * "nome": "Paraíba do Sul", * "codigoIbge": "3303708" * } * @@ -201,6 +201,6 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ \ No newline at end of file diff --git a/src/main/resources/apidoc/marcador.apidoc b/src/main/resources/apidoc/marcador.apidoc index 8dc7854..ae58a60 100644 --- a/src/main/resources/apidoc/marcador.apidoc +++ b/src/main/resources/apidoc/marcador.apidoc @@ -10,20 +10,20 @@ * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI * - * @apiExample {curl} Exemplo de requisio: + * @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. + * @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" + * "code":"código do erro" * } */ @@ -40,11 +40,11 @@ * @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. + * @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 requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i https:///sei-broker/service/cosap/marcadores/3/processos * * @apiSuccessExample {json} Success-Response: @@ -54,7 +54,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ diff --git a/src/main/resources/apidoc/processo.apidoc b/src/main/resources/apidoc/processo.apidoc index 9b98c6e..d75ebcb 100644 --- a/src/main/resources/apidoc/processo.apidoc +++ b/src/main/resources/apidoc/processo.apidoc @@ -6,113 +6,113 @@ * * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA * - * @apiDescription Este mtodo realiza uma consulta a processos no SEI e no SIPAR. + * @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 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: + * @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 concluso do processo (opcional) + * @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 Descrio do andamento - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoConclusao.unidade Unidade responsvel pelo 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 Cdigo 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 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) {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 Descrio do andamento - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoGeracao.unidade Unidade responsvel pelo 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 Cdigo 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 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) {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 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.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 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) {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 Cdigo 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 Nmero do processo visvel para o usurio + * @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 Nmero do processo visvel para o usurio + * @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 Nmero do processo visvel para o usurio + * @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 Descrio do andamento - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.ultimoAndamento.unidade Unidade responsvel pelo 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 Cdigo 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 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) {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 Cdigo 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 emisso + * @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 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 + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -128,23 +128,23 @@ * * @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 (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 concludo + * @apiParam (Request Body) {String} processo Numero do processo a ser concluído * - * @apiExample Exemplo de requisio: + * @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 requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -158,21 +158,21 @@ * * @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 (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 (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 (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. 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) {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 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. + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: [POST] https:///sei-broker/service/COSAP/processos/enviados * * body: @@ -187,13 +187,13 @@ * "somenteDiasUteis":true} * } * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -210,18 +210,18 @@ * @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 + * @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 requisio: + * @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 requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -237,18 +237,18 @@ * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI * - * @apiParam (Query Parameters) {String} [serie] Tipo do documento cadastrado no servio + * @apiParam (Query Parameters) {String} [serie] Tipo do documento cadastrado no serviço * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * curl -i https:///sei-broker/service/COSAP/processos/tipos * - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -264,45 +264,45 @@ * * @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 (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 representao de novo 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] 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.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 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) {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 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) {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 requisio: + * @apiExample Exemplo de requisição: * endpoint: [POST] https:///sei-broker/service/COSAP/processos * * body: * { * "dadosProcesso":{ * "idTipoProcedimento":"100000375", - * "especificacao":"Documentao REST", + * "especificacao":"Documentação REST", * "assuntos":[], - * "interessados":[{"sigla":"andre.guimaraes","nome":"Andr Lus Fernandes Guimares"}], - * "observacao":"Exemplo de requisio", + * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}], + * "observacao":"Exemplo de requisição", * "nivelAcesso":0 * }, * "documentos":[], @@ -314,12 +314,12 @@ * "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} 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 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.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. @@ -337,7 +337,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -354,22 +354,22 @@ * @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} [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 requisio: + * @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 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) {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 Cdigo do tipo + * @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. @@ -379,12 +379,12 @@ * { * "numero": "33910007118201710", * "numeroFormatado": "33910.007118/2017-10", - * "descricao": "D:2237021 - SUL AMRICA SEGURO SADE S/A", - * "unidade": "NCLEO-RJ", + * "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": "Fiscalizao: Sancionador" + * "nome": "Fiscalização: Sancionador" * } * } * @@ -392,7 +392,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -407,29 +407,29 @@ * @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 (Path Parameters) {String} processo Número do processo. * - * @apiParam (Query Parameters) {String = "S (sim), N (no)"} [exibir-atributos="N"] Sinalizador para retorno dos atributos associados. + * @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 mdulo informados. + * @apiParam (Query Parameters) {String[]} [tarefa-modulo] Filtra andamentos pelos identificadores de tarefas de módulo informados. * - * @apiExample {curl} Exemplo de requisio: + * @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 Descrio do andamento. + * @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 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) {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. @@ -439,29 +439,29 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {post} /:unidade/processos/:processo/andamentos Lanar andamento + * @api {post} /:unidade/processos/:processo/andamentos Lançar andamento * @apiName lancarAndamento * @apiGroup Processo * @apiVersion 2.0.0 * * @apiPermission RO_SEI_BROKER * - * @apiDescription Lana um andamento ao processo. + * @apiDescription Lança um andamento ao processo. * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @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 mdulo a qual o andamento se refere. - * @apiParam (Request Body) {HashMap} novoAndamento.atributos Mapa chave-valor, identificando como sero preenchidos os atributos da tarefa. + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: [POST] https:///sei-broker/service/COSAP/processos/33910003114201754/andamentos * * body: @@ -473,16 +473,16 @@ * @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.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 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) {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. @@ -492,7 +492,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -507,12 +507,12 @@ * @apiDescription Anexar um processo. * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @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 Nmero do processo a ser anexado. + * @apiParam (Request Body) {String} processoAnexado.numero Número do processo a ser anexado. * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * endpoint: [POST] https:///sei-broker/service/COSAP/processos/33910003114201754/anexados * * body: @@ -527,7 +527,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -542,14 +542,14 @@ * @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. + * @apiParam (Path Parameters) {String} processo Número do processo. + * @apiParam (Path Parameters) {String} processo Número do processo anexado. * - * @apiExample Exemplo de requisio: + * @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 Descrio do motivo para remoo do processo em anexo. + * @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 @@ -558,7 +558,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -574,10 +574,10 @@ * * @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. + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: [POST] https:///sei-broker/service/COSAP/processos/bloqueados * * body: @@ -592,7 +592,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -607,9 +607,9 @@ * @apiDescription Desbloquear um processo. * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @apiParam (Path Parameters) {String} processo Número do processo. * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * endpoint: [DELETE] https:///sei-broker/service/COSAP/processos/bloqueados/33910003093201777 * * @apiSuccessExample {json} Success-Response: @@ -619,7 +619,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -634,12 +634,12 @@ * @apiDescription Relacionar processos. * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @apiParam (Path Parameters) {String} processo Número 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. + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: [POST] https:///sei-broker/service/COSAP/processos/33910003093201777/relacionados * * body: @@ -654,7 +654,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -669,10 +669,10 @@ * @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. + * @apiParam (Path Parameters) {String} processo Número do processo. + * @apiParam (Path Parameters) {String} processoRelacionado Número do processo relacionado. * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * endpoint: [DELETE] https:///sei-broker/service/COSAP/processos/33910000086201632/relacionados/33910003107201752 * * @apiSuccessExample {json} Success-Response: @@ -682,7 +682,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -699,17 +699,17 @@ * @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.processo Número do processo a ser sobrestado. * @apiParam (Request Body) {String} sobrestamento.motivo Motivo do sobrestamento. - * @apiParam (Request Body) {String} [sobrestamento.processoVinculado] Nmero do processo vinculado. + * @apiParam (Request Body) {String} [sobrestamento.processoVinculado] Número do processo vinculado. * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * endpoint: [POST] https:///sei-broker/service/COSAP/processos/sobrestados * * body: * { * "processo":"33910003093201777", - * "motivo":"Sobrestando atravs da camada de servios." + * "motivo":"Sobrestando através da camada de serviços." * } * * @apiSuccessExample {json} Success-Response: @@ -719,7 +719,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -734,9 +734,9 @@ * @apiDescription Remover sobrestamento de processo. * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. - * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @apiParam (Path Parameters) {String} processo Número do processo. * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * endpoint: [DELETE] https:///sei-broker/service/COSAP/processos/sobrestados/33910003093201777 * * @apiSuccessExample {json} Success-Response: @@ -746,7 +746,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -760,29 +760,29 @@ * * @apiDescription Retorna os documentos de um determinado processo. * - * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @apiParam (Path Parameters) {String} processo Número do processo. * - * @apiParam (Query Parameters) {String} [tipo=null] Identificador do tipo do documento, caso seja necessrio filtrar pelo tipo + * @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 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 + * @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 requisio: + * @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 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) {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, tambm conhecido como srie. + * @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 conferncia 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 @@ -796,7 +796,7 @@ * "dataGeracao": "2015-08-10T00:00:00-03:00", * "tipo": { * "codigo": "629", - * "nome": "Relatrio de Arquivamento-SIF" + * "nome": "Relatório de Arquivamento-SIF" * } * "tipoConferencia": "4", * "assinado": true @@ -806,7 +806,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -820,21 +820,21 @@ * * @apiDescription Consulta um documento de determinado processo. * - * @apiParam (Path Parameters) {String} processo Nmero do processo. - * @apiParam (Path Parameters) {String} documento Nmero do documento. + * @apiParam (Path Parameters) {String} processo Número do processo. + * @apiParam (Path Parameters) {String} documento Número do documento. * - * @apiExample Exemplo de requisio: + * @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 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) {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, tambm conhecido como srie. + * @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 conferncia 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: @@ -846,7 +846,7 @@ * "dataGeracao": "2015-08-10T00:00:00-03:00", * "tipo": { * "codigo": "629", - * "nome": "Relatrio de Arquivamento-SIF" + * "nome": "Relatório de Arquivamento-SIF" * } * "tipoConferencia": "4", * "assinado": true @@ -856,7 +856,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ @@ -868,21 +868,21 @@ * * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA * - * @apiDescription Consulta as unidades onde o processo est aberto. + * @apiDescription Consulta as unidades onde o processo está aberto. * - * @apiParam (Path Parameters) {String} processo Nmero do processo. + * @apiParam (Path Parameters) {String} processo Número do processo. * - * @apiExample Exemplo de requisio: + * @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) {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. + * @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 @@ -901,6 +901,6 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ \ No newline at end of file diff --git a/src/main/resources/apidoc/serie.apidoc b/src/main/resources/apidoc/serie.apidoc index 8173cea..9a780be 100644 --- a/src/main/resources/apidoc/serie.apidoc +++ b/src/main/resources/apidoc/serie.apidoc @@ -1,63 +1,31 @@ /** - * @api {get} /:unidade/series Listar sries + * @api {get} /:unidade/series Listar séries * @apiName listarSeries * @apiGroup Serie - * @apiVersion 2.0.0 + * @apiVersion 2.9.1 * * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA * - * @apiDescription Este mtodo realiza uma consulta s sries. + * @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} [nome] Para selecionar a srie que possua nome igual. + * @apiParam (Query Parameters) {String} [nome] Para selecionar a série que possua nome igual. * @apiParam (Query Parameters) {String} [tipo-processo=null] Para filtrar por determinado tipo de processo. * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i https:///sei-broker/service/COSAP/series * - * @apiSuccess (Sucesso - 200) {Serie[]} series Lista de sries. + * @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 = formulrios + * @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":"cdigo do erro" + * "code":"código 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. - * @apiParam (Query Parameters) {String} [nome] Para selecionar a srie que possua nome igual. - * - * @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 index 5c0ebaa..dbd3696 100644 --- a/src/main/resources/apidoc/sipar.apidoc +++ b/src/main/resources/apidoc/sipar.apidoc @@ -4,12 +4,12 @@ * @apiGroup SIPAR * @apiVersion 2.0.0 * - * @apiDescription Marca um processo fsico (SIPAR) como importado para um processo eletrnico (SEI). + * @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 Nmero do processo a ser importado + * @apiParam (Request Body) {String} processo Número do processo a ser importado * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * endpoint: [POST] http:///sei-broker/service/sipar/importados * * body: @@ -22,7 +22,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } * * @@ -30,7 +30,7 @@ * HTTP/1.1 400 Bad Request * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } * * @@ -38,21 +38,21 @@ * HTTP/1.1 409 Conflict * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {delete} /sipar/importados/:processo Cancelar Importao Processo + * @api {delete} /sipar/importados/:processo Cancelar Importação Processo * @apiName cancelarImportacaoProcesso * @apiGroup SIPAR * @apiVersion 2.0.0 * - * @apiDescription Desmarca um processo fsico (SIPAR) como importado para um processo eletrnico (SEI). + * @apiDescription Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI). * - * @apiParam (Path Parameter) {String} processo Nmero do processo fsico existente no SIPAR contendo 17 dgitos e iniciado com 33902. Ex. 33902111111111111 + * @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 requisio: + * @apiExample {curl} Exemplo de requisição: * curl -X DELETE http:///sei-broker/service/sipar/importados/33902112492200241 * * @apiSuccessExample {json} Success-Response: @@ -62,7 +62,7 @@ * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } * * @@ -70,7 +70,7 @@ * HTTP/1.1 400 Bad Request * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } * * @@ -78,6 +78,6 @@ * HTTP/1.1 404 Not Found * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ \ No newline at end of file diff --git a/src/main/resources/apidoc/tarefa.apidoc b/src/main/resources/apidoc/tarefa.apidoc index eea9dbd..dbfd75a 100644 --- a/src/main/resources/apidoc/tarefa.apidoc +++ b/src/main/resources/apidoc/tarefa.apidoc @@ -10,23 +10,23 @@ * * @apiParam (Query Parameters) {String} [nome] Filtro para o nome da tarefa. * - * @apiExample {curl} Exemplo de requisio: + * @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 histrico resumido. - * @apiSuccess (Sucesso - 200) {String} tarefas.historicoCompleto S/N - Sinalizador indica se a tarefa aparecer no histrico completo. + * @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 mdulo. + * @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":"cdigo do erro" + * "code":"código do erro" * } */ \ No newline at end of file diff --git a/src/main/resources/apidoc/tipoConferencia.apidoc b/src/main/resources/apidoc/tipoConferencia.apidoc index 8fef2d5..efd70aa 100644 --- a/src/main/resources/apidoc/tipoConferencia.apidoc +++ b/src/main/resources/apidoc/tipoConferencia.apidoc @@ -1,26 +1,26 @@ /** - * @api {get} /:unidade/tipos-conferencia Listar tipos de conferncia + * @api {get} /:unidade/tipos-conferencia Listar tipos de conferência * @apiName listarTiposConferencia - * @apiGroup Tipos Conferncia + * @apiGroup Tipos Conferência * @apiVersion 2.0.0 * * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA * - * @apiDescription Lista os tipos de conferncia. + * @apiDescription Lista os tipos de conferência. * * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * 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. + * @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":"cdigo do erro" + * "code":"código do erro" * } */ diff --git a/src/main/resources/apidoc/unidade.apidoc b/src/main/resources/apidoc/unidade.apidoc index e1144c8..15fd420 100644 --- a/src/main/resources/apidoc/unidade.apidoc +++ b/src/main/resources/apidoc/unidade.apidoc @@ -8,43 +8,43 @@ * * @apiDescription Retorna as Unidades cadastradas no SEI. * - * @apiExample {curl} Exemplo de requisio: + * @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 Descrio 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":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {get} /unidades/{unidade}/codigo Consultar cdigo + * @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 cdigo da Unidade pesquisada. + * @apiDescription Retorna o código da Unidade pesquisada. * - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade que deseja consultar o cdigo + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade que deseja consultar o código * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i https:///sei-broker/service/unidades/COSAP/codigo * - * @apiSuccess (Sucesso - 200) {String} codigo Cdigo da unidade. + * @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":"cdigo do erro" + * "code":"código do erro" * } */ diff --git a/src/main/resources/apidoc/usuario.apidoc b/src/main/resources/apidoc/usuario.apidoc index a658d0a..2e5ba3e 100644 --- a/src/main/resources/apidoc/usuario.apidoc +++ b/src/main/resources/apidoc/usuario.apidoc @@ -1,53 +1,53 @@ /** - * @api {get} /:unidade/usuarios Listar usurios + * @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 mtodo realiza uma consulta aos usurios cadastrados que possuem o perfil "Bsico". + * @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 usurio que deseja recuperar as informaes + * @apiParam (Query Parameters) {String} [usuario=null] Id do usuário que deseja recuperar as informações * - * @apiExample {curl} Exemplo de requisio: + * @apiExample {curl} Exemplo de requisição: * curl -i http:///sei-broker/service/usuarios/COSAP * - * @apiSuccess {Usuario[]} usuarios Lista de usurios + * @apiSuccess {Usuario[]} usuarios Lista de usuários * * @apiErrorExample {json} Error-Response: * HTTP/1.1 500 Internal Server Error * { * "error":"Mensagem de erro." - * "code":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {get} :unidade/usuarios/:usuario Buscar usurio + * @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 mtodo realiza a uma busca pelo login do usurio. + * @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 usurio + * @apiParam (Path Parameters) {String} usuario Login do usuário * - * @apiExample Exemplo de requisio: + * @apiExample Exemplo de requisição: * curl -i http:///sei-broker/service/cosap/usuarios/andre.guimaraes * - * @apiSuccess {Usuario} usuario Informaes do usurio encontrado. + * @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":"cdigo do erro" + * "code":"código do erro" * } */ @@ -59,15 +59,15 @@ * * @apiPermission RO_SEI_BROKER * - * @apiDescription Este mtodo atribui o processo a um usurio. + * @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 usurio a quem deseja atribuir o processo + * @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 atribudo + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: [POST] http:///sei-broker/service/COSAP/usuarios/andre.guimaraes/processos * * body: @@ -76,149 +76,149 @@ * "reabrir":false * } * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {post} /usuarios Incluir usurio + * @api {post} /usuarios Incluir usuário * @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. + * @apiDescription Este método realiza a inclusão de novos usuários ou alterarações nos usuários 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 + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: http:///sei-broker/service/usuarios * * body: * { * "codigo":"1234", - * "nome":"Andr Lus Fernandes Guimares", + * "nome":"André Luís Fernandes Guimarães", * "login":"andre.guimaraes" * } * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {delete} /usuarios/:login Excluir usurio + * @api {delete} /usuarios/:login Excluir usuário * @apiName excluirUsuario * @apiGroup Usuario * @apiVersion 2.0.0 * * @apiPermission RO_SEI_BROKER_ADM * - * @apiDescription Este mtodo realiza a excluso de usurios. + * @apiDescription Este método realiza a exclusão de usuários. * - * @apiParam {String} codigo Cdigo que deseja atribuir ao usurio - * @apiParam {String} nome Nome do usurio - * @apiParam {String} login Login que ser atribudo ao usurio + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: [DELETE] http:///sei-broker/service/usuarios/andre.guimaraes * * body: * { * "codigo":"1234", - * "nome":"Andr Lus Fernandes Guimares", + * "nome":"André Luís Fernandes Guimarães", * "login":"andre.guimaraes" * } * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {delete} /usuarios/ativos Desativar usurio + * @api {delete} /usuarios/ativos Desativar usuário * @apiName desativarUsuario * @apiGroup Usuario * @apiVersion 2.0.0 * * @apiPermission RO_SEI_BROKER_ADM * - * @apiDescription Este mtodo desativa usurios. + * @apiDescription Este método desativa usuários. * - * @apiParam {String} codigo Cdigo que deseja atribuir ao usurio - * @apiParam {String} nome Nome do usurio - * @apiParam {String} login Login que ser atribudo ao usurio + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: [DELETE] http:///sei-broker/service/usuarios/ativos/andre.guimaraes * * body: * { * "codigo":"1234", - * "nome":"Andr Lus Fernandes Guimares", + * "nome":"André Luís Fernandes Guimarães", * "login":"andre.guimaraes" * } * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ /** - * @api {post} /usuarios/ativos Ativar usurio + * @api {post} /usuarios/ativos Ativar usuário * @apiName ativarUsuario * @apiGroup Usuario * @apiVersion 2.0.0 * * @apiPermission RO_SEI_BROKER_ADM * - * @apiDescription Este mtodo reativa usurios. + * @apiDescription Este método reativa usuários. * - * @apiParam {String} codigo Cdigo que deseja atribuir ao usurio - * @apiParam {String} nome Nome do usurio - * @apiParam {String} login Login que ser atribudo ao usurio + * @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 requisio: + * @apiExample Exemplo de requisição: * endpoint: http:///sei-broker/service/usuarios/ativos * * body: * { * "codigo":"1234", - * "nome":"Andr Lus Fernandes Guimares", + * "nome":"André Luís Fernandes Guimarães", * "login":"andre.guimaraes" * } * - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisio + * @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":"cdigo do erro" + * "code":"código do erro" * } */ -- libgit2 0.21.2