Download as
Browse Code »

Commit ee0e973949341173ffdfb238006c795ddaac5f25

Authored by Filipe Soares de Oliveira
2 parents 3bf5cba4 15fb4194
Exists in master and in 1 other branch removing-depencies

Merge branch 'apidoc' into 'master' 

Altera charset da documentação da api para UTF-8

See merge request ans/sei-broker!1
Showing 22 changed files with 691 additions and 815 deletions   Show diff stats
.classpath
View file @3bf5cba
... ... @@ -1,37 +0,0 @@
1   -<?xml version="1.0" encoding="UTF-8"?>
2   -<classpath>
3   - <classpathentry kind="src" output="target/classes" path="src/main/java">
4   - <attributes>
5   - <attribute name="optional" value="true"/>
6   - <attribute name="maven.pomderived" value="true"/>
7   - </attributes>
8   - </classpathentry>
9   - <classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
10   - <attributes>
11   - <attribute name="maven.pomderived" value="true"/>
12   - </attributes>
13   - </classpathentry>
14   - <classpathentry kind="src" output="target/test-classes" path="src/test/java">
15   - <attributes>
16   - <attribute name="optional" value="true"/>
17   - <attribute name="maven.pomderived" value="true"/>
18   - </attributes>
19   - </classpathentry>
20   - <classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
21   - <attributes>
22   - <attribute name="maven.pomderived" value="true"/>
23   - <attribute name="org.eclipse.jst.component.dependency" value="/WEB-INF/lib"/>
24   - </attributes>
25   - </classpathentry>
26   - <classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
27   - <attributes>
28   - <attribute name="maven.pomderived" value="true"/>
29   - </attributes>
30   - </classpathentry>
31   - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
32   - <attributes>
33   - <attribute name="maven.pomderived" value="true"/>
34   - </attributes>
35   - </classpathentry>
36   - <classpathentry kind="output" path="target/classes"/>
37   -</classpath>
... ... @@ -1,71 +0,0 @@
1   -<?xml version="1.0" encoding="UTF-8"?>
2   -<projectDescription>
3   - <name>sei-broker</name>
4   - <comment></comment>
5   - <projects>
6   - </projects>
7   - <buildSpec>
8   - <buildCommand>
9   - <name>tern.eclipse.ide.core.ternBuilder</name>
10   - <arguments>
11   - </arguments>
12   - </buildCommand>
13   - <buildCommand>
14   - <name>org.eclipse.wst.jsdt.core.javascriptValidator</name>
15   - <arguments>
16   - </arguments>
17   - </buildCommand>
18   - <buildCommand>
19   - <name>org.eclipse.jdt.core.javabuilder</name>
20   - <arguments>
21   - </arguments>
22   - </buildCommand>
23   - <buildCommand>
24   - <name>org.eclipse.wst.common.project.facet.core.builder</name>
25   - <arguments>
26   - </arguments>
27   - </buildCommand>
28   - <buildCommand>
29   - <name>org.jboss.tools.ws.jaxrs.metamodelBuilder</name>
30   - <arguments>
31   - </arguments>
32   - </buildCommand>
33   - <buildCommand>
34   - <name>org.jboss.tools.jst.web.kb.kbbuilder</name>
35   - <arguments>
36   - </arguments>
37   - </buildCommand>
38   - <buildCommand>
39   - <name>org.jboss.tools.cdi.core.cdibuilder</name>
40   - <arguments>
41   - </arguments>
42   - </buildCommand>
43   - <buildCommand>
44   - <name>org.eclipse.wst.validation.validationbuilder</name>
45   - <arguments>
46   - </arguments>
47   - </buildCommand>
48   - <buildCommand>
49   - <name>org.hibernate.eclipse.console.hibernateBuilder</name>
50   - <arguments>
51   - </arguments>
52   - </buildCommand>
53   - <buildCommand>
54   - <name>org.eclipse.m2e.core.maven2Builder</name>
55   - <arguments>
56   - </arguments>
57   - </buildCommand>
58   - </buildSpec>
59   - <natures>
60   - <nature>org.eclipse.jem.workbench.JavaEMFNature</nature>
61   - <nature>org.eclipse.wst.common.modulecore.ModuleCoreNature</nature>
62   - <nature>org.eclipse.jdt.core.javanature</nature>
63   - <nature>org.eclipse.m2e.core.maven2Nature</nature>
64   - <nature>org.eclipse.wst.common.project.facet.core.nature</nature>
65   - <nature>org.eclipse.wst.jsdt.core.jsNature</nature>
66   - <nature>org.jboss.tools.ws.jaxrs.nature</nature>
67   - <nature>org.jboss.tools.jst.web.kb.kbnature</nature>
68   - <nature>org.jboss.tools.cdi.core.cdinature</nature>
69   - <nature>org.hibernate.eclipse.console.hibernateNature</nature>
70   - </natures>
71   -</projectDescription>
.tern-project
View file @3bf5cba
... ... @@ -1,14 +0,0 @@
1   -{
2   - "libs": [
3   - "ecma5",
4   - "browser"
5   - ],
6   - "plugins": {
7   - "guess-types": {
8   -
9   - },
10   - "angular": {
11   -
12   - }
13   - }
14   -}
15 0 \ No newline at end of file
README.md
  Diff comments   View file @ee0e973
1 1 # SEI-Broker - Camada REST de acesso ao SEI
2 2 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.
3 3  
4   -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.
  4 +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.
5 5  
6 6 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.
7 7  
... ...
apidoc.json
  Diff comments   View file @ee0e973
1 1 {
2 2 "name": "sei-broker",
3   - "version": "2.0.0",
  3 + "version": "2.9.1",
4 4 "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 <a href=\"https://softwarepublico.gov.br/social/sei/manuais\">documentação oficial do SEI</a> para melhor entendimento do negócio e seus objetos. Mais informações do SEI-Broker veja o <a href=\"http://wiki.ans.gov.br/index.php/Sei-broker\">artigo wiki</a>.",
5 5 "title": "Documentação - sei-broker",
6 6 "url":"https://<host>/sei-broker/service",
... ...
src/main/resources/apidoc/arquivo.apidoc
  Diff comments   View file @ee0e973
... ... @@ -6,19 +6,19 @@
6 6 *
7 7 * @apiPermission RO_SEI_BROKER
8 8 *
9   - * @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
10   - * 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
11   - * 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.
  9 + * @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
  10 + * 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
  11 + * 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.
12 12 *
13 13 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
14 14 *
15 15 * @apiParam (Request Body) {Arquivo} arquivo Objeto representando um arquivo.
16 16 * @apiParam (Request Body) {String} arquivo.nome Nome do arquivo.
17 17 * @apiParam (Request Body) {String} arquivo.tamanho Tamanho total do arquivo em bytes.
18   - * @apiParam (Request Body) {String} arquivo.hash MD5 do conteúdo total do arquivo.
19   - * @apiParam (Request Body) {String} arquivo.conteudo Conteúdo total ou parcial codificado em Base64, máximo de 15MB.
  18 + * @apiParam (Request Body) {String} arquivo.hash MD5 do conteúdo total do arquivo.
  19 + * @apiParam (Request Body) {String} arquivo.conteudo Conteúdo total ou parcial codificado em Base64, máximo de 15MB.
20 20 *
21   - * @apiExample Exemplo de requisição:
  21 + * @apiExample Exemplo de requisição:
22 22 * endpoint: https://<host>/sei-broker/service/COSAP/arquivos
23 23 *
24 24 * body:
... ... @@ -26,10 +26,10 @@
26 26 * "nome":"documentos-sei-broker.pdf",
27 27 * "tamanho":"2048",
28 28 * "hash":"45F1DEFFB45A5F6C2380A4CEE9B3E452",
29   - * "conteudo":"Conteúdo total ou parcial do arquivo"
  29 + * "conteudo":"Conteúdo total ou parcial do arquivo"
30 30 * }
31 31 *
32   - * @apiSuccess (Sucesso - 201) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo
  32 + * @apiSuccess (Sucesso - 201) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo
33 33 * @apiSuccess (Sucesso - 201) {String} arquivo.identificador Identificador do arquivo criado.
34 34 *
35 35 * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado.
... ... @@ -44,38 +44,38 @@
44 44 * HTTP/1.1 500 Internal Server Error
45 45 * {
46 46 * "error":"Mensagem de erro."
47   - * "code":"código do erro"
  47 + * "code":"código do erro"
48 48 * }
49 49 */
50 50  
51 51 /**
52   - * @api {put} /:unidade/arquivos/:arquivo Adicionar conteúdo arquivo
  52 + * @api {put} /:unidade/arquivos/:arquivo Adicionar conteúdo arquivo
53 53 * @apiName adicionarConteudoArquivo
54 54 * @apiGroup Arquivo
55 55 * @apiVersion 2.0.0
56 56 *
57 57 * @apiPermission RO_SEI_BROKER
58 58 *
59   - * @apiDescription Adiciona conteúdo a um arquivo criado, o sistema identificará automaticamente quando o conteúdo foi completado validando o tamanho em bytes
60   - * 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.
  59 + * @apiDescription Adiciona conteúdo a um arquivo criado, o sistema identificará automaticamente quando o conteúdo foi completado validando o tamanho em bytes
  60 + * 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.
61 61 *
62 62 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
63   - * @apiParam (Path Parameters) {String} arquivo Identificador do arquivo que receberá o conteúdo.
  63 + * @apiParam (Path Parameters) {String} arquivo Identificador do arquivo que receberá o conteúdo.
64 64 *
65 65 * @apiParam (Request Body) {ParteArquivo} parte Objeto representando uma parte do arquivo.
66   - * @apiParam (Request Body) {String} parte.arquivo Identificador do arquivo que receberá o conteúdo.
67   - * @apiParam (Request Body) {String} parte.conteudo Conteúdo parcial codificado em Base64, máximo de 15MB.
  66 + * @apiParam (Request Body) {String} parte.arquivo Identificador do arquivo que receberá o conteúdo.
  67 + * @apiParam (Request Body) {String} parte.conteudo Conteúdo parcial codificado em Base64, máximo de 15MB.
68 68 *
69   - * @apiExample Exemplo de requisição:
  69 + * @apiExample Exemplo de requisição:
70 70 * endpoint: https://<host>/sei-broker/service/COSAP/arquivos/123456
71 71 *
72 72 * body:
73 73 * {
74 74 * "arquivo":"123456",
75   - * "conteudo":"Conteúdo parcial do arquivo"
  75 + * "conteudo":"Conteúdo parcial do arquivo"
76 76 * }
77 77 *
78   - * @apiSuccess (Sucesso - 200) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo
  78 + * @apiSuccess (Sucesso - 200) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo
79 79 * @apiSuccess (Sucesso - 200) {String} arquivo.identificador Identificador do arquivo criado.
80 80 *
81 81 * @apiSuccess (Sucesso Response Header - 200) {header} Location URL de acesso ao recurso alterado.
... ... @@ -90,7 +90,7 @@
90 90 * HTTP/1.1 500 Internal Server Error
91 91 * {
92 92 * "error":"Mensagem de erro."
93   - * "code":"código do erro"
  93 + * "code":"código do erro"
94 94 * }
95 95 */
96 96  
... ...
src/main/resources/apidoc/bloco.apidoc
  Diff comments   View file @ee0e973
... ... @@ -6,50 +6,50 @@
6 6 *
7 7 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
8 8 *
9   - * @apiDescription Recupera as informações do bloco informado.
  9 + * @apiDescription Recupera as informações do bloco informado.
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
12 12 * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja consultar
13 13 *
14 14 * @apiParam (Query Parameters) {String} [protocolos=N] S ou N para exibir os protocolos do bloco
15 15 *
16   - * @apiExample {curl} Exemplo de requisição:
  16 + * @apiExample {curl} Exemplo de requisição:
17 17 * curl -i http://<host>/sei-broker/service/COSAP/blocos/12
18 18 *
19 19 * @apiSuccess (Sucesso - 200) {RetornoConsultaBloco} bloco Objeto representando o bloco encontrado
20   - * @apiSuccess (Sucesso - 200) {String} bloco.idBloco Número do bloco
  20 + * @apiSuccess (Sucesso - 200) {String} bloco.idBloco Número do bloco
21 21 * @apiSuccess (Sucesso - 200) {Unidade} bloco.unidade Dados das unidade que gerou o bloco
22 22 * @apiSuccess (Sucesso - 200) {String} bloco.unidade.idUnidade Identificador da Unidade
23 23 * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sigla Sigla da unidade
24   - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.descricao Descrição do unidade
  24 + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.descricao Descrição do unidade
25 25 * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinProtocolo :TODO pendente
26 26 * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinArquivamento :TODO pendente
27 27 * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinOuvidoria :TODO pendente
28 28 * @apiSuccess (Sucesso - 200) {Usuario} bloco.usuario Dados das unidade que gerou o bloco
29   - * @apiSuccess (Sucesso - 200) {String} bloco.usuario.idUsuario Identificador do suário
30   - * @apiSuccess (Sucesso - 200) {String} bloco.usuario.sigla Sigla do usuário
31   - * @apiSuccess (Sucesso - 200) {String} bloco.usuario.nome Nome do usuário
32   - * @apiSuccess (Sucesso - 200) {String} bloco.descricao Descrição do bloco
33   - * @apiSuccess (Sucesso - 200) {String} bloco.tipo Tipo do bloco (A=Assinatura, R=Reunião ou I=Interno)
34   - * @apiSuccess (Sucesso - 200) {String} bloco.estado Estado do bloco (A=Aberto, D=Disponibilizado, R=Retornado ou C=Concluído)
35   - * @apiSuccess (Sucesso - 200) {Unidade[]} bloco.unidadesDisponibilizacao Dados das unidades configuradas para disponibilização (ver estrutura Unidade)
  29 + * @apiSuccess (Sucesso - 200) {String} bloco.usuario.idUsuario Identificador do suário
  30 + * @apiSuccess (Sucesso - 200) {String} bloco.usuario.sigla Sigla do usuário
  31 + * @apiSuccess (Sucesso - 200) {String} bloco.usuario.nome Nome do usuário
  32 + * @apiSuccess (Sucesso - 200) {String} bloco.descricao Descrição do bloco
  33 + * @apiSuccess (Sucesso - 200) {String} bloco.tipo Tipo do bloco (A=Assinatura, R=Reunião ou I=Interno)
  34 + * @apiSuccess (Sucesso - 200) {String} bloco.estado Estado do bloco (A=Aberto, D=Disponibilizado, R=Retornado ou C=Concluído)
  35 + * @apiSuccess (Sucesso - 200) {Unidade[]} bloco.unidadesDisponibilizacao Dados das unidades configuradas para disponibilização (ver estrutura Unidade)
36 36 * @apiSuccess (Sucesso - 200) {ProtocoloBloco[]} bloco.protocolos Processos ou documentos do bloco
37   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.protocoloFormatado Número de protocolo formatado
  37 + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.protocoloFormatado Número de protocolo formatado
38 38 * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.identificacao :TODO pendente
39   - * @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
  39 + * @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
40 40 * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.nome Nome do assinante
41   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.cargoFuncao Cargo ou função utilizado no momento da assinatura
  41 + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.cargoFuncao Cargo ou função utilizado no momento da assinatura
42 42 * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.dataHora Data/hora em que ocorreu a assinatura
43   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idUsuario Identificador do usuário
  43 + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idUsuario Identificador do usuário
44 44 * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idOrigem :TODO pendente
45 45 * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idOrgao :TODO pendente
46   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.sigla Login do usuário responsável pela assinatura
  46 + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.sigla Login do usuário responsável pela assinatura
47 47 *
48 48 * @apiErrorExample {json} Error-Response:
49 49 * HTTP/1.1 500 Internal Server Error
50 50 * {
51 51 * "error":"Mensagem de erro."
52   - * "code":"código do erro"
  52 + * "code":"código do erro"
53 53 * }
54 54 */
55 55  
... ... @@ -67,19 +67,19 @@
67 67 *
68 68 * @apiParam (Request Body) {String} bloco Numero do bloco que deseja disponibilizar
69 69 *
70   - * @apiExample Exemplo de requisição:
  70 + * @apiExample Exemplo de requisição:
71 71 * endpoint: [POST] http://<host>/sei-broker/service/COSAP/blocos/disponibilizados
72 72 *
73 73 * body:
74 74 * 12
75 75 *
76   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  76 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
77 77 *
78 78 * @apiErrorExample {json} Error-Response:
79 79 * HTTP/1.1 500 Internal Server Error
80 80 * {
81 81 * "error":"Mensagem de erro."
82   - * "code":"código do erro"
  82 + * "code":"código do erro"
83 83 * }
84 84 */
85 85  
... ... @@ -91,21 +91,21 @@
91 91 *
92 92 * @apiPermission RO_SEI_BROKER
93 93 *
94   - * @apiDescription Cancela a disponibilização de blocos.
  94 + * @apiDescription Cancela a disponibilização de blocos.
95 95 *
96 96 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
97 97 * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja indisponibilizar
98 98 *
99   - * @apiExample Exemplo de requisição:
  99 + * @apiExample Exemplo de requisição:
100 100 * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/disponibilizados/12
101 101 *
102   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  102 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
103 103 *
104 104 * @apiErrorExample {json} Error-Response:
105 105 * HTTP/1.1 500 Internal Server Error
106 106 * {
107 107 * "error":"Mensagem de erro."
108   - * "code":"código do erro"
  108 + * "code":"código do erro"
109 109 * }
110 110 */
111 111  
... ... @@ -122,16 +122,16 @@
122 122 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
123 123 * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja excluir
124 124 *
125   - * @apiExample Exemplo de requisição:
  125 + * @apiExample Exemplo de requisição:
126 126 * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/12
127 127 *
128   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  128 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
129 129 *
130 130 * @apiErrorExample {json} Error-Response:
131 131 * HTTP/1.1 500 Internal Server Error
132 132 * {
133 133 * "error":"Mensagem de erro."
134   - * "code":"código do erro"
  134 + * "code":"código do erro"
135 135 * }
136 136 */
137 137  
... ... @@ -147,14 +147,14 @@
147 147 *
148 148 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
149 149 *
150   - * @apiParam (Request Body) {NovoBloco} novoBloco Objeto de criação de bloco
  150 + * @apiParam (Request Body) {NovoBloco} novoBloco Objeto de criação de bloco
151 151 * @apiParam (Request Body) {String="ASSINATURA","INTERNO","REUNIAO"} novoBloco.tipo Tipo do bloco a ser criado
152   - * @apiParam (Request Body) {String} novoBloco.descricao Descrição do bloco
153   - * @apiParam (Request Body) {String[]} novoBloco.unidades Códigos das unidades onde o bloco deve ser disponibilizado, ou vazio para não disponibilizar
154   - * @apiParam (Request Body) {String[]} novoBloco.documentos Código dos documentos que serão incluídos no bloco
  152 + * @apiParam (Request Body) {String} novoBloco.descricao Descrição do bloco
  153 + * @apiParam (Request Body) {String[]} novoBloco.unidades Códigos das unidades onde o bloco deve ser disponibilizado, ou vazio para não disponibilizar
  154 + * @apiParam (Request Body) {String[]} novoBloco.documentos Código dos documentos que serão incluídos no bloco
155 155 * @apiParam (Request Body) {Boolean} novoBloco.disponibilizar=false Informa se o bloco criado deve ser disponibilizado automaticamente
156 156 *
157   - * @apiExample Exemplo de requisição:
  157 + * @apiExample Exemplo de requisição:
158 158 * endpoint: http://<host>/sei-broker/service/COSAP/blocos
159 159 *
160 160 * body:
... ... @@ -166,7 +166,7 @@
166 166 * "disponibilizar":true
167 167 * }
168 168 *
169   - * @apiSuccess (Sucesso Response Body - 201) {String} resultado Código do bloco criado
  169 + * @apiSuccess (Sucesso Response Body - 201) {String} resultado Código do bloco criado
170 170 *
171 171 * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado
172 172 *
... ... @@ -174,7 +174,7 @@
174 174 * HTTP/1.1 500 Internal Server Error
175 175 * {
176 176 * "error":"Mensagem de erro."
177   - * "code":"código do erro"
  177 + * "code":"código do erro"
178 178 * }
179 179 */
180 180  
... ... @@ -191,23 +191,23 @@
191 191 * @apiParam (Header Parameters) {String} Content-Type Informar text/plain
192 192 *
193 193 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
194   - * @apiParam (Path Parameters) {String} bloco Número do bloco onde o documento será incluído
  194 + * @apiParam (Path Parameters) {String} bloco Número do bloco onde o documento será incluído
195 195 *
196   - * @apiParam (Request Body) {String} documento Número do documento que será incluído do bloco
  196 + * @apiParam (Request Body) {String} documento Número do documento que será incluído do bloco
197 197 *
198   - * @apiExample Exemplo de requisição:
  198 + * @apiExample Exemplo de requisição:
199 199 * endpoint: [POST] http://<host>/sei-broker/service/COSAP/blocos/12/documentos
200 200 *
201 201 * body:
202 202 * 0000050
203 203 *
204   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  204 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
205 205 *
206 206 * @apiErrorExample {json} Error-Response:
207 207 * HTTP/1.1 500 Internal Server Error
208 208 * {
209 209 * "error":"Mensagem de erro."
210   - * "code":"código do erro"
  210 + * "code":"código do erro"
211 211 * }
212 212 */
213 213  
... ... @@ -224,21 +224,21 @@
224 224 * @apiParam (Header Parameters) {String} Content-Type Informar application/json
225 225 *
226 226 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
227   - * @apiParam (Path Parameters) {String} bloco Número do bloco onde o documento será incluído
  227 + * @apiParam (Path Parameters) {String} bloco Número do bloco onde o documento será incluído
228 228 *
229   - * @apiParam (Request Body) {InclusaoDocumentoBloco} inclusao Objeto com os dados do documento a ser incluído
230   - * @apiParam (Request Body) {String} bloco Número do bloco onde o documento será inserido
231   - * @apiParam (Request Body) {String} documento Número do documento
232   - * @apiParam (Request Body) {String} [anotacao] Texto de anotação associado com o documento no bloco
  229 + * @apiParam (Request Body) {InclusaoDocumentoBloco} inclusao Objeto com os dados do documento a ser incluído
  230 + * @apiParam (Request Body) {String} bloco Número do bloco onde o documento será inserido
  231 + * @apiParam (Request Body) {String} documento Número do documento
  232 + * @apiParam (Request Body) {String} [anotacao] Texto de anotação associado com o documento no bloco
233 233 *
234   - * @apiExample Exemplo de requisição:
  234 + * @apiExample Exemplo de requisição:
235 235 * endpoint: [POST] http://<host>/sei-broker/service/COSAP/blocos/12/documentos
236 236 *
237 237 * @apiErrorExample {json} Error-Response:
238 238 * HTTP/1.1 500 Internal Server Error
239 239 * {
240 240 * "error":"Mensagem de erro."
241   - * "code":"código do erro"
  241 + * "code":"código do erro"
242 242 * }
243 243 */
244 244  
... ... @@ -253,19 +253,19 @@
253 253 * @apiDescription Remove o documento do bloco.
254 254 *
255 255 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
256   - * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o documento será retirado
257   - * @apiParam (Path Parameters) {String} documento Numero do documento que será retirado do bloco
  256 + * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o documento será retirado
  257 + * @apiParam (Path Parameters) {String} documento Numero do documento que será retirado do bloco
258 258 *
259   - * @apiExample Exemplo de requisição:
  259 + * @apiExample Exemplo de requisição:
260 260 * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/12/documentos/0000050
261 261 *
262   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  262 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
263 263 *
264 264 * @apiErrorExample {json} Error-Response:
265 265 * HTTP/1.1 500 Internal Server Error
266 266 * {
267 267 * "error":"Mensagem de erro."
268   - * "code":"código do erro"
  268 + * "code":"código do erro"
269 269 * }
270 270 */
271 271  
... ... @@ -280,22 +280,22 @@
280 280 * @apiDescription Inclui um processo no bloco.
281 281 *
282 282 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
283   - * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído
  283 + * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído
284 284 *
285   - * @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
  285 + * @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
286 286 *
287   - * @apiParam (Request Body) {String} processo Numero do processo que será incluído no bloco
  287 + * @apiParam (Request Body) {String} processo Numero do processo que será incluído no bloco
288 288 *
289   - * @apiExample Exemplo de requisição:
  289 + * @apiExample Exemplo de requisição:
290 290 * curl -X PUT http://<host>/sei-broker/service/COSAP/blocos/12/processos
291 291 *
292   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  292 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
293 293 *
294 294 * @apiErrorExample {json} Error-Response:
295 295 * HTTP/1.1 500 Internal Server Error
296 296 * {
297 297 * "error":"Mensagem de erro."
298   - * "code":"código do erro"
  298 + * "code":"código do erro"
299 299 * }
300 300 */
301 301  
... ... @@ -307,26 +307,26 @@
307 307 *
308 308 * @apiPermission RO_SEI_BROKER
309 309 *
310   - * @apiDescription Inclui um processo no bloco, junto com uma anotação.
  310 + * @apiDescription Inclui um processo no bloco, junto com uma anotação.
311 311 *
312 312 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
313   - * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído
  313 + * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído
314 314 *
315   - * @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
  315 + * @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
316 316 *
317   - * @apiParam (Request Body) {InclusaoProcessoBloco} inclusao Objeto com os dados do processo a ser incluído
318   - * @apiParam (Request Body) {String} bloco Número do bloco onde o processo será inserido
319   - * @apiParam (Request Body) {String} processo Número do processo
320   - * @apiParam (Request Body) {String} [anotacao] Texto de anotação associado com o processo no bloco
  317 + * @apiParam (Request Body) {InclusaoProcessoBloco} inclusao Objeto com os dados do processo a ser incluído
  318 + * @apiParam (Request Body) {String} bloco Número do bloco onde o processo será inserido
  319 + * @apiParam (Request Body) {String} processo Número do processo
  320 + * @apiParam (Request Body) {String} [anotacao] Texto de anotação associado com o processo no bloco
321 321 *
322   - * @apiExample Exemplo de requisição:
  322 + * @apiExample Exemplo de requisição:
323 323 * curl -X PUT http://<host>/sei-broker/service/COSAP/blocos/12/processos
324 324 *
325 325 * @apiErrorExample {json} Error-Response:
326 326 * HTTP/1.1 500 Internal Server Error
327 327 * {
328 328 * "error":"Mensagem de erro."
329   - * "code":"código do erro"
  329 + * "code":"código do erro"
330 330 * }
331 331 */
332 332  
... ... @@ -338,23 +338,23 @@
338 338 *
339 339 * @apiPermission RO_SEI_BROKER
340 340 *
341   - * @apiDescription Este método remove o processo do bloco.
  341 + * @apiDescription Este método remove o processo do bloco.
342 342 *
343 343 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
344   - * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o processo será retirado
345   - * @apiParam (Path Parameters) {String} processo Numero do processo que será retirado do bloco
  344 + * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o processo será retirado
  345 + * @apiParam (Path Parameters) {String} processo Numero do processo que será retirado do bloco
346 346 *
347   - * @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
  347 + * @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
348 348 *
349   - * @apiExample Exemplo de requisição:
  349 + * @apiExample Exemplo de requisição:
350 350 * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/12/processos/33910000029201653
351 351 *
352   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  352 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
353 353 *
354 354 * @apiErrorExample {json} Error-Response:
355 355 * HTTP/1.1 500 Internal Server Error
356 356 * {
357 357 * "error":"Mensagem de erro."
358   - * "code":"código do erro"
  358 + * "code":"código do erro"
359 359 * }
360 360 */
... ...
src/main/resources/apidoc/cargo.apidoc
  Diff comments   View file @ee0e973
... ... @@ -12,19 +12,19 @@
12 12 *
13 13 * @apiParam (Query Parameters) {String} [idCargo] Identificador do cargo
14 14 *
15   - * @apiExample Exemplo de requisição:
  15 + * @apiExample Exemplo de requisição:
16 16 * curl -i http://<host>/sei-broker/service/COSAP/cargos
17 17 *
18 18 * @apiSuccess (Sucesso - 200) {Cargo[]} resultado Lista com os cargos encontrados
19 19 * @apiSuccess (Sucesso - 200) {String} resultado.idCargo Identificador do cargo no SEI
20   - * @apiSuccess (Sucesso - 200) {String} resultado.expressaoCargo Descrição do cargo (Ex.: Governador)
21   - * @apiSuccess (Sucesso - 200) {String} resultado.expressaoTratamento Tratamento para o cargo (Ex.: A Sua Excelência o Senhor)
  20 + * @apiSuccess (Sucesso - 200) {String} resultado.expressaoCargo Descrição do cargo (Ex.: Governador)
  21 + * @apiSuccess (Sucesso - 200) {String} resultado.expressaoTratamento Tratamento para o cargo (Ex.: A Sua Excelência o Senhor)
22 22 * @apiSuccess (Sucesso - 200) {String} resultado.expressaoVocativo Vocativo para o cargo (Ex.: Senhor Governador)
23 23 *
24 24 * @apiErrorExample {json} Error-Response:
25 25 * HTTP/1.1 500 Internal Server Error
26 26 * {
27 27 * "error":"Mensagem de erro."
28   - * "code":"código do erro"
  28 + * "code":"código do erro"
29 29 * }
30 30 */
31 31 \ No newline at end of file
... ...
src/main/resources/apidoc/contato.apidoc
  Diff comments   View file @ee0e973
... ... @@ -10,7 +10,7 @@
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
12 12 *
13   - * @apiExample Exemplo de requisição:
  13 + * @apiExample Exemplo de requisição:
14 14 * curl -i http://<host>/sei-broker/service/cosap/contatos/tipos
15 15 *
16 16 * @apiSuccess (Sucesso - 200) {TipoContato[]} resultado Lista com os tipos de contato, representados por uma Enum TipoContato.
... ... @@ -19,7 +19,7 @@
19 19 * HTTP/1.1 500 Internal Server Error
20 20 * {
21 21 * "error":"Mensagem de erro."
22   - * "code":"código do erro"
  22 + * "code":"código do erro"
23 23 * }
24 24 */
25 25  
... ... @@ -31,7 +31,7 @@
31 31 *
32 32 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
33 33 *
34   - * @apiDescription Consulta os contatos de determinado tipo, o retorno pode ser PessoaFisica ou PessoaJuridica é recomendado utilizar a ans-commons-sei.
  34 + * @apiDescription Consulta os contatos de determinado tipo, o retorno pode ser PessoaFisica ou PessoaJuridica é recomendado utilizar a ans-commons-sei.
35 35 *
36 36 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
37 37 * @apiParam (Path Parameters) {String} tipo Tipo do contato
... ... @@ -41,10 +41,10 @@
41 41 * @apiParam (Query Parameters) {String} [cnpj] CNPJ do contato
42 42 * @apiParam (Query Parameters) {String} [sigla] Sigla(login) do contato
43 43 * @apiParam (Query Parameters) {String} [matricula] Matricula do contato
44   - * @apiParam (Query Parameters) {String} [qtdRegistros = 1] Quantidade de contatos que serão exibidos
45   - * @apiParam (Query Parameters) {String} [pagina = 1] Número da página
  44 + * @apiParam (Query Parameters) {String} [qtdRegistros = 1] Quantidade de contatos que serão exibidos
  45 + * @apiParam (Query Parameters) {String} [pagina = 1] Número da página
46 46 *
47   - * @apiExample Exemplo de requisição:
  47 + * @apiExample Exemplo de requisição:
48 48 * curl -i http://<host>/sei-broker/service/cosap/contatos/operadoras?qtdRegistros=20
49 49 *
50 50 * @apiSuccess (Sucesso - 200) {List} resultado Lista com os contatos encontrados.
... ... @@ -55,27 +55,27 @@
55 55 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato.
56 56 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
57 57 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.celular] Celular do contato.
58   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observações sobre o contato.
59   - * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
60   - * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
61   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
62   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
63   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Número do endereço.
64   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
65   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
66   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
  58 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observações sobre o contato.
  59 + * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
  60 + * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
  61 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
  62 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
  63 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Número do endereço.
  64 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
  65 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
  66 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
67 67 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.uf] Sigla do estado.
68   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] País do endereço.
69   - * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
  68 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] País do endereço.
  69 + * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
70 70 * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
71 71 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
72 72 * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
73 73 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
74 74 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica.
75   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
  75 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
76 76 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
77 77 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica.
78   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
  78 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
79 79 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
80 80 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
81 81 *
... ... @@ -83,15 +83,15 @@
83 83 * HTTP/1.1 200 OK
84 84 * {
85 85 * "@type": "Juridica",
86   - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
  86 + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÃCIOS LTDA",
87 87 * "endereco": {
88   - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
  88 + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
89 89 * "complemento": "Teste de complemento",
90 90 * "numero": null,
91 91 * "uf": "MG",
92 92 * "pais": "Brasil",
93 93 * "cidade": "3101508",
94   - * "bairro": "PRAÇA DA BANDEIRA",
  94 + * "bairro": "PRAÇA DA BANDEIRA",
95 95 * "cep": "36660000"
96 96 * },
97 97 * "email": "teste@email.com",
... ... @@ -108,7 +108,7 @@
108 108 * HTTP/1.1 500 Internal Server Error
109 109 * {
110 110 * "error":"Mensagem de erro."
111   - * "code":"código do erro"
  111 + * "code":"código do erro"
112 112 * }
113 113 */
114 114  
... ... @@ -126,7 +126,7 @@
126 126 * @apiParam (Path Parameters) {String} tipo Tipo do contato
127 127 * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato
128 128 *
129   - * @apiExample Exemplo de requisição:
  129 + * @apiExample Exemplo de requisição:
130 130 * curl -i http://<host>/sei-broker/service/cosap/contatos/operadoras/419761
131 131 *
132 132 * @apiSuccess (Sucesso - 200) {Pessoa} resultado.pessoa Pessoa que representa o contato.
... ... @@ -136,27 +136,27 @@
136 136 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato.
137 137 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
138 138 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.celular] Celular do contato.
139   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observações sobre o contato.
140   - * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
141   - * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
142   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
143   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
144   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Número do endereço.
145   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
146   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
147   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
  139 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observações sobre o contato.
  140 + * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
  141 + * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
  142 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
  143 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
  144 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Número do endereço.
  145 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
  146 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
  147 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
148 148 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.uf] Sigla do estado.
149   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] País do endereço.
150   - * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
  149 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] País do endereço.
  150 + * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
151 151 * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
152 152 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
153 153 * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
154 154 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
155 155 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica.
156   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
  156 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
157 157 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
158 158 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica.
159   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
  159 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
160 160 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
161 161 * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
162 162 *
... ... @@ -164,16 +164,16 @@
164 164 * HTTP/1.1 200 OK
165 165 * {
166 166 * "@type": "Juridica",
167   - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
  167 + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÃCIOS LTDA",
168 168 * "sigla": "419761",
169 169 * "endereco": {
170   - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
  170 + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
171 171 * "complemento": "Teste de complemento",
172 172 * "numero": null,
173 173 * "uf": "MG",
174 174 * "pais": "Brasil",
175 175 * "cidade": "3101508",
176   - * "bairro": "PRAÇA DA BANDEIRA",
  176 + * "bairro": "PRAÇA DA BANDEIRA",
177 177 * "cep": "36660000"
178 178 * },
179 179 * "email": "teste@email.com",
... ... @@ -190,7 +190,7 @@
190 190 * HTTP/1.1 500 Internal Server Error
191 191 * {
192 192 * "error":"Mensagem de erro."
193   - * "code":"código do erro"
  193 + * "code":"código do erro"
194 194 * }
195 195 */
196 196  
... ... @@ -214,46 +214,46 @@
214 214 * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato.
215 215 * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
216 216 * @apiParam (Request Body) {String} [resultado.pessoa.celular] Celular do contato.
217   - * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observações sobre o contato.
218   - * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
219   - * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
220   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
221   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
222   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Número do endereço.
223   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
224   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
225   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
  217 + * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observações sobre o contato.
  218 + * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
  219 + * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
  220 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
  221 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
  222 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Número do endereço.
  223 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
  224 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
  225 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
226 226 * @apiParam (Request Body) {String} [resultado.pessoa.endereco.uf] Sigla do estado.
227   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] País do endereço.
228   - * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
  227 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] País do endereço.
  228 + * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
229 229 * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
230 230 * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
231 231 * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
232 232 * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
233 233 * @apiParam (Request Body) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica.
234   - * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
  234 + * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
235 235 * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
236 236 * @apiParam (Request Body) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica.
237   - * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
  237 + * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
238 238 * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
239 239 * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
240 240 *
241   - * @apiExample Exemplo de requisição:
  241 + * @apiExample Exemplo de requisição:
242 242 * endpoint: http://<host>/sei-broker/service/cosap/contatos/operadoras
243 243 *
244 244 * body:
245 245 * {
246 246 * "@type": "Juridica",
247   - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
  247 + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÃCIOS LTDA",
248 248 * "sigla": "419761",
249 249 * "endereco": {
250   - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
  250 + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
251 251 * "complemento": "Teste de complemento",
252 252 * "numero": null,
253 253 * "uf": "MG",
254 254 * "pais": "Brasil",
255 255 * "cidade": "3101508",
256   - * "bairro": "PRAÇA DA BANDEIRA",
  256 + * "bairro": "PRAÇA DA BANDEIRA",
257 257 * "cep": "36660000"
258 258 * },
259 259 * "email": "teste@email.com",
... ... @@ -272,7 +272,7 @@
272 272 * HTTP/1.1 500 Internal Server Error
273 273 * {
274 274 * "error":"Mensagem de erro."
275   - * "code":"código do erro"
  275 + * "code":"código do erro"
276 276 * }
277 277 */
278 278  
... ... @@ -297,46 +297,46 @@
297 297 * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato.
298 298 * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
299 299 * @apiParam (Request Body) {String} [resultado.pessoa.celular] Celular do contato.
300   - * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observações sobre o contato.
301   - * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
302   - * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
303   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
304   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
305   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Número do endereço.
306   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
307   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
308   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
  300 + * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observações sobre o contato.
  301 + * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
  302 + * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
  303 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
  304 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
  305 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Número do endereço.
  306 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
  307 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
  308 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
309 309 * @apiParam (Request Body) {String} [resultado.pessoa.endereco.uf] Sigla do estado.
310   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] País do endereço.
311   - * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
  310 + * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] País do endereço.
  311 + * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
312 312 * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
313 313 * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
314 314 * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
315 315 * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
316 316 * @apiParam (Request Body) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica.
317   - * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
  317 + * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
318 318 * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
319 319 * @apiParam (Request Body) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica.
320   - * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
  320 + * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
321 321 * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
322 322 * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
323 323 *
324   - * @apiExample Exemplo de requisição:
  324 + * @apiExample Exemplo de requisição:
325 325 * endpoint: http://<host>/sei-broker/service/cosap/contatos/operadoras
326 326 *
327 327 * body:
328 328 * {
329 329 * "@type": "Juridica",
330   - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
  330 + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÃCIOS LTDA",
331 331 * "sigla": "419761",
332 332 * "endereco": {
333   - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
  333 + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
334 334 * "complemento": "Teste de complemento",
335 335 * "numero": null,
336 336 * "uf": "MG",
337 337 * "pais": "Brasil",
338 338 * "cidade": "3101508",
339   - * "bairro": "PRAÇA DA BANDEIRA",
  339 + * "bairro": "PRAÇA DA BANDEIRA",
340 340 * "cep": "36660000"
341 341 * },
342 342 * "email": "teste@email.com",
... ... @@ -356,6 +356,6 @@
356 356 * HTTP/1.1 500 Internal Server Error
357 357 * {
358 358 * "error":"Mensagem de erro."
359   - * "code":"código do erro"
  359 + * "code":"código do erro"
360 360 * }
361 361 */
362 362 \ No newline at end of file
... ...
src/main/resources/apidoc/documento.apidoc
  Diff comments   View file @ee0e973
... ... @@ -9,58 +9,58 @@
9 9 * @apiDescription Consulta documento cadastrado no SEI.
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
12   - * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informações
  12 + * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informações
13 13 *
14   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento = N] exibir o andamento do processo
15   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [assinaturas = N] exibir as assinaturas presentes no documento
16   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [publicacao = N] exibir detalhes da publicação
17   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [campos = N] exibir campos do formulário
  14 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento = N] exibir o andamento do processo
  15 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [assinaturas = N] exibir as assinaturas presentes no documento
  16 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [publicacao = N] exibir detalhes da publicação
  17 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [campos = N] exibir campos do formulário
18 18 *
19   - * @apiExample {curl} Exemplo de requisição:
  19 + * @apiExample {curl} Exemplo de requisição:
20 20 * curl -i https://<host>/sei-broker/service/COSAP/documentos/0000050?assinaturas=S&andamento=S
21 21 *
22   - * @apiSuccess (Sucesso - 200) {RetornoConsultaDocumento} retornoConsultaDocumento Informações do documento encontrado no SEI
  22 + * @apiSuccess (Sucesso - 200) {RetornoConsultaDocumento} retornoConsultaDocumento Informações do documento encontrado no SEI
23 23 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.idProcedimento Id interno do processo no SEI
24   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.procedimentoFormatado Número do processo visível para o usuário
  24 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.procedimentoFormatado Número do processo visível para o usuário
25 25 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.idDocumento Id interno do documento no SEI
26   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.documentoFormatado Número do documento visível para o usuário
  26 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.documentoFormatado Número do documento visível para o usuário
27 27 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.linkAcesso Link para acesso ao documento
28 28 * @apiSuccess (Sucesso - 200) {Serie} retornoConsultaDocumento.serie Dados do tipo do documento
29 29 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.idSerie Identificador do tipo de documento
30 30 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.nome Nome do tipo de documento
31 31 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.aplicabilidade :TODO pendente
32   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.numero Número do documento
33   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.data Data de geração para documentos internos e para documentos externos é a data informada na tela de cadastro
  32 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.numero Número do documento
  33 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.data Data de geração para documentos internos e para documentos externos é a data informada na tela de cadastro
34 34 * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.unidadeElaboradora Dados da unidade que gerou o documento
35 35 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.descricao Nome da unidade
36   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.idUnidade Código da unidade
  36 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.idUnidade Código da unidade
37 37 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sigla Sigla da unidade
38 38 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinProtocolo :TODO pendente
39 39 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinArquivamento :TODO pendente
40 40 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinOuvidoria :TODO pendente
41   - * @apiSuccess (Sucesso - 200) {Andamento} retornoConsultaDocumento.andamentoGeracao Informações do andamento de geração (opcional)
  41 + * @apiSuccess (Sucesso - 200) {Andamento} retornoConsultaDocumento.andamentoGeracao Informações do andamento de geração (opcional)
42 42 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idAndamento Identificador do andamento
43 43 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefa :TODO pendente
44 44 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefaModulo :TODO pendente
45   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.descricao Descrição do andamento
  45 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.descricao Descrição do andamento
46 46 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.dataHora Data e hora do registro de andamento
47   - * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.andamentoGeracao.unidade Unidade responsável pelo andamento (ver estrutura Unidade)
48   - * @apiSuccess (Sucesso - 200) {Usuario} retornoConsultaDocumento.andamentoGeracao.usuario Usuário responsável pela ação
49   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.idUsuario Código do usuário
50   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.nome Nome do usuário
51   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.sigla Login do usuário
  47 + * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.andamentoGeracao.unidade Unidade responsável pelo andamento (ver estrutura Unidade)
  48 + * @apiSuccess (Sucesso - 200) {Usuario} retornoConsultaDocumento.andamentoGeracao.usuario Usuário responsável pela ação
  49 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.idUsuario Código do usuário
  50 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.nome Nome do usuário
  51 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.sigla Login do usuário
52 52 * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} retornoConsultaDocumento.andamentoGeracao.atributos Lista com os atributos relacionados ao andamento
53 53 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.nome Nome do atributo
54 54 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.valor Valor do atributo
55 55 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.idOrigem :TODO pendente
56 56 * @apiSuccess (Sucesso - 200) {Assinatura[]} retornoConsultaDocumento.assinaturas Conjunto de assinaturas do documento
57 57 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.nome Nome do assinante
58   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.cargoFuncao Cargo ou função utilizado no momento da assinatura
  58 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.cargoFuncao Cargo ou função utilizado no momento da assinatura
59 59 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.dataHora Data/hora em que ocorreu a assinatura
60   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idUsuario Identificador do usuário
  60 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idUsuario Identificador do usuário
61 61 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idOrigem :TODO pendente
62 62 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idOrgao :TODO pendente
63   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.sigla Login do usuário responsável pela assinatura
  63 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.sigla Login do usuário responsável pela assinatura
64 64 * @apiSuccess (Sucesso - 200) {Publicacao} retornoConsultaDocumento.publicacao :TODO pendente
65 65 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.nomeVeiculo :TODO pendente
66 66 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.numero :TODO pendente
... ... @@ -73,7 +73,7 @@
73 73 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.pagina :TODO pendente
74 74 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.secao :TODO pendente
75 75 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.data :TODO pendente
76   - * @apiSuccess (Sucesso - 200) {Campo[]} retornoConsultaDocumento.campos Conjunto de campos do formulário
  76 + * @apiSuccess (Sucesso - 200) {Campo[]} retornoConsultaDocumento.campos Conjunto de campos do formulário
77 77 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.nome Nome do campo
78 78 * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.valor Valor do campo
79 79 *
... ... @@ -106,7 +106,7 @@
106 106 * HTTP/1.1 500 Internal Server Error
107 107 * {
108 108 * "error":"Mensagem de erro."
109   - * "code":"código do erro"
  109 + * "code":"código do erro"
110 110 * }
111 111 */
112 112  
... ... @@ -118,41 +118,41 @@
118 118 *
119 119 * @apiPermission RO_SEI_BROKER
120 120 *
121   - * @apiDescription Inclui um documento no SEI, podem ser incluídos documentos internos e externos, para documentos externo o tamanho máximo é 20MB.
  121 + * @apiDescription Inclui um documento no SEI, podem ser incluídos documentos internos e externos, para documentos externo o tamanho máximo é 20MB.
122 122 *
123 123 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
124 124 *
125   - * @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)
  125 + * @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)
126 126 *
127 127 * @apiParam (Request Body) {String = "G (Gerado)","R (Recebido)"} tipo Tipo de documento
128   - * @apiParam (Request Body) {String} idSerie Identificador do tipo de documento no SEI (Consultar serviço Listar Séries)
  128 + * @apiParam (Request Body) {String} idSerie Identificador do tipo de documento no SEI (Consultar serviço Listar Séries)
129 129 * @apiParam (Request Body) {String} idProcedimento Identificador do processo onde o documento deve ser inserido. Opcional se protocoloProcedimento informado
130   - * @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.
131   - * @apiParam (Request Body) {String} [idTipoConferencia] Identificador do tipo de conferência associada com o documento externo
132   - * @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).
133   - * @apiParam (Request Body) {String} [data] Data do documento (dd/MM/yyyy), obrigatório para documentos externos. Passar null para documentos gerados.
134   - * @apiParam (Request Body) {String} [descricao] Descrição do documento para documentos gerados. Passar null para documentos externos
135   - * @apiParam (Request Body) {Remetente} [remetente] Obrigatório para documentos externos, passar null para documentos gerados.
  130 + * @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.
  131 + * @apiParam (Request Body) {String} [idTipoConferencia] Identificador do tipo de conferência associada com o documento externo
  132 + * @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).
  133 + * @apiParam (Request Body) {String} [data] Data do documento (dd/MM/yyyy), obrigatório para documentos externos. Passar null para documentos gerados.
  134 + * @apiParam (Request Body) {String} [descricao] Descrição do documento para documentos gerados. Passar null para documentos externos
  135 + * @apiParam (Request Body) {Remetente} [remetente] Obrigatório para documentos externos, passar null para documentos gerados.
136 136 * @apiParam (Request Body) {String} [remetente.nome] Nome do remetente
137 137 * @apiParam (Request Body) {String} [remetente.sigla] Login do remetente
138   - * @apiParam (Request Body) {Interessado[]} [interessados] Informar um conjunto com os dados de interessados. Se não existirem interessados deve ser informado um conjunto vazio
  138 + * @apiParam (Request Body) {Interessado[]} [interessados] Informar um conjunto com os dados de interessados. Se não existirem interessados deve ser informado um conjunto vazio
139 139 * @apiParam (Request Body) {String} [interessados.nome] Nome do interessado
140 140 * @apiParam (Request Body) {String} [interessados.sigla] Login do interessado
141   - * @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
142   - * @apiParam (Request Body) {String} [destinatarios.nome] Nome do destinatário
143   - * @apiParam (Request Body) {String} [destinatarios.sigla] Login do destinatário
144   - * @apiParam (Request Body) {String} [observacao] Texto da observação da unidade, passar null se não existir
145   - * @apiParam (Request Body) {String{200}} [nomeArquivo] Nome do arquivo, obrigatório para documentos externos. Passar null para documentos gerados.
146   - * @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.
147   - * @apiParam (Request Body) {String = "0 (público)","1 (restrito)", "2 (sigiloso)", "null (herda do tipo de processo)"} [nivelAcesso] Nível de acesso do documento
148   - * @apiParam (Request Body) {String} [idHipoteseLegal] Identificador da hipótese legal associada
149   - * @apiParam (Request Body) {String} [idArquivo] Identificador do arquivo enviado pelo serviço de Incluir Arquivo
150   - * @apiParam (Request Body) {String = "S (Sim)","N (Não)"} [sinBloqueado] Bloquear o documento, não permite excluí-lo ou alterar seu conteúdo
151   - * @apiParam (Request Body) {Campo} [campos] Conjunto de campos associados com o formulário
  141 + * @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
  142 + * @apiParam (Request Body) {String} [destinatarios.nome] Nome do destinatário
  143 + * @apiParam (Request Body) {String} [destinatarios.sigla] Login do destinatário
  144 + * @apiParam (Request Body) {String} [observacao] Texto da observação da unidade, passar null se não existir
  145 + * @apiParam (Request Body) {String{200}} [nomeArquivo] Nome do arquivo, obrigatório para documentos externos. Passar null para documentos gerados.
  146 + * @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.
  147 + * @apiParam (Request Body) {String = "0 (público)","1 (restrito)", "2 (sigiloso)", "null (herda do tipo de processo)"} [nivelAcesso] Nível de acesso do documento
  148 + * @apiParam (Request Body) {String} [idHipoteseLegal] Identificador da hipótese legal associada
  149 + * @apiParam (Request Body) {String} [idArquivo] Identificador do arquivo enviado pelo serviço de Incluir Arquivo
  150 + * @apiParam (Request Body) {String = "S (Sim)","N (Não)"} [sinBloqueado] Bloquear o documento, não permite excluí-lo ou alterar seu conteúdo
  151 + * @apiParam (Request Body) {Campo} [campos] Conjunto de campos associados com o formulário
152 152 * @apiParam (Request Body) {String} [campos.nome] Nome do campo
153 153 * @apiParam (Request Body) {String} [campos.valor] Valor do campo
154 154 *
155   - * @apiExample Exemplo de requisição:
  155 + * @apiExample Exemplo de requisição:
156 156 * endpoint: https://<host>/sei-broker/service/COSAP/documentos
157 157 *
158 158 * body:
... ... @@ -165,16 +165,16 @@
165 165 * "data":null,
166 166 * "descricao":"Documento demonstrativo",
167 167 * "remetente":null,
168   - * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}],
  168 + * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}],
169 169 * "destinatarios":[],
170 170 * "observacao":null,
171 171 * "nomeArquivo":null,
172   - * "conteudo":"Conteúdo Base64",
  172 + * "conteudo":"Conteúdo Base64",
173 173 * "nivelAcesso":"0"
174 174 * }
175 175 *
176   - * @apiSuccess (Sucesso Response Body - 201) {String} idDocumento número interno do documento
177   - * @apiSuccess (Sucesso Response Body - 201) {String} documentoFormatado número do documento visível para o usuário
  176 + * @apiSuccess (Sucesso Response Body - 201) {String} idDocumento número interno do documento
  177 + * @apiSuccess (Sucesso Response Body - 201) {String} documentoFormatado número do documento visível para o usuário
178 178 * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso link para acesso ao documento
179 179 *
180 180 * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado.
... ... @@ -191,7 +191,7 @@
191 191 * HTTP/1.1 500 Internal Server Error
192 192 * {
193 193 * "error":"Mensagem de erro."
194   - * "code":"código do erro"
  194 + * "code":"código do erro"
195 195 * }
196 196 */
197 197  
... ... @@ -207,10 +207,10 @@
207 207 *
208 208 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
209 209 *
210   - * @apiParam (Request Body) {String} documento Numero do documento que será cancelado
  210 + * @apiParam (Request Body) {String} documento Numero do documento que será cancelado
211 211 * @apiParam (Request Body) {String} motivo Motivo do cancelamento
212 212 *
213   - * @apiExample Exemplo de requisição:
  213 + * @apiExample Exemplo de requisição:
214 214 * endpoint: https://<host>/sei-broker/service/COSAP/documentos/cancelados
215 215 *
216 216 * body:
... ... @@ -220,13 +220,13 @@
220 220 * }
221 221 *
222 222 *
223   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  223 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
224 224 *
225 225 * @apiErrorExample {json} Error-Response:
226 226 * HTTP/1.1 500 Internal Server Error
227 227 * {
228 228 * "error":"Mensagem de erro."
229   - * "code":"código do erro"
  229 + * "code":"código do erro"
230 230 * }
231 231 */
232 232  
... ... @@ -242,25 +242,25 @@
242 242 *
243 243 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
244 244 *
245   - * @apiParam (Query Parameters) {String} [hash] Hash SHA-256 gerado a partir do conteúdo enviado ao Broker
246   - * @apiParam (Query Parameters) {String} [processo] Número do processo onde o documento foi inserido
247   - * @apiParam (Query Parameters) {String} [numeroInformado] Número informado na inclusão do documento, exibido na árvore do processo.
248   - * @apiParam (Query Parameters) {String} [pagina=1] Número da página
249   - * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que serão exibidos por página
  245 + * @apiParam (Query Parameters) {String} [hash] Hash SHA-256 gerado a partir do conteúdo enviado ao Broker
  246 + * @apiParam (Query Parameters) {String} [processo] Número do processo onde o documento foi inserido
  247 + * @apiParam (Query Parameters) {String} [numeroInformado] Número informado na inclusão do documento, exibido na árvore do processo.
  248 + * @apiParam (Query Parameters) {String} [pagina=1] Número da página
  249 + * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que serão exibidos por página
250 250 *
251   - * @apiExample Exemplo de requisição:
  251 + * @apiExample Exemplo de requisição:
252 252 * curl -i https://<host>/sei-broker/service/COSAP/documentos/enviados-broker?pagina=1&qtdRegsitros=30
253 253 *
254 254 * @apiSuccess (Sucesso Response Body - 200) {InclusaoDocumento} resultado Objeto com dados sobre o documento
255   - * @apiSuccess (Sucesso Response Body - 200) {Date} resultado.data Data do envio (padrão ISO-8601)
256   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.hash Hash SHA-256 gerado a partir do conteúdo enviado ao Broker
257   - * @apiSuccess (Sucesso Response Body - 200) {Integer} resultado.id Identificação da inclusão de documento
258   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.nome Nome do documento incluído
259   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numero Número retonado pelo SEI, NULL caso tenha ocorrido algum problema.
260   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.processo Número do processo
261   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.sistema Sistema responsável pela inclusão
262   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.unidade Unidade onde foi incluído o documento
263   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numeroInformado Valor opcional informado na inclusão do documento
  255 + * @apiSuccess (Sucesso Response Body - 200) {Date} resultado.data Data do envio (padrão ISO-8601)
  256 + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.hash Hash SHA-256 gerado a partir do conteúdo enviado ao Broker
  257 + * @apiSuccess (Sucesso Response Body - 200) {Integer} resultado.id Identificação da inclusão de documento
  258 + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.nome Nome do documento incluído
  259 + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numero Número retonado pelo SEI, NULL caso tenha ocorrido algum problema.
  260 + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.processo Número do processo
  261 + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.sistema Sistema responsável pela inclusão
  262 + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.unidade Unidade onde foi incluído o documento
  263 + * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numeroInformado Valor opcional informado na inclusão do documento
264 264 *
265 265 * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta
266 266 *
... ... @@ -269,7 +269,7 @@
269 269 * {
270 270 * "id": 1717,
271 271 * "data": "2016-10-31T11:59:56.016+0000",
272   - * "nome": "Doc Homologação.pdf",
  272 + * "nome": "Doc Homologação.pdf",
273 273 * "numero": "0003312",
274 274 * "hash": "ca7ebe0c37419db14ffd4f09485a1ebed8e8deeed594e15720da185ee32e9d19",
275 275 * "sistema": "desenv_integracao_sei",
... ... @@ -282,7 +282,7 @@
282 282 * HTTP/1.1 500 Internal Server Error
283 283 * {
284 284 * "error":"Mensagem de erro."
285   - * "code":"código do erro"
  285 + * "code":"código do erro"
286 286 * }
287 287 */
288 288  
... ... @@ -299,9 +299,9 @@
299 299 * @apiParam (Header Parameters) {String} Accept Utilize application/pdf
300 300 *
301 301 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
302   - * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informações
  302 + * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informações
303 303 *
304   - * @apiExample {curl} Exemplo de requisição:
  304 + * @apiExample {curl} Exemplo de requisição:
305 305 * curl -i https://<host>/sei-broker/service/COSIT/documentos/0003322
306 306 *
307 307 * @apiSuccess (Sucesso - 200) {PDF} binario Arquivo no formato PDF.
... ... @@ -310,7 +310,7 @@
310 310 * HTTP/1.1 500 Internal Server Error
311 311 * {
312 312 * "error":"Mensagem de erro."
313   - * "code":"código do erro"
  313 + * "code":"código do erro"
314 314 * }
315 315 */
316 316  
... ... @@ -326,28 +326,28 @@
326 326 *
327 327 * @apiParam (Path Parameters) {String} interessado Identificador do interessado
328 328 *
329   - * @apiParam (Query Parameters) {String} [tipo] Tipo/Série do documento
  329 + * @apiParam (Query Parameters) {String} [tipo] Tipo/Série do documento
330 330 * @apiParam (Query Parameters) {boolean} [somenteAssinados=false] Exibir somente documentos assinados
331   - * @apiParam (Query Parameters) {boolean} [orderByProcesso=false] Ordenar pelo número do processo, por padrão o retorno é ordenado pela dataGeracao
  331 + * @apiParam (Query Parameters) {boolean} [orderByProcesso=false] Ordenar pelo número do processo, por padrão o retorno é ordenado pela dataGeracao
332 332 * @apiParam (Query Parameters) {boolean} [crescente=false] Ordenar em ordem crescente
333   - * @apiParam (Query Parameters) {String} [pagina=1] Número da página
334   - * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por página
  333 + * @apiParam (Query Parameters) {String} [pagina=1] Número da página
  334 + * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por página
335 335 *
336   - * @apiExample Exemplo de requisição:
  336 + * @apiExample Exemplo de requisição:
337 337 * curl -i https://<host>/sei-broker/service/interessados/005711/documentos
338 338 *
339 339 * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados.
340 340 * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentos.documentoResumido Resumo do documento encontrado no SEI.
341   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Número do documento.
342   - * @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.
343   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.unidade Unidade responsável pelo documento.
344   - * @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.
345   - * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de geração do documento.
346   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.processo Processo onde o documento está incluído.
  341 + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Número do documento.
  342 + * @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.
  343 + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.unidade Unidade responsável pelo documento.
  344 + * @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.
  345 + * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de geração do documento.
  346 + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.processo Processo onde o documento está incluído.
347 347 * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentos.documentoResumido.tipo Objeto representando o tipo do documento.
348   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série.
  348 + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série.
349 349 * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.nome Nome do tipo do documento.
350   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferência do documento.
  350 + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferência do documento.
351 351 * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado.
352 352 *
353 353 * @apiSuccess (Sucesso Response Header - 200) {header} total_registros Quantidade de registros que existem para essa consulta
... ... @@ -363,7 +363,7 @@
363 363 * "processo": "33910.000002/2017-41",
364 364 * "tipo": {
365 365 * "codigo": "629",
366   - * "nome": "Relatório de Arquivamento-SIF"
  366 + * "nome": "Relatório de Arquivamento-SIF"
367 367 * }
368 368 * "tipoConferencia": "4",
369 369 * "assinado": true
... ... @@ -373,7 +373,37 @@
373 373 * HTTP/1.1 500 Internal Server Error
374 374 * {
375 375 * "error":"Mensagem de erro."
376   - * "code":"código do erro"
  376 + * "code":"código do erro"
377 377 * }
378 378 */
379 379  
  380 + /**
  381 + * @api {get} /:unidade/tipos-documentos Listar tipos documentos
  382 + * @apiName listarTiposDocumentos
  383 + * @apiGroup Documento
  384 + * @apiVersion 2.0.0
  385 + *
  386 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  387 + *
  388 + * @apiDescription Lista os tipos de documentos do SEI.
  389 + *
  390 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  391 + *
  392 + * @apiParam (Query Parameters) {String} [filtro] Para filtrar por documentos que contenham o trecho no nome.
  393 + * @apiParam (Query Parameters) {String} [nome] Para selecionar a série que possua nome igual.
  394 + *
  395 + * @apiExample {curl} Exemplo de requisição:
  396 + * curl -i https://<host>/sei-broker/service/COSAP/tipos-documentos
  397 + *
  398 + * @apiSuccess (Sucesso - 200) {List} tipos Lista com os tipos de documentos
  399 + * @apiSuccess (Sucesso - 200) {String} tipos.identificador Identificador do tipo de documento
  400 + * @apiSuccess (Sucesso - 200) {String} tipos.nome Nome do tipo de documento
  401 + * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários
  402 + *
  403 + * @apiErrorExample {json} Error-Response:
  404 + * HTTP/1.1 500 Internal Server Error
  405 + * {
  406 + * "error":"Mensagem de erro."
  407 + * "code":"código do erro"
  408 + * }
  409 + */
380 410 \ No newline at end of file
... ...
src/main/resources/apidoc/extensao.apidoc
  Diff comments   View file @ee0e973
1 1 /**
2   - * @api {get} /:unidade/extensoes Listar extensões
  2 + * @api {get} /:unidade/extensoes Listar extensões
3 3 * @apiName listarExtensoesPermitidas
4 4 * @apiGroup Extensao
5 5 * @apiVersion 2.0.0
6 6 *
7 7 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
8 8 *
9   - * @apiDescription Este método realiza uma busca pelas extensões de arquivos permitidas.
  9 + * @apiDescription Este método realiza uma busca pelas extensões de arquivos permitidas.
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
12 12 *
13   - * @apiParam (Query Parameters) {String} [extensao=null] Para filtrar por uma determinada extensão.
  13 + * @apiParam (Query Parameters) {String} [extensao=null] Para filtrar por uma determinada extensão.
14 14 *
15   - * @apiExample {curl} Exemplo de requisição:
  15 + * @apiExample {curl} Exemplo de requisição:
16 16 * curl -i http://<host>/sei-broker/service/COSAP/extensoes/
17 17 *
18   - * @apiSuccess (Sucesso - 200) {ArquivoExtensao[]} extensoes Lista de extensões permitidas.
19   - * @apiSuccess (Sucesso - 200) {String} extensoes.idArquivoExtensao Identificador interno do SEI relativo a extensão
20   - * @apiSuccess (Sucesso - 200) {String} extensoes.extensao Texto da extensão (ex.: pdf, ods, doc, ppt,...)
21   - * @apiSuccess (Sucesso - 200) {String} extensoes.descricao Descrição da extensão
  18 + * @apiSuccess (Sucesso - 200) {ArquivoExtensao[]} extensoes Lista de extensões permitidas.
  19 + * @apiSuccess (Sucesso - 200) {String} extensoes.idArquivoExtensao Identificador interno do SEI relativo a extensão
  20 + * @apiSuccess (Sucesso - 200) {String} extensoes.extensao Texto da extensão (ex.: pdf, ods, doc, ppt,...)
  21 + * @apiSuccess (Sucesso - 200) {String} extensoes.descricao Descrição da extensão
22 22 *
23 23 * @apiErrorExample {json} Error-Response:
24 24 * HTTP/1.1 500 Internal Server Error
25 25 * {
26 26 * "error":"Mensagem de erro."
27   - * "code":"código do erro"
  27 + * "code":"código do erro"
28 28 * }
29 29 */
30 30 \ No newline at end of file
... ...
src/main/resources/apidoc/hipoteseLegal.apidoc
  Diff comments   View file @ee0e973
1 1 /**
2   - * @api {get} /:unidade/hipoteses-legais Listar hipóteses legais
  2 + * @api {get} /:unidade/hipoteses-legais Listar hipóteses legais
3 3 * @apiName listarHipoteses
4 4 * @apiGroup Hipotese Legal
5 5 * @apiVersion 2.0.0
6 6 *
7 7 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
8 8 *
9   - * @apiDescription Lista as hipóteses legais.
  9 + * @apiDescription Lista as hipóteses legais.
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
12 12 *
13   - * @apiParam (Query Parameters) {String} [nivelAcesso] Filtra hipóteses pelo nível de acesso associado (1 - restrito, 2 - sigiloso)
  13 + * @apiParam (Query Parameters) {String} [nivelAcesso] Filtra hipóteses pelo nível de acesso associado (1 - restrito, 2 - sigiloso)
14 14 *
15   - * @apiExample Exemplo de requisição:
  15 + * @apiExample Exemplo de requisição:
16 16 * curl -i https://<host>/sei-broker/service/COSAP/hipoteses-legais
17 17 *
18   - * @apiSuccess (Sucesso - 200) {HipoteseLegal[]} resultado Lista com as hipóteses legais encontrados
19   - * @apiSuccess (Sucesso - 200) {String} resultado.idHipoteseLegal Identificador da hipótese legal no SEI
20   - * @apiSuccess (Sucesso - 200) {String} resultado.nome Nome da hipótese legal
21   - * @apiSuccess (Sucesso - 200) {String} resultado.baseLegal Descrição da base legal
22   - * @apiSuccess (Sucesso - 200) {String} resultado.nivelAcesso Nivel de acesso associado a hipótese legal
  18 + * @apiSuccess (Sucesso - 200) {HipoteseLegal[]} resultado Lista com as hipóteses legais encontrados
  19 + * @apiSuccess (Sucesso - 200) {String} resultado.idHipoteseLegal Identificador da hipótese legal no SEI
  20 + * @apiSuccess (Sucesso - 200) {String} resultado.nome Nome da hipótese legal
  21 + * @apiSuccess (Sucesso - 200) {String} resultado.baseLegal Descrição da base legal
  22 + * @apiSuccess (Sucesso - 200) {String} resultado.nivelAcesso Nivel de acesso associado a hipótese legal
23 23 *
24 24 * @apiErrorExample {json} Error-Response:
25 25 * HTTP/1.1 500 Internal Server Error
26 26 * {
27 27 * "error":"Mensagem de erro."
28   - * "code":"código do erro"
  28 + * "code":"código do erro"
29 29 * }
30 30 */
31 31 \ No newline at end of file
... ...
src/main/resources/apidoc/info.apidoc
  Diff comments   View file @ee0e973
1 1 /**
2   - * @api {get} /info/versao Consultar versão
  2 + * @api {get} /info/versao Consultar versão
3 3 * @apiName getNumeroVersao
4 4 * @apiGroup Info
5 5 * @apiVersion 2.0.0
6 6 *
7   - * @apiDescription Este método realiza uma consulta para saber a versão do sei-broker que está disponível.
  7 + * @apiDescription Este método realiza uma consulta para saber a versão do sei-broker que está disponível.
8 8 *
9   - * @apiExample {curl} Exemplo de requisição:
  9 + * @apiExample {curl} Exemplo de requisição:
10 10 * curl -i http://<host>/sei-broker/service/info/versao
11 11 *
12   - * @apiSuccess {String} versao Número da versão.
  12 + * @apiSuccess {String} versao Número da versão.
13 13 *
14 14 * @apiErrorExample {json} Error-Response:
15 15 * HTTP/1.1 500 Internal Server Error
16 16 * {
17 17 * "error":"Mensagem de erro."
18   - * "code":"código do erro"
  18 + * "code":"código do erro"
19 19 * }
20 20 */
21 21  
22 22 /**
23   - * @api {get} /info/conexoes/mysql Testar conexão MySQL
  23 + * @api {get} /info/conexoes/mysql Testar conexão MySQL
24 24 * @apiName testMySQLConnection
25 25 * @apiGroup Info
26 26 * @apiVersion 2.0.0
27 27 *
28   - * @apiDescription Testa a conexão com o MySQL e retorna o número de versão do banco.
  28 + * @apiDescription Testa a conexão com o MySQL e retorna o número de versão do banco.
29 29 *
30   - * @apiExample {curl} Exemplo de requisição:
  30 + * @apiExample {curl} Exemplo de requisição:
31 31 * curl -i http://<host>/sei-broker/service/info/conexoes/mysql
32 32 *
33   - * @apiSuccess {String} versao Número de versão do MySQL.
  33 + * @apiSuccess {String} versao Número de versão do MySQL.
34 34 *
35 35 * @apiErrorExample {json} Error-Response:
36 36 * HTTP/1.1 500 Internal Server Error
37 37 * {
38 38 * "error":"Mensagem de erro."
39   - * "code":"código do erro"
  39 + * "code":"código do erro"
40 40 * }
41 41 */
42 42  
43 43 /**
44   - * @api {get} /info/conexoes/oracle Testar conexão Oracle
  44 + * @api {get} /info/conexoes/oracle Testar conexão Oracle
45 45 * @apiName testOracleConnection
46 46 * @apiGroup Info
47 47 * @apiVersion 2.0.0
48 48 *
49   - * @apiDescription Testa a conexão com o Oracle e retorna o número de versão do banco.
  49 + * @apiDescription Testa a conexão com o Oracle e retorna o número de versão do banco.
50 50 *
51   - * @apiExample {curl} Exemplo de requisição:
  51 + * @apiExample {curl} Exemplo de requisição:
52 52 * curl -i http://<host>/sei-broker/service/info/conexoes/oracle
53 53 *
54   - * @apiSuccess {String} versao Número de versão do Oracle.
  54 + * @apiSuccess {String} versao Número de versão do Oracle.
55 55 *
56 56 * @apiErrorExample {json} Error-Response:
57 57 * HTTP/1.1 500 Internal Server Error
58 58 * {
59 59 * "error":"Mensagem de erro."
60   - * "code":"código do erro"
  60 + * "code":"código do erro"
61 61 * }
62 62 */
63 63  
64 64 /**
65   - * @api {get} /info/conexoes/sei Testar conexão SEI
  65 + * @api {get} /info/conexoes/sei Testar conexão SEI
66 66 * @apiName testSEIConnection
67 67 * @apiGroup Info
68 68 * @apiVersion 2.0.0
69 69 *
70   - * @apiDescription Testa a conexão com o SEI fazendo uma consulta ao serviço listar unidades.
  70 + * @apiDescription Testa a conexão com o SEI fazendo uma consulta ao serviço listar unidades.
71 71 *
72   - * @apiExample {curl} Exemplo de requisição:
  72 + * @apiExample {curl} Exemplo de requisição:
73 73 * curl -i http://<host>/sei-broker/service/info/conexoes/sei
74 74 *
75 75 * @apiSuccess {String} mensagem Mensagem de sucesso.
... ... @@ -78,7 +78,7 @@
78 78 * HTTP/1.1 500 Internal Server Error
79 79 * {
80 80 * "error":"Mensagem de erro."
81   - * "code":"código do erro"
  81 + * "code":"código do erro"
82 82 * }
83 83 */
84 84  
... ... @@ -91,12 +91,12 @@
91 91 * @apiDescription Lista os requests recebidos pelo broker.
92 92 *
93 93 *
94   - * @apiParam (Query Parameters) {String} [operacao] nome do método acessado
95   - * @apiParam (Query Parameters) {String} [origem] usuário que originou a requisição
96   - * @apiParam (Query Parameters) {int} [pag=1] número da página
97   - * @apiParam (Query Parameters) {int} [itens=50] quantidade de itens listados por página
  94 + * @apiParam (Query Parameters) {String} [operacao] nome do método acessado
  95 + * @apiParam (Query Parameters) {String} [origem] usuário que originou a requisição
  96 + * @apiParam (Query Parameters) {int} [pag=1] número da página
  97 + * @apiParam (Query Parameters) {int} [itens=50] quantidade de itens listados por página
98 98 *
99   - * @apiExample {curl} Exemplo de requisição:
  99 + * @apiExample {curl} Exemplo de requisição:
100 100 * curl -i http://<host>/sei-broker/service/info/requests
101 101 *
102 102 * @apiSuccess {String} mensagem Mensagem de sucesso.
... ... @@ -105,6 +105,6 @@
105 105 * HTTP/1.1 500 Internal Server Error
106 106 * {
107 107 * "error":"Mensagem de erro."
108   - * "code":"código do erro"
  108 + * "code":"código do erro"
109 109 * }
110 110 */
111 111 \ No newline at end of file
... ...
src/main/resources/apidoc/infra.apidoc
  Diff comments   View file @ee0e973
1 1 /**
2   - * @api {get} /:unidade/paises Listar países
  2 + * @api {get} /:unidade/paises Listar países
3 3 * @apiName getPaises
4 4 * @apiGroup Endereco
5 5 * @apiVersion 2.0.0
6 6 *
7 7 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
8 8 *
9   - * @apiDescription Consulta países cadastrados.
  9 + * @apiDescription Consulta países cadastrados.
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
12 12 *
13   - * @apiExample Exemplo de requisição:
  13 + * @apiExample Exemplo de requisição:
14 14 * curl -i http://<host>/sei-broker/service/cosap/paises
15 15 *
16   - * @apiSuccess (Sucesso - 200) {List} resultado Lista com os países.
17   - * @apiSuccess (Sucesso - 200) {Pais} resultado.pais Objeto representando o país.
18   - * @apiSuccess (Sucesso - 200) {String} resultado.pais.idPais Identificador do país no SEI.
19   - * @apiSuccess (Sucesso - 200) {String} resultado.pais.nome Nome do país.
  16 + * @apiSuccess (Sucesso - 200) {List} resultado Lista com os países.
  17 + * @apiSuccess (Sucesso - 200) {Pais} resultado.pais Objeto representando o país.
  18 + * @apiSuccess (Sucesso - 200) {String} resultado.pais.idPais Identificador do país no SEI.
  19 + * @apiSuccess (Sucesso - 200) {String} resultado.pais.nome Nome do país.
20 20 *
21 21 * @apiSuccessExample {json} Success-Response:
22 22 * HTTP/1.1 200 OK
23 23 * {
24 24 * "idPais": "4",
25   - * "nome": "Afeganistão"
  25 + * "nome": "Afeganistão"
26 26 * }
27 27 *
28 28 * @apiErrorExample {json} Error-Response:
29 29 * HTTP/1.1 500 Internal Server Error
30 30 * {
31 31 * "error":"Mensagem de erro."
32   - * "code":"código do erro"
  32 + * "code":"código do erro"
33 33 * }
34 34 */
35 35  
... ... @@ -45,16 +45,16 @@
45 45 *
46 46 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
47 47 *
48   - * @apiExample Exemplo de requisição:
  48 + * @apiExample Exemplo de requisição:
49 49 * curl -i http://<host>/sei-broker/service/cosap/estados
50 50 *
51 51 * @apiSuccess (Sucesso - 200) {List} resultado Lista com os estados.
52 52 * @apiSuccess (Sucesso - 200) {Estado} resultado.estado Objeto representando um estado.
53 53 * @apiSuccess (Sucesso - 200) {String} resultado.estado.idEstado Identificador do estado no SEI.
54   - * @apiSuccess (Sucesso - 200) {String} resultado.estado.idPais Identificador do país no SEI.
  54 + * @apiSuccess (Sucesso - 200) {String} resultado.estado.idPais Identificador do país no SEI.
55 55 * @apiSuccess (Sucesso - 200) {String} resultado.estado.sigla Sigla do estado.
56 56 * @apiSuccess (Sucesso - 200) {String} resultado.estado.nome Nome do estado.
57   - * @apiSuccess (Sucesso - 200) {String} resultado.estado.codigoIbge Código do IBGE.
  57 + * @apiSuccess (Sucesso - 200) {String} resultado.estado.codigoIbge Código do IBGE.
58 58 *
59 59 * @apiSuccessExample {json} Success-Response:
60 60 * HTTP/1.1 200 OK
... ... @@ -70,7 +70,7 @@
70 70 * HTTP/1.1 500 Internal Server Error
71 71 * {
72 72 * "error":"Mensagem de erro."
73   - * "code":"código do erro"
  73 + * "code":"código do erro"
74 74 * }
75 75 */
76 76  
... ... @@ -89,15 +89,15 @@
89 89 *
90 90 * @apiParam (Query Parameters) {String} [pais="76 (Brasil)"] Identificador do pais que deseja listar os estados.
91 91 *
92   - * @apiExample Exemplo de requisição:
  92 + * @apiExample Exemplo de requisição:
93 93 * curl -i http://<host>/sei-broker/service/cosap/estados/AC
94 94 *
95 95 * @apiSuccess (Sucesso - 200) {Estado} estado Objeto representando um estado.
96 96 * @apiSuccess (Sucesso - 200) {String} estado.idEstado Identificador do estado no SEI.
97   - * @apiSuccess (Sucesso - 200) {String} estado.idPais Identificador do país no SEI.
  97 + * @apiSuccess (Sucesso - 200) {String} estado.idPais Identificador do país no SEI.
98 98 * @apiSuccess (Sucesso - 200) {String} estado.sigla Sigla do estado.
99 99 * @apiSuccess (Sucesso - 200) {String} estado.nome Nome do estado.
100   - * @apiSuccess (Sucesso - 200) {String} estado.codigoIbge Código do IBGE.
  100 + * @apiSuccess (Sucesso - 200) {String} estado.codigoIbge Código do IBGE.
101 101 *
102 102 * @apiSuccessExample {json} Success-Response:
103 103 * HTTP/1.1 200 OK
... ... @@ -113,7 +113,7 @@
113 113 * HTTP/1.1 500 Internal Server Error
114 114 * {
115 115 * "error":"Mensagem de erro."
116   - * "code":"código do erro"
  116 + * "code":"código do erro"
117 117 * }
118 118 */
119 119  
... ... @@ -132,13 +132,13 @@
132 132 *
133 133 * @apiParam (Query Parameters) {String} [filtro] String utilizada para filtrar as cidades.
134 134 *
135   - * @apiExample Exemplo de requisição:
  135 + * @apiExample Exemplo de requisição:
136 136 * curl -i http://<host>/sei-broker/service/cosap/estados/rj/cidades?filtro=paraiba
137 137 *
138 138 * @apiSuccess (Sucesso - 200) {List} resultado Lista com os cidades encontradas.
139 139 * @apiSuccess (Sucesso - 200) {Cidade} resultado.cidade Objeto representando uma cidade.
140 140 * @apiSuccess (Sucesso - 200) {String} resultado.cidade.nome Nome da cidade.
141   - * @apiSuccess (Sucesso - 200) {String} resultado.cidade.codigoIbge Código do IBGE.
  141 + * @apiSuccess (Sucesso - 200) {String} resultado.cidade.codigoIbge Código do IBGE.
142 142 * @apiSuccess (Sucesso - 200) {Estado} resultado.cidade.estado Objeto representando um estado.
143 143 * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.nome Nome do estado.
144 144 * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.sigla Sigla do estado.
... ... @@ -150,7 +150,7 @@
150 150 * "sigla": "RJ",
151 151 * "nome": "Rio de Janeiro"
152 152 * },
153   - * "nome": "Paraíba do Sul",
  153 + * "nome": "Paraíba do Sul",
154 154 * "codigoIbge": "3303708"
155 155 * }
156 156 *
... ... @@ -158,7 +158,7 @@
158 158 * HTTP/1.1 500 Internal Server Error
159 159 * {
160 160 * "error":"Mensagem de erro."
161   - * "code":"código do erro"
  161 + * "code":"código do erro"
162 162 * }
163 163 */
164 164  
... ... @@ -170,18 +170,18 @@
170 170 *
171 171 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
172 172 *
173   - * @apiDescription Consulta a cidade pelo código do IBGE.
  173 + * @apiDescription Consulta a cidade pelo código do IBGE.
174 174 *
175 175 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
176 176 * @apiParam (Path Parameters) {String} estado Sigla do estado.
177   - * @apiParam (Path Parameters) {String} cidade Código do IBGE.
  177 + * @apiParam (Path Parameters) {String} cidade Código do IBGE.
178 178 *
179   - * @apiExample Exemplo de requisição:
  179 + * @apiExample Exemplo de requisição:
180 180 * curl -i http://<host>/sei-broker/service/cosap/estados/rj/cidades/3303708
181 181 *
182 182 * @apiSuccess (Sucesso - 200) {Cidade} cidade Objeto representando uma cidade.
183 183 * @apiSuccess (Sucesso - 200) {String} cidade.nome Nome da cidade.
184   - * @apiSuccess (Sucesso - 200) {String} cidade.codigoIbge Código do IBGE.
  184 + * @apiSuccess (Sucesso - 200) {String} cidade.codigoIbge Código do IBGE.
185 185 * @apiSuccess (Sucesso - 200) {Estado} cidade.estado Objeto representando um estado.
186 186 * @apiSuccess (Sucesso - 200) {String} cidade.estado.nome Nome do estado.
187 187 * @apiSuccess (Sucesso - 200) {String} cidade.estado.sigla Sigla do estado.
... ... @@ -193,7 +193,7 @@
193 193 * "sigla": "RJ",
194 194 * "nome": "Rio de Janeiro"
195 195 * },
196   - * "nome": "Paraíba do Sul",
  196 + * "nome": "Paraíba do Sul",
197 197 * "codigoIbge": "3303708"
198 198 * }
199 199 *
... ... @@ -201,6 +201,6 @@
201 201 * HTTP/1.1 500 Internal Server Error
202 202 * {
203 203 * "error":"Mensagem de erro."
204   - * "code":"código do erro"
  204 + * "code":"código do erro"
205 205 * }
206 206 */
207 207 \ No newline at end of file
... ...
src/main/resources/apidoc/marcador.apidoc
  Diff comments   View file @ee0e973
... ... @@ -10,20 +10,20 @@
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
12 12 *
13   - * @apiExample {curl} Exemplo de requisição:
  13 + * @apiExample {curl} Exemplo de requisição:
14 14 * curl -i https://<host>/sei-broker/service/cosap/marcadores
15 15 *
16 16 * @apiSuccess (Sucesso - 200) {Marcador[]} marcadores Lista de marcadores
17 17 * @apiSuccess (Sucesso - 200) {String} marcadores.id Identificador do marcador.
18 18 * @apiSuccess (Sucesso - 200) {String} marcadores.nome Nome do marcador.
19   - * @apiSuccess (Sucesso - 200) {String} marcadores.icone Ícone do marcador em formato PNG codificado em Base64.
20   - * @apiSuccess (Sucesso - 200) {String} marcadores.sinAtivo S/N - Sinalizador indica se o marcador está ativo.
  19 + * @apiSuccess (Sucesso - 200) {String} marcadores.icone Ãcone do marcador em formato PNG codificado em Base64.
  20 + * @apiSuccess (Sucesso - 200) {String} marcadores.sinAtivo S/N - Sinalizador indica se o marcador está ativo.
21 21 *
22 22 * @apiErrorExample {json} Error-Response:
23 23 * HTTP/1.1 500 Internal Server Error
24 24 * {
25 25 * "error":"Mensagem de erro."
26   - * "code":"código do erro"
  26 + * "code":"código do erro"
27 27 * }
28 28 */
29 29  
... ... @@ -40,11 +40,11 @@
40 40 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
41 41 * @apiParam (Path Parameters) {String} identificador Identificador do marcador no SEI.
42 42 *
43   - * @apiParam (Request Body) {MarcacaoProcesso} marcacaoProcesso Objeto de com as definições da marcação.
44   - * @apiParam (Request Body) {String} marcacaoProcesso.processo Número do processo no SEI.
45   - * @apiParam (Request Body) {String} marcacaoProcesso.texto Texto para associação.
  43 + * @apiParam (Request Body) {MarcacaoProcesso} marcacaoProcesso Objeto de com as definições da marcação.
  44 + * @apiParam (Request Body) {String} marcacaoProcesso.processo Número do processo no SEI.
  45 + * @apiParam (Request Body) {String} marcacaoProcesso.texto Texto para associação.
46 46 *
47   - * @apiExample {curl} Exemplo de requisição:
  47 + * @apiExample {curl} Exemplo de requisição:
48 48 * curl -i https://<host>/sei-broker/service/cosap/marcadores/3/processos
49 49 *
50 50 * @apiSuccessExample {json} Success-Response:
... ... @@ -54,7 +54,7 @@
54 54 * HTTP/1.1 500 Internal Server Error
55 55 * {
56 56 * "error":"Mensagem de erro."
57   - * "code":"código do erro"
  57 + * "code":"código do erro"
58 58 * }
59 59 */
60 60  
... ...
src/main/resources/apidoc/processo.apidoc
  Diff comments   View file @ee0e973
... ... @@ -6,113 +6,113 @@
6 6 *
7 7 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
8 8 *
9   - * @apiDescription Este método realiza uma consulta a processos no SEI e no SIPAR.
  9 + * @apiDescription Este método realiza uma consulta a processos no SEI e no SIPAR.
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
12   - * @apiParam (Path Parameters) {String} processo Número do processo que deseja consultar
13   - *
14   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [assuntos=N] Exibir assuntos do processo
15   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [interessados=N] Exibir interessados no processo
16   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [observacoes=N] Exibir observações feitas no processo
17   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento=N] Exibir andamento do processo
18   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento-conclusao=N] Exibir o andamento da conclusão do processo
19   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [ultimo-andamento=N] Exibir o último andamento dado ao processo
20   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [unidades=N] Exibir unidades onde o processo está aberto
21   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [relacionados=N] Exibir processos relacionados
22   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [anexados=N] Exibir processos anexados
23   - * @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
24   - *
25   - * @apiExample {curl} Exemplo de requisição:
  12 + * @apiParam (Path Parameters) {String} processo Número do processo que deseja consultar
  13 + *
  14 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [assuntos=N] Exibir assuntos do processo
  15 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [interessados=N] Exibir interessados no processo
  16 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [observacoes=N] Exibir observações feitas no processo
  17 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento=N] Exibir andamento do processo
  18 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento-conclusao=N] Exibir o andamento da conclusão do processo
  19 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [ultimo-andamento=N] Exibir o último andamento dado ao processo
  20 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [unidades=N] Exibir unidades onde o processo está aberto
  21 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [relacionados=N] Exibir processos relacionados
  22 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [anexados=N] Exibir processos anexados
  23 + * @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
  24 + *
  25 + * @apiExample {curl} Exemplo de requisição:
26 26 * curl -i https://<host>/sei-broker/service/COSAP/processos/33910000029201653
27 27 *
28 28 * @apiSuccess (Sucesso - 200) {ResultadoConsultaProcesso} resultadoConsultaProcesso Objeto de retorno da consulta aos processos, pode um conter processo do SEI ou do SIPAR
29 29 * @apiSuccess (Sucesso - 200) {RetornoConsultaProcedimento} resultadoConsultaProcesso.sei Resultado de processo do SEI
30   - * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoConclusao Andamento da conclusão do processo (opcional)
  30 + * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoConclusao Andamento da conclusão do processo (opcional)
31 31 * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.andamentoConclusao.dataHora Data e hora do registro de andamento
32   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.descricao Descrição do andamento
33   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoConclusao.unidade Unidade responsável pelo andamento
  32 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.descricao Descrição do andamento
  33 + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoConclusao.unidade Unidade responsável pelo andamento
34 34 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.descricao Nome da unidade
35   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.idUnidade Código da unidade
  35 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.idUnidade Código da unidade
36 36 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.sigla Sigla da unidade
37   - * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoConclusao.usuario Usuário responsável pela ação
38   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.idUsuario Código do usuário
39   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.nome Nome do usuário
40   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.sigla Login do usuário
41   - * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoGeracao Andamento da geração do processo (opcional)
  37 + * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoConclusao.usuario Usuário responsável pela ação
  38 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.idUsuario Código do usuário
  39 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.nome Nome do usuário
  40 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.sigla Login do usuário
  41 + * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoGeracao Andamento da geração do processo (opcional)
42 42 * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.andamentoGeracao.dataHora Data e hora do registro de andamento
43   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.descricao Descrição do andamento
44   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoGeracao.unidade Unidade responsável pelo andamento
  43 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.descricao Descrição do andamento
  44 + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoGeracao.unidade Unidade responsável pelo andamento
45 45 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.descricao Nome da unidade
46   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.idUnidade Código da unidade
  46 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.idUnidade Código da unidade
47 47 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.sigla Sigla da unidade
48   - * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoGeracao.usuario Usuário responsável pela ação
49   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.idUsuario Código do usuário
50   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.nome Nome do usuário
51   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.sigla Login do usuário
  48 + * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoGeracao.usuario Usuário responsável pela ação
  49 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.idUsuario Código do usuário
  50 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.nome Nome do usuário
  51 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.sigla Login do usuário
52 52 * @apiSuccess (Sucesso - 200) {Assunto} resultadoConsultaProcesso.sei.assuntos Lista de assuntos
53   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.assuntos.codigoEstruturado Código do assunto
54   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.descricao Descrição do assunto
55   - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.dataAutuacao Data de autuação do processo
56   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.especificacao Especificação do processo
  53 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.assuntos.codigoEstruturado Código do assunto
  54 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.descricao Descrição do assunto
  55 + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.dataAutuacao Data de autuação do processo
  56 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.especificacao Especificação do processo
57 57 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI
58 58 * @apiSuccess (Sucesso - 200) {Interessado} resultadoConsultaProcesso.sei.interessados Lista de interessados no processo (opcional)
59 59 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.nome Nome do interessado
60 60 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.sigla Login do interessado
61 61 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI
62 62 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.linkAcesso Link para acesso ao processo
63   - * @apiSuccess (Sucesso - 200) {Observacao} resultadoConsultaProcesso.sei.observacoes Observações feitas sobre o processo (opcional)
64   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.descricao Descrição da obsevação
65   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.observacoes.unidade Unidade responsável pela observação
  63 + * @apiSuccess (Sucesso - 200) {Observacao} resultadoConsultaProcesso.sei.observacoes Observações feitas sobre o processo (opcional)
  64 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.descricao Descrição da obsevação
  65 + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.observacoes.unidade Unidade responsável pela observação
66 66 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.descricao Nome da unidade
67   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.idUnidade Código da unidade
  67 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.idUnidade Código da unidade
68 68 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.sigla Sigla da unidade
69 69 * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosAnexados Lista com os processos anexados
70 70 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.idProcedimento Identificador do processo
71   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.procedimentoFormatado Número do processo visível para o usuário
  71 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.procedimentoFormatado Número do processo visível para o usuário
72 72 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.tipoProcedimento Tipo do processo
73 73 * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosRelacionados Lista com os processos relacionados
74 74 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.idProcedimento Identificador do processo
75   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.procedimentoFormatado Número do processo visível para o usuário
  75 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.procedimentoFormatado Número do processo visível para o usuário
76 76 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.tipoProcedimento Tipo do processo
77 77 *
78   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentoFormatado Número do processo visível para o usuário
  78 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentoFormatado Número do processo visível para o usuário
79 79 * @apiSuccess (Sucesso - 200) {TipoProcedimento} resultadoConsultaProcesso.sei.tipoProcedimento Tipo de procedimento
80 80 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.idTipoProcedimento Identificador do tipo de procedimento
81 81 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.nome Nome do tipo de procedimento
82 82 * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.ultimoAndamento Ultimo andamento do processo (opcional)
83 83 * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.ultimoAndamento.dataHora Data e hora do registro de andamento
84   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.descricao Descrição do andamento
85   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.ultimoAndamento.unidade Unidade responsável pelo andamento
  84 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.descricao Descrição do andamento
  85 + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.ultimoAndamento.unidade Unidade responsável pelo andamento
86 86 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.descricao Nome da unidade
87   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.idUnidade Código da unidade
  87 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.idUnidade Código da unidade
88 88 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.sigla Sigla da unidade
89   - * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.ultimoAndamento.usuario Usuário responsável pela ação
90   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.idUsuario Código do usuário
91   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.nome Nome do usuário
92   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.sigla Login do usuário
93   - * @apiSuccess (Sucesso - 200) {UnidadeProcedimentoAberto} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto Unidades onde o processo está aberto (opcional)
94   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade Unidade onde o processo está aberto
  89 + * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.ultimoAndamento.usuario Usuário responsável pela ação
  90 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.idUsuario Código do usuário
  91 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.nome Nome do usuário
  92 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.sigla Login do usuário
  93 + * @apiSuccess (Sucesso - 200) {UnidadeProcedimentoAberto} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto Unidades onde o processo está aberto (opcional)
  94 + * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade Unidade onde o processo está aberto
95 95 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.descricao Nome da unidade
96   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.idUnidade Código da unidade
  96 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.idUnidade Código da unidade
97 97 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.sigla Sigla da unidade
98 98 *
99 99 * @apiSuccess (Sucesso - 200) {DocumentoSIPAR} resultadoConsultaProcesso.sipar Resultado de processo do SIPAR
100 100 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.digito Digito do processo
101 101 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.operadora Operadora relacionada ao processo
102   - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.emissao Data de emissão
  102 + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.emissao Data de emissão
103 103 * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.registro Data de registro
104 104 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.tipo Tipo do processo
105 105 * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.resumo Resumo sobre o processo
106   - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoPosse Código do orgão que tem a posse do processo
107   - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoOrigem Código do orgão de origem do processo
108   - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoRegistro Código do orgão de registro do processo
109   - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.assunto Código do assunto
  106 + * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoPosse Código do orgão que tem a posse do processo
  107 + * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoOrigem Código do orgão de origem do processo
  108 + * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoRegistro Código do orgão de registro do processo
  109 + * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.assunto Código do assunto
110 110 *
111 111 * @apiErrorExample {json} Error-Response:
112 112 * HTTP/1.1 500 Internal Server Error
113 113 * {
114 114 * "error":"Mensagem de erro."
115   - * "code":"código do erro"
  115 + * "code":"código do erro"
116 116 * }
117 117 */
118 118  
... ... @@ -128,23 +128,23 @@
128 128 *
129 129 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
130 130 *
131   - * @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
  131 + * @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
132 132 *
133   - * @apiParam (Request Body) {String} processo Numero do processo a ser concluído
  133 + * @apiParam (Request Body) {String} processo Numero do processo a ser concluído
134 134 *
135   - * @apiExample Exemplo de requisição:
  135 + * @apiExample Exemplo de requisição:
136 136 * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/concluidos
137 137 *
138 138 * body:
139 139 * 33910000029201653
140 140 *
141   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  141 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
142 142 *
143 143 * @apiErrorExample {json} Error-Response:
144 144 * HTTP/1.1 500 Internal Server Error
145 145 * {
146 146 * "error":"Mensagem de erro."
147   - * "code":"código do erro"
  147 + * "code":"código do erro"
148 148 * }
149 149 */
150 150  
... ... @@ -158,21 +158,21 @@
158 158 *
159 159 * @apiDescription Envia processos a outras unidades.
160 160 *
161   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. Representa a unidade de localização atual do processo.
  161 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. Representa a unidade de localização atual do processo.
162 162 *
163   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [reabir=N] Reabrir automaticamente caso esteja concluído na unidade
164   - * @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
  163 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [reabir=N] Reabrir automaticamente caso esteja concluído na unidade
  164 + * @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
165 165 *
166   - * @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.
167   - * @apiParam (Request Body) {String[]} unidadesDestino Lista com os identificadores das unidades de destino do processo, código ou nome da unidade.
  166 + * @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.
  167 + * @apiParam (Request Body) {String[]} unidadesDestino Lista com os identificadores das unidades de destino do processo, código ou nome da unidade.
168 168 * @apiParam (Request Body) {Boolean} manterAbertoOrigem=false Informa se o processo deve continuar aberto na unidade de origem .
169   - * @apiParam (Request Body) {Boolean} removerAnotacoes=false Informa se as anotações do processo devem ser removidas.
170   - * @apiParam (Request Body) {Boolean} enviarEmailNotificacao=false Informa se deve ser enviado um e-mail de notificação.
171   - * @apiParam (Request Body) {Date} dataRetornoProgramado=null Data para retorno programado do processo a unidade (padrão ISO-8601).
172   - * @apiParam (Request Body) {Integer} qtdDiasAteRetorno=null Quantidade de dias até o retorno do processo.
173   - * @apiParam (Request Body) {Boolean} somenteDiasUteis=false Informa se só serão contabilizados dias úteis.
  169 + * @apiParam (Request Body) {Boolean} removerAnotacoes=false Informa se as anotações do processo devem ser removidas.
  170 + * @apiParam (Request Body) {Boolean} enviarEmailNotificacao=false Informa se deve ser enviado um e-mail de notificação.
  171 + * @apiParam (Request Body) {Date} dataRetornoProgramado=null Data para retorno programado do processo a unidade (padrão ISO-8601).
  172 + * @apiParam (Request Body) {Integer} qtdDiasAteRetorno=null Quantidade de dias até o retorno do processo.
  173 + * @apiParam (Request Body) {Boolean} somenteDiasUteis=false Informa se só serão contabilizados dias úteis.
174 174 *
175   - * @apiExample Exemplo de requisição:
  175 + * @apiExample Exemplo de requisição:
176 176 * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/enviados
177 177 *
178 178 * body:
... ... @@ -187,13 +187,13 @@
187 187 * "somenteDiasUteis":true}
188 188 * }
189 189 *
190   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  190 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
191 191 *
192 192 * @apiErrorExample {json} Error-Response:
193 193 * HTTP/1.1 500 Internal Server Error
194 194 * {
195 195 * "error":"Mensagem de erro."
196   - * "code":"código do erro"
  196 + * "code":"código do erro"
197 197 * }
198 198 */
199 199  
... ... @@ -210,18 +210,18 @@
210 210 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
211 211 * @apiParam (Path Parameters) {String} processo Numero do processo a ser reaberto
212 212 *
213   - * @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
  213 + * @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
214 214 *
215   - * @apiExample Exemplo de requisição:
  215 + * @apiExample Exemplo de requisição:
216 216 * curl -X DELETE https://<host>/sei-broker/service/COSAP/processos/concluidos/33910000029201653
217 217 *
218   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  218 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
219 219 *
220 220 * @apiErrorExample {json} Error-Response:
221 221 * HTTP/1.1 500 Internal Server Error
222 222 * {
223 223 * "error":"Mensagem de erro."
224   - * "code":"código do erro"
  224 + * "code":"código do erro"
225 225 * }
226 226 */
227 227  
... ... @@ -237,18 +237,18 @@
237 237 *
238 238 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
239 239 *
240   - * @apiParam (Query Parameters) {String} [serie] Tipo do documento cadastrado no serviço
  240 + * @apiParam (Query Parameters) {String} [serie] Tipo do documento cadastrado no serviço
241 241 *
242   - * @apiExample Exemplo de requisição:
  242 + * @apiExample Exemplo de requisição:
243 243 * curl -i https://<host>/sei-broker/service/COSAP/processos/tipos
244 244 *
245   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  245 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
246 246 *
247 247 * @apiErrorExample {json} Error-Response:
248 248 * HTTP/1.1 500 Internal Server Error
249 249 * {
250 250 * "error":"Mensagem de erro."
251   - * "code":"código do erro"
  251 + * "code":"código do erro"
252 252 * }
253 253 */
254 254  
... ... @@ -264,45 +264,45 @@
264 264 *
265 265 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
266 266 *
267   - * @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
  267 + * @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
268 268 *
269   - * @apiParam (Request Body) {NovoProcesso} novoProcesso Objeto de representação de novo processo.
  269 + * @apiParam (Request Body) {NovoProcesso} novoProcesso Objeto de representação de novo processo.
270 270 * @apiParam (Request Body) {Procedimento} novoProcesso.dadosProcesso Dados do processo.
271 271 * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.idTipoProcedimento Identificador do tipo de processo no SEI (Consultar tipos de processo).
272   - * @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.
273   - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.dataAutuacao] Data de autuação do processo, se não for informada o sistema utilizará a data atual.
274   - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.especificacao Especificação do processo.
275   - * @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).
276   - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.codigoEstruturado Código do assunto
277   - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.descricao Descrição do assunto
278   - * @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.
  272 + * @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.
  273 + * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.dataAutuacao] Data de autuação do processo, se não for informada o sistema utilizará a data atual.
  274 + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.especificacao Especificação do processo.
  275 + * @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).
  276 + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.codigoEstruturado Código do assunto
  277 + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.descricao Descrição do assunto
  278 + * @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.
279 279 * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.interessados.nome Nome do interessado
280 280 * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.interessados.sigla Login do interessado
281   - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.observacao] Texto da observação, passar null se não existir.
282   - * @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.
283   - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.idHipoteseLegal] Identificador da hipótese legal associada. *
284   - * @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.
285   - * @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.
286   - * @apiParam (Request Body) {String[]} [novoProcesso.unidadesDestino] Lista com os identificadores das unidades de destino do processo, código ou nome da unidade.
  281 + * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.observacao] Texto da observação, passar null se não existir.
  282 + * @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.
  283 + * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.idHipoteseLegal] Identificador da hipótese legal associada. *
  284 + * @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.
  285 + * @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.
  286 + * @apiParam (Request Body) {String[]} [novoProcesso.unidadesDestino] Lista com os identificadores das unidades de destino do processo, código ou nome da unidade.
287 287 * @apiParam (Request Body) {Boolean} [novoProcesso.manterAbertoOrigem=false] Indica se o processo deve ser mantido aberto na unidade de origem.
288   - * @apiParam (Request Body) {Boolean} [novoProcesso.enviarEmailNotificacao=false] Indica se deve ser enviado email de aviso para as unidades destinatárias.
289   - * @apiParam (Request Body) {Date} [novoProcesso.dataRetornoProgramado] Data para definição de Retorno Programado.
290   - * @apiParam (Request Body) {Integer} [novoProcesso.qtdDiasAteRetorno] Número de dias para o Retorno Programado.
291   - * @apiParam (Request Body) {Boolean} [novoProcesso.somenteDiasUteis=false] Indica se o valor passado no parâmetro qtdDiasAteRetorno corresponde a dias úteis ou não.
292   - * @apiParam (Request Body) {String} [novoProcesso.idMarcador] Identificador de um marcador da unidade para associação.
  288 + * @apiParam (Request Body) {Boolean} [novoProcesso.enviarEmailNotificacao=false] Indica se deve ser enviado email de aviso para as unidades destinatárias.
  289 + * @apiParam (Request Body) {Date} [novoProcesso.dataRetornoProgramado] Data para definição de Retorno Programado.
  290 + * @apiParam (Request Body) {Integer} [novoProcesso.qtdDiasAteRetorno] Número de dias para o Retorno Programado.
  291 + * @apiParam (Request Body) {Boolean} [novoProcesso.somenteDiasUteis=false] Indica se o valor passado no parâmetro qtdDiasAteRetorno corresponde a dias úteis ou não.
  292 + * @apiParam (Request Body) {String} [novoProcesso.idMarcador] Identificador de um marcador da unidade para associação.
293 293 * @apiParam (Request Body) {String} [novoProcesso.textoMarcador] Texto do marcador.
294 294 *
295   - * @apiExample Exemplo de requisição:
  295 + * @apiExample Exemplo de requisição:
296 296 * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos
297 297 *
298 298 * body:
299 299 * {
300 300 * "dadosProcesso":{
301 301 * "idTipoProcedimento":"100000375",
302   - * "especificacao":"Documentação REST",
  302 + * "especificacao":"Documentação REST",
303 303 * "assuntos":[],
304   - * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}],
305   - * "observacao":"Exemplo de requisição",
  304 + * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}],
  305 + * "observacao":"Exemplo de requisição",
306 306 * "nivelAcesso":0
307 307 * },
308 308 * "documentos":[],
... ... @@ -314,12 +314,12 @@
314 314 * "somenteDiasUteis":false
315 315 * }
316 316 *
317   - * @apiSuccess (Sucesso Response Body - 201) {String} idProcedimento Número do processo gerado
318   - * @apiSuccess (Sucesso Response Body - 201) {String} procedimentoFormatado Número formatado do processo gerado
  317 + * @apiSuccess (Sucesso Response Body - 201) {String} idProcedimento Número do processo gerado
  318 + * @apiSuccess (Sucesso Response Body - 201) {String} procedimentoFormatado Número formatado do processo gerado
319 319 * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso Link de acesso ao processo
320 320 * @apiSuccess (Sucesso Response Body - 201) {RetornoInclusaoDocumento} retornoInclusaoDocumentos Retorno dos documentos inseridos no processo (opcional)
321   - * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.idDocumento Número interno do documento
322   - * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.documentoFormatado Número do documento visível para o usuário
  321 + * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.idDocumento Número interno do documento
  322 + * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.documentoFormatado Número do documento visível para o usuário
323 323 * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.linkAcesso Link para acesso ao documento
324 324 *
325 325 * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado.
... ... @@ -337,7 +337,7 @@
337 337 * HTTP/1.1 500 Internal Server Error
338 338 * {
339 339 * "error":"Mensagem de erro."
340   - * "code":"código do erro"
  340 + * "code":"código do erro"
341 341 * }
342 342 */
343 343  
... ... @@ -354,22 +354,22 @@
354 354 * @apiParam (Query Parameters) {Boolean} [crescente=false] Ordenar em ordem crescente, processos mais antigos primeiro
355 355 * @apiParam (Query Parameters) {String} [interessado] Identificador do interessado
356 356 * @apiParam (Query Parameters) {String} [unidade] Unidade da qual deseja filtrar os processos
357   - * @apiParam (Query Parameters) {String} [pagina=1] Número da página
358   - * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por página
  357 + * @apiParam (Query Parameters) {String} [pagina=1] Número da página
  358 + * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por página
359 359 * @apiParam (Query Parameters) {String} [tipo] Identificador do tipo de processo que deseja filtrar
360 360 *
361   - * @apiExample Exemplo de requisição:
  361 + * @apiExample Exemplo de requisição:
362 362 * curl -i https://<host>/sei-broker/service/processos
363 363 *
364 364 * @apiSuccess (Sucesso Response Body - 200) {List} processos Lista com os processos encontrados
365 365 * @apiSuccess (Sucesso Response Body - 200) {ProcessoResumido} processos.processoResumido Resumo do processo encontrado no SEI
366   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numero Número do processo
367   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numeroFormatado Número do processo formatado
368   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.descricao Descrição do processo
369   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.unidade Unidade responsável pelo processo
370   - * @apiSuccess (Sucesso Response Body - 200) {Data} processos.processoResumido.dataGeracao Data de geração do processo
  366 + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numero Número do processo
  367 + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numeroFormatado Número do processo formatado
  368 + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.descricao Descrição do processo
  369 + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.unidade Unidade responsável pelo processo
  370 + * @apiSuccess (Sucesso Response Body - 200) {Data} processos.processoResumido.dataGeracao Data de geração do processo
371 371 * @apiSuccess (Sucesso Response Body - 200) {Tipo} processos.processoResumido.tipo Objeto com os dados do tipo de processo
372   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.codigo Código do tipo
  372 + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.codigo Código do tipo
373 373 * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.nome Nome do tipo
374 374 *
375 375 * @apiSuccess (Sucesso Response Header - 200) {header} total_registros quantidade de registros que existem para essa consulta.
... ... @@ -379,12 +379,12 @@
379 379 * {
380 380 * "numero": "33910007118201710",
381 381 * "numeroFormatado": "33910.007118/2017-10",
382   - * "descricao": "D:2237021 - SUL AMÉRICA SEGURO SAÚDE S/A",
383   - * "unidade": "NÚCLEO-RJ",
  382 + * "descricao": "D:2237021 - SUL AMÉRICA SEGURO SAÚDE S/A",
  383 + * "unidade": "NÚCLEO-RJ",
384 384 * "dataGeracao": "2017-10-09T03:00:00.000+0000",
385 385 * "tipo": {
386 386 * "codigo": "100000882",
387   - * "nome": "Fiscalização: Sancionador"
  387 + * "nome": "Fiscalização: Sancionador"
388 388 * }
389 389 * }
390 390 *
... ... @@ -392,7 +392,7 @@
392 392 * HTTP/1.1 500 Internal Server Error
393 393 * {
394 394 * "error":"Mensagem de erro."
395   - * "code":"código do erro"
  395 + * "code":"código do erro"
396 396 * }
397 397 */
398 398  
... ... @@ -407,29 +407,29 @@
407 407 * @apiDescription Lista as andamentos do processo.
408 408 *
409 409 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
410   - * @apiParam (Path Parameters) {String} processo Número do processo.
  410 + * @apiParam (Path Parameters) {String} processo Número do processo.
411 411 *
412   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [exibir-atributos="N"] Sinalizador para retorno dos atributos associados.
  412 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [exibir-atributos="N"] Sinalizador para retorno dos atributos associados.
413 413 * @apiParam (Query Parameters) {String[]} [andamento] Filtra andamentos pelos identificadores informados.
414 414 * @apiParam (Query Parameters) {String[]} [tarefa="1,48,65"] Filtra andamentos pelos identificadores de tarefas informados (consultar lista de tarefas).
415   - * @apiParam (Query Parameters) {String[]} [tarefa-modulo] Filtra andamentos pelos identificadores de tarefas de módulo informados.
  415 + * @apiParam (Query Parameters) {String[]} [tarefa-modulo] Filtra andamentos pelos identificadores de tarefas de módulo informados.
416 416 *
417   - * @apiExample {curl} Exemplo de requisição:
  417 + * @apiExample {curl} Exemplo de requisição:
418 418 * curl -i https://<host>/sei-broker/service/cosap/processos/33910003114201754/andamentos
419 419 *
420 420 * @apiSuccess (Sucesso - 200) {Andamento[]} andamentos Lista dos andamentos do processo.
421 421 * @apiSuccess (Sucesso - 200) {String} andamentos.idAndamento Identificador do andamento.
422 422 * @apiSuccess (Sucesso - 200) {String} andamentos.idTarefa Identificador da tarefa.
423   - * @apiSuccess (Sucesso - 200) {String} andamentos.descricao Descrição do andamento.
  423 + * @apiSuccess (Sucesso - 200) {String} andamentos.descricao Descrição do andamento.
424 424 * @apiSuccess (Sucesso - 200) {String} andamentos.dataHora Data e hora do andamento.
425 425 * @apiSuccess (Sucesso - 200) {Unidade} andamentos.unidade Unidade onde o andamento ocorreu.
426 426 * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.idUnidade Identificador da unidade.
427 427 * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.sigla Sigla da unidade.
428   - * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.descricao Descrição da unidade.
429   - * @apiSuccess (Sucesso - 200) {Usuario} andamentos.usuario Usuário responsável pelo andamento.
430   - * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.idUsuario Identificador do usuário.
431   - * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.sigla Login do usuário.
432   - * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.nome Nome do usuário.
  428 + * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.descricao Descrição da unidade.
  429 + * @apiSuccess (Sucesso - 200) {Usuario} andamentos.usuario Usuário responsável pelo andamento.
  430 + * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.idUsuario Identificador do usuário.
  431 + * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.sigla Login do usuário.
  432 + * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.nome Nome do usuário.
433 433 * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} andamentos.atributos Lista com os atributos relacionados ao andamento.
434 434 * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.nome Nome do atributo.
435 435 * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.valor Valor do atributo.
... ... @@ -439,29 +439,29 @@
439 439 * HTTP/1.1 500 Internal Server Error
440 440 * {
441 441 * "error":"Mensagem de erro."
442   - * "code":"código do erro"
  442 + * "code":"código do erro"
443 443 * }
444 444 */
445 445  
446 446 /**
447   - * @api {post} /:unidade/processos/:processo/andamentos Lançar andamento
  447 + * @api {post} /:unidade/processos/:processo/andamentos Lançar andamento
448 448 * @apiName lancarAndamento
449 449 * @apiGroup Processo
450 450 * @apiVersion 2.0.0
451 451 *
452 452 * @apiPermission RO_SEI_BROKER
453 453 *
454   - * @apiDescription Lança um andamento ao processo.
  454 + * @apiDescription Lança um andamento ao processo.
455 455 *
456 456 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
457   - * @apiParam (Path Parameters) {String} processo Número do processo.
  457 + * @apiParam (Path Parameters) {String} processo Número do processo.
458 458 *
459 459 * @apiParam (Request Body) {NovoAndamento} novoAndamento Objeto representando o novo andamento.
460 460 * @apiParam (Request Body) {String} novoAndamento.tarefa Identificador da tarefa a qual o andamento se refere (consultar lista de tarefas).
461   - * @apiParam (Request Body) {String} [novoAndamento.tarefaModulo] Identificadoe da tarefa módulo a qual o andamento se refere.
462   - * @apiParam (Request Body) {HashMap} novoAndamento.atributos Mapa chave-valor, identificando como serão preenchidos os atributos da tarefa.
  461 + * @apiParam (Request Body) {String} [novoAndamento.tarefaModulo] Identificadoe da tarefa módulo a qual o andamento se refere.
  462 + * @apiParam (Request Body) {HashMap} novoAndamento.atributos Mapa chave-valor, identificando como serão preenchidos os atributos da tarefa.
463 463 *
464   - * @apiExample Exemplo de requisição:
  464 + * @apiExample Exemplo de requisição:
465 465 * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/33910003114201754/andamentos
466 466 *
467 467 * body:
... ... @@ -473,16 +473,16 @@
473 473 * @apiSuccess (Sucesso - 201) {Andamento} andamento Andamento criado.
474 474 * @apiSuccess (Sucesso - 201) {String} andamento.idAndamento Identificador do andamento.
475 475 * @apiSuccess (Sucesso - 201) {String} andamento.idTarefa Identificador da tarefa.
476   - * @apiSuccess (Sucesso - 201) {String} andamento.descricao Descrição do andamento.
  476 + * @apiSuccess (Sucesso - 201) {String} andamento.descricao Descrição do andamento.
477 477 * @apiSuccess (Sucesso - 201) {String} andamento.dataHora Data e hora do andamento.
478 478 * @apiSuccess (Sucesso - 201) {Unidade} andamento.unidade Unidade onde o andamento ocorreu.
479 479 * @apiSuccess (Sucesso - 201) {String} andamento.unidade.idUnidade Identificador da unidade.
480 480 * @apiSuccess (Sucesso - 201) {String} andamento.unidade.sigla Sigla da unidade.
481   - * @apiSuccess (Sucesso - 201) {String} andamento.unidade.descricao Descrição da unidade.
482   - * @apiSuccess (Sucesso - 201) {Usuario} andamento.usuario Usuário responsável pelo andamento.
483   - * @apiSuccess (Sucesso - 201) {String} andamento.usuario.idUsuario Identificador do usuário.
484   - * @apiSuccess (Sucesso - 201) {String} andamento.usuario.sigla Login do usuário.
485   - * @apiSuccess (Sucesso - 201) {String} andamento.usuario.nome Nome do usuário.
  481 + * @apiSuccess (Sucesso - 201) {String} andamento.unidade.descricao Descrição da unidade.
  482 + * @apiSuccess (Sucesso - 201) {Usuario} andamento.usuario Usuário responsável pelo andamento.
  483 + * @apiSuccess (Sucesso - 201) {String} andamento.usuario.idUsuario Identificador do usuário.
  484 + * @apiSuccess (Sucesso - 201) {String} andamento.usuario.sigla Login do usuário.
  485 + * @apiSuccess (Sucesso - 201) {String} andamento.usuario.nome Nome do usuário.
486 486 * @apiSuccess (Sucesso - 201) {AtributoAndamento[]} andamento.atributos Lista com os atributos relacionados ao andamento.
487 487 * @apiSuccess (Sucesso - 201) {String} andamento.atributos.nome Nome do atributo.
488 488 * @apiSuccess (Sucesso - 201) {String} andamento.atributos.valor Valor do atributo.
... ... @@ -492,7 +492,7 @@
492 492 * HTTP/1.1 500 Internal Server Error
493 493 * {
494 494 * "error":"Mensagem de erro."
495   - * "code":"código do erro"
  495 + * "code":"código do erro"
496 496 * }
497 497 */
498 498  
... ... @@ -507,12 +507,12 @@
507 507 * @apiDescription Anexar um processo.
508 508 *
509 509 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
510   - * @apiParam (Path Parameters) {String} processo Número do processo.
  510 + * @apiParam (Path Parameters) {String} processo Número do processo.
511 511 *
512 512 * @apiParam (Request Body) {ProcessoAnexado} processoAnexado Objeto representando o processo a ser anexado.
513   - * @apiParam (Request Body) {String} processoAnexado.numero Número do processo a ser anexado.
  513 + * @apiParam (Request Body) {String} processoAnexado.numero Número do processo a ser anexado.
514 514 *
515   - * @apiExample Exemplo de requisição:
  515 + * @apiExample Exemplo de requisição:
516 516 * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/33910003114201754/anexados
517 517 *
518 518 * body:
... ... @@ -527,7 +527,7 @@
527 527 * HTTP/1.1 500 Internal Server Error
528 528 * {
529 529 * "error":"Mensagem de erro."
530   - * "code":"código do erro"
  530 + * "code":"código do erro"
531 531 * }
532 532 */
533 533  
... ... @@ -542,14 +542,14 @@
542 542 * @apiDescription Remove um processo anexado.
543 543 *
544 544 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
545   - * @apiParam (Path Parameters) {String} processo Número do processo.
546   - * @apiParam (Path Parameters) {String} processo Número do processo anexado.
  545 + * @apiParam (Path Parameters) {String} processo Número do processo.
  546 + * @apiParam (Path Parameters) {String} processo Número do processo anexado.
547 547 *
548   - * @apiExample Exemplo de requisição:
  548 + * @apiExample Exemplo de requisição:
549 549 * curl -X DELETE https://<host>/sei-broker/service/COSAP/processos/33910003114201754/anexados/33910003093201777
550 550 *
551 551 * @apiParam (Request Body) {Motivo} motivo Objeto com o motivo.
552   - * @apiParam (Request Body) {String} motivo.motivo Descrição do motivo para remoção do processo em anexo.
  552 + * @apiParam (Request Body) {String} motivo.motivo Descrição do motivo para remoção do processo em anexo.
553 553 *
554 554 * @apiSuccessExample {json} Success-Response:
555 555 * HTTP/1.1 200 OK
... ... @@ -558,7 +558,7 @@
558 558 * HTTP/1.1 500 Internal Server Error
559 559 * {
560 560 * "error":"Mensagem de erro."
561   - * "code":"código do erro"
  561 + * "code":"código do erro"
562 562 * }
563 563 */
564 564  
... ... @@ -574,10 +574,10 @@
574 574 *
575 575 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
576 576 *
577   - * @apiParam (Request Body) {ProcessoBloqueado} processoBloqueado Objeto com o número do processo a ser bloqueado.
578   - * @apiParam (Request Body) {String} processoBloqueado.numero Número do processo a ser bloqueado.
  577 + * @apiParam (Request Body) {ProcessoBloqueado} processoBloqueado Objeto com o número do processo a ser bloqueado.
  578 + * @apiParam (Request Body) {String} processoBloqueado.numero Número do processo a ser bloqueado.
579 579 *
580   - * @apiExample Exemplo de requisição:
  580 + * @apiExample Exemplo de requisição:
581 581 * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/bloqueados
582 582 *
583 583 * body:
... ... @@ -592,7 +592,7 @@
592 592 * HTTP/1.1 500 Internal Server Error
593 593 * {
594 594 * "error":"Mensagem de erro."
595   - * "code":"código do erro"
  595 + * "code":"código do erro"
596 596 * }
597 597 */
598 598  
... ... @@ -607,9 +607,9 @@
607 607 * @apiDescription Desbloquear um processo.
608 608 *
609 609 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
610   - * @apiParam (Path Parameters) {String} processo Número do processo.
  610 + * @apiParam (Path Parameters) {String} processo Número do processo.
611 611 *
612   - * @apiExample Exemplo de requisição:
  612 + * @apiExample Exemplo de requisição:
613 613 * endpoint: [DELETE] https://<host>/sei-broker/service/COSAP/processos/bloqueados/33910003093201777
614 614 *
615 615 * @apiSuccessExample {json} Success-Response:
... ... @@ -619,7 +619,7 @@
619 619 * HTTP/1.1 500 Internal Server Error
620 620 * {
621 621 * "error":"Mensagem de erro."
622   - * "code":"código do erro"
  622 + * "code":"código do erro"
623 623 * }
624 624 */
625 625  
... ... @@ -634,12 +634,12 @@
634 634 * @apiDescription Relacionar processos.
635 635 *
636 636 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
637   - * @apiParam (Path Parameters) {String} processo Número do processo.
  637 + * @apiParam (Path Parameters) {String} processo Número do processo.
638 638 *
639   - * @apiParam (Request Body) {ProcessoRelacionado} processoRelacionado Objeto com o número do processo a ser relacionado.
640   - * @apiParam (Request Body) {String} processoRelacionado.numero Número do processo a ser relacionado.
  639 + * @apiParam (Request Body) {ProcessoRelacionado} processoRelacionado Objeto com o número do processo a ser relacionado.
  640 + * @apiParam (Request Body) {String} processoRelacionado.numero Número do processo a ser relacionado.
641 641 *
642   - * @apiExample Exemplo de requisição:
  642 + * @apiExample Exemplo de requisição:
643 643 * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/33910003093201777/relacionados
644 644 *
645 645 * body:
... ... @@ -654,7 +654,7 @@
654 654 * HTTP/1.1 500 Internal Server Error
655 655 * {
656 656 * "error":"Mensagem de erro."
657   - * "code":"código do erro"
  657 + * "code":"código do erro"
658 658 * }
659 659 */
660 660  
... ... @@ -669,10 +669,10 @@
669 669 * @apiDescription Desrelacionar processos.
670 670 *
671 671 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
672   - * @apiParam (Path Parameters) {String} processo Número do processo.
673   - * @apiParam (Path Parameters) {String} processoRelacionado Número do processo relacionado.
  672 + * @apiParam (Path Parameters) {String} processo Número do processo.
  673 + * @apiParam (Path Parameters) {String} processoRelacionado Número do processo relacionado.
674 674 *
675   - * @apiExample Exemplo de requisição:
  675 + * @apiExample Exemplo de requisição:
676 676 * endpoint: [DELETE] https://<host>/sei-broker/service/COSAP/processos/33910000086201632/relacionados/33910003107201752
677 677 *
678 678 * @apiSuccessExample {json} Success-Response:
... ... @@ -682,7 +682,7 @@
682 682 * HTTP/1.1 500 Internal Server Error
683 683 * {
684 684 * "error":"Mensagem de erro."
685   - * "code":"código do erro"
  685 + * "code":"código do erro"
686 686 * }
687 687 */
688 688  
... ... @@ -699,17 +699,17 @@
699 699 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
700 700 *
701 701 * @apiParam (Request Body) {SobrestamentoProcesso} sobrestamento Objeto com o motivo do sobrestamento.
702   - * @apiParam (Request Body) {String} sobrestamento.processo Número do processo a ser sobrestado.
  702 + * @apiParam (Request Body) {String} sobrestamento.processo Número do processo a ser sobrestado.
703 703 * @apiParam (Request Body) {String} sobrestamento.motivo Motivo do sobrestamento.
704   - * @apiParam (Request Body) {String} [sobrestamento.processoVinculado] Número do processo vinculado.
  704 + * @apiParam (Request Body) {String} [sobrestamento.processoVinculado] Número do processo vinculado.
705 705 *
706   - * @apiExample Exemplo de requisição:
  706 + * @apiExample Exemplo de requisição:
707 707 * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/sobrestados
708 708 *
709 709 * body:
710 710 * {
711 711 * "processo":"33910003093201777",
712   - * "motivo":"Sobrestando através da camada de serviços."
  712 + * "motivo":"Sobrestando através da camada de serviços."
713 713 * }
714 714 *
715 715 * @apiSuccessExample {json} Success-Response:
... ... @@ -719,7 +719,7 @@
719 719 * HTTP/1.1 500 Internal Server Error
720 720 * {
721 721 * "error":"Mensagem de erro."
722   - * "code":"código do erro"
  722 + * "code":"código do erro"
723 723 * }
724 724 */
725 725  
... ... @@ -734,9 +734,9 @@
734 734 * @apiDescription Remover sobrestamento de processo.
735 735 *
736 736 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
737   - * @apiParam (Path Parameters) {String} processo Número do processo.
  737 + * @apiParam (Path Parameters) {String} processo Número do processo.
738 738 *
739   - * @apiExample Exemplo de requisição:
  739 + * @apiExample Exemplo de requisição:
740 740 * endpoint: [DELETE] https://<host>/sei-broker/service/COSAP/processos/sobrestados/33910003093201777
741 741 *
742 742 * @apiSuccessExample {json} Success-Response:
... ... @@ -746,7 +746,7 @@
746 746 * HTTP/1.1 500 Internal Server Error
747 747 * {
748 748 * "error":"Mensagem de erro."
749   - * "code":"código do erro"
  749 + * "code":"código do erro"
750 750 * }
751 751 */
752 752  
... ... @@ -760,29 +760,29 @@
760 760 *
761 761 * @apiDescription Retorna os documentos de um determinado processo.
762 762 *
763   - * @apiParam (Path Parameters) {String} processo Número do processo.
  763 + * @apiParam (Path Parameters) {String} processo Número do processo.
764 764 *
765   - * @apiParam (Query Parameters) {String} [tipo=null] Identificador do tipo do documento, caso seja necessário filtrar pelo tipo
  765 + * @apiParam (Query Parameters) {String} [tipo=null] Identificador do tipo do documento, caso seja necessário filtrar pelo tipo
766 766 * @apiParam (Query Parameters) {String = "G (gerado/interno), R (recebido/externo)"} [origem=null] Filtra os documentos por gerados ou recebidos
767 767 * @apiParam (Query Parameters) {boolean} [somenteAssinados=false] Exibir somente documentos assinados
768   - * @apiParam (Query Parameters) {String} [numeroInformado] Filtrar pelo número informado
769   - * @apiParam (Query Parameters) {String} [pagina=1] Número da página
770   - * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que serão exibidos por página
  768 + * @apiParam (Query Parameters) {String} [numeroInformado] Filtrar pelo número informado
  769 + * @apiParam (Query Parameters) {String} [pagina=1] Número da página
  770 + * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que serão exibidos por página
771 771 *
772   - * @apiExample Exemplo de requisição:
  772 + * @apiExample Exemplo de requisição:
773 773 * curl -i https://<host>/sei-broker/service/processos/33910003149201793/documentos
774 774 *
775 775 * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados.
776 776 * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentos.documentoResumido Resumo do documento encontrado no SEI.
777   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Número do documento.
778   - * @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.
779   - * @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)
780   - * @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.
781   - * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de geração do documento.
  777 + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Número do documento.
  778 + * @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.
  779 + * @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)
  780 + * @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.
  781 + * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de geração do documento.
782 782 * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentos.documentoResumido.tipo Objeto representando o tipo do documento.
783   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série.
  783 + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série.
784 784 * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.nome Nome do tipo do documento.
785   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferência do documento.
  785 + * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferência do documento.
786 786 * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado.
787 787 *
788 788 * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta
... ... @@ -796,7 +796,7 @@
796 796 * "dataGeracao": "2015-08-10T00:00:00-03:00",
797 797 * "tipo": {
798 798 * "codigo": "629",
799   - * "nome": "Relatório de Arquivamento-SIF"
  799 + * "nome": "Relatório de Arquivamento-SIF"
800 800 * }
801 801 * "tipoConferencia": "4",
802 802 * "assinado": true
... ... @@ -806,7 +806,7 @@
806 806 * HTTP/1.1 500 Internal Server Error
807 807 * {
808 808 * "error":"Mensagem de erro."
809   - * "code":"código do erro"
  809 + * "code":"código do erro"
810 810 * }
811 811 */
812 812  
... ... @@ -820,21 +820,21 @@
820 820 *
821 821 * @apiDescription Consulta um documento de determinado processo.
822 822 *
823   - * @apiParam (Path Parameters) {String} processo Número do processo.
824   - * @apiParam (Path Parameters) {String} documento Número do documento.
  823 + * @apiParam (Path Parameters) {String} processo Número do processo.
  824 + * @apiParam (Path Parameters) {String} documento Número do documento.
825 825 *
826   - * @apiExample Exemplo de requisição:
  826 + * @apiExample Exemplo de requisição:
827 827 * curl -i https://<host>/sei-broker/service/processos/33910002924201874/documentos/55737058
828 828 *
829 829 * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentoResumido Resumo do documento encontrado no SEI.
830   - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numero Número do documento.
831   - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numeroInformado Número informado na inclusão do documento, também conhecido como número de árvore.
832   - * @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.
833   - * @apiSuccess (Sucesso Response Body - 200) {Data} documentoResumido.dataGeracao Data de geração do documento.
  830 + * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numero Número do documento.
  831 + * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numeroInformado Número informado na inclusão do documento, também conhecido como número de árvore.
  832 + * @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.
  833 + * @apiSuccess (Sucesso Response Body - 200) {Data} documentoResumido.dataGeracao Data de geração do documento.
834 834 * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentoResumido.tipo Objeto representando o tipo do documento.
835   - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série.
  835 + * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série.
836 836 * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipo.nome Nome do tipo do documento.
837   - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipoConferencia Tipo de conferência do documento.
  837 + * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipoConferencia Tipo de conferência do documento.
838 838 * @apiSuccess (Sucesso Response Body - 200) {boolean} documentoResumido.assinado Boolean indicando se o documento foi assinado.
839 839 *
840 840 * @apiSuccessExample {json} Success-Response:
... ... @@ -846,7 +846,7 @@
846 846 * "dataGeracao": "2015-08-10T00:00:00-03:00",
847 847 * "tipo": {
848 848 * "codigo": "629",
849   - * "nome": "Relatório de Arquivamento-SIF"
  849 + * "nome": "Relatório de Arquivamento-SIF"
850 850 * }
851 851 * "tipoConferencia": "4",
852 852 * "assinado": true
... ... @@ -856,7 +856,7 @@
856 856 * HTTP/1.1 500 Internal Server Error
857 857 * {
858 858 * "error":"Mensagem de erro."
859   - * "code":"código do erro"
  859 + * "code":"código do erro"
860 860 * }
861 861 */
862 862  
... ... @@ -868,21 +868,21 @@
868 868 *
869 869 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
870 870 *
871   - * @apiDescription Consulta as unidades onde o processo está aberto.
  871 + * @apiDescription Consulta as unidades onde o processo está aberto.
872 872 *
873   - * @apiParam (Path Parameters) {String} processo Número do processo.
  873 + * @apiParam (Path Parameters) {String} processo Número do processo.
874 874 *
875   - * @apiExample Exemplo de requisição:
  875 + * @apiExample Exemplo de requisição:
876 876 * curl -i https://<host>/sei-broker/service/processos/33910002924201874/unidades
877 877 *
878   - * @apiSuccess (Sucesso Response Body - 200) {List} unidades Lista da unidades onde o processo está aberto.
  878 + * @apiSuccess (Sucesso Response Body - 200) {List} unidades Lista da unidades onde o processo está aberto.
879 879 * @apiSuccess (Sucesso Response Body - 200) {Unidade} unidades.unidade Objeto Unidade.
880 880 * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.idUnidade Identificador da unidade.
881 881 * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sigla Sigla de unidade.
882   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.descricao Descrição da unidade.
883   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinProtocolo Descrição pendente da área de negócio.
884   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinArquivamento Descrição pendente da área de negócio.
885   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinOuvidoria Descrição pendente da área de negócio.
  882 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.descricao Descrição da unidade.
  883 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinProtocolo Descrição pendente da área de negócio.
  884 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinArquivamento Descrição pendente da área de negócio.
  885 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinOuvidoria Descrição pendente da área de negócio.
886 886 *
887 887 * @apiSuccessExample {json} Success-Response:
888 888 * HTTP/1.1 200 OK
... ... @@ -901,6 +901,6 @@
901 901 * HTTP/1.1 500 Internal Server Error
902 902 * {
903 903 * "error":"Mensagem de erro."
904   - * "code":"código do erro"
  904 + * "code":"código do erro"
905 905 * }
906 906 */
907 907 \ No newline at end of file
... ...
src/main/resources/apidoc/serie.apidoc
  Diff comments   View file @ee0e973
1 1 /**
2   - * @api {get} /:unidade/series Listar séries
  2 + * @api {get} /:unidade/series Listar séries
3 3 * @apiName listarSeries
4 4 * @apiGroup Serie
5   - * @apiVersion 2.0.0
  5 + * @apiVersion 2.9.1
6 6 *
7 7 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
8 8 *
9   - * @apiDescription Este método realiza uma consulta às séries.
  9 + * @apiDescription Este método realiza uma consulta às séries.
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
12 12 *
13 13 * @apiParam (Query Parameters) {String} [filtro] Para filtrar por series que contenham o trecho no nome.
14   - * @apiParam (Query Parameters) {String} [nome] Para selecionar a série que possua nome igual.
  14 + * @apiParam (Query Parameters) {String} [nome] Para selecionar a série que possua nome igual.
15 15 * @apiParam (Query Parameters) {String} [tipo-processo=null] Para filtrar por determinado tipo de processo.
16 16 *
17   - * @apiExample {curl} Exemplo de requisição:
  17 + * @apiExample {curl} Exemplo de requisição:
18 18 * curl -i https://<host>/sei-broker/service/COSAP/series
19 19 *
20   - * @apiSuccess (Sucesso - 200) {Serie[]} series Lista de séries.
  20 + * @apiSuccess (Sucesso - 200) {Serie[]} series Lista de séries.
21 21 * @apiSuccess (Sucesso - 200) {String} series.idSerie Identificador do tipo de documento
22 22 * @apiSuccess (Sucesso - 200) {String} series.nome Nome do tipo de documento
23   - * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários
  23 + * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários
24 24 *
25 25 * @apiErrorExample {json} Error-Response:
26 26 * HTTP/1.1 500 Internal Server Error
27 27 * {
28 28 * "error":"Mensagem de erro."
29   - * "code":"código do erro"
  29 + * "code":"código do erro"
30 30 * }
31 31 */
32   -
33   - /**
34   - * @api {get} /:unidade/tipos-documentos Listar tipos documentos
35   - * @apiName listarTiposDocumentos
36   - * @apiGroup Documento
37   - * @apiVersion 2.0.0
38   - *
39   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
40   - *
41   - * @apiDescription Lista os tipos de documentos do SEI.
42   - *
43   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
44   - *
45   - * @apiParam (Query Parameters) {String} [filtro] Para filtrar por documentos que contenham o trecho no nome.
46   - * @apiParam (Query Parameters) {String} [nome] Para selecionar a série que possua nome igual.
47   - *
48   - * @apiExample {curl} Exemplo de requisição:
49   - * curl -i https://<host>/sei-broker/service/COSAP/tipos-documentos
50   - *
51   - * @apiSuccess (Sucesso - 200) {List} tipos Lista com os tipos de documentos
52   - * @apiSuccess (Sucesso - 200) {String} tipos.identificador Identificador do tipo de documento
53   - * @apiSuccess (Sucesso - 200) {String} tipos.nome Nome do tipo de documento
54   - * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários
55   - *
56   - * @apiErrorExample {json} Error-Response:
57   - * HTTP/1.1 500 Internal Server Error
58   - * {
59   - * "error":"Mensagem de erro."
60   - * "code":"código do erro"
61   - * }
62   - */
63   -
... ...
src/main/resources/apidoc/sipar.apidoc
  Diff comments   View file @ee0e973
... ... @@ -4,12 +4,12 @@
4 4 * @apiGroup SIPAR
5 5 * @apiVersion 2.0.0
6 6 *
7   - * @apiDescription Marca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
  7 + * @apiDescription Marca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
8 8 *
9 9 * @apiParam (Header Parameters) {String} content-type Informar text/plain
10   - * @apiParam (Request Body) {String} processo Número do processo a ser importado
  10 + * @apiParam (Request Body) {String} processo Número do processo a ser importado
11 11 *
12   - * @apiExample Exemplo de requisição:
  12 + * @apiExample Exemplo de requisição:
13 13 * endpoint: [POST] http://<host>/sei-broker/service/sipar/importados
14 14 *
15 15 * body:
... ... @@ -22,7 +22,7 @@
22 22 * HTTP/1.1 500 Internal Server Error
23 23 * {
24 24 * "error":"Mensagem de erro."
25   - * "code":"código do erro"
  25 + * "code":"código do erro"
26 26 * }
27 27 *
28 28 *
... ... @@ -30,7 +30,7 @@
30 30 * HTTP/1.1 400 Bad Request
31 31 * {
32 32 * "error":"Mensagem de erro."
33   - * "code":"código do erro"
  33 + * "code":"código do erro"
34 34 * }
35 35 *
36 36 *
... ... @@ -38,21 +38,21 @@
38 38 * HTTP/1.1 409 Conflict
39 39 * {
40 40 * "error":"Mensagem de erro."
41   - * "code":"código do erro"
  41 + * "code":"código do erro"
42 42 * }
43 43 */
44 44  
45 45 /**
46   - * @api {delete} /sipar/importados/:processo Cancelar Importação Processo
  46 + * @api {delete} /sipar/importados/:processo Cancelar Importação Processo
47 47 * @apiName cancelarImportacaoProcesso
48 48 * @apiGroup SIPAR
49 49 * @apiVersion 2.0.0
50 50 *
51   - * @apiDescription Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
  51 + * @apiDescription Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
52 52 *
53   - * @apiParam (Path Parameter) {String} processo Número do processo físico existente no SIPAR contendo 17 dígitos e iniciado com 33902. Ex. 33902111111111111
  53 + * @apiParam (Path Parameter) {String} processo Número do processo físico existente no SIPAR contendo 17 dígitos e iniciado com 33902. Ex. 33902111111111111
54 54 *
55   - * @apiExample {curl} Exemplo de requisição:
  55 + * @apiExample {curl} Exemplo de requisição:
56 56 * curl -X DELETE http://<host>/sei-broker/service/sipar/importados/33902112492200241
57 57 *
58 58 * @apiSuccessExample {json} Success-Response:
... ... @@ -62,7 +62,7 @@
62 62 * HTTP/1.1 500 Internal Server Error
63 63 * {
64 64 * "error":"Mensagem de erro."
65   - * "code":"código do erro"
  65 + * "code":"código do erro"
66 66 * }
67 67 *
68 68 *
... ... @@ -70,7 +70,7 @@
70 70 * HTTP/1.1 400 Bad Request
71 71 * {
72 72 * "error":"Mensagem de erro."
73   - * "code":"código do erro"
  73 + * "code":"código do erro"
74 74 * }
75 75 *
76 76 *
... ... @@ -78,6 +78,6 @@
78 78 * HTTP/1.1 404 Not Found
79 79 * {
80 80 * "error":"Mensagem de erro."
81   - * "code":"código do erro"
  81 + * "code":"código do erro"
82 82 * }
83 83 */
84 84 \ No newline at end of file
... ...
src/main/resources/apidoc/tarefa.apidoc
  Diff comments   View file @ee0e973
... ... @@ -10,23 +10,23 @@
10 10 *
11 11 * @apiParam (Query Parameters) {String} [nome] Filtro para o nome da tarefa.
12 12 *
13   - * @apiExample {curl} Exemplo de requisição:
  13 + * @apiExample {curl} Exemplo de requisição:
14 14 * curl -i https://<host>/sei-broker/service/tarefas
15 15 *
16 16 * @apiSuccess (Sucesso - 200) {List} tarefas Lista com as tarefas
17 17 * @apiSuccess (Sucesso - 200) {String} tarefas.identificados Identificador da tarefa.
18 18 * @apiSuccess (Sucesso - 200) {String} tarefas.nome Nome da tarefa.
19   - * @apiSuccess (Sucesso - 200) {String} tarefas.historicoResumido S/N - Sinalizador indica se a tarefa aparecerá no histórico resumido.
20   - * @apiSuccess (Sucesso - 200) {String} tarefas.historicoCompleto S/N - Sinalizador indica se a tarefa aparecerá no histórico completo.
  19 + * @apiSuccess (Sucesso - 200) {String} tarefas.historicoResumido S/N - Sinalizador indica se a tarefa aparecerá no histórico resumido.
  20 + * @apiSuccess (Sucesso - 200) {String} tarefas.historicoCompleto S/N - Sinalizador indica se a tarefa aparecerá no histórico completo.
21 21 * @apiSuccess (Sucesso - 200) {String} tarefas.fecharAndamentosAbertos S/N - Sinalizador indica se a tarefa fecha andamentos abertos.
22 22 * @apiSuccess (Sucesso - 200) {String} tarefas.lancarAndamentoFechado S/N - Sinalizador indica que a tarefa encerra o andamento.
23   - * @apiSuccess (Sucesso - 200) {String} tarefas.permiteProcessoFechado S/N - Sinalizador indica se é permitida essa tarefa em processo fechado.
24   - * @apiSuccess (Sucesso - 200) {String} tarefas.identicadorTarefaModulo Identificador de tarefa módulo.
  23 + * @apiSuccess (Sucesso - 200) {String} tarefas.permiteProcessoFechado S/N - Sinalizador indica se é permitida essa tarefa em processo fechado.
  24 + * @apiSuccess (Sucesso - 200) {String} tarefas.identicadorTarefaModulo Identificador de tarefa módulo.
25 25 *
26 26 * @apiErrorExample {json} Error-Response:
27 27 * HTTP/1.1 500 Internal Server Error
28 28 * {
29 29 * "error":"Mensagem de erro."
30   - * "code":"código do erro"
  30 + * "code":"código do erro"
31 31 * }
32 32 */
33 33 \ No newline at end of file
... ...
src/main/resources/apidoc/tipoConferencia.apidoc
  Diff comments   View file @ee0e973
1 1 /**
2   - * @api {get} /:unidade/tipos-conferencia Listar tipos de conferência
  2 + * @api {get} /:unidade/tipos-conferencia Listar tipos de conferência
3 3 * @apiName listarTiposConferencia
4   - * @apiGroup Tipos Conferência
  4 + * @apiGroup Tipos Conferência
5 5 * @apiVersion 2.0.0
6 6 *
7 7 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
8 8 *
9   - * @apiDescription Lista os tipos de conferência.
  9 + * @apiDescription Lista os tipos de conferência.
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
12 12 *
13   - * @apiExample {curl} Exemplo de requisição:
  13 + * @apiExample {curl} Exemplo de requisição:
14 14 * curl -i https://<host>/sei-broker/service/cosap/tipos-conferencia
15 15 *
16   - * @apiSuccess (Sucesso - 200) {TipoConferencia[]} tipos Lista de tipos de conferência.
17   - * @apiSuccess (Sucesso - 200) {String} tipos.idTipoConferencia Identificador do tipo de conferência.
18   - * @apiSuccess (Sucesso - 200) {String} tipos.descricao Descrição do tipo de conferência.
  16 + * @apiSuccess (Sucesso - 200) {TipoConferencia[]} tipos Lista de tipos de conferência.
  17 + * @apiSuccess (Sucesso - 200) {String} tipos.idTipoConferencia Identificador do tipo de conferência.
  18 + * @apiSuccess (Sucesso - 200) {String} tipos.descricao Descrição do tipo de conferência.
19 19 *
20 20 * @apiErrorExample {json} Error-Response:
21 21 * HTTP/1.1 500 Internal Server Error
22 22 * {
23 23 * "error":"Mensagem de erro."
24   - * "code":"código do erro"
  24 + * "code":"código do erro"
25 25 * }
26 26 */
... ...
src/main/resources/apidoc/unidade.apidoc
  Diff comments   View file @ee0e973
... ... @@ -8,43 +8,43 @@
8 8 *
9 9 * @apiDescription Retorna as Unidades cadastradas no SEI.
10 10 *
11   - * @apiExample {curl} Exemplo de requisição:
  11 + * @apiExample {curl} Exemplo de requisição:
12 12 * curl -i https://<host>/sei-broker/service/unidades/
13 13 *
14 14 * @apiSuccess (Sucesso - 200) {Unidade[]} unidades Lista de unidades
15 15 * @apiSuccess (Sucesso - 200) {String} unidades.idUnidade Identificador da unidade
16 16 * @apiSuccess (Sucesso - 200) {String} unidades.sigla Sigla da unidade
17   - * @apiSuccess (Sucesso - 200) {String} unidades.descricao Descrição da unidade
  17 + * @apiSuccess (Sucesso - 200) {String} unidades.descricao Descrição da unidade
18 18 *
19 19 * @apiErrorExample {json} Error-Response:
20 20 * HTTP/1.1 500 Internal Server Error
21 21 * {
22 22 * "error":"Mensagem de erro."
23   - * "code":"código do erro"
  23 + * "code":"código do erro"
24 24 * }
25 25 */
26 26  
27 27 /**
28   - * @api {get} /unidades/{unidade}/codigo Consultar código
  28 + * @api {get} /unidades/{unidade}/codigo Consultar código
29 29 * @apiName consultarCodigo
30 30 * @apiGroup Unidade
31 31 * @apiVersion 2.0.0
32 32 *
33 33 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
34 34 *
35   - * @apiDescription Retorna o código da Unidade pesquisada.
  35 + * @apiDescription Retorna o código da Unidade pesquisada.
36 36 *
37   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade que deseja consultar o código
  37 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade que deseja consultar o código
38 38 *
39   - * @apiExample {curl} Exemplo de requisição:
  39 + * @apiExample {curl} Exemplo de requisição:
40 40 * curl -i https://<host>/sei-broker/service/unidades/COSAP/codigo
41 41 *
42   - * @apiSuccess (Sucesso - 200) {String} codigo Código da unidade.
  42 + * @apiSuccess (Sucesso - 200) {String} codigo Código da unidade.
43 43 *
44 44 * @apiErrorExample {json} Error-Response:
45 45 * HTTP/1.1 500 Internal Server Error
46 46 * {
47 47 * "error":"Mensagem de erro."
48   - * "code":"código do erro"
  48 + * "code":"código do erro"
49 49 * }
50 50 */
... ...
src/main/resources/apidoc/usuario.apidoc
  Diff comments   View file @ee0e973
1 1 /**
2   - * @api {get} /:unidade/usuarios Listar usuários
  2 + * @api {get} /:unidade/usuarios Listar usuários
3 3 * @apiName listarUsuarios
4 4 * @apiGroup Usuario
5 5 * @apiVersion 2.0.0
6 6 *
7 7 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
8 8 *
9   - * @apiDescription Este método realiza uma consulta aos usuários cadastrados que possuem o perfil "Básico".
  9 + * @apiDescription Este método realiza uma consulta aos usuários cadastrados que possuem o perfil "Básico".
10 10 *
11 11 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
12 12 *
13   - * @apiParam (Query Parameters) {String} [usuario=null] Id do usuário que deseja recuperar as informações
  13 + * @apiParam (Query Parameters) {String} [usuario=null] Id do usuário que deseja recuperar as informações
14 14 *
15   - * @apiExample {curl} Exemplo de requisição:
  15 + * @apiExample {curl} Exemplo de requisição:
16 16 * curl -i http://<host>/sei-broker/service/usuarios/COSAP
17 17 *
18   - * @apiSuccess {Usuario[]} usuarios Lista de usuários
  18 + * @apiSuccess {Usuario[]} usuarios Lista de usuários
19 19 *
20 20 * @apiErrorExample {json} Error-Response:
21 21 * HTTP/1.1 500 Internal Server Error
22 22 * {
23 23 * "error":"Mensagem de erro."
24   - * "code":"código do erro"
  24 + * "code":"código do erro"
25 25 * }
26 26 */
27 27  
28 28 /**
29   - * @api {get} :unidade/usuarios/:usuario Buscar usuário
  29 + * @api {get} :unidade/usuarios/:usuario Buscar usuário
30 30 * @apiName buscarUsuario
31 31 * @apiGroup Usuario
32 32 * @apiVersion 2.0.0
33 33 *
34 34 * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
35 35 *
36   - * @apiDescription Este método realiza a uma busca pelo login do usuário.
  36 + * @apiDescription Este método realiza a uma busca pelo login do usuário.
37 37 *
38 38 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
39   - * @apiParam (Path Parameters) {String} usuario Login do usuário
  39 + * @apiParam (Path Parameters) {String} usuario Login do usuário
40 40 *
41   - * @apiExample Exemplo de requisição:
  41 + * @apiExample Exemplo de requisição:
42 42 * curl -i http://<host>/sei-broker/service/cosap/usuarios/andre.guimaraes
43 43 *
44   - * @apiSuccess {Usuario} usuario Informações do usuário encontrado.
  44 + * @apiSuccess {Usuario} usuario Informações do usuário encontrado.
45 45 *
46 46 * @apiErrorExample {json} Error-Response:
47 47 * HTTP/1.1 500 Internal Server Error
48 48 * {
49 49 * "error":"Mensagem de erro."
50   - * "code":"código do erro"
  50 + * "code":"código do erro"
51 51 * }
52 52 */
53 53  
... ... @@ -59,15 +59,15 @@
59 59 *
60 60 * @apiPermission RO_SEI_BROKER
61 61 *
62   - * @apiDescription Este método atribui o processo a um usuário.
  62 + * @apiDescription Este método atribui o processo a um usuário.
63 63 *
64 64 * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
65   - * @apiParam (Path Parameters) {String} usuario Login do usuário a quem deseja atribuir o processo
  65 + * @apiParam (Path Parameters) {String} usuario Login do usuário a quem deseja atribuir o processo
66 66 *
67   - * @apiParam (Request Body) {String} processo Numero do processo a ser atribuído
  67 + * @apiParam (Request Body) {String} processo Numero do processo a ser atribuído
68 68 * @apiParam (Request Body) {String} [reabrir-processo=N] S ou N para reabrir o processo
69 69 *
70   - * @apiExample Exemplo de requisição:
  70 + * @apiExample Exemplo de requisição:
71 71 * endpoint: [POST] http://<host>/sei-broker/service/COSAP/usuarios/andre.guimaraes/processos
72 72 *
73 73 * body:
... ... @@ -76,149 +76,149 @@
76 76 * "reabrir":false
77 77 * }
78 78 *
79   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  79 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
80 80 *
81 81 * @apiErrorExample {json} Error-Response:
82 82 * HTTP/1.1 500 Internal Server Error
83 83 * {
84 84 * "error":"Mensagem de erro."
85   - * "code":"código do erro"
  85 + * "code":"código do erro"
86 86 * }
87 87 */
88 88  
89 89 /**
90   - * @api {post} /usuarios Incluir usuário
  90 + * @api {post} /usuarios Incluir usuário
91 91 * @apiName incluirUsuario
92 92 * @apiGroup Usuario
93 93 * @apiVersion 2.0.0
94 94 *
95 95 * @apiPermission RO_SEI_BROKER_ADM
96 96 *
97   - * @apiDescription Este método realiza a inclusão de novos usuários ou alterarações nos usuários existentes.
  97 + * @apiDescription Este método realiza a inclusão de novos usuários ou alterarações nos usuários existentes.
98 98 *
99   - * @apiParam (Request Body) {String} codigo Código que deseja atribuir ao usuário
100   - * @apiParam (Request Body) {String} nome Nome do usuário
101   - * @apiParam (Request Body) {String} login Login que será atribuído ao usuário
  99 + * @apiParam (Request Body) {String} codigo Código que deseja atribuir ao usuário
  100 + * @apiParam (Request Body) {String} nome Nome do usuário
  101 + * @apiParam (Request Body) {String} login Login que será atribuído ao usuário
102 102 *
103   - * @apiExample Exemplo de requisição:
  103 + * @apiExample Exemplo de requisição:
104 104 * endpoint: http://<host>/sei-broker/service/usuarios
105 105 *
106 106 * body:
107 107 * {
108 108 * "codigo":"1234",
109   - * "nome":"André Luís Fernandes Guimarães",
  109 + * "nome":"André Luís Fernandes Guimarães",
110 110 * "login":"andre.guimaraes"
111 111 * }
112 112 *
113   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  113 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
114 114 *
115 115 * @apiErrorExample {json} Error-Response:
116 116 * HTTP/1.1 500 Internal Server Error
117 117 * {
118 118 * "error":"Mensagem de erro."
119   - * "code":"código do erro"
  119 + * "code":"código do erro"
120 120 * }
121 121 */
122 122  
123 123 /**
124   - * @api {delete} /usuarios/:login Excluir usuário
  124 + * @api {delete} /usuarios/:login Excluir usuário
125 125 * @apiName excluirUsuario
126 126 * @apiGroup Usuario
127 127 * @apiVersion 2.0.0
128 128 *
129 129 * @apiPermission RO_SEI_BROKER_ADM
130 130 *
131   - * @apiDescription Este método realiza a exclusão de usuários.
  131 + * @apiDescription Este método realiza a exclusão de usuários.
132 132 *
133   - * @apiParam {String} codigo Código que deseja atribuir ao usuário
134   - * @apiParam {String} nome Nome do usuário
135   - * @apiParam {String} login Login que será atribuído ao usuário
  133 + * @apiParam {String} codigo Código que deseja atribuir ao usuário
  134 + * @apiParam {String} nome Nome do usuário
  135 + * @apiParam {String} login Login que será atribuído ao usuário
136 136 *
137   - * @apiExample Exemplo de requisição:
  137 + * @apiExample Exemplo de requisição:
138 138 * endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/andre.guimaraes
139 139 *
140 140 * body:
141 141 * {
142 142 * "codigo":"1234",
143   - * "nome":"André Luís Fernandes Guimarães",
  143 + * "nome":"André Luís Fernandes Guimarães",
144 144 * "login":"andre.guimaraes"
145 145 * }
146 146 *
147   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  147 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
148 148 *
149 149 * @apiErrorExample {json} Error-Response:
150 150 * HTTP/1.1 500 Internal Server Error
151 151 * {
152 152 * "error":"Mensagem de erro."
153   - * "code":"código do erro"
  153 + * "code":"código do erro"
154 154 * }
155 155 */
156 156  
157 157 /**
158   - * @api {delete} /usuarios/ativos Desativar usuário
  158 + * @api {delete} /usuarios/ativos Desativar usuário
159 159 * @apiName desativarUsuario
160 160 * @apiGroup Usuario
161 161 * @apiVersion 2.0.0
162 162 *
163 163 * @apiPermission RO_SEI_BROKER_ADM
164 164 *
165   - * @apiDescription Este método desativa usuários.
  165 + * @apiDescription Este método desativa usuários.
166 166 *
167   - * @apiParam {String} codigo Código que deseja atribuir ao usuário
168   - * @apiParam {String} nome Nome do usuário
169   - * @apiParam {String} login Login que será atribuído ao usuário
  167 + * @apiParam {String} codigo Código que deseja atribuir ao usuário
  168 + * @apiParam {String} nome Nome do usuário
  169 + * @apiParam {String} login Login que será atribuído ao usuário
170 170 *
171   - * @apiExample Exemplo de requisição:
  171 + * @apiExample Exemplo de requisição:
172 172 * endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/ativos/andre.guimaraes
173 173 *
174 174 * body:
175 175 * {
176 176 * "codigo":"1234",
177   - * "nome":"André Luís Fernandes Guimarães",
  177 + * "nome":"André Luís Fernandes Guimarães",
178 178 * "login":"andre.guimaraes"
179 179 * }
180 180 *
181   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  181 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
182 182 *
183 183 * @apiErrorExample {json} Error-Response:
184 184 * HTTP/1.1 500 Internal Server Error
185 185 * {
186 186 * "error":"Mensagem de erro."
187   - * "code":"código do erro"
  187 + * "code":"código do erro"
188 188 * }
189 189 */
190 190  
191 191 /**
192   - * @api {post} /usuarios/ativos Ativar usuário
  192 + * @api {post} /usuarios/ativos Ativar usuário
193 193 * @apiName ativarUsuario
194 194 * @apiGroup Usuario
195 195 * @apiVersion 2.0.0
196 196 *
197 197 * @apiPermission RO_SEI_BROKER_ADM
198 198 *
199   - * @apiDescription Este método reativa usuários.
  199 + * @apiDescription Este método reativa usuários.
200 200 *
201   - * @apiParam {String} codigo Código que deseja atribuir ao usuário
202   - * @apiParam {String} nome Nome do usuário
203   - * @apiParam {String} login Login que será atribuído ao usuário
  201 + * @apiParam {String} codigo Código que deseja atribuir ao usuário
  202 + * @apiParam {String} nome Nome do usuário
  203 + * @apiParam {String} login Login que será atribuído ao usuário
204 204 *
205   - * @apiExample Exemplo de requisição:
  205 + * @apiExample Exemplo de requisição:
206 206 * endpoint: http://<host>/sei-broker/service/usuarios/ativos
207 207 *
208 208 * body:
209 209 * {
210 210 * "codigo":"1234",
211   - * "nome":"André Luís Fernandes Guimarães",
  211 + * "nome":"André Luís Fernandes Guimarães",
212 212 * "login":"andre.guimaraes"
213 213 * }
214 214 *
215   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  215 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
216 216 *
217 217 * @apiErrorExample {json} Error-Response:
218 218 * HTTP/1.1 500 Internal Server Error
219 219 * {
220 220 * "error":"Mensagem de erro."
221   - * "code":"código do erro"
  221 + * "code":"código do erro"
222 222 * }
223 223 */
224 224  
... ...