Download as
Browse Code »

Commit e97917255a293387aba2d656fe47953555172a6a

Authored by andre.guimaraes
1 parent d099286d
Exists in master and in 1 other branch removing-depencies

Cria arquivos para a documentação 

Remoção da documentação de dentro das classes Resource, a documentação
passa a ficar em arquivos *.apidoc divididos por dominio.
Showing 34 changed files with 3101 additions and 3057 deletions   Show diff stats
src/main/java/br/gov/ans/integracao/sei/rest/ArquivoResource.java
  Diff comments   View file @e979172
... ... @@ -39,56 +39,7 @@ public class ArquivoResource {
39 39  
40 40 @Context
41 41 private UriInfo uriInfo;
42   -
43   - /**
44   - * @api {post} /:unidade/arquivos Adicionar arquivo
45   - * @apiName adicionarArquivo
46   - * @apiGroup Arquivo
47   - * @apiVersion 2.0.0
48   - *
49   - * @apiPermission RO_SEI_BROKER
50   - *
51   - * @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
52   - * 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
53   - * 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.
54   - *
55   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
56   - *
57   - * @apiParam (Request Body) {Arquivo} arquivo Objeto representando um arquivo.
58   - * @apiParam (Request Body) {String} arquivo.nome Nome do arquivo.
59   - * @apiParam (Request Body) {String} arquivo.tamanho Tamanho total do arquivo em bytes.
60   - * @apiParam (Request Body) {String} arquivo.hash MD5 do conteúdo total do arquivo.
61   - * @apiParam (Request Body) {String} arquivo.conteudo Conteúdo total ou parcial codificado em Base64, máximo de 15MB.
62   - *
63   - * @apiExample Exemplo de requisição:
64   - * endpoint: https://<host>/sei-broker/service/COSAP/arquivos
65   - *
66   - * body:
67   - * {
68   - * "nome":"documentos-sei-broker.pdf",
69   - * "tamanho":"2048",
70   - * "hash":"45F1DEFFB45A5F6C2380A4CEE9B3E452",
71   - * "conteudo":"Conteúdo total ou parcial do arquivo"
72   - * }
73   - *
74   - * @apiSuccess (Sucesso - 201) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo
75   - * @apiSuccess (Sucesso - 201) {String} arquivo.identificador Identificador do arquivo criado.
76   - *
77   - * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado.
78   - *
79   - * @apiSuccessExample {json} Success-Response:
80   - * HTTP/1.1 201 Created
81   - * {
82   - * "identificador":"123456"
83   - * }
84   - *
85   - * @apiErrorExample {json} Error-Response:
86   - * HTTP/1.1 500 Internal Server Error
87   - * {
88   - * "error":"Mensagem de erro."
89   - * "code":"código do erro"
90   - * }
91   - */
  42 +
92 43 @POST
93 44 @Path("{unidade}/arquivos")
94 45 @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -102,51 +53,6 @@ public class ArquivoResource {
102 53 return Response.created(getResourcePath(identificador)).entity(new ArquivoCriado(identificador)).build();
103 54 }
104 55  
105   - /**
106   - * @api {put} /:unidade/arquivos/:arquivo Adicionar conteúdo arquivo
107   - * @apiName adicionarConteudoArquivo
108   - * @apiGroup Arquivo
109   - * @apiVersion 2.0.0
110   - *
111   - * @apiPermission RO_SEI_BROKER
112   - *
113   - * @apiDescription Adiciona conteúdo a um arquivo criado, o sistema identificará automaticamente quando o conteúdo foi completado validando o tamanho em bytes
114   - * 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.
115   - *
116   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
117   - * @apiParam (Path Parameters) {String} arquivo Identificador do arquivo que receberá o conteúdo.
118   - *
119   - * @apiParam (Request Body) {ParteArquivo} parte Objeto representando uma parte do arquivo.
120   - * @apiParam (Request Body) {String} parte.arquivo Identificador do arquivo que receberá o conteúdo.
121   - * @apiParam (Request Body) {String} parte.conteudo Conteúdo parcial codificado em Base64, máximo de 15MB.
122   - *
123   - * @apiExample Exemplo de requisição:
124   - * endpoint: https://<host>/sei-broker/service/COSAP/arquivos/123456
125   - *
126   - * body:
127   - * {
128   - * "arquivo":"123456",
129   - * "conteudo":"Conteúdo parcial do arquivo"
130   - * }
131   - *
132   - * @apiSuccess (Sucesso - 200) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo
133   - * @apiSuccess (Sucesso - 200) {String} arquivo.identificador Identificador do arquivo criado.
134   - *
135   - * @apiSuccess (Sucesso Response Header - 200) {header} Location URL de acesso ao recurso alterado.
136   - *
137   - * @apiSuccessExample {json} Success-Response:
138   - * HTTP/1.1 200 Created
139   - * {
140   - * "identificador":"123456"
141   - * }
142   - *
143   - * @apiErrorExample {json} Error-Response:
144   - * HTTP/1.1 500 Internal Server Error
145   - * {
146   - * "error":"Mensagem de erro."
147   - * "code":"código do erro"
148   - * }
149   - */
150 56 @PUT
151 57 @Path("{unidade}/arquivos/{arquivo}")
152 58 @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/BlocoResource.java
  Diff comments   View file @e979172
... ... @@ -47,60 +47,6 @@ public class BlocoResource {
47 47 @Context
48 48 private UriInfo uriInfo;
49 49  
50   - /**
51   - * @api {get} /:unidade/blocos/:bloco Consultar bloco
52   - * @apiName consultarBloco
53   - * @apiGroup Bloco
54   - * @apiVersion 2.0.0
55   - *
56   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
57   - *
58   - * @apiDescription Recupera as informações do bloco informado.
59   - *
60   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
61   - * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja consultar
62   - *
63   - * @apiParam (Query Parameters) {String} [protocolos=N] S ou N para exibir os protocolos do bloco
64   - *
65   - * @apiExample {curl} Exemplo de requisição:
66   - * curl -i http://<host>/sei-broker/service/COSAP/blocos/12
67   - *
68   - * @apiSuccess (Sucesso - 200) {RetornoConsultaBloco} bloco Objeto representando o bloco encontrado
69   - * @apiSuccess (Sucesso - 200) {String} bloco.idBloco Número do bloco
70   - * @apiSuccess (Sucesso - 200) {Unidade} bloco.unidade Dados das unidade que gerou o bloco
71   - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.idUnidade Identificador da Unidade
72   - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sigla Sigla da unidade
73   - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.descricao Descrição do unidade
74   - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinProtocolo :TODO pendente
75   - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinArquivamento :TODO pendente
76   - * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinOuvidoria :TODO pendente
77   - * @apiSuccess (Sucesso - 200) {Usuario} bloco.usuario Dados das unidade que gerou o bloco
78   - * @apiSuccess (Sucesso - 200) {String} bloco.usuario.idUsuario Identificador do suário
79   - * @apiSuccess (Sucesso - 200) {String} bloco.usuario.sigla Sigla do usuário
80   - * @apiSuccess (Sucesso - 200) {String} bloco.usuario.nome Nome do usuário
81   - * @apiSuccess (Sucesso - 200) {String} bloco.descricao Descrição do bloco
82   - * @apiSuccess (Sucesso - 200) {String} bloco.tipo Tipo do bloco (A=Assinatura, R=Reunião ou I=Interno)
83   - * @apiSuccess (Sucesso - 200) {String} bloco.estado Estado do bloco (A=Aberto, D=Disponibilizado, R=Retornado ou C=Concluído)
84   - * @apiSuccess (Sucesso - 200) {Unidade[]} bloco.unidadesDisponibilizacao Dados das unidades configuradas para disponibilização (ver estrutura Unidade)
85   - * @apiSuccess (Sucesso - 200) {ProtocoloBloco[]} bloco.protocolos Processos ou documentos do bloco
86   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.protocoloFormatado Número de protocolo formatado
87   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.identificacao :TODO pendente
88   - * @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
89   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.nome Nome do assinante
90   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.cargoFuncao Cargo ou função utilizado no momento da assinatura
91   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.dataHora Data/hora em que ocorreu a assinatura
92   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idUsuario Identificador do usuário
93   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idOrigem :TODO pendente
94   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idOrgao :TODO pendente
95   - * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.sigla Login do usuário responsável pela assinatura
96   - *
97   - * @apiErrorExample {json} Error-Response:
98   - * HTTP/1.1 500 Internal Server Error
99   - * {
100   - * "error":"Mensagem de erro."
101   - * "code":"código do erro"
102   - * }
103   - */
104 50 @GET
105 51 @Path("{unidade}/blocos/{bloco}")
106 52 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -109,36 +55,6 @@ public class BlocoResource {
109 55 return seiNativeService.consultarBloco(Constantes.SEI_BROKER, Operacao.CONSULTAR_BLOCO, unidadeResource.consultarCodigo(unidade), bloco, getSOuN(exibirProtocolos));
110 56 }
111 57  
112   -
113   - /**
114   - * @api {post} /:unidade/blocos/disponibilizados Disponibilizar bloco
115   - * @apiName disponibilizarBloco
116   - * @apiGroup Bloco
117   - * @apiVersion 2.0.0
118   - *
119   - * @apiPermission RO_SEI_BROKER
120   - *
121   - * @apiDescription Disponibiliza um determinado bloco.
122   - *
123   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
124   - *
125   - * @apiParam (Request Body) {String} bloco Numero do bloco que deseja disponibilizar
126   - *
127   - * @apiExample Exemplo de requisição:
128   - * endpoint: [POST] http://<host>/sei-broker/service/COSAP/blocos/disponibilizados
129   - *
130   - * body:
131   - * 12
132   - *
133   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
134   - *
135   - * @apiErrorExample {json} Error-Response:
136   - * HTTP/1.1 500 Internal Server Error
137   - * {
138   - * "error":"Mensagem de erro."
139   - * "code":"código do erro"
140   - * }
141   - */
142 58 @POST
143 59 @Path("{unidade}/blocos/disponibilizados")
144 60 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -148,32 +64,6 @@ public class BlocoResource {
148 64 return trueOrFalse(resultado) + "";
149 65 }
150 66  
151   -
152   - /**
153   - * @api {delete} /:unidade/blocos/disponibilizados/12 Indisponibilizar bloco
154   - * @apiName cancelarDisponibilizacaoBloco
155   - * @apiGroup Bloco
156   - * @apiVersion 2.0.0
157   - *
158   - * @apiPermission RO_SEI_BROKER
159   - *
160   - * @apiDescription Cancela a disponibilização de blocos.
161   - *
162   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
163   - * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja indisponibilizar
164   - *
165   - * @apiExample Exemplo de requisição:
166   - * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/disponibilizados/12
167   - *
168   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
169   - *
170   - * @apiErrorExample {json} Error-Response:
171   - * HTTP/1.1 500 Internal Server Error
172   - * {
173   - * "error":"Mensagem de erro."
174   - * "code":"código do erro"
175   - * }
176   - */
177 67 @DELETE
178 68 @Path("{unidade}/blocos/disponibilizados/{bloco}")
179 69 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -184,32 +74,6 @@ public class BlocoResource {
184 74 return trueOrFalse(resultado) + "";
185 75 }
186 76  
187   -
188   - /**
189   - * @api {delete} /:unidade/blocos/:bloco Excluir bloco
190   - * @apiName excluirBloco
191   - * @apiGroup Bloco
192   - * @apiVersion 2.0.0
193   - *
194   - * @apiPermission RO_SEI_BROKER
195   - *
196   - * @apiDescription Exclui um bloco criado.
197   - *
198   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
199   - * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja excluir
200   - *
201   - * @apiExample Exemplo de requisição:
202   - * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/12
203   - *
204   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
205   - *
206   - * @apiErrorExample {json} Error-Response:
207   - * HTTP/1.1 500 Internal Server Error
208   - * {
209   - * "error":"Mensagem de erro."
210   - * "code":"código do erro"
211   - * }
212   - */
213 77 @DELETE
214 78 @Path("{unidade}/blocos/{bloco}")
215 79 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -218,49 +82,7 @@ public class BlocoResource {
218 82  
219 83 return trueOrFalse(resultado) + "";
220 84 }
221   -
222   - /**
223   - * @api {post} /:unidade/blocos Gerar bloco
224   - * @apiName gerarBloco
225   - * @apiGroup Bloco
226   - * @apiVersion 2.0.0
227   - *
228   - * @apiPermission RO_SEI_BROKER
229   - *
230   - * @apiDescription Gera um novo bloco.
231   - *
232   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
233   - *
234   - * @apiParam (Request Body) {NovoBloco} novoBloco Objeto de criação de bloco
235   - * @apiParam (Request Body) {String="ASSINATURA","INTERNO","REUNIAO"} novoBloco.tipo Tipo do bloco a ser criado
236   - * @apiParam (Request Body) {String} novoBloco.descricao Descrição do bloco
237   - * @apiParam (Request Body) {String[]} novoBloco.unidades Códigos das unidades onde o bloco deve ser disponibilizado, ou vazio para não disponibilizar
238   - * @apiParam (Request Body) {String[]} novoBloco.documentos Código dos documentos que serão incluídos no bloco
239   - * @apiParam (Request Body) {Boolean} novoBloco.disponibilizar=false Informa se o bloco criado deve ser disponibilizado automaticamente
240   - *
241   - * @apiExample Exemplo de requisição:
242   - * endpoint: http://<host>/sei-broker/service/COSAP/blocos
243   - *
244   - * body:
245   - * {
246   - * "tipo":"ASSINATURA",
247   - * "descricao":"Bloco demonstrativo.",
248   - * "unidades":["110000935"],
249   - * "documentos":["0000131"],
250   - * "disponibilizar":true
251   - * }
252   - *
253   - * @apiSuccess (Sucesso Response Body - 201) {String} resultado Código do bloco criado
254   - *
255   - * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado
256   - *
257   - * @apiErrorExample {json} Error-Response:
258   - * HTTP/1.1 500 Internal Server Error
259   - * {
260   - * "error":"Mensagem de erro."
261   - * "code":"código do erro"
262   - * }
263   - */
  85 +
264 86 @Path("{unidade}/blocos")
265 87 @POST
266 88 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -271,39 +93,7 @@ public class BlocoResource {
271 93  
272 94 return Response.created(getResourcePath(retorno)).entity(retorno).build();
273 95 }
274   -
275   - /**
276   - * @api {POST} /:unidade/blocos/:bloco/documentos Incluir documento
277   - * @apiName incluirDocumentoNoBloco
278   - * @apiGroup Bloco
279   - * @apiVersion 2.0.0
280   - *
281   - * @apiPermission RO_SEI_BROKER
282   - *
283   - * @apiDescription Inclui um documento no bloco.
284   - *
285   - * @apiParam (Header Parameters) {String} Content-Type Informar text/plain
286   - *
287   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
288   - * @apiParam (Path Parameters) {String} bloco Número do bloco onde o documento será incluído
289   - *
290   - * @apiParam (Request Body) {String} documento Número do documento que será incluído do bloco
291   - *
292   - * @apiExample Exemplo de requisição:
293   - * endpoint: [POST] http://<host>/sei-broker/service/COSAP/blocos/12/documentos
294   - *
295   - * body:
296   - * 0000050
297   - *
298   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
299   - *
300   - * @apiErrorExample {json} Error-Response:
301   - * HTTP/1.1 500 Internal Server Error
302   - * {
303   - * "error":"Mensagem de erro."
304   - * "code":"código do erro"
305   - * }
306   - */
  96 +
307 97 @POST
308 98 @Path("{unidade}/blocos/{bloco}/documentos")
309 99 @Consumes({MediaType.TEXT_PLAIN})
... ... @@ -315,37 +105,7 @@ public class BlocoResource {
315 105  
316 106 return trueOrFalse(resultado) + "";
317 107 }
318   -
319   - /**
320   - * @api {POST} /:unidade/blocos/:bloco/documentos Incluir documento anotado
321   - * @apiName incluirDocumentoComAnotacaoNoBloco
322   - * @apiGroup Bloco
323   - * @apiVersion 2.0.0
324   - *
325   - * @apiPermission RO_SEI_BROKER
326   - *
327   - * @apiDescription Inclui um documento no bloco.
328   - *
329   - * @apiParam (Header Parameters) {String} Content-Type Informar application/json
330   - *
331   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
332   - * @apiParam (Path Parameters) {String} bloco Número do bloco onde o documento será incluído
333   - *
334   - * @apiParam (Request Body) {InclusaoDocumentoBloco} inclusao Objeto com os dados do documento a ser incluído
335   - * @apiParam (Request Body) {String} bloco Número do bloco onde o documento será inserido
336   - * @apiParam (Request Body) {String} documento Número do documento
337   - * @apiParam (Request Body) {String} [anotacao] Texto de anotação associado com o documento no bloco
338   - *
339   - * @apiExample Exemplo de requisição:
340   - * endpoint: [POST] http://<host>/sei-broker/service/COSAP/blocos/12/documentos
341   - *
342   - * @apiErrorExample {json} Error-Response:
343   - * HTTP/1.1 500 Internal Server Error
344   - * {
345   - * "error":"Mensagem de erro."
346   - * "code":"código do erro"
347   - * }
348   - */
  108 +
349 109 @POST
350 110 @Path("{unidade}/blocos/{bloco}/documentos")
351 111 @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -361,33 +121,7 @@ public class BlocoResource {
361 121 throw new Exception(messages.getMessage("erro.documento.incluir.bloco"));
362 122 }
363 123 }
364   -
365   - /**
366   - * @api {delete} /:unidade/:bloco/documentos/:documento Remover documento
367   - * @apiName retirarDocumentoDoBloco
368   - * @apiGroup Bloco
369   - * @apiVersion 2.0.0
370   - *
371   - * @apiPermission RO_SEI_BROKER
372   - *
373   - * @apiDescription Remove o documento do bloco.
374   - *
375   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
376   - * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o documento será retirado
377   - * @apiParam (Path Parameters) {String} documento Numero do documento que será retirado do bloco
378   - *
379   - * @apiExample Exemplo de requisição:
380   - * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/12/documentos/0000050
381   - *
382   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
383   - *
384   - * @apiErrorExample {json} Error-Response:
385   - * HTTP/1.1 500 Internal Server Error
386   - * {
387   - * "error":"Mensagem de erro."
388   - * "code":"código do erro"
389   - * }
390   - */
  124 +
391 125 @DELETE
392 126 @Path("{unidade}/blocos/{bloco}/documentos/{documento}")
393 127 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -396,36 +130,7 @@ public class BlocoResource {
396 130  
397 131 return trueOrFalse(resultado) + "";
398 132 }
399   -
400   - /**
401   - * @api {post} /:unidade/blocos/:bloco/processos Incluir processo
402   - * @apiName incluirProcessoNoBloco
403   - * @apiGroup Bloco
404   - * @apiVersion 2.0.0
405   - *
406   - * @apiPermission RO_SEI_BROKER
407   - *
408   - * @apiDescription Inclui um processo no bloco.
409   - *
410   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
411   - * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído
412   - *
413   - * @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
414   - *
415   - * @apiParam (Request Body) {String} processo Numero do processo que será incluído no bloco
416   - *
417   - * @apiExample Exemplo de requisição:
418   - * curl -X PUT http://<host>/sei-broker/service/COSAP/blocos/12/processos
419   - *
420   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
421   - *
422   - * @apiErrorExample {json} Error-Response:
423   - * HTTP/1.1 500 Internal Server Error
424   - * {
425   - * "error":"Mensagem de erro."
426   - * "code":"código do erro"
427   - * }
428   - */
  133 +
429 134 @POST
430 135 @Path("{unidade}/blocos/{bloco}/processos")
431 136 @Consumes({MediaType.TEXT_PLAIN})
... ... @@ -441,37 +146,7 @@ public class BlocoResource {
441 146  
442 147 return trueOrFalse(resultado) + "";
443 148 }
444   -
445   - /**
446   - * @api {post} /:unidade/blocos/:bloco/processos Incluir processo anotado
447   - * @apiName incluirProcessoComAnotacaoNoBloco
448   - * @apiGroup Bloco
449   - * @apiVersion 2.0.0
450   - *
451   - * @apiPermission RO_SEI_BROKER
452   - *
453   - * @apiDescription Inclui um processo no bloco, junto com uma anotação.
454   - *
455   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
456   - * @apiParam (Path Parameters) {String} bloco Numero do bloco onde o processo será incluído
457   - *
458   - * @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
459   - *
460   - * @apiParam (Request Body) {InclusaoProcessoBloco} inclusao Objeto com os dados do processo a ser incluído
461   - * @apiParam (Request Body) {String} bloco Número do bloco onde o processo será inserido
462   - * @apiParam (Request Body) {String} processo Número do processo
463   - * @apiParam (Request Body) {String} [anotacao] Texto de anotação associado com o processo no bloco
464   - *
465   - * @apiExample Exemplo de requisição:
466   - * curl -X PUT http://<host>/sei-broker/service/COSAP/blocos/12/processos
467   - *
468   - * @apiErrorExample {json} Error-Response:
469   - * HTTP/1.1 500 Internal Server Error
470   - * {
471   - * "error":"Mensagem de erro."
472   - * "code":"código do erro"
473   - * }
474   - */
  149 +
475 150 @POST
476 151 @Path("{unidade}/blocos/{bloco}/processos")
477 152 @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -492,35 +167,7 @@ public class BlocoResource {
492 167 throw new Exception(messages.getMessage("erro.processo.incluir.bloco"));
493 168 }
494 169 }
495   -
496   - /**
497   - * @api {delete} /:unidade/blocos/:bloco/processos/:processo Remover processo
498   - * @apiName retirarProcessoDoBloco
499   - * @apiGroup Bloco
500   - * @apiVersion 2.0.0
501   - *
502   - * @apiPermission RO_SEI_BROKER
503   - *
504   - * @apiDescription Este método remove o processo do bloco.
505   - *
506   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
507   - * @apiParam (Path Parameters) {String} bloco Numero do bloco de onde o processo será retirado
508   - * @apiParam (Path Parameters) {String} processo Numero do processo que será retirado do bloco
509   - *
510   - * @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
511   - *
512   - * @apiExample Exemplo de requisição:
513   - * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/12/processos/33910000029201653
514   - *
515   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
516   - *
517   - * @apiErrorExample {json} Error-Response:
518   - * HTTP/1.1 500 Internal Server Error
519   - * {
520   - * "error":"Mensagem de erro."
521   - * "code":"código do erro"
522   - * }
523   - */
  170 +
524 171 @DELETE
525 172 @Path("{unidade}/blocos/{bloco}/processos/{processo}")
526 173 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/CargoResource.java
  Diff comments   View file @e979172
... ... @@ -24,36 +24,6 @@ public class CargoResource {
24 24 @Inject
25 25 private UnidadeResource unidadeResource;
26 26  
27   - /**
28   - * @api {get} /:unidade/cargos Listar cargos
29   - * @apiName listarCargos
30   - * @apiGroup Cargo
31   - * @apiVersion 2.0.0
32   - *
33   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
34   - *
35   - * @apiDescription Lista os cargos.
36   - *
37   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
38   - *
39   - * @apiParam (Query Parameters) {String} [idCargo] Identificador do cargo
40   - *
41   - * @apiExample Exemplo de requisição:
42   - * curl -i http://<host>/sei-broker/service/COSAP/cargos
43   - *
44   - * @apiSuccess (Sucesso - 200) {Cargo[]} resultado Lista com os cargos encontrados
45   - * @apiSuccess (Sucesso - 200) {String} resultado.idCargo Identificador do cargo no SEI
46   - * @apiSuccess (Sucesso - 200) {String} resultado.expressaoCargo Descrição do cargo (Ex.: Governador)
47   - * @apiSuccess (Sucesso - 200) {String} resultado.expressaoTratamento Tratamento para o cargo (Ex.: A Sua Excelência o Senhor)
48   - * @apiSuccess (Sucesso - 200) {String} resultado.expressaoVocativo Vocativo para o cargo (Ex.: Senhor Governador)
49   - *
50   - * @apiErrorExample {json} Error-Response:
51   - * HTTP/1.1 500 Internal Server Error
52   - * {
53   - * "error":"Mensagem de erro."
54   - * "code":"código do erro"
55   - * }
56   - */
57 27 @GET
58 28 @Path("{unidade}/cargos")
59 29 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/ContatoResource.java
  Diff comments   View file @e979172
... ... @@ -65,126 +65,14 @@ public class ContatoResource {
65 65  
66 66 @PersistenceContext(unitName = "sei_pu", type = PersistenceContextType.EXTENDED)
67 67 private EntityManager em;
68   -
69   - /**
70   - * @api {get} /:unidade/contatos/tipos Tipos de contato
71   - * @apiName listarTipos
72   - * @apiGroup Contato
73   - * @apiVersion 2.0.0
74   - *
75   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
76   - *
77   - * @apiDescription Consulta os tipos de contato.
78   - *
79   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
80   - *
81   - * @apiExample Exemplo de requisição:
82   - * curl -i http://<host>/sei-broker/service/cosap/contatos/tipos
83   - *
84   - * @apiSuccess (Sucesso - 200) {TipoContato[]} resultado Lista com os tipos de contato, representados por uma Enum TipoContato.
85   - *
86   - * @apiErrorExample {json} Error-Response:
87   - * HTTP/1.1 500 Internal Server Error
88   - * {
89   - * "error":"Mensagem de erro."
90   - * "code":"código do erro"
91   - * }
92   - */
  68 +
93 69 @GET
94 70 @Path("{unidade}/contatos/tipos")
95 71 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
96 72 public TipoContato[] listarTipos(@PathParam("unidade") String unidade){
97 73 return TipoContato.values();
98 74 }
99   -
100   - /**
101   - * @api {get} /:unidade/contatos/:tipo Listar contatos
102   - * @apiName listarContatos
103   - * @apiGroup Contato
104   - * @apiVersion 2.0.0
105   - *
106   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
107   - *
108   - * @apiDescription Consulta os contatos de determinado tipo, o retorno pode ser PessoaFisica ou PessoaJuridica é recomendado utilizar a ans-commons-sei.
109   - *
110   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
111   - * @apiParam (Path Parameters) {String} tipo Tipo do contato
112   - *
113   - * @apiParam (Query Parameters) {String} [nome] Nome do contato
114   - * @apiParam (Query Parameters) {String} [cpf] CPF do contato
115   - * @apiParam (Query Parameters) {String} [cnpj] CNPJ do contato
116   - * @apiParam (Query Parameters) {String} [sigla] Sigla(login) do contato
117   - * @apiParam (Query Parameters) {String} [matricula] Matricula do contato
118   - * @apiParam (Query Parameters) {String} [qtdRegistros = 1] Quantidade de contatos que serão exibidos
119   - * @apiParam (Query Parameters) {String} [pagina = 1] Número da página
120   - *
121   - * @apiExample Exemplo de requisição:
122   - * curl -i http://<host>/sei-broker/service/cosap/contatos/operadoras?qtdRegistros=20
123   - *
124   - * @apiSuccess (Sucesso - 200) {List} resultado Lista com os contatos encontrados.
125   - * @apiSuccess (Sucesso - 200) {Pessoa} resultado.pessoa Pessoa que representa o contato.
126   - * @apiSuccess (Sucesso - 200) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa.
127   - * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.nome Nome do contato.
128   - * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.sigla Sigla(login) do contato.
129   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato.
130   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
131   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.celular] Celular do contato.
132   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observações sobre o contato.
133   - * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
134   - * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
135   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
136   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
137   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Número do endereço.
138   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
139   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
140   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
141   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.uf] Sigla do estado.
142   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] País do endereço.
143   - * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
144   - * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
145   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
146   - * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
147   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
148   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica.
149   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
150   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
151   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica.
152   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
153   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
154   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
155   - *
156   - * @apiSuccessExample {json} Success-Response:
157   - * HTTP/1.1 200 OK
158   - * {
159   - * "@type": "Juridica",
160   - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
161   - * "endereco": {
162   - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
163   - * "complemento": "Teste de complemento",
164   - * "numero": null,
165   - * "uf": "MG",
166   - * "pais": "Brasil",
167   - * "cidade": "3101508",
168   - * "bairro": "PRAÇA DA BANDEIRA",
169   - * "cep": "36660000"
170   - * },
171   - * "email": "teste@email.com",
172   - * "celular": "(32)982538993",
173   - * "telefone": "(32)34624649",
174   - * "observacao": "Observado via SEI-Broker",
175   - * "ativo": true,
176   - * "associado": null,
177   - * "cnpj": "19541931000125",
178   - * "website": "sitiodopicapauamarelo.com.br"
179   - * }
180   - *
181   - * @apiErrorExample {json} Error-Response:
182   - * HTTP/1.1 500 Internal Server Error
183   - * {
184   - * "error":"Mensagem de erro."
185   - * "code":"código do erro"
186   - * }
187   - */
  75 +
188 76 @GET
189 77 @Path("{unidade}/contatos/{tipo}")
190 78 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -199,88 +87,7 @@ public class ContatoResource {
199 87  
200 88 return pessoas;
201 89 }
202   -
203   - /**
204   - * @api {get} /:unidade/contatos/:tipo/:sigla Consultar contato
205   - * @apiName getContato
206   - * @apiGroup Contato
207   - * @apiVersion 2.0.0
208   - *
209   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
210   - *
211   - * @apiDescription Consulta contato pela sigla(login)
212   - *
213   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
214   - * @apiParam (Path Parameters) {String} tipo Tipo do contato
215   - * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato
216   - *
217   - * @apiExample Exemplo de requisição:
218   - * curl -i http://<host>/sei-broker/service/cosap/contatos/operadoras/419761
219   - *
220   - * @apiSuccess (Sucesso - 200) {Pessoa} resultado.pessoa Pessoa que representa o contato.
221   - * @apiSuccess (Sucesso - 200) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa.
222   - * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.nome Nome do contato.
223   - * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.sigla Sigla(login) do contato.
224   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato.
225   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
226   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.celular] Celular do contato.
227   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.observacao] Observações sobre o contato.
228   - * @apiSuccess (Sucesso - 200) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
229   - * @apiSuccess (Sucesso - 200) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
230   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
231   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
232   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.numero] Número do endereço.
233   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
234   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
235   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
236   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.uf] Sigla do estado.
237   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.endereco.pais] País do endereço.
238   - * @apiSuccess (Sucesso - 200) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
239   - * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
240   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
241   - * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
242   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
243   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica.
244   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
245   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
246   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica.
247   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
248   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
249   - * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
250   - *
251   - * @apiSuccessExample {json} Success-Response:
252   - * HTTP/1.1 200 OK
253   - * {
254   - * "@type": "Juridica",
255   - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
256   - * "sigla": "419761",
257   - * "endereco": {
258   - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
259   - * "complemento": "Teste de complemento",
260   - * "numero": null,
261   - * "uf": "MG",
262   - * "pais": "Brasil",
263   - * "cidade": "3101508",
264   - * "bairro": "PRAÇA DA BANDEIRA",
265   - * "cep": "36660000"
266   - * },
267   - * "email": "teste@email.com",
268   - * "celular": "(32)982538993",
269   - * "telefone": "(32)34624649",
270   - * "observacao": "Observado via SEI-Broker",
271   - * "ativo": true,
272   - * "associado": null,
273   - * "cnpj": "19541931000125",
274   - * "website": "sitiodopicapauamarelo.com.br"
275   - * }
276   - *
277   - * @apiErrorExample {json} Error-Response:
278   - * HTTP/1.1 500 Internal Server Error
279   - * {
280   - * "error":"Mensagem de erro."
281   - * "code":"código do erro"
282   - * }
283   - */
  90 +
284 91 @GET
285 92 @Path("{unidade}/contatos/{tipo}/{sigla}")
286 93 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -294,88 +101,7 @@ public class ContatoResource {
294 101  
295 102 return pessoaHelper.buildPessoa(contatos[0]);
296 103 }
297   -
298   - /**
299   - * @api {post} /:unidade/contatos/:tipo Incluir contato
300   - * @apiName criarContato
301   - * @apiGroup Contato
302   - * @apiVersion 2.0.0
303   - *
304   - * @apiPermission RO_SEI_BROKER
305   - *
306   - * @apiDescription Incluir contato
307   - *
308   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
309   - * @apiParam (Path Parameters) {String} tipo Tipo do contato
310   - *
311   - * @apiParam (Request Body) {Pessoa} resultado.pessoa Pessoa que representa o contato.
312   - * @apiParam (Request Body) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa.
313   - * @apiParam (Request Body) {String} resultado.pessoa.nome Nome do contato.
314   - * @apiParam (Request Body) {String} resultado.pessoa.sigla Sigla(login) do contato.
315   - * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato.
316   - * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
317   - * @apiParam (Request Body) {String} [resultado.pessoa.celular] Celular do contato.
318   - * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observações sobre o contato.
319   - * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
320   - * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
321   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
322   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
323   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Número do endereço.
324   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
325   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
326   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
327   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.uf] Sigla do estado.
328   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] País do endereço.
329   - * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
330   - * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
331   - * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
332   - * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
333   - * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
334   - * @apiParam (Request Body) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica.
335   - * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
336   - * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
337   - * @apiParam (Request Body) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica.
338   - * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
339   - * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
340   - * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
341   - *
342   - * @apiExample Exemplo de requisição:
343   - * endpoint: http://<host>/sei-broker/service/cosap/contatos/operadoras
344   - *
345   - * body:
346   - * {
347   - * "@type": "Juridica",
348   - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
349   - * "sigla": "419761",
350   - * "endereco": {
351   - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
352   - * "complemento": "Teste de complemento",
353   - * "numero": null,
354   - * "uf": "MG",
355   - * "pais": "Brasil",
356   - * "cidade": "3101508",
357   - * "bairro": "PRAÇA DA BANDEIRA",
358   - * "cep": "36660000"
359   - * },
360   - * "email": "teste@email.com",
361   - * "celular": "(32)982538993",
362   - * "telefone": "(32)34624649",
363   - * "observacao": "Observado via SEI-Broker",
364   - * "ativo": true,
365   - * "associado": null,
366   - * "cnpj": "19541931000125",
367   - * "website": "sitiodopicapauamarelo.com.br"
368   - * }
369   - *
370   - * @apiSuccess (Criado - 201) {header} Location URL de acesso ao recurso criado.
371   - *
372   - * @apiErrorExample {json} Error-Response:
373   - * HTTP/1.1 500 Internal Server Error
374   - * {
375   - * "error":"Mensagem de erro."
376   - * "code":"código do erro"
377   - * }
378   - */
  104 +
379 105 @POST
380 106 @Path("{unidade}/contatos/{tipo}")
381 107 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -391,90 +117,7 @@ public class ContatoResource {
391 117 return Response.status(Status.BAD_REQUEST).build();
392 118 }
393 119 }
394   -
395   - /**
396   - * @api {put} /:unidade/contatos/:tipo/:sigla Atualizar contato
397   - * @apiName atualizarContato
398   - * @apiGroup Contato
399   - * @apiVersion 2.0.0
400   - *
401   - * @apiPermission RO_SEI_BROKER
402   - *
403   - * @apiDescription Atualizar contato
404   - *
405   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
406   - * @apiParam (Path Parameters) {String} tipo Tipo do contato
407   - * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato
408   - *
409   - * @apiParam (Request Body) {Pessoa} resultado.pessoa Pessoa que representa o contato.
410   - * @apiParam (Request Body) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa.
411   - * @apiParam (Request Body) {String} resultado.pessoa.nome Nome do contato.
412   - * @apiParam (Request Body) {String} resultado.pessoa.sigla Sigla(login) do contato.
413   - * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato.
414   - * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
415   - * @apiParam (Request Body) {String} [resultado.pessoa.celular] Celular do contato.
416   - * @apiParam (Request Body) {String} [resultado.pessoa.observacao] Observações sobre o contato.
417   - * @apiParam (Request Body) {Boolean} [resultado.pessoa.ativo = false] Situação do contato.
418   - * @apiParam (Request Body) {Endereco} [resultado.pessoa.endereco] Endereço do contato.
419   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.logradouro] Logradouro do endereço.
420   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.complemento] Complento do endereço.
421   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.numero] Número do endereço.
422   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cep] CEP do endereço.
423   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.bairro] Bairro do endereço.
424   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.cidade] Código do IBGE da cidade.
425   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.uf] Sigla do estado.
426   - * @apiParam (Request Body) {String} [resultado.pessoa.endereco.pais] País do endereço.
427   - * @apiParam (Request Body) {PessoaJuridica} [resultado.pessoa.associado] Pessoa Jurídica a qual o contato está associado.
428   - * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
429   - * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
430   - * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
431   - * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
432   - * @apiParam (Request Body) {String} [resultado.pessoa.rg] RG do contato, presente em contatos do tipo PessoaFisica.
433   - * @apiParam (Request Body) {String} [resultado.pessoa.orgaoEmissor] Orgão emissor do RG, presente em contatos do tipo PessoaFisica.
434   - * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
435   - * @apiParam (Request Body) {String} [resultado.pessoa.matricula] Matricula do contato, presente em contatos do tipo PessoaFisica.
436   - * @apiParam (Request Body) {String} [resultado.pessoa.matriculaOab] Número de registro do OAB, presente em contatos do tipo PessoaFisica.
437   - * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
438   - * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
439   - *
440   - * @apiExample Exemplo de requisição:
441   - * endpoint: http://<host>/sei-broker/service/cosap/contatos/operadoras
442   - *
443   - * body:
444   - * {
445   - * "@type": "Juridica",
446   - * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
447   - * "sigla": "419761",
448   - * "endereco": {
449   - * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
450   - * "complemento": "Teste de complemento",
451   - * "numero": null,
452   - * "uf": "MG",
453   - * "pais": "Brasil",
454   - * "cidade": "3101508",
455   - * "bairro": "PRAÇA DA BANDEIRA",
456   - * "cep": "36660000"
457   - * },
458   - * "email": "teste@email.com",
459   - * "celular": "(32)982538993",
460   - * "telefone": "(32)34624649",
461   - * "observacao": "Observado via SEI-Broker",
462   - * "ativo": true,
463   - * "associado": null,
464   - * "cnpj": "19541931000125",
465   - * "website": "sitiodopicapauamarelo.com.br"
466   - * }
467   - *
468   - * @apiSuccessExample {json} Success-Response:
469   - * HTTP/1.1 200 OK
470   - *
471   - * @apiErrorExample {json} Error-Response:
472   - * HTTP/1.1 500 Internal Server Error
473   - * {
474   - * "error":"Mensagem de erro."
475   - * "code":"código do erro"
476   - * }
477   - */
  120 +
478 121 @PUT
479 122 @Path("{unidade}/contatos/{tipo}/{sigla}")
480 123 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/DocumentoResource.java
  Diff comments   View file @e979172
1 1 package br.gov.ans.integracao.sei.rest;
2 2  
3   -import static br.gov.ans.integracao.sei.utils.Util.decodeConteudoMustache;
4   -import static br.gov.ans.integracao.sei.utils.Util.encodeBase64;
5 3 import static br.gov.ans.integracao.sei.utils.Util.getSOuN;
6 4 import static br.gov.ans.integracao.sei.utils.Util.parseInt;
7 5 import static br.gov.ans.integracao.sei.utils.Util.trueOrFalse;
8 6 import static br.gov.ans.utils.PDFUtil.getPDF;
9 7  
10 8 import java.io.InputStream;
11   -import java.io.StringWriter;
12 9 import java.net.URI;
13 10 import java.net.URL;
14 11 import java.net.URLConnection;
15 12 import java.rmi.RemoteException;
16 13 import java.util.List;
17   -import java.util.Map;
18 14  
19 15 import javax.inject.Inject;
20 16 import javax.transaction.HeuristicMixedException;
... ... @@ -40,11 +36,8 @@ import javax.ws.rs.core.UriInfo;
40 36  
41 37 import org.apache.commons.io.IOUtils;
42 38 import org.apache.commons.lang3.StringUtils;
43   -import org.codehaus.jackson.JsonParseException;
44 39 import org.jboss.logging.Logger;
45 40  
46   -import com.github.mustachejava.Mustache;
47   -
48 41 import br.gov.ans.commons.security.crypt.HashUtils;
49 42 import br.gov.ans.dao.DAO;
50 43 import br.gov.ans.integracao.sei.client.Documento;
... ... @@ -65,7 +58,6 @@ import br.gov.ans.integracao.sei.modelo.Operacao;
65 58 import br.gov.ans.integracao.sei.utils.Constantes;
66 59 import br.gov.ans.integracao.sei.utils.MessagesKeys;
67 60 import br.gov.ans.utils.MessageUtils;
68   -import br.gov.ans.utils.MustacheUtils;
69 61  
70 62 @Path("/")
71 63 public class DocumentoResource {
... ... @@ -105,118 +97,7 @@ public class DocumentoResource {
105 97  
106 98 @Inject
107 99 private UserTransaction userTransaction;
108   -
109   - /**
110   - * @api {get} /:unidade/documentos/:documento Consultar documento
111   - * @apiName consultarDocumento
112   - * @apiGroup Documento
113   - * @apiVersion 2.0.0
114   - *
115   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
116   - *
117   - * @apiDescription Consulta documento cadastrado no SEI.
118   - *
119   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
120   - * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informações
121   - *
122   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento = N] exibir o andamento do processo
123   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [assinaturas = N] exibir as assinaturas presentes no documento
124   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [publicacao = N] exibir detalhes da publicação
125   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [campos = N] exibir campos do formulário
126   - *
127   - * @apiExample {curl} Exemplo de requisição:
128   - * curl -i https://<host>/sei-broker/service/COSAP/documentos/0000050?assinaturas=S&andamento=S
129   - *
130   - * @apiSuccess (Sucesso - 200) {RetornoConsultaDocumento} retornoConsultaDocumento Informações do documento encontrado no SEI
131   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.idProcedimento Id interno do processo no SEI
132   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.procedimentoFormatado Número do processo visível para o usuário
133   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.idDocumento Id interno do documento no SEI
134   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.documentoFormatado Número do documento visível para o usuário
135   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.linkAcesso Link para acesso ao documento
136   - * @apiSuccess (Sucesso - 200) {Serie} retornoConsultaDocumento.serie Dados do tipo do documento
137   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.idSerie Identificador do tipo de documento
138   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.nome Nome do tipo de documento
139   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.aplicabilidade :TODO pendente
140   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.numero Número do documento
141   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.data Data de geração para documentos internos e para documentos externos é a data informada na tela de cadastro
142   - * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.unidadeElaboradora Dados da unidade que gerou o documento
143   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.descricao Nome da unidade
144   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.idUnidade Código da unidade
145   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sigla Sigla da unidade
146   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinProtocolo :TODO pendente
147   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinArquivamento :TODO pendente
148   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinOuvidoria :TODO pendente
149   - * @apiSuccess (Sucesso - 200) {Andamento} retornoConsultaDocumento.andamentoGeracao Informações do andamento de geração (opcional)
150   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idAndamento Identificador do andamento
151   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefa :TODO pendente
152   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefaModulo :TODO pendente
153   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.descricao Descrição do andamento
154   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.dataHora Data e hora do registro de andamento
155   - * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.andamentoGeracao.unidade Unidade responsável pelo andamento (ver estrutura Unidade)
156   - * @apiSuccess (Sucesso - 200) {Usuario} retornoConsultaDocumento.andamentoGeracao.usuario Usuário responsável pela ação
157   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.idUsuario Código do usuário
158   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.nome Nome do usuário
159   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.usuario.sigla Login do usuário
160   - * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} retornoConsultaDocumento.andamentoGeracao.atributos Lista com os atributos relacionados ao andamento
161   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.nome Nome do atributo
162   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.valor Valor do atributo
163   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.idOrigem :TODO pendente
164   - * @apiSuccess (Sucesso - 200) {Assinatura[]} retornoConsultaDocumento.assinaturas Conjunto de assinaturas do documento
165   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.nome Nome do assinante
166   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.cargoFuncao Cargo ou função utilizado no momento da assinatura
167   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.dataHora Data/hora em que ocorreu a assinatura
168   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idUsuario Identificador do usuário
169   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idOrigem :TODO pendente
170   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idOrgao :TODO pendente
171   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.sigla Login do usuário responsável pela assinatura
172   - * @apiSuccess (Sucesso - 200) {Publicacao} retornoConsultaDocumento.publicacao :TODO pendente
173   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.nomeVeiculo :TODO pendente
174   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.numero :TODO pendente
175   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.dataDisponibilizacao :TODO pendente
176   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.dataPublicacao :TODO pendente
177   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.estado :TODO pendente
178   - * @apiSuccess (Sucesso - 200) {PublicacaoImprensaNacional} retornoConsultaDocumento.publicacao.imprensaNacional :TODO pendente
179   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.siglaVeiculo :TODO pendente
180   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.descricaoVeiculo :TODO pendente
181   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.pagina :TODO pendente
182   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.secao :TODO pendente
183   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.data :TODO pendente
184   - * @apiSuccess (Sucesso - 200) {Campo[]} retornoConsultaDocumento.campos Conjunto de campos do formulário
185   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.nome Nome do campo
186   - * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.valor Valor do campo
187   - *
188   - * @apiSuccessExample {json} Success-Response:
189   - * HTTP/1.1 200 OK
190   - * {
191   - * "idProcedimento":"52",
192   - * "procedimentoFormatado":"16.0.000000005-5",
193   - * "idDocumento":"152",
194   - * "documentoFormatado":"0000123",
195   - * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=procedimento_trabalhar&id_procedimento=52&id_documento=152",
196   - * "serie":{
197   - * "idSerie":"12",
198   - * "nome":"Memorando"
199   - * },
200   - * "numero":"6",
201   - * "data":"05/04/2016",
202   - * "unidadeElaboradora":{
203   - * "idUnidade":"110000934",
204   - * "sigla":"COSAP",
205   - * "descricao":"Coordenadoria de Sistemas e Aplicativos"
206   - * },
207   - * "andamentoGeracao":null,
208   - * "assinaturas":[],
209   - * "publicacao":null,
210   - * "campos":[]
211   - * }
212   - *
213   - * @apiErrorExample {json} Error-Response:
214   - * HTTP/1.1 500 Internal Server Error
215   - * {
216   - * "error":"Mensagem de erro."
217   - * "code":"código do erro"
218   - * }
219   - */
  100 +
220 101 @GET
221 102 @Path("{unidade}/documentos/{documento:\\d+}")
222 103 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -225,91 +106,7 @@ public class DocumentoResource {
225 106 return seiNativeService.consultarDocumento(Constantes.SEI_BROKER, Operacao.CONSULTAR_DOCUMENTO, unidadeResource.consultarCodigo(unidade), documento,
226 107 getSOuN(andamento), getSOuN(assinaturas), getSOuN(publicacao), getSOuN(campos));
227 108 }
228   -
229   - /**
230   - * @api {post} /:unidade/documentos Incluir documento
231   - * @apiName incluirDocumento
232   - * @apiGroup Documento
233   - * @apiVersion 2.0.0
234   - *
235   - * @apiPermission RO_SEI_BROKER
236   - *
237   - * @apiDescription Inclui um documento no SEI, podem ser incluídos documentos internos e externos, para documentos externo o tamanho máximo é 20MB.
238   - *
239   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
240   - *
241   - * @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)
242   - *
243   - * @apiParam (Request Body) {String = "G (Gerado)","R (Recebido)"} tipo Tipo de documento
244   - * @apiParam (Request Body) {String} idSerie Identificador do tipo de documento no SEI (Consultar serviço Listar Séries)
245   - * @apiParam (Request Body) {String} idProcedimento Identificador do processo onde o documento deve ser inserido. Opcional se protocoloProcedimento informado
246   - * @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.
247   - * @apiParam (Request Body) {String} [idTipoConferencia] Identificador do tipo de conferência associada com o documento externo
248   - * @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).
249   - * @apiParam (Request Body) {String} [data] Data do documento (dd/MM/yyyy), obrigatório para documentos externos. Passar null para documentos gerados.
250   - * @apiParam (Request Body) {String} [descricao] Descrição do documento para documentos gerados. Passar null para documentos externos
251   - * @apiParam (Request Body) {Remetente} [remetente] Obrigatório para documentos externos, passar null para documentos gerados.
252   - * @apiParam (Request Body) {String} [remetente.nome] Nome do remetente
253   - * @apiParam (Request Body) {String} [remetente.sigla] Login do remetente
254   - * @apiParam (Request Body) {Interessado[]} [interessados] Informar um conjunto com os dados de interessados. Se não existirem interessados deve ser informado um conjunto vazio
255   - * @apiParam (Request Body) {String} [interessados.nome] Nome do interessado
256   - * @apiParam (Request Body) {String} [interessados.sigla] Login do interessado
257   - * @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
258   - * @apiParam (Request Body) {String} [destinatarios.nome] Nome do destinatário
259   - * @apiParam (Request Body) {String} [destinatarios.sigla] Login do destinatário
260   - * @apiParam (Request Body) {String} [observacao] Texto da observação da unidade, passar null se não existir
261   - * @apiParam (Request Body) {String{200}} [nomeArquivo] Nome do arquivo, obrigatório para documentos externos. Passar null para documentos gerados.
262   - * @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.
263   - * @apiParam (Request Body) {String = "0 (público)","1 (restrito)", "2 (sigiloso)", "null (herda do tipo de processo)"} [nivelAcesso] Nível de acesso do documento
264   - * @apiParam (Request Body) {String} [idHipoteseLegal] Identificador da hipótese legal associada
265   - * @apiParam (Request Body) {String} [idArquivo] Identificador do arquivo enviado pelo serviço de Incluir Arquivo
266   - * @apiParam (Request Body) {String = "S (Sim)","N (Não)"} [sinBloqueado] Bloquear o documento, não permite excluí-lo ou alterar seu conteúdo
267   - * @apiParam (Request Body) {Campo} [campos] Conjunto de campos associados com o formulário
268   - * @apiParam (Request Body) {String} [campos.nome] Nome do campo
269   - * @apiParam (Request Body) {String} [campos.valor] Valor do campo
270   - *
271   - * @apiExample Exemplo de requisição:
272   - * endpoint: https://<host>/sei-broker/service/COSAP/documentos
273   - *
274   - * body:
275   - * {
276   - * "tipo":"G",
277   - * "idProcedimento":"33910000173201771",
278   - * "protocoloProcedimento":null,
279   - * "idSerie":null,
280   - * "numero":null,
281   - * "data":null,
282   - * "descricao":"Documento demonstrativo",
283   - * "remetente":null,
284   - * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}],
285   - * "destinatarios":[],
286   - * "observacao":null,
287   - * "nomeArquivo":null,
288   - * "conteudo":"Conteúdo Base64",
289   - * "nivelAcesso":"0"
290   - * }
291   - *
292   - * @apiSuccess (Sucesso Response Body - 201) {String} idDocumento número interno do documento
293   - * @apiSuccess (Sucesso Response Body - 201) {String} documentoFormatado número do documento visível para o usuário
294   - * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso link para acesso ao documento
295   - *
296   - * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado.
297   - *
298   - * @apiSuccessExample {json} Success-Response:
299   - * HTTP/1.1 201 Created
300   - * {
301   - * "idDocumento":"1140000000872",
302   - * "documentoFormatado":"0003934",
303   - * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=arvore_visualizar&acao_origem=procedimento_visualizar&id_procedimento=267&id_documento=1017&sta_editor=I&infra_sistema=100000100&infra_unidade_atual=110000934&infra_hash=3d798777382d6ac455317f3a87ad9bd1f9650315e019ef922f388b829902a95b"
304   - * }
305   - *
306   - * @apiErrorExample {json} Error-Response:
307   - * HTTP/1.1 500 Internal Server Error
308   - * {
309   - * "error":"Mensagem de erro."
310   - * "code":"código do erro"
311   - * }
312   - */
  109 +
313 110 @POST
314 111 @Path("{unidade}/documentos")
315 112 @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -340,41 +137,7 @@ public class DocumentoResource {
340 137  
341 138 return Response.created(getResourcePath(retorno.getDocumentoFormatado())).entity(retorno).build();
342 139 }
343   -
344   - /**
345   - * @api {post} /:unidade/documentos/cancelados Cancelar documento
346   - * @apiName cancelarDocumento
347   - * @apiGroup Documento
348   - * @apiVersion 2.0.0
349   - *
350   - * @apiPermission RO_SEI_BROKER
351   - *
352   - * @apiDescription Cancela um documento.
353   - *
354   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
355   - *
356   - * @apiParam (Request Body) {String} documento Numero do documento que será cancelado
357   - * @apiParam (Request Body) {String} motivo Motivo do cancelamento
358   - *
359   - * @apiExample Exemplo de requisição:
360   - * endpoint: https://<host>/sei-broker/service/COSAP/documentos/cancelados
361   - *
362   - * body:
363   - * {
364   - * "documento":"0000050",
365   - * "motivo":"Motivo do cancelamento."
366   - * }
367   - *
368   - *
369   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
370   - *
371   - * @apiErrorExample {json} Error-Response:
372   - * HTTP/1.1 500 Internal Server Error
373   - * {
374   - * "error":"Mensagem de erro."
375   - * "code":"código do erro"
376   - * }
377   - */
  140 +
378 141 @POST
379 142 @Path("{unidade}/documentos/cancelados")
380 143 @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -391,62 +154,7 @@ public class DocumentoResource {
391 154  
392 155 return trueOrFalse(resultado) + "";
393 156 }
394   -
395   - /**
396   - * @api {get} /:unidade/documentos/enviados-broker Listar documentos enviados
397   - * @apiName consultarDocumentosIncluidosBroker
398   - * @apiGroup Documento
399   - * @apiVersion 2.0.0
400   - *
401   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
402   - *
403   - * @apiDescription Consulta documentos inclusos pelo SEI-Broker.
404   - *
405   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
406   - *
407   - * @apiParam (Query Parameters) {String} [hash] Hash SHA-256 gerado a partir do conteúdo enviado ao Broker
408   - * @apiParam (Query Parameters) {String} [processo] Número do processo onde o documento foi inserido
409   - * @apiParam (Query Parameters) {String} [numeroInformado] Número informado na inclusão do documento, exibido na árvore do processo.
410   - * @apiParam (Query Parameters) {String} [pagina=1] Número da página
411   - * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que serão exibidos por página
412   - *
413   - * @apiExample Exemplo de requisição:
414   - * curl -i https://<host>/sei-broker/service/COSAP/documentos/enviados-broker?pagina=1&qtdRegsitros=30
415   - *
416   - * @apiSuccess (Sucesso Response Body - 200) {InclusaoDocumento} resultado Objeto com dados sobre o documento
417   - * @apiSuccess (Sucesso Response Body - 200) {Date} resultado.data Data do envio (padrão ISO-8601)
418   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.hash Hash SHA-256 gerado a partir do conteúdo enviado ao Broker
419   - * @apiSuccess (Sucesso Response Body - 200) {Integer} resultado.id Identificação da inclusão de documento
420   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.nome Nome do documento incluído
421   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numero Número retonado pelo SEI, NULL caso tenha ocorrido algum problema.
422   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.processo Número do processo
423   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.sistema Sistema responsável pela inclusão
424   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.unidade Unidade onde foi incluído o documento
425   - * @apiSuccess (Sucesso Response Body - 200) {String} resultado.numeroInformado Valor opcional informado na inclusão do documento
426   - *
427   - * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta
428   - *
429   - * @apiSuccessExample {json} Success-Response:
430   - * HTTP/1.1 200 OK
431   - * {
432   - * "id": 1717,
433   - * "data": "2016-10-31T11:59:56.016+0000",
434   - * "nome": "Doc Homologação.pdf",
435   - * "numero": "0003312",
436   - * "hash": "ca7ebe0c37419db14ffd4f09485a1ebed8e8deeed594e15720da185ee32e9d19",
437   - * "sistema": "desenv_integracao_sei",
438   - * "unidade": "COAI",
439   - * "processo": "33910000097201612",
440   - * "numeroInformado":"2016ans45875"
441   - * }
442   - *
443   - * @apiErrorExample {json} Error-Response:
444   - * HTTP/1.1 500 Internal Server Error
445   - * {
446   - * "error":"Mensagem de erro."
447   - * "code":"código do erro"
448   - * }
449   - */
  157 +
450 158 @GET
451 159 @Path("{unidade}/documentos/enviados-broker")
452 160 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -464,33 +172,6 @@ public class DocumentoResource {
464 172 .header("total_registros", totalRegistros).build();
465 173 }
466 174  
467   - /**
468   - * @api {get} /:unidade/documentos/:documento Exportar documento
469   - * @apiName exportarDocumento
470   - * @apiGroup Documento
471   - * @apiVersion 2.0.0
472   - *
473   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
474   - *
475   - * @apiDescription Exporta documentos do SEI em PDF.
476   - *
477   - * @apiParam (Header Parameters) {String} Accept Utilize application/pdf
478   - *
479   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
480   - * @apiParam (Path Parameters) {String} documento Id do documento que deseja recuperar as informações
481   - *
482   - * @apiExample {curl} Exemplo de requisição:
483   - * curl -i https://<host>/sei-broker/service/COSIT/documentos/0003322
484   - *
485   - * @apiSuccess (Sucesso - 200) {PDF} binario Arquivo no formato PDF.
486   - *
487   - * @apiErrorExample {json} Error-Response:
488   - * HTTP/1.1 500 Internal Server Error
489   - * {
490   - * "error":"Mensagem de erro."
491   - * "code":"código do erro"
492   - * }
493   - */
494 175 @GET
495 176 @Path("{unidade}/documentos/{documento}")
496 177 @Produces("application/pdf")
... ... @@ -527,69 +208,7 @@ public class DocumentoResource {
527 208 return Response.ok(bytes).header("Content-Disposition", "attachment; filename=" +documento+ ".pdf").build();
528 209  
529 210 }
530   -
531   - /**
532   - * @api {get} /interessados/:interessado/documentos Consultar por interessado
533   - * @apiName consultarDocumentoInteressado
534   - * @apiGroup Documento
535   - * @apiVersion 2.0.0
536   - *
537   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
538   - *
539   - * @apiDescription Retorna os documentos de um determinado interessado.
540   - *
541   - * @apiParam (Path Parameters) {String} interessado Identificador do interessado
542   - *
543   - * @apiParam (Query Parameters) {String} [tipo] Tipo/Série do documento
544   - * @apiParam (Query Parameters) {boolean} [somenteAssinados=false] Exibir somente documentos assinados
545   - * @apiParam (Query Parameters) {boolean} [orderByProcesso=false] Ordenar pelo número do processo, por padrão o retorno é ordenado pela dataGeracao
546   - * @apiParam (Query Parameters) {boolean} [crescente=false] Ordenar em ordem crescente
547   - * @apiParam (Query Parameters) {String} [pagina=1] Número da página
548   - * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por página
549   - *
550   - * @apiExample Exemplo de requisição:
551   - * curl -i https://<host>/sei-broker/service/interessados/005711/documentos
552   - *
553   - * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados.
554   - * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentos.documentoResumido Resumo do documento encontrado no SEI.
555   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Número do documento.
556   - * @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.
557   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.unidade Unidade responsável pelo documento.
558   - * @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.
559   - * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de geração do documento.
560   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.processo Processo onde o documento está incluído.
561   - * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentos.documentoResumido.tipo Objeto representando o tipo do documento.
562   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série.
563   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.nome Nome do tipo do documento.
564   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferência do documento.
565   - * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado.
566   - *
567   - * @apiSuccess (Sucesso Response Header - 200) {header} total_registros Quantidade de registros que existem para essa consulta
568   - *
569   - * @apiSuccessExample {json} Success-Response:
570   - * HTTP/1.1 200 OK
571   - * {
572   - * "numero": "0670949",
573   - * "numeroInformado": "594",
574   - * "unidade": "COSAP",
575   - * "origem": "RECEBIDO",
576   - * "dataGeracao": "2015-08-10T00:00:00-03:00",
577   - * "processo": "33910.000002/2017-41",
578   - * "tipo": {
579   - * "codigo": "629",
580   - * "nome": "Relatório de Arquivamento-SIF"
581   - * }
582   - * "tipoConferencia": "4",
583   - * "assinado": true
584   - * }
585   - *
586   - * @apiErrorExample {json} Error-Response:
587   - * HTTP/1.1 500 Internal Server Error
588   - * {
589   - * "error":"Mensagem de erro."
590   - * "code":"código do erro"
591   - * }
592   - */
  211 +
593 212 @GET
594 213 @Path("interessados/{interessado}/documentos")
595 214 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/ExtensoesResource.java
  Diff comments   View file @e979172
... ... @@ -21,36 +21,7 @@ public class ExtensoesResource {
21 21  
22 22 @Inject
23 23 private UnidadeResource unidadeResource;
24   -
25   - /**
26   - * @api {get} /:unidade/extensoes Listar extensões
27   - * @apiName listarExtensoesPermitidas
28   - * @apiGroup Extensao
29   - * @apiVersion 2.0.0
30   - *
31   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
32   - *
33   - * @apiDescription Este método realiza uma busca pelas extensões de arquivos permitidas.
34   - *
35   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
36   - *
37   - * @apiParam (Query Parameters) {String} [extensao=null] Para filtrar por uma determinada extensão.
38   - *
39   - * @apiExample {curl} Exemplo de requisição:
40   - * curl -i http://<host>/sei-broker/service/COSAP/extensoes/
41   - *
42   - * @apiSuccess (Sucesso - 200) {ArquivoExtensao[]} extensoes Lista de extensões permitidas.
43   - * @apiSuccess (Sucesso - 200) {String} extensoes.idArquivoExtensao Identificador interno do SEI relativo a extensão
44   - * @apiSuccess (Sucesso - 200) {String} extensoes.extensao Texto da extensão (ex.: pdf, ods, doc, ppt,...)
45   - * @apiSuccess (Sucesso - 200) {String} extensoes.descricao Descrição da extensão
46   - *
47   - * @apiErrorExample {json} Error-Response:
48   - * HTTP/1.1 500 Internal Server Error
49   - * {
50   - * "error":"Mensagem de erro."
51   - * "code":"código do erro"
52   - * }
53   - */
  24 +
54 25 @Path("{unidade}/extensoes")
55 26 @GET
56 27 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/HipoteseLegalResource.java
  Diff comments   View file @e979172
... ... @@ -25,36 +25,6 @@ public class HipoteseLegalResource {
25 25 @Inject
26 26 private UnidadeResource unidadeResource;
27 27  
28   - /**
29   - * @api {get} /:unidade/hipoteses-legais Listar hipóteses legais
30   - * @apiName listarHipoteses
31   - * @apiGroup Hipotese Legal
32   - * @apiVersion 2.0.0
33   - *
34   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
35   - *
36   - * @apiDescription Lista as hipóteses legais.
37   - *
38   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
39   - *
40   - * @apiParam (Query Parameters) {String} [nivelAcesso] Filtra hipóteses pelo nível de acesso associado (1 - restrito, 2 - sigiloso)
41   - *
42   - * @apiExample Exemplo de requisição:
43   - * curl -i https://<host>/sei-broker/service/COSAP/hipoteses-legais
44   - *
45   - * @apiSuccess (Sucesso - 200) {HipoteseLegal[]} resultado Lista com as hipóteses legais encontrados
46   - * @apiSuccess (Sucesso - 200) {String} resultado.idHipoteseLegal Identificador da hipótese legal no SEI
47   - * @apiSuccess (Sucesso - 200) {String} resultado.nome Nome da hipótese legal
48   - * @apiSuccess (Sucesso - 200) {String} resultado.baseLegal Descrição da base legal
49   - * @apiSuccess (Sucesso - 200) {String} resultado.nivelAcesso Nivel de acesso associado a hipótese legal
50   - *
51   - * @apiErrorExample {json} Error-Response:
52   - * HTTP/1.1 500 Internal Server Error
53   - * {
54   - * "error":"Mensagem de erro."
55   - * "code":"código do erro"
56   - * }
57   - */
58 28 @GET
59 29 @Path("{unidade}/hipoteses-legais")
60 30 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/InfoResource.java
  Diff comments   View file @e979172
... ... @@ -47,54 +47,14 @@ public class InfoResource {
47 47  
48 48 @Inject
49 49 private LogIntegracaoSistemicaDAO dao;
50   -
51   - /**
52   - * @api {get} /info/versao Consultar versão
53   - * @apiName getNumeroVersao
54   - * @apiGroup Info
55   - * @apiVersion 2.0.0
56   - *
57   - * @apiDescription Este método realiza uma consulta para saber a versão do sei-broker que está disponível.
58   - *
59   - * @apiExample {curl} Exemplo de requisição:
60   - * curl -i http://<host>/sei-broker/service/info/versao
61   - *
62   - * @apiSuccess {String} versao Número da versão.
63   - *
64   - * @apiErrorExample {json} Error-Response:
65   - * HTTP/1.1 500 Internal Server Error
66   - * {
67   - * "error":"Mensagem de erro."
68   - * "code":"código do erro"
69   - * }
70   - */
  50 +
71 51 @GET
72 52 @Path("/versao")
73 53 @Produces(MediaType.TEXT_PLAIN)
74 54 public String getNumeroVersao(){
75 55 return messages.getMessage("sei.broker.versao");
76 56 }
77   -
78   - /**
79   - * @api {get} /info/conexoes/mysql Testar conexão MySQL
80   - * @apiName testMySQLConnection
81   - * @apiGroup Info
82   - * @apiVersion 2.0.0
83   - *
84   - * @apiDescription Testa a conexão com o MySQL e retorna o número de versão do banco.
85   - *
86   - * @apiExample {curl} Exemplo de requisição:
87   - * curl -i http://<host>/sei-broker/service/info/conexoes/mysql
88   - *
89   - * @apiSuccess {String} versao Número de versão do MySQL.
90   - *
91   - * @apiErrorExample {json} Error-Response:
92   - * HTTP/1.1 500 Internal Server Error
93   - * {
94   - * "error":"Mensagem de erro."
95   - * "code":"código do erro"
96   - * }
97   - */
  57 +
98 58 @GET
99 59 @Path("/conexoes/mysql")
100 60 @Produces(MediaType.TEXT_PLAIN)
... ... @@ -108,27 +68,7 @@ public class InfoResource {
108 68 throw new Exception(messages.getMessage("erro.testar.mysql"));
109 69 }
110 70 }
111   -
112   - /**
113   - * @api {get} /info/conexoes/oracle Testar conexão Oracle
114   - * @apiName testOracleConnection
115   - * @apiGroup Info
116   - * @apiVersion 2.0.0
117   - *
118   - * @apiDescription Testa a conexão com o Oracle e retorna o número de versão do banco.
119   - *
120   - * @apiExample {curl} Exemplo de requisição:
121   - * curl -i http://<host>/sei-broker/service/info/conexoes/oracle
122   - *
123   - * @apiSuccess {String} versao Número de versão do Oracle.
124   - *
125   - * @apiErrorExample {json} Error-Response:
126   - * HTTP/1.1 500 Internal Server Error
127   - * {
128   - * "error":"Mensagem de erro."
129   - * "code":"código do erro"
130   - * }
131   - */
  71 +
132 72 @GET
133 73 @Path("/conexoes/oracle")
134 74 @Produces(MediaType.TEXT_PLAIN)
... ... @@ -143,26 +83,6 @@ public class InfoResource {
143 83 }
144 84 }
145 85  
146   - /**
147   - * @api {get} /info/conexoes/sei Testar conexão SEI
148   - * @apiName testSEIConnection
149   - * @apiGroup Info
150   - * @apiVersion 2.0.0
151   - *
152   - * @apiDescription Testa a conexão com o SEI fazendo uma consulta ao serviço listar unidades.
153   - *
154   - * @apiExample {curl} Exemplo de requisição:
155   - * curl -i http://<host>/sei-broker/service/info/conexoes/sei
156   - *
157   - * @apiSuccess {String} mensagem Mensagem de sucesso.
158   - *
159   - * @apiErrorExample {json} Error-Response:
160   - * HTTP/1.1 500 Internal Server Error
161   - * {
162   - * "error":"Mensagem de erro."
163   - * "code":"código do erro"
164   - * }
165   - */
166 86 @GET
167 87 @Path("/conexoes/sei")
168 88 @Produces(MediaType.TEXT_PLAIN)
... ... @@ -176,33 +96,7 @@ public class InfoResource {
176 96 throw new Exception(messages.getMessage("erro.testar.sei"));
177 97 }
178 98 }
179   -
180   - /**
181   - * @api {get} /info/requests Listar Requests
182   - * @apiName getUltimosRequests
183   - * @apiGroup Info
184   - * @apiVersion 2.0.0
185   - *
186   - * @apiDescription Lista os requests recebidos pelo broker.
187   - *
188   - *
189   - * @apiParam (Query Parameters) {String} [operacao] nome do método acessado
190   - * @apiParam (Query Parameters) {String} [origem] usuário que originou a requisição
191   - * @apiParam (Query Parameters) {int} [pag=1] número da página
192   - * @apiParam (Query Parameters) {int} [itens=50] quantidade de itens listados por página
193   - *
194   - * @apiExample {curl} Exemplo de requisição:
195   - * curl -i http://<host>/sei-broker/service/info/requests
196   - *
197   - * @apiSuccess {String} mensagem Mensagem de sucesso.
198   - *
199   - * @apiErrorExample {json} Error-Response:
200   - * HTTP/1.1 500 Internal Server Error
201   - * {
202   - * "error":"Mensagem de erro."
203   - * "code":"código do erro"
204   - * }
205   - */
  99 +
206 100 @GET
207 101 @Path("/requests")
208 102 @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
... ...
src/main/java/br/gov/ans/integracao/sei/rest/InfraResource.java
  Diff comments   View file @e979172
... ... @@ -39,41 +39,7 @@ public class InfraResource {
39 39  
40 40 @Inject
41 41 private CidadeDAO cidadeDAO;
42   -
43   - /**
44   - * @api {get} /:unidade/paises Listar países
45   - * @apiName getPaises
46   - * @apiGroup Endereco
47   - * @apiVersion 2.0.0
48   - *
49   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
50   - *
51   - * @apiDescription Consulta países cadastrados.
52   - *
53   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
54   - *
55   - * @apiExample Exemplo de requisição:
56   - * curl -i http://<host>/sei-broker/service/cosap/paises
57   - *
58   - * @apiSuccess (Sucesso - 200) {List} resultado Lista com os países.
59   - * @apiSuccess (Sucesso - 200) {Pais} resultado.pais Objeto representando o país.
60   - * @apiSuccess (Sucesso - 200) {String} resultado.pais.idPais Identificador do país no SEI.
61   - * @apiSuccess (Sucesso - 200) {String} resultado.pais.nome Nome do país.
62   - *
63   - * @apiSuccessExample {json} Success-Response:
64   - * HTTP/1.1 200 OK
65   - * {
66   - * "idPais": "4",
67   - * "nome": "Afeganistão"
68   - * }
69   - *
70   - * @apiErrorExample {json} Error-Response:
71   - * HTTP/1.1 500 Internal Server Error
72   - * {
73   - * "error":"Mensagem de erro."
74   - * "code":"código do erro"
75   - * }
76   - */
  42 +
77 43 @GET
78 44 @Path("{unidade}/paises")
79 45 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -81,46 +47,6 @@ public class InfraResource {
81 47 return seiNativeService.listarPaises(Constantes.SEI_BROKER, Operacao.LISTAR_ESTADOS, unidadeResource.consultarCodigo(unidade));
82 48 }
83 49  
84   - /**
85   - * @api {get} /:unidade/estados Listar estados
86   - * @apiName getEstados
87   - * @apiGroup Endereco
88   - * @apiVersion 2.0.0
89   - *
90   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
91   - *
92   - * @apiDescription Consulta estados cadastrados.
93   - *
94   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
95   - *
96   - * @apiExample Exemplo de requisição:
97   - * curl -i http://<host>/sei-broker/service/cosap/estados
98   - *
99   - * @apiSuccess (Sucesso - 200) {List} resultado Lista com os estados.
100   - * @apiSuccess (Sucesso - 200) {Estado} resultado.estado Objeto representando um estado.
101   - * @apiSuccess (Sucesso - 200) {String} resultado.estado.idEstado Identificador do estado no SEI.
102   - * @apiSuccess (Sucesso - 200) {String} resultado.estado.idPais Identificador do país no SEI.
103   - * @apiSuccess (Sucesso - 200) {String} resultado.estado.sigla Sigla do estado.
104   - * @apiSuccess (Sucesso - 200) {String} resultado.estado.nome Nome do estado.
105   - * @apiSuccess (Sucesso - 200) {String} resultado.estado.codigoIbge Código do IBGE.
106   - *
107   - * @apiSuccessExample {json} Success-Response:
108   - * HTTP/1.1 200 OK
109   - * {
110   - * "idEstado": "2",
111   - * "idPais": "76",
112   - * "sigla": "AC",
113   - * "nome": "Acre",
114   - * "codigoIbge": "12"
115   - * }
116   - *
117   - * @apiErrorExample {json} Error-Response:
118   - * HTTP/1.1 500 Internal Server Error
119   - * {
120   - * "error":"Mensagem de erro."
121   - * "code":"código do erro"
122   - * }
123   - */
124 50 @GET
125 51 @Path("{unidade}/estados")
126 52 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -131,49 +57,7 @@ public class InfraResource {
131 57  
132 58 return seiNativeService.listarEstados(Constantes.SEI_BROKER, Operacao.LISTAR_ESTADOS, unidadeResource.consultarCodigo(unidade), pais);
133 59 }
134   -
135   - /**
136   - * @api {get} /:unidade/estados Consultar estado
137   - * @apiName getEstado
138   - * @apiGroup Endereco
139   - * @apiVersion 2.0.0
140   - *
141   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
142   - *
143   - * @apiDescription Consulta o estado pela sigla.
144   - *
145   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
146   - * @apiParam (Path Parameters) {String} sigla Sigla do estado
147   - *
148   - * @apiParam (Query Parameters) {String} [pais="76 (Brasil)"] Identificador do pais que deseja listar os estados.
149   - *
150   - * @apiExample Exemplo de requisição:
151   - * curl -i http://<host>/sei-broker/service/cosap/estados/AC
152   - *
153   - * @apiSuccess (Sucesso - 200) {Estado} estado Objeto representando um estado.
154   - * @apiSuccess (Sucesso - 200) {String} estado.idEstado Identificador do estado no SEI.
155   - * @apiSuccess (Sucesso - 200) {String} estado.idPais Identificador do país no SEI.
156   - * @apiSuccess (Sucesso - 200) {String} estado.sigla Sigla do estado.
157   - * @apiSuccess (Sucesso - 200) {String} estado.nome Nome do estado.
158   - * @apiSuccess (Sucesso - 200) {String} estado.codigoIbge Código do IBGE.
159   - *
160   - * @apiSuccessExample {json} Success-Response:
161   - * HTTP/1.1 200 OK
162   - * {
163   - * "idEstado": "2",
164   - * "idPais": "76",
165   - * "sigla": "AC",
166   - * "nome": "Acre",
167   - * "codigoIbge": "12"
168   - * }
169   - *
170   - * @apiErrorExample {json} Error-Response:
171   - * HTTP/1.1 500 Internal Server Error
172   - * {
173   - * "error":"Mensagem de erro."
174   - * "code":"código do erro"
175   - * }
176   - */
  60 +
177 61 @GET
178 62 @Path("{unidade}/estados/{uf}")
179 63 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -191,100 +75,14 @@ public class InfraResource {
191 75  
192 76 return estados[indexOf];
193 77 }
194   -
195   - /**
196   - * @api {get} /:unidade/estados/:estado/cidades Listar cidades
197   - * @apiName getCidades
198   - * @apiGroup Endereco
199   - * @apiVersion 2.0.0
200   - *
201   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
202   - *
203   - * @apiDescription Consulta as cidades de um determinado estado.
204   - *
205   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
206   - * @apiParam (Path Parameters) {String} estado Sigla do estado.
207   - *
208   - * @apiParam (Query Parameters) {String} [filtro] String utilizada para filtrar as cidades.
209   - *
210   - * @apiExample Exemplo de requisição:
211   - * curl -i http://<host>/sei-broker/service/cosap/estados/rj/cidades?filtro=paraiba
212   - *
213   - * @apiSuccess (Sucesso - 200) {List} resultado Lista com os cidades encontradas.
214   - * @apiSuccess (Sucesso - 200) {Cidade} resultado.cidade Objeto representando uma cidade.
215   - * @apiSuccess (Sucesso - 200) {String} resultado.cidade.nome Nome da cidade.
216   - * @apiSuccess (Sucesso - 200) {String} resultado.cidade.codigoIbge Código do IBGE.
217   - * @apiSuccess (Sucesso - 200) {Estado} resultado.cidade.estado Objeto representando um estado.
218   - * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.nome Nome do estado.
219   - * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.sigla Sigla do estado.
220   - *
221   - * @apiSuccessExample {json} Success-Response:
222   - * HTTP/1.1 200 OK
223   - * {
224   - * "estado": {
225   - * "sigla": "RJ",
226   - * "nome": "Rio de Janeiro"
227   - * },
228   - * "nome": "Paraíba do Sul",
229   - * "codigoIbge": "3303708"
230   - * }
231   - *
232   - * @apiErrorExample {json} Error-Response:
233   - * HTTP/1.1 500 Internal Server Error
234   - * {
235   - * "error":"Mensagem de erro."
236   - * "code":"código do erro"
237   - * }
238   - */
  78 +
239 79 @GET
240 80 @Path("{unidade}/estados/{uf}/cidades")
241 81 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
242 82 public List<br.gov.ans.integracao.sei.modelo.Cidade> getCidades(@PathParam("unidade") String unidade,@PathParam("uf") String uf, @QueryParam("filtro") String filtro) throws RemoteException,BusinessException,Exception{
243 83 return cidadeDAO.getCidades(uf, filtro);
244 84 }
245   -
246   - /**
247   - * @api {get} /:unidade/estados/:estado/cidades/:cidade Consultar cidade
248   - * @apiName getCidade
249   - * @apiGroup Endereco
250   - * @apiVersion 2.0.0
251   - *
252   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
253   - *
254   - * @apiDescription Consulta a cidade pelo código do IBGE.
255   - *
256   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
257   - * @apiParam (Path Parameters) {String} estado Sigla do estado.
258   - * @apiParam (Path Parameters) {String} cidade Código do IBGE.
259   - *
260   - * @apiExample Exemplo de requisição:
261   - * curl -i http://<host>/sei-broker/service/cosap/estados/rj/cidades/3303708
262   - *
263   - * @apiSuccess (Sucesso - 200) {Cidade} cidade Objeto representando uma cidade.
264   - * @apiSuccess (Sucesso - 200) {String} cidade.nome Nome da cidade.
265   - * @apiSuccess (Sucesso - 200) {String} cidade.codigoIbge Código do IBGE.
266   - * @apiSuccess (Sucesso - 200) {Estado} cidade.estado Objeto representando um estado.
267   - * @apiSuccess (Sucesso - 200) {String} cidade.estado.nome Nome do estado.
268   - * @apiSuccess (Sucesso - 200) {String} cidade.estado.sigla Sigla do estado.
269   - *
270   - * @apiSuccessExample {json} Success-Response:
271   - * HTTP/1.1 200 OK
272   - * {
273   - * "estado": {
274   - * "sigla": "RJ",
275   - * "nome": "Rio de Janeiro"
276   - * },
277   - * "nome": "Paraíba do Sul",
278   - * "codigoIbge": "3303708"
279   - * }
280   - *
281   - * @apiErrorExample {json} Error-Response:
282   - * HTTP/1.1 500 Internal Server Error
283   - * {
284   - * "error":"Mensagem de erro."
285   - * "code":"código do erro"
286   - * }
287   - */
  85 +
288 86 @GET
289 87 @Path("{unidade}/estados/{uf}/cidades/{ibge}")
290 88 @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
... ...
src/main/java/br/gov/ans/integracao/sei/rest/MarcadorResource.java
  Diff comments   View file @e979172
... ... @@ -36,72 +36,14 @@ public class MarcadorResource {
36 36  
37 37 @Inject
38 38 private MessageUtils messages;
39   -
40   - /**
41   - * @api {get} /:unidade/marcadores Listar marcadores
42   - * @apiName listarMarcadores
43   - * @apiGroup Marcador
44   - * @apiVersion 2.0.0
45   - *
46   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
47   - *
48   - * @apiDescription Lista os marcadores de uma unidade.
49   - *
50   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
51   - *
52   - * @apiExample {curl} Exemplo de requisição:
53   - * curl -i https://<host>/sei-broker/service/cosap/marcadores
54   - *
55   - * @apiSuccess (Sucesso - 200) {Marcador[]} marcadores Lista de marcadores
56   - * @apiSuccess (Sucesso - 200) {String} marcadores.id Identificador do marcador.
57   - * @apiSuccess (Sucesso - 200) {String} marcadores.nome Nome do marcador.
58   - * @apiSuccess (Sucesso - 200) {String} marcadores.icone Ícone do marcador em formato PNG codificado em Base64.
59   - * @apiSuccess (Sucesso - 200) {String} marcadores.sinAtivo S/N - Sinalizador indica se o marcador está ativo.
60   - *
61   - * @apiErrorExample {json} Error-Response:
62   - * HTTP/1.1 500 Internal Server Error
63   - * {
64   - * "error":"Mensagem de erro."
65   - * "code":"código do erro"
66   - * }
67   - */
  39 +
68 40 @GET
69 41 @Path("{unidade}/marcadores")
70 42 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
71 43 public Marcador[] listarMarcadores(@PathParam("unidade") String unidade) throws RemoteException, Exception{
72 44 return seiNativeService.listarMarcadoresUnidade(Constantes.SEI_BROKER, Operacao.LISTAR_MARCADORES_UNIDADE, unidadeResource.consultarCodigo(unidade));
73 45 }
74   -
75   - /**
76   - * @api {post} /:unidade/marcadores/:identificador/processos Adicionar Processo
77   - * @apiName marcarProcesso
78   - * @apiGroup Marcador
79   - * @apiVersion 2.0.0
80   - *
81   - * @apiPermission RO_SEI_BROKER
82   - *
83   - * @apiDescription Adiciona um processo ao marcador.
84   - *
85   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
86   - * @apiParam (Path Parameters) {String} identificador Identificador do marcador no SEI.
87   - *
88   - * @apiParam (Request Body) {MarcacaoProcesso} marcacaoProcesso Objeto de com as definições da marcação.
89   - * @apiParam (Request Body) {String} marcacaoProcesso.processo Número do processo no SEI.
90   - * @apiParam (Request Body) {String} marcacaoProcesso.texto Texto para associação.
91   - *
92   - * @apiExample {curl} Exemplo de requisição:
93   - * curl -i https://<host>/sei-broker/service/cosap/marcadores/3/processos
94   - *
95   - * @apiSuccessExample {json} Success-Response:
96   - * HTTP/1.1 201 Created
97   - *
98   - * @apiErrorExample {json} Error-Response:
99   - * HTTP/1.1 500 Internal Server Error
100   - * {
101   - * "error":"Mensagem de erro."
102   - * "code":"código do erro"
103   - * }
104   - */
  46 +
105 47 @POST
106 48 @Path("{unidade}/marcadores/{marcador}/processos")
107 49 @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/ProcessoResource.java
  Diff comments   View file @e979172
... ... @@ -100,124 +100,7 @@ public class ProcessoResource {
100 100  
101 101 @Context
102 102 private UriInfo uriInfo;
103   -
104   - /**
105   - * @api {get} /:unidade/processos/:processo Consultar processo
106   - * @apiName consultarProcesso
107   - * @apiGroup Processo
108   - * @apiVersion 2.0.0
109   - *
110   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
111   - *
112   - * @apiDescription Este método realiza uma consulta a processos no SEI e no SIPAR.
113   - *
114   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
115   - * @apiParam (Path Parameters) {String} processo Número do processo que deseja consultar
116   - *
117   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [assuntos=N] Exibir assuntos do processo
118   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [interessados=N] Exibir interessados no processo
119   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [observacoes=N] Exibir observações feitas no processo
120   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento=N] Exibir andamento do processo
121   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [andamento-conclusao=N] Exibir o andamento da conclusão do processo
122   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [ultimo-andamento=N] Exibir o último andamento dado ao processo
123   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [unidades=N] Exibir unidades onde o processo está aberto
124   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [relacionados=N] Exibir processos relacionados
125   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [anexados=N] Exibir processos anexados
126   - * @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
127   - *
128   - * @apiExample {curl} Exemplo de requisição:
129   - * curl -i https://<host>/sei-broker/service/COSAP/processos/33910000029201653
130   - *
131   - * @apiSuccess (Sucesso - 200) {ResultadoConsultaProcesso} resultadoConsultaProcesso Objeto de retorno da consulta aos processos, pode um conter processo do SEI ou do SIPAR
132   - * @apiSuccess (Sucesso - 200) {RetornoConsultaProcedimento} resultadoConsultaProcesso.sei Resultado de processo do SEI
133   - * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoConclusao Andamento da conclusão do processo (opcional)
134   - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.andamentoConclusao.dataHora Data e hora do registro de andamento
135   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.descricao Descrição do andamento
136   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoConclusao.unidade Unidade responsável pelo andamento
137   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.descricao Nome da unidade
138   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.idUnidade Código da unidade
139   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.unidade.sigla Sigla da unidade
140   - * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoConclusao.usuario Usuário responsável pela ação
141   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.idUsuario Código do usuário
142   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.nome Nome do usuário
143   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoConclusao.usuario.sigla Login do usuário
144   - * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.andamentoGeracao Andamento da geração do processo (opcional)
145   - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.andamentoGeracao.dataHora Data e hora do registro de andamento
146   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.descricao Descrição do andamento
147   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.andamentoGeracao.unidade Unidade responsável pelo andamento
148   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.descricao Nome da unidade
149   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.idUnidade Código da unidade
150   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.unidade.sigla Sigla da unidade
151   - * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.andamentoGeracao.usuario Usuário responsável pela ação
152   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.idUsuario Código do usuário
153   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.nome Nome do usuário
154   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.andamentoGeracao.usuario.sigla Login do usuário
155   - * @apiSuccess (Sucesso - 200) {Assunto} resultadoConsultaProcesso.sei.assuntos Lista de assuntos
156   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.assuntos.codigoEstruturado Código do assunto
157   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.descricao Descrição do assunto
158   - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.dataAutuacao Data de autuação do processo
159   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.especificacao Especificação do processo
160   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI
161   - * @apiSuccess (Sucesso - 200) {Interessado} resultadoConsultaProcesso.sei.interessados Lista de interessados no processo (opcional)
162   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.nome Nome do interessado
163   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.sigla Login do interessado
164   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI
165   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.linkAcesso Link para acesso ao processo
166   - * @apiSuccess (Sucesso - 200) {Observacao} resultadoConsultaProcesso.sei.observacoes Observações feitas sobre o processo (opcional)
167   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.descricao Descrição da obsevação
168   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.observacoes.unidade Unidade responsável pela observação
169   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.descricao Nome da unidade
170   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.idUnidade Código da unidade
171   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.sigla Sigla da unidade
172   - * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosAnexados Lista com os processos anexados
173   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.idProcedimento Identificador do processo
174   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.procedimentoFormatado Número do processo visível para o usuário
175   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.tipoProcedimento Tipo do processo
176   - * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosRelacionados Lista com os processos relacionados
177   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.idProcedimento Identificador do processo
178   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.procedimentoFormatado Número do processo visível para o usuário
179   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.tipoProcedimento Tipo do processo
180   - *
181   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentoFormatado Número do processo visível para o usuário
182   - * @apiSuccess (Sucesso - 200) {TipoProcedimento} resultadoConsultaProcesso.sei.tipoProcedimento Tipo de procedimento
183   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.idTipoProcedimento Identificador do tipo de procedimento
184   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.nome Nome do tipo de procedimento
185   - * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.ultimoAndamento Ultimo andamento do processo (opcional)
186   - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sei.ultimoAndamento.dataHora Data e hora do registro de andamento
187   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.descricao Descrição do andamento
188   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.ultimoAndamento.unidade Unidade responsável pelo andamento
189   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.descricao Nome da unidade
190   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.idUnidade Código da unidade
191   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.unidade.sigla Sigla da unidade
192   - * @apiSuccess (Sucesso - 200) {Usuario} resultadoConsultaProcesso.sei.ultimoAndamento.usuario Usuário responsável pela ação
193   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.idUsuario Código do usuário
194   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.nome Nome do usuário
195   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.ultimoAndamento.usuario.sigla Login do usuário
196   - * @apiSuccess (Sucesso - 200) {UnidadeProcedimentoAberto} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto Unidades onde o processo está aberto (opcional)
197   - * @apiSuccess (Sucesso - 200) {Unidade} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade Unidade onde o processo está aberto
198   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.descricao Nome da unidade
199   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.idUnidade Código da unidade
200   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.sigla Sigla da unidade
201   - *
202   - * @apiSuccess (Sucesso - 200) {DocumentoSIPAR} resultadoConsultaProcesso.sipar Resultado de processo do SIPAR
203   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.digito Digito do processo
204   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.operadora Operadora relacionada ao processo
205   - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.emissao Data de emissão
206   - * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.registro Data de registro
207   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.tipo Tipo do processo
208   - * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.resumo Resumo sobre o processo
209   - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoPosse Código do orgão que tem a posse do processo
210   - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoOrigem Código do orgão de origem do processo
211   - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.orgaoRegistro Código do orgão de registro do processo
212   - * @apiSuccess (Sucesso - 200) {Long} resultadoConsultaProcesso.sipar.assunto Código do assunto
213   - *
214   - * @apiErrorExample {json} Error-Response:
215   - * HTTP/1.1 500 Internal Server Error
216   - * {
217   - * "error":"Mensagem de erro."
218   - * "code":"código do erro"
219   - * }
220   - */
  103 +
221 104 @GET
222 105 @Path("{unidade}/processos/{processo:\\d+}")
223 106 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -277,38 +160,7 @@ public class ProcessoResource {
277 160  
278 161 return documentoSiparDAO.getDocumento(documento, ano, digito);
279 162 }
280   -
281   - /**
282   - * @api {post} /:unidade/processos/concluidos Concluir processo
283   - * @apiName concluirProcesso
284   - * @apiGroup Processo
285   - * @apiVersion 2.0.0
286   - *
287   - * @apiPermission RO_SEI_BROKER
288   - *
289   - * @apiDescription Conclui o processo informado.
290   - *
291   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
292   - *
293   - * @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
294   - *
295   - * @apiParam (Request Body) {String} processo Numero do processo a ser concluído
296   - *
297   - * @apiExample Exemplo de requisição:
298   - * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/concluidos
299   - *
300   - * body:
301   - * 33910000029201653
302   - *
303   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
304   - *
305   - * @apiErrorExample {json} Error-Response:
306   - * HTTP/1.1 500 Internal Server Error
307   - * {
308   - * "error":"Mensagem de erro."
309   - * "code":"código do erro"
310   - * }
311   - */
  163 +
312 164 @POST
313 165 @Path("{unidade}/processos/concluidos")
314 166 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -321,56 +173,7 @@ public class ProcessoResource {
321 173  
322 174 return trueOrFalse(resultado) + "";
323 175 }
324   -
325   -
326   - /**
327   - * @api {post} /:unidade/processos/enviados Enviar processo
328   - * @apiName enviarProcesso
329   - * @apiGroup Processo
330   - * @apiVersion 2.0.0
331   - *
332   - * @apiPermission RO_SEI_BROKER
333   - *
334   - * @apiDescription Envia processos a outras unidades.
335   - *
336   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. Representa a unidade de localização atual do processo.
337   - *
338   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [reabir=N] Reabrir automaticamente caso esteja concluído na unidade
339   - * @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
340   - *
341   - * @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.
342   - * @apiParam (Request Body) {String[]} unidadesDestino Lista com os identificadores das unidades de destino do processo, código ou nome da unidade.
343   - * @apiParam (Request Body) {Boolean} manterAbertoOrigem=false Informa se o processo deve continuar aberto na unidade de origem .
344   - * @apiParam (Request Body) {Boolean} removerAnotacoes=false Informa se as anotações do processo devem ser removidas.
345   - * @apiParam (Request Body) {Boolean} enviarEmailNotificacao=false Informa se deve ser enviado um e-mail de notificação.
346   - * @apiParam (Request Body) {Date} dataRetornoProgramado=null Data para retorno programado do processo a unidade (padrão ISO-8601).
347   - * @apiParam (Request Body) {Integer} qtdDiasAteRetorno=null Quantidade de dias até o retorno do processo.
348   - * @apiParam (Request Body) {Boolean} somenteDiasUteis=false Informa se só serão contabilizados dias úteis.
349   - *
350   - * @apiExample Exemplo de requisição:
351   - * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/enviados
352   - *
353   - * body:
354   - * {
355   - * "numeroDoProcesso":"1600000000098",
356   - * "unidadesDestino":["110000934","110000934"],
357   - * "manterAbertoOrigem":false,
358   - * "removerAnotacoes":false,
359   - * "enviarEmailNotificacao":true,
360   - * "dataRetornoProgramado":2016-04-14T19:39:22.292+0000,
361   - * "qtdDiasAteRetorno":5,
362   - * "somenteDiasUteis":true}
363   - * }
364   - *
365   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
366   - *
367   - * @apiErrorExample {json} Error-Response:
368   - * HTTP/1.1 500 Internal Server Error
369   - * {
370   - * "error":"Mensagem de erro."
371   - * "code":"código do erro"
372   - * }
373   - */
  176 +
374 177 @POST
375 178 @Path("{unidade}/processos/enviados")
376 179 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -391,35 +194,7 @@ public class ProcessoResource {
391 194  
392 195 return trueOrFalse(resultado) + "";
393 196 }
394   -
395   -
396   - /**
397   - * @api {delete} /:unidade/processos/concluidos/:processo Reabrir processo
398   - * @apiName reabrirProcesso
399   - * @apiGroup Processo
400   - * @apiVersion 2.0.0
401   - *
402   - * @apiPermission RO_SEI_BROKER
403   - *
404   - * @apiDescription Reabre um processo.
405   - *
406   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
407   - * @apiParam (Path Parameters) {String} processo Numero do processo a ser reaberto
408   - *
409   - * @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
410   - *
411   - * @apiExample Exemplo de requisição:
412   - * curl -X DELETE https://<host>/sei-broker/service/COSAP/processos/concluidos/33910000029201653
413   - *
414   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
415   - *
416   - * @apiErrorExample {json} Error-Response:
417   - * HTTP/1.1 500 Internal Server Error
418   - * {
419   - * "error":"Mensagem de erro."
420   - * "code":"código do erro"
421   - * }
422   - */
  197 +
423 198 @DELETE
424 199 @Path("{unidade}/processos/concluidos/{processo:\\d+}")
425 200 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -432,33 +207,7 @@ public class ProcessoResource {
432 207  
433 208 return trueOrFalse(resultado) + "";
434 209 }
435   -
436   - /**
437   - * @api {get} /:unidade/processos/tipos Tipos de processo
438   - * @apiName listarTiposProcesso
439   - * @apiGroup Processo
440   - * @apiVersion 2.0.0
441   - *
442   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
443   - *
444   - * @apiDescription Consulta os tipos de processo.
445   - *
446   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
447   - *
448   - * @apiParam (Query Parameters) {String} [serie] Tipo do documento cadastrado no serviço
449   - *
450   - * @apiExample Exemplo de requisição:
451   - * curl -i https://<host>/sei-broker/service/COSAP/processos/tipos
452   - *
453   - * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
454   - *
455   - * @apiErrorExample {json} Error-Response:
456   - * HTTP/1.1 500 Internal Server Error
457   - * {
458   - * "error":"Mensagem de erro."
459   - * "code":"código do erro"
460   - * }
461   - */
  210 +
462 211 @GET
463 212 @Path("{unidade}/processos/tipos")
464 213 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -466,94 +215,6 @@ public class ProcessoResource {
466 215 return seiNativeService.listarTiposProcedimento(Constantes.SEI_BROKER, Operacao.LISTAR_TIPOS_PROCESSO, unidadeResource.consultarCodigo(unidade), serie);
467 216 }
468 217  
469   - /**
470   - * @api {post} /:unidade/processos Abrir processo
471   - * @apiName abrirProcesso
472   - * @apiGroup Processo
473   - * @apiVersion 2.0.0
474   - *
475   - * @apiPermission RO_SEI_BROKER
476   - *
477   - * @apiDescription Abre um processo.
478   - *
479   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
480   - *
481   - * @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
482   - *
483   - * @apiParam (Request Body) {NovoProcesso} novoProcesso Objeto de representação de novo processo.
484   - * @apiParam (Request Body) {Procedimento} novoProcesso.dadosProcesso Dados do processo.
485   - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.idTipoProcedimento Identificador do tipo de processo no SEI (Consultar tipos de processo).
486   - * @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.
487   - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.dataAutuacao] Data de autuação do processo, se não for informada o sistema utilizará a data atual.
488   - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.especificacao Especificação do processo.
489   - * @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).
490   - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.codigoEstruturado Código do assunto
491   - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.assuntos.descricao Descrição do assunto
492   - * @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.
493   - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.interessados.nome Nome do interessado
494   - * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.interessados.sigla Login do interessado
495   - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.observacao] Texto da observação, passar null se não existir.
496   - * @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.
497   - * @apiParam (Request Body) {String} [novoProcesso.dadosProcesso.idHipoteseLegal] Identificador da hipótese legal associada. *
498   - * @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.
499   - * @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.
500   - * @apiParam (Request Body) {String[]} [novoProcesso.unidadesDestino] Lista com os identificadores das unidades de destino do processo, código ou nome da unidade.
501   - * @apiParam (Request Body) {Boolean} [novoProcesso.manterAbertoOrigem=false] Indica se o processo deve ser mantido aberto na unidade de origem.
502   - * @apiParam (Request Body) {Boolean} [novoProcesso.enviarEmailNotificacao=false] Indica se deve ser enviado email de aviso para as unidades destinatárias.
503   - * @apiParam (Request Body) {Date} [novoProcesso.dataRetornoProgramado] Data para definição de Retorno Programado.
504   - * @apiParam (Request Body) {Integer} [novoProcesso.qtdDiasAteRetorno] Número de dias para o Retorno Programado.
505   - * @apiParam (Request Body) {Boolean} [novoProcesso.somenteDiasUteis=false] Indica se o valor passado no parâmetro qtdDiasAteRetorno corresponde a dias úteis ou não.
506   - * @apiParam (Request Body) {String} [novoProcesso.idMarcador] Identificador de um marcador da unidade para associação.
507   - * @apiParam (Request Body) {String} [novoProcesso.textoMarcador] Texto do marcador.
508   - *
509   - * @apiExample Exemplo de requisição:
510   - * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos
511   - *
512   - * body:
513   - * {
514   - * "dadosProcesso":{
515   - * "idTipoProcedimento":"100000375",
516   - * "especificacao":"Documentação REST",
517   - * "assuntos":[],
518   - * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}],
519   - * "observacao":"Exemplo de requisição",
520   - * "nivelAcesso":0
521   - * },
522   - * "documentos":[],
523   - * "processosRelacionados":["186649"],
524   - * "unidadesDestino":["COTEC","110000935","COSAP"],
525   - * "manterAbertoOrigem":true,
526   - * "enviarEmailNotificacao":true,
527   - * "qtdDiasAteRetorno":null,
528   - * "somenteDiasUteis":false
529   - * }
530   - *
531   - * @apiSuccess (Sucesso Response Body - 201) {String} idProcedimento Número do processo gerado
532   - * @apiSuccess (Sucesso Response Body - 201) {String} procedimentoFormatado Número formatado do processo gerado
533   - * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso Link de acesso ao processo
534   - * @apiSuccess (Sucesso Response Body - 201) {RetornoInclusaoDocumento} retornoInclusaoDocumentos Retorno dos documentos inseridos no processo (opcional)
535   - * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.idDocumento Número interno do documento
536   - * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.documentoFormatado Número do documento visível para o usuário
537   - * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.linkAcesso Link para acesso ao documento
538   - *
539   - * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado.
540   - *
541   - * @apiSuccessExample {json} Success-Response:
542   - * HTTP/1.1 200 OK
543   - * {
544   - * "idProcedimento":"33910000056201626",
545   - * "procedimentoFormatado":"33910.000056/2016-26",
546   - * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=arvore_visualizar&acao_origem=procedimento_visualizar&id_procedimento=267&infra_sistema=100000100&infra_unidade_atual=110000934&infra_hash=7a6a75f6b8ec6b43aaffc6616159a85e35e444b9b32da54108e467bc9f3bdfab",
547   - * "retornoInclusaoDocumentos":[]
548   - * }
549   - *
550   - * @apiErrorExample {json} Error-Response:
551   - * HTTP/1.1 500 Internal Server Error
552   - * {
553   - * "error":"Mensagem de erro."
554   - * "code":"código do erro"
555   - * }
556   - */
557 218 @POST
558 219 @Path("{unidade}/processos")
559 220 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -573,61 +234,7 @@ public class ProcessoResource {
573 234  
574 235 return Response.created(getResourcePath(getOnlyNumbers(retorno.getProcedimentoFormatado()))).entity(retorno).build();
575 236 }
576   -
577   - /**
578   - * @api {get} /processos Listar processos
579   - * @apiName consultarProcessos
580   - * @apiGroup Processo
581   - * @apiVersion 2.0.0
582   - *
583   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
584   - *
585   - * @apiDescription Lista os processos conforme os filtros informados.
586   - *
587   - * @apiParam (Query Parameters) {Boolean} [crescente=false] Ordenar em ordem crescente, processos mais antigos primeiro
588   - * @apiParam (Query Parameters) {String} [interessado] Identificador do interessado
589   - * @apiParam (Query Parameters) {String} [unidade] Unidade da qual deseja filtrar os processos
590   - * @apiParam (Query Parameters) {String} [pagina=1] Número da página
591   - * @apiParam (Query Parameters) {String} [qtdRegistros=50] Quantidade de registros retornados por página
592   - * @apiParam (Query Parameters) {String} [tipo] Identificador do tipo de processo que deseja filtrar
593   - *
594   - * @apiExample Exemplo de requisição:
595   - * curl -i https://<host>/sei-broker/service/processos
596   - *
597   - * @apiSuccess (Sucesso Response Body - 200) {List} processos Lista com os processos encontrados
598   - * @apiSuccess (Sucesso Response Body - 200) {ProcessoResumido} processos.processoResumido Resumo do processo encontrado no SEI
599   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numero Número do processo
600   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.numeroFormatado Número do processo formatado
601   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.descricao Descrição do processo
602   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.unidade Unidade responsável pelo processo
603   - * @apiSuccess (Sucesso Response Body - 200) {Data} processos.processoResumido.dataGeracao Data de geração do processo
604   - * @apiSuccess (Sucesso Response Body - 200) {Tipo} processos.processoResumido.tipo Objeto com os dados do tipo de processo
605   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.codigo Código do tipo
606   - * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.nome Nome do tipo
607   - *
608   - * @apiSuccess (Sucesso Response Header - 200) {header} total_registros quantidade de registros que existem para essa consulta.
609   - *
610   - * @apiSuccessExample {json} Success-Response:
611   - * HTTP/1.1 200 OK
612   - * {
613   - * "numero": "33910007118201710",
614   - * "numeroFormatado": "33910.007118/2017-10",
615   - * "descricao": "D:2237021 - SUL AMÉRICA SEGURO SAÚDE S/A",
616   - * "unidade": "NÚCLEO-RJ",
617   - * "dataGeracao": "2017-10-09T03:00:00.000+0000",
618   - * "tipo": {
619   - * "codigo": "100000882",
620   - * "nome": "Fiscalização: Sancionador"
621   - * }
622   - * }
623   - *
624   - * @apiErrorExample {json} Error-Response:
625   - * HTTP/1.1 500 Internal Server Error
626   - * {
627   - * "error":"Mensagem de erro."
628   - * "code":"código do erro"
629   - * }
630   - */
  237 +
631 238 @GET
632 239 @Path("/processos")
633 240 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -663,53 +270,7 @@ public class ProcessoResource {
663 270  
664 271 return consultarProcessos(interessado, unidade, tipoProcesso, crescente, pagina, qtdRegistros);
665 272 }
666   -
667   - /**
668   - * @api {get} /:unidade/processos/:processo/andamentos Listar andamentos
669   - * @apiName listarAndamentos
670   - * @apiGroup Processo
671   - * @apiVersion 2.0.0
672   - *
673   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
674   - *
675   - * @apiDescription Lista as andamentos do processo.
676   - *
677   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
678   - * @apiParam (Path Parameters) {String} processo Número do processo.
679   - *
680   - * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [exibir-atributos="N"] Sinalizador para retorno dos atributos associados.
681   - * @apiParam (Query Parameters) {String[]} [andamento] Filtra andamentos pelos identificadores informados.
682   - * @apiParam (Query Parameters) {String[]} [tarefa="1,48,65"] Filtra andamentos pelos identificadores de tarefas informados (consultar lista de tarefas).
683   - * @apiParam (Query Parameters) {String[]} [tarefa-modulo] Filtra andamentos pelos identificadores de tarefas de módulo informados.
684   - *
685   - * @apiExample {curl} Exemplo de requisição:
686   - * curl -i https://<host>/sei-broker/service/cosap/processos/33910003114201754/andamentos
687   - *
688   - * @apiSuccess (Sucesso - 200) {Andamento[]} andamentos Lista dos andamentos do processo.
689   - * @apiSuccess (Sucesso - 200) {String} andamentos.idAndamento Identificador do andamento.
690   - * @apiSuccess (Sucesso - 200) {String} andamentos.idTarefa Identificador da tarefa.
691   - * @apiSuccess (Sucesso - 200) {String} andamentos.descricao Descrição do andamento.
692   - * @apiSuccess (Sucesso - 200) {String} andamentos.dataHora Data e hora do andamento.
693   - * @apiSuccess (Sucesso - 200) {Unidade} andamentos.unidade Unidade onde o andamento ocorreu.
694   - * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.idUnidade Identificador da unidade.
695   - * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.sigla Sigla da unidade.
696   - * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.descricao Descrição da unidade.
697   - * @apiSuccess (Sucesso - 200) {Usuario} andamentos.usuario Usuário responsável pelo andamento.
698   - * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.idUsuario Identificador do usuário.
699   - * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.sigla Login do usuário.
700   - * @apiSuccess (Sucesso - 200) {String} andamentos.usuario.nome Nome do usuário.
701   - * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} andamentos.atributos Lista com os atributos relacionados ao andamento.
702   - * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.nome Nome do atributo.
703   - * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.valor Valor do atributo.
704   - * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.idOrigem Identificador de origem do atributo.
705   - *
706   - * @apiErrorExample {json} Error-Response:
707   - * HTTP/1.1 500 Internal Server Error
708   - * {
709   - * "error":"Mensagem de erro."
710   - * "code":"código do erro"
711   - * }
712   - */
  273 +
713 274 @GET
714 275 @Path("/{unidade}/processos/{processo:\\d+}/andamentos")
715 276 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -723,59 +284,7 @@ public class ProcessoResource {
723 284 return seiNativeService.listarAndamentos(Constantes.SEI_BROKER, Operacao.LISTAR_ANDAMENTOS, unidadeResource.consultarCodigo(unidade), formatarNumeroProcesso(processo),
724 285 getSOuN(retornarAtributos), andamentos, tarefas, tarefasModulos);
725 286 }
726   -
727   - /**
728   - * @api {post} /:unidade/processos/:processo/andamentos Lançar andamento
729   - * @apiName lancarAndamento
730   - * @apiGroup Processo
731   - * @apiVersion 2.0.0
732   - *
733   - * @apiPermission RO_SEI_BROKER
734   - *
735   - * @apiDescription Lança um andamento ao processo.
736   - *
737   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
738   - * @apiParam (Path Parameters) {String} processo Número do processo.
739   - *
740   - * @apiParam (Request Body) {NovoAndamento} novoAndamento Objeto representando o novo andamento.
741   - * @apiParam (Request Body) {String} novoAndamento.tarefa Identificador da tarefa a qual o andamento se refere (consultar lista de tarefas).
742   - * @apiParam (Request Body) {String} [novoAndamento.tarefaModulo] Identificadoe da tarefa módulo a qual o andamento se refere.
743   - * @apiParam (Request Body) {HashMap} novoAndamento.atributos Mapa chave-valor, identificando como serão preenchidos os atributos da tarefa.
744   - *
745   - * @apiExample Exemplo de requisição:
746   - * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/33910003114201754/andamentos
747   - *
748   - * body:
749   - * {
750   - * "tarefa":"65",
751   - * "atributos":{"DESCRICAO":"Novo andamento adicionado pelo SEI-Broker"}
752   - * }
753   - *
754   - * @apiSuccess (Sucesso - 201) {Andamento} andamento Andamento criado.
755   - * @apiSuccess (Sucesso - 201) {String} andamento.idAndamento Identificador do andamento.
756   - * @apiSuccess (Sucesso - 201) {String} andamento.idTarefa Identificador da tarefa.
757   - * @apiSuccess (Sucesso - 201) {String} andamento.descricao Descrição do andamento.
758   - * @apiSuccess (Sucesso - 201) {String} andamento.dataHora Data e hora do andamento.
759   - * @apiSuccess (Sucesso - 201) {Unidade} andamento.unidade Unidade onde o andamento ocorreu.
760   - * @apiSuccess (Sucesso - 201) {String} andamento.unidade.idUnidade Identificador da unidade.
761   - * @apiSuccess (Sucesso - 201) {String} andamento.unidade.sigla Sigla da unidade.
762   - * @apiSuccess (Sucesso - 201) {String} andamento.unidade.descricao Descrição da unidade.
763   - * @apiSuccess (Sucesso - 201) {Usuario} andamento.usuario Usuário responsável pelo andamento.
764   - * @apiSuccess (Sucesso - 201) {String} andamento.usuario.idUsuario Identificador do usuário.
765   - * @apiSuccess (Sucesso - 201) {String} andamento.usuario.sigla Login do usuário.
766   - * @apiSuccess (Sucesso - 201) {String} andamento.usuario.nome Nome do usuário.
767   - * @apiSuccess (Sucesso - 201) {AtributoAndamento[]} andamento.atributos Lista com os atributos relacionados ao andamento.
768   - * @apiSuccess (Sucesso - 201) {String} andamento.atributos.nome Nome do atributo.
769   - * @apiSuccess (Sucesso - 201) {String} andamento.atributos.valor Valor do atributo.
770   - * @apiSuccess (Sucesso - 201) {String} andamento.atributos.idOrigem Identificador de origem do atributo.
771   - *
772   - * @apiErrorExample {json} Error-Response:
773   - * HTTP/1.1 500 Internal Server Error
774   - * {
775   - * "error":"Mensagem de erro."
776   - * "code":"código do erro"
777   - * }
778   - */
  287 +
779 288 @POST
780 289 @Path("/{unidade}/processos/{processo:\\d+}/andamentos")
781 290 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -786,41 +295,7 @@ public class ProcessoResource {
786 295  
787 296 return Response.status(Status.CREATED).entity(andamentoLancado).build();
788 297 }
789   -
790   - /**
791   - * @api {post} /:unidade/processos/:processo/anexados Anexar processo
792   - * @apiName anexarProcesso
793   - * @apiGroup Processo
794   - * @apiVersion 2.0.0
795   - *
796   - * @apiPermission RO_SEI_BROKER
797   - *
798   - * @apiDescription Anexar um processo.
799   - *
800   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
801   - * @apiParam (Path Parameters) {String} processo Número do processo.
802   - *
803   - * @apiParam (Request Body) {ProcessoAnexado} processoAnexado Objeto representando o processo a ser anexado.
804   - * @apiParam (Request Body) {String} processoAnexado.numero Número do processo a ser anexado.
805   - *
806   - * @apiExample Exemplo de requisição:
807   - * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/33910003114201754/anexados
808   - *
809   - * body:
810   - * {
811   - * "numero":"33910003093201777"
812   - * }
813   - *
814   - * @apiSuccessExample {json} Success-Response:
815   - * HTTP/1.1 200 OK
816   - *
817   - * @apiErrorExample {json} Error-Response:
818   - * HTTP/1.1 500 Internal Server Error
819   - * {
820   - * "error":"Mensagem de erro."
821   - * "code":"código do erro"
822   - * }
823   - */
  298 +
824 299 @POST
825 300 @Path("/{unidade}/processos/{processo:\\d+}/anexados")
826 301 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -838,37 +313,7 @@ public class ProcessoResource {
838 313 throw new Exception(messages.getMessage("erro.anexar.processo"));
839 314 }
840 315 }
841   -
842   - /**
843   - * @api {delete} /:unidade/processos/:processo/anexados/:processoAnexado Desanexar processo
844   - * @apiName desanexarProcesso
845   - * @apiGroup Processo
846   - * @apiVersion 2.0.0
847   - *
848   - * @apiPermission RO_SEI_BROKER
849   - *
850   - * @apiDescription Remove um processo anexado.
851   - *
852   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
853   - * @apiParam (Path Parameters) {String} processo Número do processo.
854   - * @apiParam (Path Parameters) {String} processo Número do processo anexado.
855   - *
856   - * @apiExample Exemplo de requisição:
857   - * curl -X DELETE https://<host>/sei-broker/service/COSAP/processos/33910003114201754/anexados/33910003093201777
858   - *
859   - * @apiParam (Request Body) {Motivo} motivo Objeto com o motivo.
860   - * @apiParam (Request Body) {String} motivo.motivo Descrição do motivo para remoção do processo em anexo.
861   - *
862   - * @apiSuccessExample {json} Success-Response:
863   - * HTTP/1.1 200 OK
864   - *
865   - * @apiErrorExample {json} Error-Response:
866   - * HTTP/1.1 500 Internal Server Error
867   - * {
868   - * "error":"Mensagem de erro."
869   - * "code":"código do erro"
870   - * }
871   - */
  316 +
872 317 @DELETE
873 318 @Path("/{unidade}/processos/{processo:\\d+}/anexados/{processoAnexado:\\d+}")
874 319 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -887,40 +332,7 @@ public class ProcessoResource {
887 332 throw new Exception(messages.getMessage("erro.desanexar.processo"));
888 333 }
889 334 }
890   -
891   - /**
892   - * @api {post} /:unidade/processos/bloqueados Bloquear processo
893   - * @apiName bloquearProcesso
894   - * @apiGroup Processo
895   - * @apiVersion 2.0.0
896   - *
897   - * @apiPermission RO_SEI_BROKER
898   - *
899   - * @apiDescription Bloquear um processo.
900   - *
901   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
902   - *
903   - * @apiParam (Request Body) {ProcessoBloqueado} processoBloqueado Objeto com o número do processo a ser bloqueado.
904   - * @apiParam (Request Body) {String} processoBloqueado.numero Número do processo a ser bloqueado.
905   - *
906   - * @apiExample Exemplo de requisição:
907   - * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/bloqueados
908   - *
909   - * body:
910   - * {
911   - * "numero":"33910003093201777"
912   - * }
913   - *
914   - * @apiSuccessExample {json} Success-Response:
915   - * HTTP/1.1 200 OK
916   - *
917   - * @apiErrorExample {json} Error-Response:
918   - * HTTP/1.1 500 Internal Server Error
919   - * {
920   - * "error":"Mensagem de erro."
921   - * "code":"código do erro"
922   - * }
923   - */
  335 +
924 336 @POST
925 337 @Path("/{unidade}/processos/bloqueados")
926 338 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -939,33 +351,7 @@ public class ProcessoResource {
939 351 throw new Exception(messages.getMessage("erro.bloquear.processo"));
940 352 }
941 353 }
942   -
943   - /**
944   - * @api {delete} /:unidade/processos/bloqueados/:processo Desbloquear processo
945   - * @apiName desbloquearProcesso
946   - * @apiGroup Processo
947   - * @apiVersion 2.0.0
948   - *
949   - * @apiPermission RO_SEI_BROKER
950   - *
951   - * @apiDescription Desbloquear um processo.
952   - *
953   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
954   - * @apiParam (Path Parameters) {String} processo Número do processo.
955   - *
956   - * @apiExample Exemplo de requisição:
957   - * endpoint: [DELETE] https://<host>/sei-broker/service/COSAP/processos/bloqueados/33910003093201777
958   - *
959   - * @apiSuccessExample {json} Success-Response:
960   - * HTTP/1.1 200 OK
961   - *
962   - * @apiErrorExample {json} Error-Response:
963   - * HTTP/1.1 500 Internal Server Error
964   - * {
965   - * "error":"Mensagem de erro."
966   - * "code":"código do erro"
967   - * }
968   - */
  354 +
969 355 @DELETE
970 356 @Path("/{unidade}/processos/bloqueados/{processo:\\d+}")
971 357 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -979,41 +365,7 @@ public class ProcessoResource {
979 365 throw new Exception(messages.getMessage("erro.desbloquear.processo"));
980 366 }
981 367 }
982   -
983   - /**
984   - * @api {post} /:unidade/processos/:processo/relacionados Relacionar processo
985   - * @apiName relacionarProcesso
986   - * @apiGroup Processo
987   - * @apiVersion 2.0.0
988   - *
989   - * @apiPermission RO_SEI_BROKER
990   - *
991   - * @apiDescription Relacionar processos.
992   - *
993   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
994   - * @apiParam (Path Parameters) {String} processo Número do processo.
995   - *
996   - * @apiParam (Request Body) {ProcessoRelacionado} processoRelacionado Objeto com o número do processo a ser relacionado.
997   - * @apiParam (Request Body) {String} processoRelacionado.numero Número do processo a ser relacionado.
998   - *
999   - * @apiExample Exemplo de requisição:
1000   - * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/33910003093201777/relacionados
1001   - *
1002   - * body:
1003   - * {
1004   - * "numero":"33910000086201632"
1005   - * }
1006   - *
1007   - * @apiSuccessExample {json} Success-Response:
1008   - * HTTP/1.1 200 OK
1009   - *
1010   - * @apiErrorExample {json} Error-Response:
1011   - * HTTP/1.1 500 Internal Server Error
1012   - * {
1013   - * "error":"Mensagem de erro."
1014   - * "code":"código do erro"
1015   - * }
1016   - */
  368 +
1017 369 @POST
1018 370 @Path("/{unidade}/processos/{processo:\\d+}/relacionados")
1019 371 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -1031,34 +383,7 @@ public class ProcessoResource {
1031 383 throw new Exception(messages.getMessage("erro.relacionar.processo"));
1032 384 }
1033 385 }
1034   -
1035   - /**
1036   - * @api {delete} /:unidade/processos/:processo/relacionados/:processoRelacionado Desrelacionar processo
1037   - * @apiName desrelacionarProcesso
1038   - * @apiGroup Processo
1039   - * @apiVersion 2.0.0
1040   - *
1041   - * @apiPermission RO_SEI_BROKER
1042   - *
1043   - * @apiDescription Desrelacionar processos.
1044   - *
1045   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
1046   - * @apiParam (Path Parameters) {String} processo Número do processo.
1047   - * @apiParam (Path Parameters) {String} processoRelacionado Número do processo relacionado.
1048   - *
1049   - * @apiExample Exemplo de requisição:
1050   - * endpoint: [DELETE] https://<host>/sei-broker/service/COSAP/processos/33910000086201632/relacionados/33910003107201752
1051   - *
1052   - * @apiSuccessExample {json} Success-Response:
1053   - * HTTP/1.1 200 OK
1054   - *
1055   - * @apiErrorExample {json} Error-Response:
1056   - * HTTP/1.1 500 Internal Server Error
1057   - * {
1058   - * "error":"Mensagem de erro."
1059   - * "code":"código do erro"
1060   - * }
1061   - */
  386 +
1062 387 @DELETE
1063 388 @Path("/{unidade}/processos/{processo:\\d+}/relacionados/{processoRelacionado:\\d+}")
1064 389 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -1074,43 +399,7 @@ public class ProcessoResource {
1074 399 throw new Exception(messages.getMessage("erro.desrelacionar.processo"));
1075 400 }
1076 401 }
1077   -
1078   - /**
1079   - * @api {post} /:unidade/processos/sobrestados Sobrestar processo
1080   - * @apiName sobrestarProcesso
1081   - * @apiGroup Processo
1082   - * @apiVersion 2.0.0
1083   - *
1084   - * @apiPermission RO_SEI_BROKER
1085   - *
1086   - * @apiDescription Sobrestar processo.
1087   - *
1088   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
1089   - *
1090   - * @apiParam (Request Body) {SobrestamentoProcesso} sobrestamento Objeto com o motivo do sobrestamento.
1091   - * @apiParam (Request Body) {String} sobrestamento.processo Número do processo a ser sobrestado.
1092   - * @apiParam (Request Body) {String} sobrestamento.motivo Motivo do sobrestamento.
1093   - * @apiParam (Request Body) {String} [sobrestamento.processoVinculado] Número do processo vinculado.
1094   - *
1095   - * @apiExample Exemplo de requisição:
1096   - * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/sobrestados
1097   - *
1098   - * body:
1099   - * {
1100   - * "processo":"33910003093201777",
1101   - * "motivo":"Sobrestando através da camada de serviços."
1102   - * }
1103   - *
1104   - * @apiSuccessExample {json} Success-Response:
1105   - * HTTP/1.1 200 OK
1106   - *
1107   - * @apiErrorExample {json} Error-Response:
1108   - * HTTP/1.1 500 Internal Server Error
1109   - * {
1110   - * "error":"Mensagem de erro."
1111   - * "code":"código do erro"
1112   - * }
1113   - */
  402 +
1114 403 @POST
1115 404 @Path("/{unidade}/processos/sobrestados")
1116 405 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -1129,33 +418,7 @@ public class ProcessoResource {
1129 418 throw new Exception(messages.getMessage("erro.sobrestar.processo"));
1130 419 }
1131 420 }
1132   -
1133   - /**
1134   - * @api {delete} /:unidade/processos/sobrestados/:processo Remover sobrestamento
1135   - * @apiName removerSobrestamentoProcesso
1136   - * @apiGroup Processo
1137   - * @apiVersion 2.0.0
1138   - *
1139   - * @apiPermission RO_SEI_BROKER
1140   - *
1141   - * @apiDescription Remover sobrestamento de processo.
1142   - *
1143   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
1144   - * @apiParam (Path Parameters) {String} processo Número do processo.
1145   - *
1146   - * @apiExample Exemplo de requisição:
1147   - * endpoint: [DELETE] https://<host>/sei-broker/service/COSAP/processos/sobrestados/33910003093201777
1148   - *
1149   - * @apiSuccessExample {json} Success-Response:
1150   - * HTTP/1.1 200 OK
1151   - *
1152   - * @apiErrorExample {json} Error-Response:
1153   - * HTTP/1.1 500 Internal Server Error
1154   - * {
1155   - * "error":"Mensagem de erro."
1156   - * "code":"código do erro"
1157   - * }
1158   - */
  421 +
1159 422 @DELETE
1160 423 @Path("/{unidade}/processos/sobrestados/{processo:\\d+}")
1161 424 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -1170,66 +433,7 @@ public class ProcessoResource {
1170 433 throw new Exception(messages.getMessage("erro.remover.sobrestamento.processo"));
1171 434 }
1172 435 }
1173   -
1174   - /**
1175   - * @api {get} /processos/:processo/documentos Listar documentos
1176   - * @apiName listarDocumentosPorProcesso
1177   - * @apiGroup Processo
1178   - * @apiVersion 2.0.0
1179   - *
1180   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
1181   - *
1182   - * @apiDescription Retorna os documentos de um determinado processo.
1183   - *
1184   - * @apiParam (Path Parameters) {String} processo Número do processo.
1185   - *
1186   - * @apiParam (Query Parameters) {String} [tipo=null] Identificador do tipo do documento, caso seja necessário filtrar pelo tipo
1187   - * @apiParam (Query Parameters) {String = "G (gerado/interno), R (recebido/externo)"} [origem=null] Filtra os documentos por gerados ou recebidos
1188   - * @apiParam (Query Parameters) {boolean} [somenteAssinados=false] Exibir somente documentos assinados
1189   - * @apiParam (Query Parameters) {String} [numeroInformado] Filtrar pelo número informado
1190   - * @apiParam (Query Parameters) {String} [pagina=1] Número da página
1191   - * @apiParam (Query Parameters) {String} [qtdRegistros = 50] Quantidade de registros que serão exibidos por página
1192   - *
1193   - * @apiExample Exemplo de requisição:
1194   - * curl -i https://<host>/sei-broker/service/processos/33910003149201793/documentos
1195   - *
1196   - * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados.
1197   - * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentos.documentoResumido Resumo do documento encontrado no SEI.
1198   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.numero Número do documento.
1199   - * @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.
1200   - * @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)
1201   - * @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.
1202   - * @apiSuccess (Sucesso Response Body - 200) {Data} documentos.documentoResumido.dataGeracao Data de geração do documento.
1203   - * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentos.documentoResumido.tipo Objeto representando o tipo do documento.
1204   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série.
1205   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipo.nome Nome do tipo do documento.
1206   - * @apiSuccess (Sucesso Response Body - 200) {String} documentos.documentoResumido.tipoConferencia Tipo de conferência do documento.
1207   - * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado.
1208   - *
1209   - * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta
1210   - *
1211   - * @apiSuccessExample {json} Success-Response:
1212   - * HTTP/1.1 200 OK
1213   - * {
1214   - * "numero": "0670949",
1215   - * "numeroInformado": "594",
1216   - * "origem": "RECEBIDO",
1217   - * "dataGeracao": "2015-08-10T00:00:00-03:00",
1218   - * "tipo": {
1219   - * "codigo": "629",
1220   - * "nome": "Relatório de Arquivamento-SIF"
1221   - * }
1222   - * "tipoConferencia": "4",
1223   - * "assinado": true
1224   - * }
1225   - *
1226   - * @apiErrorExample {json} Error-Response:
1227   - * HTTP/1.1 500 Internal Server Error
1228   - * {
1229   - * "error":"Mensagem de erro."
1230   - * "code":"código do erro"
1231   - * }
1232   - */
  436 +
1233 437 @GET
1234 438 @Path("/processos/{processo:\\d+}/documentos")
1235 439 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -1253,56 +457,7 @@ public class ProcessoResource {
1253 457 return Response.status(getStatus(totalDocumentosProcesso.intValue(), tamanhoPagina)).header("total_registros", totalDocumentosProcesso)
1254 458 .entity(new GenericEntity<List<DocumentoResumido>>(documentosProcesso){}).build();
1255 459 }
1256   -
1257   - /**
1258   - * @api {get} /processos/:processo/documentos/:documento Consultar documento
1259   - * @apiName consultarDocumentoDoProcesso
1260   - * @apiGroup Processo
1261   - * @apiVersion 2.0.0
1262   - *
1263   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
1264   - *
1265   - * @apiDescription Consulta um documento de determinado processo.
1266   - *
1267   - * @apiParam (Path Parameters) {String} processo Número do processo.
1268   - * @apiParam (Path Parameters) {String} documento Número do documento.
1269   - *
1270   - * @apiExample Exemplo de requisição:
1271   - * curl -i https://<host>/sei-broker/service/processos/33910002924201874/documentos/55737058
1272   - *
1273   - * @apiSuccess (Sucesso Response Body - 200) {DocumentoResumido} documentoResumido Resumo do documento encontrado no SEI.
1274   - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numero Número do documento.
1275   - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.numeroInformado Número informado na inclusão do documento, também conhecido como número de árvore.
1276   - * @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.
1277   - * @apiSuccess (Sucesso Response Body - 200) {Data} documentoResumido.dataGeracao Data de geração do documento.
1278   - * @apiSuccess (Sucesso Response Body - 200) {Tipo} documentoResumido.tipo Objeto representando o tipo do documento.
1279   - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipo.codigo Identificados do tipo do documento, também conhecido como série.
1280   - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipo.nome Nome do tipo do documento.
1281   - * @apiSuccess (Sucesso Response Body - 200) {String} documentoResumido.tipoConferencia Tipo de conferência do documento.
1282   - * @apiSuccess (Sucesso Response Body - 200) {boolean} documentoResumido.assinado Boolean indicando se o documento foi assinado.
1283   - *
1284   - * @apiSuccessExample {json} Success-Response:
1285   - * HTTP/1.1 200 OK
1286   - * {
1287   - * "numero": "0670949",
1288   - * "numeroInformado": "594",
1289   - * "origem": "RECEBIDO",
1290   - * "dataGeracao": "2015-08-10T00:00:00-03:00",
1291   - * "tipo": {
1292   - * "codigo": "629",
1293   - * "nome": "Relatório de Arquivamento-SIF"
1294   - * }
1295   - * "tipoConferencia": "4",
1296   - * "assinado": true
1297   - * }
1298   - *
1299   - * @apiErrorExample {json} Error-Response:
1300   - * HTTP/1.1 500 Internal Server Error
1301   - * {
1302   - * "error":"Mensagem de erro."
1303   - * "code":"código do erro"
1304   - * }
1305   - */
  460 +
1306 461 @GET
1307 462 @Path("/processos/{processo:\\d+}/documentos/{documento:\\d+}")
1308 463 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -1316,51 +471,7 @@ public class ProcessoResource {
1316 471 throw new ResourceNotFoundException(messages.getMessage("erro.documento.nao.encontrado", documento, formatarNumeroProcesso(processo)));
1317 472 }
1318 473 }
1319   -
1320   - /**
1321   - * @api {get} /processos/:processo/unidades Consultar unidades
1322   - * @apiName consultarUnidadesProcesso
1323   - * @apiGroup Processo
1324   - * @apiVersion 2.0.0
1325   - *
1326   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
1327   - *
1328   - * @apiDescription Consulta as unidades onde o processo está aberto.
1329   - *
1330   - * @apiParam (Path Parameters) {String} processo Número do processo.
1331   - *
1332   - * @apiExample Exemplo de requisição:
1333   - * curl -i https://<host>/sei-broker/service/processos/33910002924201874/unidades
1334   - *
1335   - * @apiSuccess (Sucesso Response Body - 200) {List} unidades Lista da unidades onde o processo está aberto.
1336   - * @apiSuccess (Sucesso Response Body - 200) {Unidade} unidades.unidade Objeto Unidade.
1337   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.idUnidade Identificador da unidade.
1338   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sigla Sigla de unidade.
1339   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.descricao Descrição da unidade.
1340   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinProtocolo Descrição pendente da área de negócio.
1341   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinArquivamento Descrição pendente da área de negócio.
1342   - * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.sinOuvidoria Descrição pendente da área de negócio.
1343   - *
1344   - * @apiSuccessExample {json} Success-Response:
1345   - * HTTP/1.1 200 OK
1346   - * [
1347   - * {
1348   - * "idUnidade": "110000934",
1349   - * "sigla": "COSAP",
1350   - * "descricao": "Coordenadoria de Sistemas e Aplicativos",
1351   - * "sinProtocolo": "S",
1352   - * "sinArquivamento": "N",
1353   - * "sinOuvidoria": "N"
1354   - * }
1355   - * ]
1356   - *
1357   - * @apiErrorExample {json} Error-Response:
1358   - * HTTP/1.1 500 Internal Server Error
1359   - * {
1360   - * "error":"Mensagem de erro."
1361   - * "code":"código do erro"
1362   - * }
1363   - */
  474 +
1364 475 @GET
1365 476 @Path("/processos/{processo:\\d+}/unidades")
1366 477 @Produces(MediaType.APPLICATION_JSON)
... ...
src/main/java/br/gov/ans/integracao/sei/rest/SeriesResource.java
  Diff comments   View file @e979172
... ... @@ -37,37 +37,7 @@ public class SeriesResource {
37 37  
38 38 @Inject
39 39 private MessageUtils messages;
40   -
41   - /**
42   - * @api {get} /:unidade/series Listar séries
43   - * @apiName listarSeries
44   - * @apiGroup Serie
45   - * @apiVersion 2.0.0
46   - *
47   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
48   - *
49   - * @apiDescription Este método realiza uma consulta às séries.
50   - *
51   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
52   - *
53   - * @apiParam (Query Parameters) {String} [filtro] Para filtrar por series que contenham o trecho no nome.
54   - * @apiParam (Query Parameters) {String} [tipo-processo=null] Para filtrar por determinado tipo de processo.
55   - *
56   - * @apiExample {curl} Exemplo de requisição:
57   - * curl -i https://<host>/sei-broker/service/COSAP/series
58   - *
59   - * @apiSuccess (Sucesso - 200) {Serie[]} series Lista de séries.
60   - * @apiSuccess (Sucesso - 200) {String} series.idSerie Identificador do tipo de documento
61   - * @apiSuccess (Sucesso - 200) {String} series.nome Nome do tipo de documento
62   - * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários
63   - *
64   - * @apiErrorExample {json} Error-Response:
65   - * HTTP/1.1 500 Internal Server Error
66   - * {
67   - * "error":"Mensagem de erro."
68   - * "code":"código do erro"
69   - * }
70   - */
  40 +
71 41 @GET
72 42 @Path("{unidade}/series")
73 43 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -88,36 +58,7 @@ public class SeriesResource {
88 58  
89 59 return series;
90 60 }
91   -
92   - /**
93   - * @api {get} /:unidade/tipos-documentos Listar tipos documentos
94   - * @apiName listarTiposDocumentos
95   - * @apiGroup Documento
96   - * @apiVersion 2.0.0
97   - *
98   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
99   - *
100   - * @apiDescription Lista os tipos de documentos do SEI.
101   - *
102   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
103   - *
104   - * @apiParam (Query Parameters) {String} [filtro] Para filtrar por documentos que contenham o trecho no nome.
105   - *
106   - * @apiExample {curl} Exemplo de requisição:
107   - * curl -i https://<host>/sei-broker/service/COSAP/tipos-documentos
108   - *
109   - * @apiSuccess (Sucesso - 200) {List} tipos Lista com os tipos de documentos
110   - * @apiSuccess (Sucesso - 200) {String} tipos.identificador Identificador do tipo de documento
111   - * @apiSuccess (Sucesso - 200) {String} tipos.nome Nome do tipo de documento
112   - * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários
113   - *
114   - * @apiErrorExample {json} Error-Response:
115   - * HTTP/1.1 500 Internal Server Error
116   - * {
117   - * "error":"Mensagem de erro."
118   - * "code":"código do erro"
119   - * }
120   - */
  61 +
121 62 @GET
122 63 @Path("{unidade}/tipos-documentos")
123 64 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/SiparResource.java
  Diff comments   View file @e979172
... ... @@ -12,7 +12,6 @@ import javax.ws.rs.PathParam;
12 12 import javax.ws.rs.core.Context;
13 13 import javax.ws.rs.core.MediaType;
14 14 import javax.ws.rs.core.Response;
15   -import javax.ws.rs.core.Response.Status;
16 15 import javax.ws.rs.core.UriBuilder;
17 16 import javax.ws.rs.core.UriInfo;
18 17  
... ... @@ -43,50 +42,7 @@ public class SiparResource {
43 42  
44 43 private static int TRUE = 1;
45 44 private static int FALSE = 0;
46   -
47   - /**
48   - * @api {post} /sipar/importados Importar Processo
49   - * @apiName importarProcesso
50   - * @apiGroup SIPAR
51   - * @apiVersion 2.0.0
52   - *
53   - * @apiDescription Marca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
54   - *
55   - * @apiParam (Header Parameters) {String} content-type Informar text/plain
56   - * @apiParam (Request Body) {String} processo Número do processo a ser importado
57   - *
58   - * @apiExample Exemplo de requisição:
59   - * endpoint: [POST] http://<host>/sei-broker/service/sipar/importados
60   - *
61   - * body:
62   - * 33902112492200241
63   - *
64   - * @apiSuccessExample {json} Success-Response:
65   - * HTTP/1.1 201 Created
66   - *
67   - * @apiErrorExample {json} Error-Response:
68   - * HTTP/1.1 500 Internal Server Error
69   - * {
70   - * "error":"Mensagem de erro."
71   - * "code":"código do erro"
72   - * }
73   - *
74   - *
75   - * @apiErrorExample {json} Error-Response:
76   - * HTTP/1.1 400 Bad Request
77   - * {
78   - * "error":"Mensagem de erro."
79   - * "code":"código do erro"
80   - * }
81   - *
82   - *
83   - * @apiErrorExample {json} Error-Response:
84   - * HTTP/1.1 409 Conflict
85   - * {
86   - * "error":"Mensagem de erro."
87   - * "code":"código do erro"
88   - * }
89   - */
  45 +
90 46 @POST
91 47 @Path("/importados")
92 48 @Consumes({MediaType.TEXT_PLAIN})
... ... @@ -119,46 +75,7 @@ public class SiparResource {
119 75 return Response.created(getResourcePath(processo)).build();
120 76  
121 77 }
122   -
123   - /**
124   - * @api {delete} /sipar/importados/:processo Cancelar Importação Processo
125   - * @apiName cancelarImportacaoProcesso
126   - * @apiGroup SIPAR
127   - * @apiVersion 2.0.0
128   - *
129   - * @apiDescription Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
130   - *
131   - * @apiParam (Path Parameter) {String} processo Número do processo físico existente no SIPAR contendo 17 dígitos e iniciado com 33902. Ex. 33902111111111111
132   - *
133   - * @apiExample {curl} Exemplo de requisição:
134   - * curl -X DELETE http://<host>/sei-broker/service/sipar/importados/33902112492200241
135   - *
136   - * @apiSuccessExample {json} Success-Response:
137   - * HTTP/1.1 204 No Content
138   - *
139   - * @apiErrorExample {json} Error-Response:
140   - * HTTP/1.1 500 Internal Server Error
141   - * {
142   - * "error":"Mensagem de erro."
143   - * "code":"código do erro"
144   - * }
145   - *
146   - *
147   - * @apiErrorExample {json} Error-Response:
148   - * HTTP/1.1 400 Bad Request
149   - * {
150   - * "error":"Mensagem de erro."
151   - * "code":"código do erro"
152   - * }
153   - *
154   - *
155   - * @apiErrorExample {json} Error-Response:
156   - * HTTP/1.1 404 Not Found
157   - * {
158   - * "error":"Mensagem de erro."
159   - * "code":"código do erro"
160   - * }
161   - */
  78 +
162 79 @DELETE
163 80 @Path("/importados/{processo:\\d+}")
164 81 public Response cancelarImportacaoProcesso(@PathParam("processo") String processo) throws Exception{
... ...
src/main/java/br/gov/ans/integracao/sei/rest/TarefaResource.java
  Diff comments   View file @e979172
... ... @@ -23,39 +23,6 @@ public class TarefaResource {
23 23 @Inject
24 24 private MessageUtils messages;
25 25  
26   -
27   - /**
28   - * @api {get} /tarefas Listar tarefas
29   - * @apiName listarTarefas
30   - * @apiGroup Tarefa
31   - * @apiVersion 2.0.0
32   - *
33   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
34   - *
35   - * @apiDescription Lista os tipos de tarefas existentes no SEI.
36   - *
37   - * @apiParam (Query Parameters) {String} [nome] Filtro para o nome da tarefa.
38   - *
39   - * @apiExample {curl} Exemplo de requisição:
40   - * curl -i https://<host>/sei-broker/service/tarefas
41   - *
42   - * @apiSuccess (Sucesso - 200) {List} tarefas Lista com as tarefas
43   - * @apiSuccess (Sucesso - 200) {String} tarefas.identificados Identificador da tarefa.
44   - * @apiSuccess (Sucesso - 200) {String} tarefas.nome Nome da tarefa.
45   - * @apiSuccess (Sucesso - 200) {String} tarefas.historicoResumido S/N - Sinalizador indica se a tarefa aparecerá no histórico resumido.
46   - * @apiSuccess (Sucesso - 200) {String} tarefas.historicoCompleto S/N - Sinalizador indica se a tarefa aparecerá no histórico completo.
47   - * @apiSuccess (Sucesso - 200) {String} tarefas.fecharAndamentosAbertos S/N - Sinalizador indica se a tarefa fecha andamentos abertos.
48   - * @apiSuccess (Sucesso - 200) {String} tarefas.lancarAndamentoFechado S/N - Sinalizador indica que a tarefa encerra o andamento.
49   - * @apiSuccess (Sucesso - 200) {String} tarefas.permiteProcessoFechado S/N - Sinalizador indica se é permitida essa tarefa em processo fechado.
50   - * @apiSuccess (Sucesso - 200) {String} tarefas.identicadorTarefaModulo Identificador de tarefa módulo.
51   - *
52   - * @apiErrorExample {json} Error-Response:
53   - * HTTP/1.1 500 Internal Server Error
54   - * {
55   - * "error":"Mensagem de erro."
56   - * "code":"código do erro"
57   - * }
58   - */
59 26 @GET
60 27 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
61 28 public List<Tarefa> listarTarefas(@QueryParam("nome") String filtroNome) throws ResourceNotFoundException{
... ...
src/main/java/br/gov/ans/integracao/sei/rest/TipoConferenciaResource.java
  Diff comments   View file @e979172
... ... @@ -23,32 +23,6 @@ public class TipoConferenciaResource {
23 23 @Inject
24 24 private UnidadeResource unidadeResource;
25 25  
26   - /**
27   - * @api {get} /:unidade/tipos-conferencia Listar tipos de conferência
28   - * @apiName listarTiposConferencia
29   - * @apiGroup Tipos Conferência
30   - * @apiVersion 2.0.0
31   - *
32   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
33   - *
34   - * @apiDescription Lista os tipos de conferência.
35   - *
36   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
37   - *
38   - * @apiExample {curl} Exemplo de requisição:
39   - * curl -i https://<host>/sei-broker/service/cosap/tipos-conferencia
40   - *
41   - * @apiSuccess (Sucesso - 200) {TipoConferencia[]} tipos Lista de tipos de conferência.
42   - * @apiSuccess (Sucesso - 200) {String} tipos.idTipoConferencia Identificador do tipo de conferência.
43   - * @apiSuccess (Sucesso - 200) {String} tipos.descricao Descrição do tipo de conferência.
44   - *
45   - * @apiErrorExample {json} Error-Response:
46   - * HTTP/1.1 500 Internal Server Error
47   - * {
48   - * "error":"Mensagem de erro."
49   - * "code":"código do erro"
50   - * }
51   - */
52 26 @GET
53 27 @Path("{unidade}/tipos-conferencia")
54 28 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/UnidadeResource.java
  Diff comments   View file @e979172
... ... @@ -38,31 +38,6 @@ public class UnidadeResource {
38 38  
39 39 private static Date dataCarregamentoUnidades = new Date();
40 40  
41   - /**
42   - * @api {get} /unidades Listar unidades
43   - * @apiName listarUnidades
44   - * @apiGroup Unidade
45   - * @apiVersion 2.0.0
46   - *
47   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
48   - *
49   - * @apiDescription Retorna as Unidades cadastradas no SEI.
50   - *
51   - * @apiExample {curl} Exemplo de requisição:
52   - * curl -i https://<host>/sei-broker/service/unidades/
53   - *
54   - * @apiSuccess (Sucesso - 200) {Unidade[]} unidades Lista de unidades
55   - * @apiSuccess (Sucesso - 200) {String} unidades.idUnidade Identificador da unidade
56   - * @apiSuccess (Sucesso - 200) {String} unidades.sigla Sigla da unidade
57   - * @apiSuccess (Sucesso - 200) {String} unidades.descricao Descrição da unidade
58   - *
59   - * @apiErrorExample {json} Error-Response:
60   - * HTTP/1.1 500 Internal Server Error
61   - * {
62   - * "error":"Mensagem de erro."
63   - * "code":"código do erro"
64   - * }
65   - */
66 41 @GET
67 42 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
68 43 public br.gov.ans.integracao.sei.client.Unidade[] listarUnidades() throws Exception{
... ... @@ -74,31 +49,7 @@ public class UnidadeResource {
74 49  
75 50 return lista;
76 51 }
77   -
78   - /**
79   - * @api {get} /unidades/{unidade}/codigo Consultar código
80   - * @apiName consultarCodigo
81   - * @apiGroup Unidade
82   - * @apiVersion 2.0.0
83   - *
84   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
85   - *
86   - * @apiDescription Retorna o código da Unidade pesquisada.
87   - *
88   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade que deseja consultar o código
89   - *
90   - * @apiExample {curl} Exemplo de requisição:
91   - * curl -i https://<host>/sei-broker/service/unidades/COSAP/codigo
92   - *
93   - * @apiSuccess (Sucesso - 200) {String} codigo Código da unidade.
94   - *
95   - * @apiErrorExample {json} Error-Response:
96   - * HTTP/1.1 500 Internal Server Error
97   - * {
98   - * "error":"Mensagem de erro."
99   - * "code":"código do erro"
100   - * }
101   - */
  52 +
102 53 @GET
103 54 @Path("/{chave}/codigo")
104 55 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ...
src/main/java/br/gov/ans/integracao/sei/rest/UsuarioResource.java
  Diff comments   View file @e979172
... ... @@ -44,106 +44,20 @@ public class UsuarioResource {
44 44 @Inject
45 45 private MessageUtils messages;
46 46  
47   - /**
48   - * @api {get} /:unidade/usuarios Listar usuários
49   - * @apiName listarUsuarios
50   - * @apiGroup Usuario
51   - * @apiVersion 2.0.0
52   - *
53   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
54   - *
55   - * @apiDescription Este método realiza uma consulta aos usuários cadastrados que possuem o perfil "Básico".
56   - *
57   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
58   - *
59   - * @apiParam (Query Parameters) {String} [usuario=null] Id do usuário que deseja recuperar as informações
60   - *
61   - * @apiExample {curl} Exemplo de requisição:
62   - * curl -i http://<host>/sei-broker/service/usuarios/COSAP
63   - *
64   - * @apiSuccess {Usuario[]} usuarios Lista de usuários
65   - *
66   - * @apiErrorExample {json} Error-Response:
67   - * HTTP/1.1 500 Internal Server Error
68   - * {
69   - * "error":"Mensagem de erro."
70   - * "code":"código do erro"
71   - * }
72   - */
73 47 @GET
74 48 @Path("/{unidade}/usuarios")
75 49 @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
76 50 public br.gov.ans.integracao.sei.client.Usuario[] listarUsuarios(@PathParam("unidade") String unidade, @QueryParam("usuario") String usuario) throws RemoteException, Exception{
77 51 return seiNativeService.listarUsuarios(Constantes.SEI_BROKER, Operacao.LISTAR_USUARIOS, unidadeResource.consultarCodigo(unidade), usuario);
78 52 }
79   -
80   -
81   - /**
82   - * @api {get} :unidade/usuarios/:usuario Buscar usuário
83   - * @apiName buscarUsuario
84   - * @apiGroup Usuario
85   - * @apiVersion 2.0.0
86   - *
87   - * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
88   - *
89   - * @apiDescription Este método realiza a uma busca pelo login do usuário.
90   - *
91   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
92   - * @apiParam (Path Parameters) {String} usuario Login do usuário
93   - *
94   - * @apiExample Exemplo de requisição:
95   - * curl -i http://<host>/sei-broker/service/cosap/usuarios/andre.guimaraes
96   - *
97   - * @apiSuccess {Usuario} usuario Informações do usuário encontrado.
98   - *
99   - * @apiErrorExample {json} Error-Response:
100   - * HTTP/1.1 500 Internal Server Error
101   - * {
102   - * "error":"Mensagem de erro."
103   - * "code":"código do erro"
104   - * }
105   - */
  53 +
106 54 @GET
107 55 @Path("/{unidade}/usuarios/{usuario}")
108 56 @Produces(MediaType.APPLICATION_JSON)
109 57 public br.gov.ans.integracao.sei.client.Usuario buscarUsuario(@PathParam("unidade") String unidade, @PathParam("usuario") String usuario) throws Exception{
110 58 return getUsuario(usuario, unidade);
111 59 }
112   -
113   - /**
114   - * @api {post} /:unidade/:usuario/processos Atribuir processo
115   - * @apiName atribuirProcesso
116   - * @apiGroup Usuario
117   - * @apiVersion 2.0.0
118   - *
119   - * @apiPermission RO_SEI_BROKER
120   - *
121   - * @apiDescription Este método atribui o processo a um usuário.
122   - *
123   - * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
124   - * @apiParam (Path Parameters) {String} usuario Login do usuário a quem deseja atribuir o processo
125   - *
126   - * @apiParam (Request Body) {String} processo Numero do processo a ser atribuído
127   - * @apiParam (Request Body) {String} [reabrir-processo=N] S ou N para reabrir o processo
128   - *
129   - * @apiExample Exemplo de requisição:
130   - * endpoint: [POST] http://<host>/sei-broker/service/COSAP/usuarios/andre.guimaraes/processos
131   - *
132   - * body:
133   - * {
134   - * "processo":"33910000029201653",
135   - * "reabrir":false
136   - * }
137   - *
138   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
139   - *
140   - * @apiErrorExample {json} Error-Response:
141   - * HTTP/1.1 500 Internal Server Error
142   - * {
143   - * "error":"Mensagem de erro."
144   - * "code":"código do erro"
145   - * }
146   - */
  60 +
147 61 @POST
148 62 @Path("/{unidade}/usuarios/{usuario}/processos")
149 63 @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
... ... @@ -155,40 +69,7 @@ public class UsuarioResource {
155 69  
156 70 return trueOrFalse(resultado) + "";
157 71 }
158   -
159   - /**
160   - * @api {post} /usuarios Incluir usuário
161   - * @apiName incluirUsuario
162   - * @apiGroup Usuario
163   - * @apiVersion 2.0.0
164   - *
165   - * @apiPermission RO_SEI_BROKER_ADM
166   - *
167   - * @apiDescription Este método realiza a inclusão de novos usuários ou alterarações nos usuários existentes.
168   - *
169   - * @apiParam (Request Body) {String} codigo Código que deseja atribuir ao usuário
170   - * @apiParam (Request Body) {String} nome Nome do usuário
171   - * @apiParam (Request Body) {String} login Login que será atribuído ao usuário
172   - *
173   - * @apiExample Exemplo de requisição:
174   - * endpoint: http://<host>/sei-broker/service/usuarios
175   - *
176   - * body:
177   - * {
178   - * "codigo":"1234",
179   - * "nome":"André Luís Fernandes Guimarães",
180   - * "login":"andre.guimaraes"
181   - * }
182   - *
183   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
184   - *
185   - * @apiErrorExample {json} Error-Response:
186   - * HTTP/1.1 500 Internal Server Error
187   - * {
188   - * "error":"Mensagem de erro."
189   - * "code":"código do erro"
190   - * }
191   - */
  72 +
192 73 @POST
193 74 @Path("/usuarios")
194 75 @Consumes({MediaType.APPLICATION_JSON})
... ... @@ -197,40 +78,6 @@ public class UsuarioResource {
197 78 return manterUsuario(Acao.ALTERAR_INCLUIR, usuario);
198 79 }
199 80  
200   -
201   - /**
202   - * @api {delete} /usuarios/:login Excluir usuário
203   - * @apiName excluirUsuario
204   - * @apiGroup Usuario
205   - * @apiVersion 2.0.0
206   - *
207   - * @apiPermission RO_SEI_BROKER_ADM
208   - *
209   - * @apiDescription Este método realiza a exclusão de usuários.
210   - *
211   - * @apiParam {String} codigo Código que deseja atribuir ao usuário
212   - * @apiParam {String} nome Nome do usuário
213   - * @apiParam {String} login Login que será atribuído ao usuário
214   - *
215   - * @apiExample Exemplo de requisição:
216   - * endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/andre.guimaraes
217   - *
218   - * body:
219   - * {
220   - * "codigo":"1234",
221   - * "nome":"André Luís Fernandes Guimarães",
222   - * "login":"andre.guimaraes"
223   - * }
224   - *
225   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
226   - *
227   - * @apiErrorExample {json} Error-Response:
228   - * HTTP/1.1 500 Internal Server Error
229   - * {
230   - * "error":"Mensagem de erro."
231   - * "code":"código do erro"
232   - * }
233   - */
234 81 @DELETE
235 82 @Path("/usuarios/{login}")
236 83 @Consumes({MediaType.APPLICATION_JSON})
... ... @@ -238,41 +85,7 @@ public class UsuarioResource {
238 85 public Boolean excluirUsuario(@PathParam("login") String login,Usuario usuario) throws Exception{
239 86 return manterUsuario(Acao.EXCLUIR, usuario);
240 87 }
241   -
242   -
243   - /**
244   - * @api {delete} /usuarios/ativos Desativar usuário
245   - * @apiName desativarUsuario
246   - * @apiGroup Usuario
247   - * @apiVersion 2.0.0
248   - *
249   - * @apiPermission RO_SEI_BROKER_ADM
250   - *
251   - * @apiDescription Este método desativa usuários.
252   - *
253   - * @apiParam {String} codigo Código que deseja atribuir ao usuário
254   - * @apiParam {String} nome Nome do usuário
255   - * @apiParam {String} login Login que será atribuído ao usuário
256   - *
257   - * @apiExample Exemplo de requisição:
258   - * endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/ativos/andre.guimaraes
259   - *
260   - * body:
261   - * {
262   - * "codigo":"1234",
263   - * "nome":"André Luís Fernandes Guimarães",
264   - * "login":"andre.guimaraes"
265   - * }
266   - *
267   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
268   - *
269   - * @apiErrorExample {json} Error-Response:
270   - * HTTP/1.1 500 Internal Server Error
271   - * {
272   - * "error":"Mensagem de erro."
273   - * "code":"código do erro"
274   - * }
275   - */
  88 +
276 89 @DELETE
277 90 @Path("/usuarios/ativos/{login}")
278 91 @Consumes({MediaType.APPLICATION_JSON})
... ... @@ -280,40 +93,7 @@ public class UsuarioResource {
280 93 public Boolean desativarUsuario(@PathParam("login") String login,Usuario usuario) throws Exception{
281 94 return manterUsuario(Acao.DESATIVAR, usuario);
282 95 }
283   -
284   - /**
285   - * @api {post} /usuarios/ativos Ativar usuário
286   - * @apiName ativarUsuario
287   - * @apiGroup Usuario
288   - * @apiVersion 2.0.0
289   - *
290   - * @apiPermission RO_SEI_BROKER_ADM
291   - *
292   - * @apiDescription Este método reativa usuários.
293   - *
294   - * @apiParam {String} codigo Código que deseja atribuir ao usuário
295   - * @apiParam {String} nome Nome do usuário
296   - * @apiParam {String} login Login que será atribuído ao usuário
297   - *
298   - * @apiExample Exemplo de requisição:
299   - * endpoint: http://<host>/sei-broker/service/usuarios/ativos
300   - *
301   - * body:
302   - * {
303   - * "codigo":"1234",
304   - * "nome":"André Luís Fernandes Guimarães",
305   - * "login":"andre.guimaraes"
306   - * }
307   - *
308   - * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
309   - *
310   - * @apiErrorExample {json} Error-Response:
311   - * HTTP/1.1 500 Internal Server Error
312   - * {
313   - * "error":"Mensagem de erro."
314   - * "code":"código do erro"
315   - * }
316   - */
  96 +
317 97 @POST
318 98 @Path("/usuarios/ativos")
319 99 @Consumes({MediaType.APPLICATION_JSON})
... ...
src/main/resources/apidoc/arquivo.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,96 @@
  1 + /**
  2 + * @api {post} /:unidade/arquivos Adicionar arquivo
  3 + * @apiName adicionarArquivo
  4 + * @apiGroup Arquivo
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER
  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.
  12 + *
  13 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  14 + *
  15 + * @apiParam (Request Body) {Arquivo} arquivo Objeto representando um arquivo.
  16 + * @apiParam (Request Body) {String} arquivo.nome Nome do arquivo.
  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.
  20 + *
  21 + * @apiExample Exemplo de requisição:
  22 + * endpoint: https://<host>/sei-broker/service/COSAP/arquivos
  23 + *
  24 + * body:
  25 + * {
  26 + * "nome":"documentos-sei-broker.pdf",
  27 + * "tamanho":"2048",
  28 + * "hash":"45F1DEFFB45A5F6C2380A4CEE9B3E452",
  29 + * "conteudo":"Conteúdo total ou parcial do arquivo"
  30 + * }
  31 + *
  32 + * @apiSuccess (Sucesso - 201) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo
  33 + * @apiSuccess (Sucesso - 201) {String} arquivo.identificador Identificador do arquivo criado.
  34 + *
  35 + * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado.
  36 + *
  37 + * @apiSuccessExample {json} Success-Response:
  38 + * HTTP/1.1 201 Created
  39 + * {
  40 + * "identificador":"123456"
  41 + * }
  42 + *
  43 + * @apiErrorExample {json} Error-Response:
  44 + * HTTP/1.1 500 Internal Server Error
  45 + * {
  46 + * "error":"Mensagem de erro."
  47 + * "code":"código do erro"
  48 + * }
  49 + */
  50 +
  51 + /**
  52 + * @api {put} /:unidade/arquivos/:arquivo Adicionar conteúdo arquivo
  53 + * @apiName adicionarConteudoArquivo
  54 + * @apiGroup Arquivo
  55 + * @apiVersion 2.0.0
  56 + *
  57 + * @apiPermission RO_SEI_BROKER
  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.
  61 + *
  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.
  64 + *
  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.
  68 + *
  69 + * @apiExample Exemplo de requisição:
  70 + * endpoint: https://<host>/sei-broker/service/COSAP/arquivos/123456
  71 + *
  72 + * body:
  73 + * {
  74 + * "arquivo":"123456",
  75 + * "conteudo":"Conteúdo parcial do arquivo"
  76 + * }
  77 + *
  78 + * @apiSuccess (Sucesso - 200) {ArquivoCriado} arquivo Objeto de retorno da criação do arquivo
  79 + * @apiSuccess (Sucesso - 200) {String} arquivo.identificador Identificador do arquivo criado.
  80 + *
  81 + * @apiSuccess (Sucesso Response Header - 200) {header} Location URL de acesso ao recurso alterado.
  82 + *
  83 + * @apiSuccessExample {json} Success-Response:
  84 + * HTTP/1.1 200 Created
  85 + * {
  86 + * "identificador":"123456"
  87 + * }
  88 + *
  89 + * @apiErrorExample {json} Error-Response:
  90 + * HTTP/1.1 500 Internal Server Error
  91 + * {
  92 + * "error":"Mensagem de erro."
  93 + * "code":"código do erro"
  94 + * }
  95 + */
  96 +
... ...
src/main/resources/apidoc/bloco.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,360 @@
  1 + /**
  2 + * @api {get} /:unidade/blocos/:bloco Consultar bloco
  3 + * @apiName consultarBloco
  4 + * @apiGroup Bloco
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Recupera as informações do bloco informado.
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  12 + * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja consultar
  13 + *
  14 + * @apiParam (Query Parameters) {String} [protocolos=N] S ou N para exibir os protocolos do bloco
  15 + *
  16 + * @apiExample {curl} Exemplo de requisição:
  17 + * curl -i http://<host>/sei-broker/service/COSAP/blocos/12
  18 + *
  19 + * @apiSuccess (Sucesso - 200) {RetornoConsultaBloco} bloco Objeto representando o bloco encontrado
  20 + * @apiSuccess (Sucesso - 200) {String} bloco.idBloco Número do bloco
  21 + * @apiSuccess (Sucesso - 200) {Unidade} bloco.unidade Dados das unidade que gerou o bloco
  22 + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.idUnidade Identificador da Unidade
  23 + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sigla Sigla da unidade
  24 + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.descricao Descrição do unidade
  25 + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinProtocolo :TODO pendente
  26 + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinArquivamento :TODO pendente
  27 + * @apiSuccess (Sucesso - 200) {String} bloco.unidade.sinOuvidoria :TODO pendente
  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)
  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
  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
  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
  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
  44 + * @apiSuccess (Sucesso - 200) {String} bloco.protocolos.assinaturas.idOrigem :TODO pendente
  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
  47 + *
  48 + * @apiErrorExample {json} Error-Response:
  49 + * HTTP/1.1 500 Internal Server Error
  50 + * {
  51 + * "error":"Mensagem de erro."
  52 + * "code":"código do erro"
  53 + * }
  54 + */
  55 +
  56 + /**
  57 + * @api {post} /:unidade/blocos/disponibilizados Disponibilizar bloco
  58 + * @apiName disponibilizarBloco
  59 + * @apiGroup Bloco
  60 + * @apiVersion 2.0.0
  61 + *
  62 + * @apiPermission RO_SEI_BROKER
  63 + *
  64 + * @apiDescription Disponibiliza um determinado bloco.
  65 + *
  66 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  67 + *
  68 + * @apiParam (Request Body) {String} bloco Numero do bloco que deseja disponibilizar
  69 + *
  70 + * @apiExample Exemplo de requisição:
  71 + * endpoint: [POST] http://<host>/sei-broker/service/COSAP/blocos/disponibilizados
  72 + *
  73 + * body:
  74 + * 12
  75 + *
  76 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  77 + *
  78 + * @apiErrorExample {json} Error-Response:
  79 + * HTTP/1.1 500 Internal Server Error
  80 + * {
  81 + * "error":"Mensagem de erro."
  82 + * "code":"código do erro"
  83 + * }
  84 + */
  85 +
  86 + /**
  87 + * @api {delete} /:unidade/blocos/disponibilizados/12 Indisponibilizar bloco
  88 + * @apiName cancelarDisponibilizacaoBloco
  89 + * @apiGroup Bloco
  90 + * @apiVersion 2.0.0
  91 + *
  92 + * @apiPermission RO_SEI_BROKER
  93 + *
  94 + * @apiDescription Cancela a disponibilização de blocos.
  95 + *
  96 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  97 + * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja indisponibilizar
  98 + *
  99 + * @apiExample Exemplo de requisição:
  100 + * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/disponibilizados/12
  101 + *
  102 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  103 + *
  104 + * @apiErrorExample {json} Error-Response:
  105 + * HTTP/1.1 500 Internal Server Error
  106 + * {
  107 + * "error":"Mensagem de erro."
  108 + * "code":"código do erro"
  109 + * }
  110 + */
  111 +
  112 + /**
  113 + * @api {delete} /:unidade/blocos/:bloco Excluir bloco
  114 + * @apiName excluirBloco
  115 + * @apiGroup Bloco
  116 + * @apiVersion 2.0.0
  117 + *
  118 + * @apiPermission RO_SEI_BROKER
  119 + *
  120 + * @apiDescription Exclui um bloco criado.
  121 + *
  122 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  123 + * @apiParam (Path Parameters) {String} bloco Numero do bloco que deseja excluir
  124 + *
  125 + * @apiExample Exemplo de requisição:
  126 + * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/12
  127 + *
  128 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  129 + *
  130 + * @apiErrorExample {json} Error-Response:
  131 + * HTTP/1.1 500 Internal Server Error
  132 + * {
  133 + * "error":"Mensagem de erro."
  134 + * "code":"código do erro"
  135 + * }
  136 + */
  137 +
  138 + /**
  139 + * @api {post} /:unidade/blocos Gerar bloco
  140 + * @apiName gerarBloco
  141 + * @apiGroup Bloco
  142 + * @apiVersion 2.0.0
  143 + *
  144 + * @apiPermission RO_SEI_BROKER
  145 + *
  146 + * @apiDescription Gera um novo bloco.
  147 + *
  148 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  149 + *
  150 + * @apiParam (Request Body) {NovoBloco} novoBloco Objeto de criação de bloco
  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
  155 + * @apiParam (Request Body) {Boolean} novoBloco.disponibilizar=false Informa se o bloco criado deve ser disponibilizado automaticamente
  156 + *
  157 + * @apiExample Exemplo de requisição:
  158 + * endpoint: http://<host>/sei-broker/service/COSAP/blocos
  159 + *
  160 + * body:
  161 + * {
  162 + * "tipo":"ASSINATURA",
  163 + * "descricao":"Bloco demonstrativo.",
  164 + * "unidades":["110000935"],
  165 + * "documentos":["0000131"],
  166 + * "disponibilizar":true
  167 + * }
  168 + *
  169 + * @apiSuccess (Sucesso Response Body - 201) {String} resultado Código do bloco criado
  170 + *
  171 + * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado
  172 + *
  173 + * @apiErrorExample {json} Error-Response:
  174 + * HTTP/1.1 500 Internal Server Error
  175 + * {
  176 + * "error":"Mensagem de erro."
  177 + * "code":"código do erro"
  178 + * }
  179 + */
  180 +
  181 + /**
  182 + * @api {POST} /:unidade/blocos/:bloco/documentos Incluir documento
  183 + * @apiName incluirDocumentoNoBloco
  184 + * @apiGroup Bloco
  185 + * @apiVersion 2.0.0
  186 + *
  187 + * @apiPermission RO_SEI_BROKER
  188 + *
  189 + * @apiDescription Inclui um documento no bloco.
  190 + *
  191 + * @apiParam (Header Parameters) {String} Content-Type Informar text/plain
  192 + *
  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
  195 + *
  196 + * @apiParam (Request Body) {String} documento Número do documento que será incluído do bloco
  197 + *
  198 + * @apiExample Exemplo de requisição:
  199 + * endpoint: [POST] http://<host>/sei-broker/service/COSAP/blocos/12/documentos
  200 + *
  201 + * body:
  202 + * 0000050
  203 + *
  204 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  205 + *
  206 + * @apiErrorExample {json} Error-Response:
  207 + * HTTP/1.1 500 Internal Server Error
  208 + * {
  209 + * "error":"Mensagem de erro."
  210 + * "code":"código do erro"
  211 + * }
  212 + */
  213 +
  214 + /**
  215 + * @api {POST} /:unidade/blocos/:bloco/documentos Incluir documento anotado
  216 + * @apiName incluirDocumentoComAnotacaoNoBloco
  217 + * @apiGroup Bloco
  218 + * @apiVersion 2.0.0
  219 + *
  220 + * @apiPermission RO_SEI_BROKER
  221 + *
  222 + * @apiDescription Inclui um documento no bloco.
  223 + *
  224 + * @apiParam (Header Parameters) {String} Content-Type Informar application/json
  225 + *
  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
  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
  233 + *
  234 + * @apiExample Exemplo de requisição:
  235 + * endpoint: [POST] http://<host>/sei-broker/service/COSAP/blocos/12/documentos
  236 + *
  237 + * @apiErrorExample {json} Error-Response:
  238 + * HTTP/1.1 500 Internal Server Error
  239 + * {
  240 + * "error":"Mensagem de erro."
  241 + * "code":"código do erro"
  242 + * }
  243 + */
  244 +
  245 + /**
  246 + * @api {delete} /:unidade/:bloco/documentos/:documento Remover documento
  247 + * @apiName retirarDocumentoDoBloco
  248 + * @apiGroup Bloco
  249 + * @apiVersion 2.0.0
  250 + *
  251 + * @apiPermission RO_SEI_BROKER
  252 + *
  253 + * @apiDescription Remove o documento do bloco.
  254 + *
  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
  258 + *
  259 + * @apiExample Exemplo de requisição:
  260 + * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/12/documentos/0000050
  261 + *
  262 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  263 + *
  264 + * @apiErrorExample {json} Error-Response:
  265 + * HTTP/1.1 500 Internal Server Error
  266 + * {
  267 + * "error":"Mensagem de erro."
  268 + * "code":"código do erro"
  269 + * }
  270 + */
  271 +
  272 + /**
  273 + * @api {post} /:unidade/blocos/:bloco/processos Incluir processo
  274 + * @apiName incluirProcessoNoBloco
  275 + * @apiGroup Bloco
  276 + * @apiVersion 2.0.0
  277 + *
  278 + * @apiPermission RO_SEI_BROKER
  279 + *
  280 + * @apiDescription Inclui um processo no bloco.
  281 + *
  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
  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
  286 + *
  287 + * @apiParam (Request Body) {String} processo Numero do processo que será incluído no bloco
  288 + *
  289 + * @apiExample Exemplo de requisição:
  290 + * curl -X PUT http://<host>/sei-broker/service/COSAP/blocos/12/processos
  291 + *
  292 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  293 + *
  294 + * @apiErrorExample {json} Error-Response:
  295 + * HTTP/1.1 500 Internal Server Error
  296 + * {
  297 + * "error":"Mensagem de erro."
  298 + * "code":"código do erro"
  299 + * }
  300 + */
  301 +
  302 + /**
  303 + * @api {post} /:unidade/blocos/:bloco/processos Incluir processo anotado
  304 + * @apiName incluirProcessoComAnotacaoNoBloco
  305 + * @apiGroup Bloco
  306 + * @apiVersion 2.0.0
  307 + *
  308 + * @apiPermission RO_SEI_BROKER
  309 + *
  310 + * @apiDescription Inclui um processo no bloco, junto com uma anotação.
  311 + *
  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
  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
  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
  321 + *
  322 + * @apiExample Exemplo de requisição:
  323 + * curl -X PUT http://<host>/sei-broker/service/COSAP/blocos/12/processos
  324 + *
  325 + * @apiErrorExample {json} Error-Response:
  326 + * HTTP/1.1 500 Internal Server Error
  327 + * {
  328 + * "error":"Mensagem de erro."
  329 + * "code":"código do erro"
  330 + * }
  331 + */
  332 +
  333 + /**
  334 + * @api {delete} /:unidade/blocos/:bloco/processos/:processo Remover processo
  335 + * @apiName retirarProcessoDoBloco
  336 + * @apiGroup Bloco
  337 + * @apiVersion 2.0.0
  338 + *
  339 + * @apiPermission RO_SEI_BROKER
  340 + *
  341 + * @apiDescription Este método remove o processo do bloco.
  342 + *
  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
  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
  348 + *
  349 + * @apiExample Exemplo de requisição:
  350 + * curl -X DELETE http://<host>/sei-broker/service/COSAP/blocos/12/processos/33910000029201653
  351 + *
  352 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  353 + *
  354 + * @apiErrorExample {json} Error-Response:
  355 + * HTTP/1.1 500 Internal Server Error
  356 + * {
  357 + * "error":"Mensagem de erro."
  358 + * "code":"código do erro"
  359 + * }
  360 + */
... ...
src/main/resources/apidoc/cargo.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,30 @@
  1 + /**
  2 + * @api {get} /:unidade/cargos Listar cargos
  3 + * @apiName listarCargos
  4 + * @apiGroup Cargo
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Lista os cargos.
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  12 + *
  13 + * @apiParam (Query Parameters) {String} [idCargo] Identificador do cargo
  14 + *
  15 + * @apiExample Exemplo de requisição:
  16 + * curl -i http://<host>/sei-broker/service/COSAP/cargos
  17 + *
  18 + * @apiSuccess (Sucesso - 200) {Cargo[]} resultado Lista com os cargos encontrados
  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)
  22 + * @apiSuccess (Sucesso - 200) {String} resultado.expressaoVocativo Vocativo para o cargo (Ex.: Senhor Governador)
  23 + *
  24 + * @apiErrorExample {json} Error-Response:
  25 + * HTTP/1.1 500 Internal Server Error
  26 + * {
  27 + * "error":"Mensagem de erro."
  28 + * "code":"código do erro"
  29 + * }
  30 + */
0 31 \ No newline at end of file
... ...
src/main/resources/apidoc/contato.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,361 @@
  1 + /**
  2 + * @api {get} /:unidade/contatos/tipos Tipos de contato
  3 + * @apiName listarTipos
  4 + * @apiGroup Contato
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Consulta os tipos de contato.
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  12 + *
  13 + * @apiExample Exemplo de requisição:
  14 + * curl -i http://<host>/sei-broker/service/cosap/contatos/tipos
  15 + *
  16 + * @apiSuccess (Sucesso - 200) {TipoContato[]} resultado Lista com os tipos de contato, representados por uma Enum TipoContato.
  17 + *
  18 + * @apiErrorExample {json} Error-Response:
  19 + * HTTP/1.1 500 Internal Server Error
  20 + * {
  21 + * "error":"Mensagem de erro."
  22 + * "code":"código do erro"
  23 + * }
  24 + */
  25 +
  26 + /**
  27 + * @api {get} /:unidade/contatos/:tipo Listar contatos
  28 + * @apiName listarContatos
  29 + * @apiGroup Contato
  30 + * @apiVersion 2.0.0
  31 + *
  32 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  33 + *
  34 + * @apiDescription Consulta os contatos de determinado tipo, o retorno pode ser PessoaFisica ou PessoaJuridica é recomendado utilizar a ans-commons-sei.
  35 + *
  36 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  37 + * @apiParam (Path Parameters) {String} tipo Tipo do contato
  38 + *
  39 + * @apiParam (Query Parameters) {String} [nome] Nome do contato
  40 + * @apiParam (Query Parameters) {String} [cpf] CPF do contato
  41 + * @apiParam (Query Parameters) {String} [cnpj] CNPJ do contato
  42 + * @apiParam (Query Parameters) {String} [sigla] Sigla(login) do contato
  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
  46 + *
  47 + * @apiExample Exemplo de requisição:
  48 + * curl -i http://<host>/sei-broker/service/cosap/contatos/operadoras?qtdRegistros=20
  49 + *
  50 + * @apiSuccess (Sucesso - 200) {List} resultado Lista com os contatos encontrados.
  51 + * @apiSuccess (Sucesso - 200) {Pessoa} resultado.pessoa Pessoa que representa o contato.
  52 + * @apiSuccess (Sucesso - 200) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa.
  53 + * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.nome Nome do contato.
  54 + * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.sigla Sigla(login) do contato.
  55 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato.
  56 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
  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.
  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.
  70 + * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
  71 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
  72 + * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
  73 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
  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.
  76 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
  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.
  79 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
  80 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
  81 + *
  82 + * @apiSuccessExample {json} Success-Response:
  83 + * HTTP/1.1 200 OK
  84 + * {
  85 + * "@type": "Juridica",
  86 + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
  87 + * "endereco": {
  88 + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
  89 + * "complemento": "Teste de complemento",
  90 + * "numero": null,
  91 + * "uf": "MG",
  92 + * "pais": "Brasil",
  93 + * "cidade": "3101508",
  94 + * "bairro": "PRAÇA DA BANDEIRA",
  95 + * "cep": "36660000"
  96 + * },
  97 + * "email": "teste@email.com",
  98 + * "celular": "(32)982538993",
  99 + * "telefone": "(32)34624649",
  100 + * "observacao": "Observado via SEI-Broker",
  101 + * "ativo": true,
  102 + * "associado": null,
  103 + * "cnpj": "19541931000125",
  104 + * "website": "sitiodopicapauamarelo.com.br"
  105 + * }
  106 + *
  107 + * @apiErrorExample {json} Error-Response:
  108 + * HTTP/1.1 500 Internal Server Error
  109 + * {
  110 + * "error":"Mensagem de erro."
  111 + * "code":"código do erro"
  112 + * }
  113 + */
  114 +
  115 + /**
  116 + * @api {get} /:unidade/contatos/:tipo/:sigla Consultar contato
  117 + * @apiName getContato
  118 + * @apiGroup Contato
  119 + * @apiVersion 2.0.0
  120 + *
  121 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  122 + *
  123 + * @apiDescription Consulta contato pela sigla(login)
  124 + *
  125 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  126 + * @apiParam (Path Parameters) {String} tipo Tipo do contato
  127 + * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato
  128 + *
  129 + * @apiExample Exemplo de requisição:
  130 + * curl -i http://<host>/sei-broker/service/cosap/contatos/operadoras/419761
  131 + *
  132 + * @apiSuccess (Sucesso - 200) {Pessoa} resultado.pessoa Pessoa que representa o contato.
  133 + * @apiSuccess (Sucesso - 200) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa.
  134 + * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.nome Nome do contato.
  135 + * @apiSuccess (Sucesso - 200) {String} resultado.pessoa.sigla Sigla(login) do contato.
  136 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.email] Email do contato.
  137 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
  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.
  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.
  151 + * @apiSuccess (Sucesso - 200) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
  152 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
  153 + * @apiSuccess (Sucesso - 200) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
  154 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
  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.
  157 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
  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.
  160 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
  161 + * @apiSuccess (Sucesso - 200) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
  162 + *
  163 + * @apiSuccessExample {json} Success-Response:
  164 + * HTTP/1.1 200 OK
  165 + * {
  166 + * "@type": "Juridica",
  167 + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
  168 + * "sigla": "419761",
  169 + * "endereco": {
  170 + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
  171 + * "complemento": "Teste de complemento",
  172 + * "numero": null,
  173 + * "uf": "MG",
  174 + * "pais": "Brasil",
  175 + * "cidade": "3101508",
  176 + * "bairro": "PRAÇA DA BANDEIRA",
  177 + * "cep": "36660000"
  178 + * },
  179 + * "email": "teste@email.com",
  180 + * "celular": "(32)982538993",
  181 + * "telefone": "(32)34624649",
  182 + * "observacao": "Observado via SEI-Broker",
  183 + * "ativo": true,
  184 + * "associado": null,
  185 + * "cnpj": "19541931000125",
  186 + * "website": "sitiodopicapauamarelo.com.br"
  187 + * }
  188 + *
  189 + * @apiErrorExample {json} Error-Response:
  190 + * HTTP/1.1 500 Internal Server Error
  191 + * {
  192 + * "error":"Mensagem de erro."
  193 + * "code":"código do erro"
  194 + * }
  195 + */
  196 +
  197 + /**
  198 + * @api {post} /:unidade/contatos/:tipo Incluir contato
  199 + * @apiName criarContato
  200 + * @apiGroup Contato
  201 + * @apiVersion 2.0.0
  202 + *
  203 + * @apiPermission RO_SEI_BROKER
  204 + *
  205 + * @apiDescription Incluir contato
  206 + *
  207 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  208 + * @apiParam (Path Parameters) {String} tipo Tipo do contato
  209 + *
  210 + * @apiParam (Request Body) {Pessoa} resultado.pessoa Pessoa que representa o contato.
  211 + * @apiParam (Request Body) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa.
  212 + * @apiParam (Request Body) {String} resultado.pessoa.nome Nome do contato.
  213 + * @apiParam (Request Body) {String} resultado.pessoa.sigla Sigla(login) do contato.
  214 + * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato.
  215 + * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
  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.
  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.
  229 + * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
  230 + * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
  231 + * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
  232 + * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
  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.
  235 + * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
  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.
  238 + * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
  239 + * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
  240 + *
  241 + * @apiExample Exemplo de requisição:
  242 + * endpoint: http://<host>/sei-broker/service/cosap/contatos/operadoras
  243 + *
  244 + * body:
  245 + * {
  246 + * "@type": "Juridica",
  247 + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
  248 + * "sigla": "419761",
  249 + * "endereco": {
  250 + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
  251 + * "complemento": "Teste de complemento",
  252 + * "numero": null,
  253 + * "uf": "MG",
  254 + * "pais": "Brasil",
  255 + * "cidade": "3101508",
  256 + * "bairro": "PRAÇA DA BANDEIRA",
  257 + * "cep": "36660000"
  258 + * },
  259 + * "email": "teste@email.com",
  260 + * "celular": "(32)982538993",
  261 + * "telefone": "(32)34624649",
  262 + * "observacao": "Observado via SEI-Broker",
  263 + * "ativo": true,
  264 + * "associado": null,
  265 + * "cnpj": "19541931000125",
  266 + * "website": "sitiodopicapauamarelo.com.br"
  267 + * }
  268 + *
  269 + * @apiSuccess (Criado - 201) {header} Location URL de acesso ao recurso criado.
  270 + *
  271 + * @apiErrorExample {json} Error-Response:
  272 + * HTTP/1.1 500 Internal Server Error
  273 + * {
  274 + * "error":"Mensagem de erro."
  275 + * "code":"código do erro"
  276 + * }
  277 + */
  278 +
  279 + /**
  280 + * @api {put} /:unidade/contatos/:tipo/:sigla Atualizar contato
  281 + * @apiName atualizarContato
  282 + * @apiGroup Contato
  283 + * @apiVersion 2.0.0
  284 + *
  285 + * @apiPermission RO_SEI_BROKER
  286 + *
  287 + * @apiDescription Atualizar contato
  288 + *
  289 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  290 + * @apiParam (Path Parameters) {String} tipo Tipo do contato
  291 + * @apiParam (Path Parameters) {String} sigla Sigla(login) do contato
  292 + *
  293 + * @apiParam (Request Body) {Pessoa} resultado.pessoa Pessoa que representa o contato.
  294 + * @apiParam (Request Body) {String="Fisica","Juridica"} resultado.pessoa.type Tipo de pessoa.
  295 + * @apiParam (Request Body) {String} resultado.pessoa.nome Nome do contato.
  296 + * @apiParam (Request Body) {String} resultado.pessoa.sigla Sigla(login) do contato.
  297 + * @apiParam (Request Body) {String} [resultado.pessoa.email] Email do contato.
  298 + * @apiParam (Request Body) {String} [resultado.pessoa.telefone] Telefone fixo do contato.
  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.
  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.
  312 + * @apiParam (Request Body) {String="Juridica"} resultado.pessoa.associado.type Tipo de pessoa, neste caso o tipo deve ser Juridica.
  313 + * @apiParam (Request Body) {String} [resultado.pessoa.associado.sigla] Sigla(login) do contato associado.
  314 + * @apiParam (Request Body) {String="MASCULINO","FEMININO"} [resultado.pessoa.sexo] Sexo do contato, presente em contatos do tipo PessoaFisica.
  315 + * @apiParam (Request Body) {String} [resultado.pessoa.cpf] CPF do contato, presente em contatos do tipo PessoaFisica.
  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.
  318 + * @apiParam (Request Body) {String} [resultado.pessoa.dataNascimento] Data de nascimento, presente em contatos do tipo PessoaFisica.
  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.
  321 + * @apiParam (Request Body) {String} [resultado.pessoa.cnpj] CNPJ do contato, presente em contatos do tipo PessoaJuridica.
  322 + * @apiParam (Request Body) {String} [resultado.pessoa.website] Site do contato, presente em contatos do tipo PessoaJuridica.
  323 + *
  324 + * @apiExample Exemplo de requisição:
  325 + * endpoint: http://<host>/sei-broker/service/cosap/contatos/operadoras
  326 + *
  327 + * body:
  328 + * {
  329 + * "@type": "Juridica",
  330 + * "nome": "18 DE JULHO ADMINISTRADORA DE BENEFÍCIOS LTDA",
  331 + * "sigla": "419761",
  332 + * "endereco": {
  333 + * "logradouro": "RUA CAPITÃO MEDEIROS DE REZENDE 274",
  334 + * "complemento": "Teste de complemento",
  335 + * "numero": null,
  336 + * "uf": "MG",
  337 + * "pais": "Brasil",
  338 + * "cidade": "3101508",
  339 + * "bairro": "PRAÇA DA BANDEIRA",
  340 + * "cep": "36660000"
  341 + * },
  342 + * "email": "teste@email.com",
  343 + * "celular": "(32)982538993",
  344 + * "telefone": "(32)34624649",
  345 + * "observacao": "Observado via SEI-Broker",
  346 + * "ativo": true,
  347 + * "associado": null,
  348 + * "cnpj": "19541931000125",
  349 + * "website": "sitiodopicapauamarelo.com.br"
  350 + * }
  351 + *
  352 + * @apiSuccessExample {json} Success-Response:
  353 + * HTTP/1.1 200 OK
  354 + *
  355 + * @apiErrorExample {json} Error-Response:
  356 + * HTTP/1.1 500 Internal Server Error
  357 + * {
  358 + * "error":"Mensagem de erro."
  359 + * "code":"código do erro"
  360 + * }
  361 + */
0 362 \ No newline at end of file
... ...
src/main/resources/apidoc/documento.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,379 @@
  1 + /**
  2 + * @api {get} /:unidade/documentos/:documento Consultar documento
  3 + * @apiName consultarDocumento
  4 + * @apiGroup Documento
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Consulta documento cadastrado no SEI.
  10 + *
  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
  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
  18 + *
  19 + * @apiExample {curl} Exemplo de requisição:
  20 + * curl -i https://<host>/sei-broker/service/COSAP/documentos/0000050?assinaturas=S&andamento=S
  21 + *
  22 + * @apiSuccess (Sucesso - 200) {RetornoConsultaDocumento} retornoConsultaDocumento Informações do documento encontrado no SEI
  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
  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
  27 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.linkAcesso Link para acesso ao documento
  28 + * @apiSuccess (Sucesso - 200) {Serie} retornoConsultaDocumento.serie Dados do tipo do documento
  29 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.idSerie Identificador do tipo de documento
  30 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.serie.nome Nome do tipo de documento
  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
  34 + * @apiSuccess (Sucesso - 200) {Unidade} retornoConsultaDocumento.unidadeElaboradora Dados da unidade que gerou o documento
  35 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.descricao Nome da unidade
  36 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.idUnidade Código da unidade
  37 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sigla Sigla da unidade
  38 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinProtocolo :TODO pendente
  39 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.unidadeElaboradora.sinArquivamento :TODO pendente
  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)
  42 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idAndamento Identificador do andamento
  43 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefa :TODO pendente
  44 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.idTarefaModulo :TODO pendente
  45 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.descricao Descrição do andamento
  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
  52 + * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} retornoConsultaDocumento.andamentoGeracao.atributos Lista com os atributos relacionados ao andamento
  53 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.nome Nome do atributo
  54 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.valor Valor do atributo
  55 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.andamentoGeracao.atributos.idOrigem :TODO pendente
  56 + * @apiSuccess (Sucesso - 200) {Assinatura[]} retornoConsultaDocumento.assinaturas Conjunto de assinaturas do documento
  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
  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
  61 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.assinaturas.idOrigem :TODO pendente
  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
  64 + * @apiSuccess (Sucesso - 200) {Publicacao} retornoConsultaDocumento.publicacao :TODO pendente
  65 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.nomeVeiculo :TODO pendente
  66 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.numero :TODO pendente
  67 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.dataDisponibilizacao :TODO pendente
  68 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.dataPublicacao :TODO pendente
  69 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.estado :TODO pendente
  70 + * @apiSuccess (Sucesso - 200) {PublicacaoImprensaNacional} retornoConsultaDocumento.publicacao.imprensaNacional :TODO pendente
  71 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.siglaVeiculo :TODO pendente
  72 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.descricaoVeiculo :TODO pendente
  73 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.pagina :TODO pendente
  74 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.secao :TODO pendente
  75 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.publicacao.imprensaNacional.data :TODO pendente
  76 + * @apiSuccess (Sucesso - 200) {Campo[]} retornoConsultaDocumento.campos Conjunto de campos do formulário
  77 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.nome Nome do campo
  78 + * @apiSuccess (Sucesso - 200) {String} retornoConsultaDocumento.campos.valor Valor do campo
  79 + *
  80 + * @apiSuccessExample {json} Success-Response:
  81 + * HTTP/1.1 200 OK
  82 + * {
  83 + * "idProcedimento":"52",
  84 + * "procedimentoFormatado":"16.0.000000005-5",
  85 + * "idDocumento":"152",
  86 + * "documentoFormatado":"0000123",
  87 + * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=procedimento_trabalhar&id_procedimento=52&id_documento=152",
  88 + * "serie":{
  89 + * "idSerie":"12",
  90 + * "nome":"Memorando"
  91 + * },
  92 + * "numero":"6",
  93 + * "data":"05/04/2016",
  94 + * "unidadeElaboradora":{
  95 + * "idUnidade":"110000934",
  96 + * "sigla":"COSAP",
  97 + * "descricao":"Coordenadoria de Sistemas e Aplicativos"
  98 + * },
  99 + * "andamentoGeracao":null,
  100 + * "assinaturas":[],
  101 + * "publicacao":null,
  102 + * "campos":[]
  103 + * }
  104 + *
  105 + * @apiErrorExample {json} Error-Response:
  106 + * HTTP/1.1 500 Internal Server Error
  107 + * {
  108 + * "error":"Mensagem de erro."
  109 + * "code":"código do erro"
  110 + * }
  111 + */
  112 +
  113 + /**
  114 + * @api {post} /:unidade/documentos Incluir documento
  115 + * @apiName incluirDocumento
  116 + * @apiGroup Documento
  117 + * @apiVersion 2.0.0
  118 + *
  119 + * @apiPermission RO_SEI_BROKER
  120 + *
  121 + * @apiDescription Inclui um documento no SEI, podem ser incluídos documentos internos e externos, para documentos externo o tamanho máximo é 20MB.
  122 + *
  123 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  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)
  126 + *
  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)
  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.
  136 + * @apiParam (Request Body) {String} [remetente.nome] Nome do remetente
  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
  139 + * @apiParam (Request Body) {String} [interessados.nome] Nome do interessado
  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
  152 + * @apiParam (Request Body) {String} [campos.nome] Nome do campo
  153 + * @apiParam (Request Body) {String} [campos.valor] Valor do campo
  154 + *
  155 + * @apiExample Exemplo de requisição:
  156 + * endpoint: https://<host>/sei-broker/service/COSAP/documentos
  157 + *
  158 + * body:
  159 + * {
  160 + * "tipo":"G",
  161 + * "idProcedimento":"33910000173201771",
  162 + * "protocoloProcedimento":null,
  163 + * "idSerie":null,
  164 + * "numero":null,
  165 + * "data":null,
  166 + * "descricao":"Documento demonstrativo",
  167 + * "remetente":null,
  168 + * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}],
  169 + * "destinatarios":[],
  170 + * "observacao":null,
  171 + * "nomeArquivo":null,
  172 + * "conteudo":"Conteúdo Base64",
  173 + * "nivelAcesso":"0"
  174 + * }
  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
  178 + * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso link para acesso ao documento
  179 + *
  180 + * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado.
  181 + *
  182 + * @apiSuccessExample {json} Success-Response:
  183 + * HTTP/1.1 201 Created
  184 + * {
  185 + * "idDocumento":"1140000000872",
  186 + * "documentoFormatado":"0003934",
  187 + * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=arvore_visualizar&acao_origem=procedimento_visualizar&id_procedimento=267&id_documento=1017&sta_editor=I&infra_sistema=100000100&infra_unidade_atual=110000934&infra_hash=3d798777382d6ac455317f3a87ad9bd1f9650315e019ef922f388b829902a95b"
  188 + * }
  189 + *
  190 + * @apiErrorExample {json} Error-Response:
  191 + * HTTP/1.1 500 Internal Server Error
  192 + * {
  193 + * "error":"Mensagem de erro."
  194 + * "code":"código do erro"
  195 + * }
  196 + */
  197 +
  198 + /**
  199 + * @api {post} /:unidade/documentos/cancelados Cancelar documento
  200 + * @apiName cancelarDocumento
  201 + * @apiGroup Documento
  202 + * @apiVersion 2.0.0
  203 + *
  204 + * @apiPermission RO_SEI_BROKER
  205 + *
  206 + * @apiDescription Cancela um documento.
  207 + *
  208 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  209 + *
  210 + * @apiParam (Request Body) {String} documento Numero do documento que será cancelado
  211 + * @apiParam (Request Body) {String} motivo Motivo do cancelamento
  212 + *
  213 + * @apiExample Exemplo de requisição:
  214 + * endpoint: https://<host>/sei-broker/service/COSAP/documentos/cancelados
  215 + *
  216 + * body:
  217 + * {
  218 + * "documento":"0000050",
  219 + * "motivo":"Motivo do cancelamento."
  220 + * }
  221 + *
  222 + *
  223 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  224 + *
  225 + * @apiErrorExample {json} Error-Response:
  226 + * HTTP/1.1 500 Internal Server Error
  227 + * {
  228 + * "error":"Mensagem de erro."
  229 + * "code":"código do erro"
  230 + * }
  231 + */
  232 +
  233 + /**
  234 + * @api {get} /:unidade/documentos/enviados-broker Listar documentos enviados
  235 + * @apiName consultarDocumentosIncluidosBroker
  236 + * @apiGroup Documento
  237 + * @apiVersion 2.0.0
  238 + *
  239 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  240 + *
  241 + * @apiDescription Consulta documentos inclusos pelo SEI-Broker.
  242 + *
  243 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  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
  250 + *
  251 + * @apiExample Exemplo de requisição:
  252 + * curl -i https://<host>/sei-broker/service/COSAP/documentos/enviados-broker?pagina=1&qtdRegsitros=30
  253 + *
  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
  264 + *
  265 + * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta
  266 + *
  267 + * @apiSuccessExample {json} Success-Response:
  268 + * HTTP/1.1 200 OK
  269 + * {
  270 + * "id": 1717,
  271 + * "data": "2016-10-31T11:59:56.016+0000",
  272 + * "nome": "Doc Homologação.pdf",
  273 + * "numero": "0003312",
  274 + * "hash": "ca7ebe0c37419db14ffd4f09485a1ebed8e8deeed594e15720da185ee32e9d19",
  275 + * "sistema": "desenv_integracao_sei",
  276 + * "unidade": "COAI",
  277 + * "processo": "33910000097201612",
  278 + * "numeroInformado":"2016ans45875"
  279 + * }
  280 + *
  281 + * @apiErrorExample {json} Error-Response:
  282 + * HTTP/1.1 500 Internal Server Error
  283 + * {
  284 + * "error":"Mensagem de erro."
  285 + * "code":"código do erro"
  286 + * }
  287 + */
  288 +
  289 + /**
  290 + * @api {get} /:unidade/documentos/:documento Exportar documento
  291 + * @apiName exportarDocumento
  292 + * @apiGroup Documento
  293 + * @apiVersion 2.0.0
  294 + *
  295 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  296 + *
  297 + * @apiDescription Exporta documentos do SEI em PDF.
  298 + *
  299 + * @apiParam (Header Parameters) {String} Accept Utilize application/pdf
  300 + *
  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
  303 + *
  304 + * @apiExample {curl} Exemplo de requisição:
  305 + * curl -i https://<host>/sei-broker/service/COSIT/documentos/0003322
  306 + *
  307 + * @apiSuccess (Sucesso - 200) {PDF} binario Arquivo no formato PDF.
  308 + *
  309 + * @apiErrorExample {json} Error-Response:
  310 + * HTTP/1.1 500 Internal Server Error
  311 + * {
  312 + * "error":"Mensagem de erro."
  313 + * "code":"código do erro"
  314 + * }
  315 + */
  316 +
  317 + /**
  318 + * @api {get} /interessados/:interessado/documentos Consultar por interessado
  319 + * @apiName consultarDocumentoInteressado
  320 + * @apiGroup Documento
  321 + * @apiVersion 2.0.0
  322 + *
  323 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  324 + *
  325 + * @apiDescription Retorna os documentos de um determinado interessado.
  326 + *
  327 + * @apiParam (Path Parameters) {String} interessado Identificador do interessado
  328 + *
  329 + * @apiParam (Query Parameters) {String} [tipo] Tipo/Série do documento
  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
  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
  335 + *
  336 + * @apiExample Exemplo de requisição:
  337 + * curl -i https://<host>/sei-broker/service/interessados/005711/documentos
  338 + *
  339 + * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados.
  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.
  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.
  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.
  351 + * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado.
  352 + *
  353 + * @apiSuccess (Sucesso Response Header - 200) {header} total_registros Quantidade de registros que existem para essa consulta
  354 + *
  355 + * @apiSuccessExample {json} Success-Response:
  356 + * HTTP/1.1 200 OK
  357 + * {
  358 + * "numero": "0670949",
  359 + * "numeroInformado": "594",
  360 + * "unidade": "COSAP",
  361 + * "origem": "RECEBIDO",
  362 + * "dataGeracao": "2015-08-10T00:00:00-03:00",
  363 + * "processo": "33910.000002/2017-41",
  364 + * "tipo": {
  365 + * "codigo": "629",
  366 + * "nome": "Relatório de Arquivamento-SIF"
  367 + * }
  368 + * "tipoConferencia": "4",
  369 + * "assinado": true
  370 + * }
  371 + *
  372 + * @apiErrorExample {json} Error-Response:
  373 + * HTTP/1.1 500 Internal Server Error
  374 + * {
  375 + * "error":"Mensagem de erro."
  376 + * "code":"código do erro"
  377 + * }
  378 + */
  379 +
... ...
src/main/resources/apidoc/extensao.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,29 @@
  1 + /**
  2 + * @api {get} /:unidade/extensoes Listar extensões
  3 + * @apiName listarExtensoesPermitidas
  4 + * @apiGroup Extensao
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Este método realiza uma busca pelas extensões de arquivos permitidas.
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  12 + *
  13 + * @apiParam (Query Parameters) {String} [extensao=null] Para filtrar por uma determinada extensão.
  14 + *
  15 + * @apiExample {curl} Exemplo de requisição:
  16 + * curl -i http://<host>/sei-broker/service/COSAP/extensoes/
  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
  22 + *
  23 + * @apiErrorExample {json} Error-Response:
  24 + * HTTP/1.1 500 Internal Server Error
  25 + * {
  26 + * "error":"Mensagem de erro."
  27 + * "code":"código do erro"
  28 + * }
  29 + */
0 30 \ No newline at end of file
... ...
src/main/resources/apidoc/hipoteseLegal.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,30 @@
  1 + /**
  2 + * @api {get} /:unidade/hipoteses-legais Listar hipóteses legais
  3 + * @apiName listarHipoteses
  4 + * @apiGroup Hipotese Legal
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Lista as hipóteses legais.
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  12 + *
  13 + * @apiParam (Query Parameters) {String} [nivelAcesso] Filtra hipóteses pelo nível de acesso associado (1 - restrito, 2 - sigiloso)
  14 + *
  15 + * @apiExample Exemplo de requisição:
  16 + * curl -i https://<host>/sei-broker/service/COSAP/hipoteses-legais
  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
  23 + *
  24 + * @apiErrorExample {json} Error-Response:
  25 + * HTTP/1.1 500 Internal Server Error
  26 + * {
  27 + * "error":"Mensagem de erro."
  28 + * "code":"código do erro"
  29 + * }
  30 + */
0 31 \ No newline at end of file
... ...
src/main/resources/apidoc/info.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,110 @@
  1 + /**
  2 + * @api {get} /info/versao Consultar versão
  3 + * @apiName getNumeroVersao
  4 + * @apiGroup Info
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiDescription Este método realiza uma consulta para saber a versão do sei-broker que está disponível.
  8 + *
  9 + * @apiExample {curl} Exemplo de requisição:
  10 + * curl -i http://<host>/sei-broker/service/info/versao
  11 + *
  12 + * @apiSuccess {String} versao Número da versão.
  13 + *
  14 + * @apiErrorExample {json} Error-Response:
  15 + * HTTP/1.1 500 Internal Server Error
  16 + * {
  17 + * "error":"Mensagem de erro."
  18 + * "code":"código do erro"
  19 + * }
  20 + */
  21 +
  22 + /**
  23 + * @api {get} /info/conexoes/mysql Testar conexão MySQL
  24 + * @apiName testMySQLConnection
  25 + * @apiGroup Info
  26 + * @apiVersion 2.0.0
  27 + *
  28 + * @apiDescription Testa a conexão com o MySQL e retorna o número de versão do banco.
  29 + *
  30 + * @apiExample {curl} Exemplo de requisição:
  31 + * curl -i http://<host>/sei-broker/service/info/conexoes/mysql
  32 + *
  33 + * @apiSuccess {String} versao Número de versão do MySQL.
  34 + *
  35 + * @apiErrorExample {json} Error-Response:
  36 + * HTTP/1.1 500 Internal Server Error
  37 + * {
  38 + * "error":"Mensagem de erro."
  39 + * "code":"código do erro"
  40 + * }
  41 + */
  42 +
  43 + /**
  44 + * @api {get} /info/conexoes/oracle Testar conexão Oracle
  45 + * @apiName testOracleConnection
  46 + * @apiGroup Info
  47 + * @apiVersion 2.0.0
  48 + *
  49 + * @apiDescription Testa a conexão com o Oracle e retorna o número de versão do banco.
  50 + *
  51 + * @apiExample {curl} Exemplo de requisição:
  52 + * curl -i http://<host>/sei-broker/service/info/conexoes/oracle
  53 + *
  54 + * @apiSuccess {String} versao Número de versão do Oracle.
  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 +
  64 + /**
  65 + * @api {get} /info/conexoes/sei Testar conexão SEI
  66 + * @apiName testSEIConnection
  67 + * @apiGroup Info
  68 + * @apiVersion 2.0.0
  69 + *
  70 + * @apiDescription Testa a conexão com o SEI fazendo uma consulta ao serviço listar unidades.
  71 + *
  72 + * @apiExample {curl} Exemplo de requisição:
  73 + * curl -i http://<host>/sei-broker/service/info/conexoes/sei
  74 + *
  75 + * @apiSuccess {String} mensagem Mensagem de sucesso.
  76 + *
  77 + * @apiErrorExample {json} Error-Response:
  78 + * HTTP/1.1 500 Internal Server Error
  79 + * {
  80 + * "error":"Mensagem de erro."
  81 + * "code":"código do erro"
  82 + * }
  83 + */
  84 +
  85 + /**
  86 + * @api {get} /info/requests Listar Requests
  87 + * @apiName getUltimosRequests
  88 + * @apiGroup Info
  89 + * @apiVersion 2.0.0
  90 + *
  91 + * @apiDescription Lista os requests recebidos pelo broker.
  92 + *
  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
  98 + *
  99 + * @apiExample {curl} Exemplo de requisição:
  100 + * curl -i http://<host>/sei-broker/service/info/requests
  101 + *
  102 + * @apiSuccess {String} mensagem Mensagem de sucesso.
  103 + *
  104 + * @apiErrorExample {json} Error-Response:
  105 + * HTTP/1.1 500 Internal Server Error
  106 + * {
  107 + * "error":"Mensagem de erro."
  108 + * "code":"código do erro"
  109 + * }
  110 + */
0 111 \ No newline at end of file
... ...
src/main/resources/apidoc/infra.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,206 @@
  1 + /**
  2 + * @api {get} /:unidade/paises Listar países
  3 + * @apiName getPaises
  4 + * @apiGroup Endereco
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Consulta países cadastrados.
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  12 + *
  13 + * @apiExample Exemplo de requisição:
  14 + * curl -i http://<host>/sei-broker/service/cosap/paises
  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.
  20 + *
  21 + * @apiSuccessExample {json} Success-Response:
  22 + * HTTP/1.1 200 OK
  23 + * {
  24 + * "idPais": "4",
  25 + * "nome": "Afeganistão"
  26 + * }
  27 + *
  28 + * @apiErrorExample {json} Error-Response:
  29 + * HTTP/1.1 500 Internal Server Error
  30 + * {
  31 + * "error":"Mensagem de erro."
  32 + * "code":"código do erro"
  33 + * }
  34 + */
  35 +
  36 + /**
  37 + * @api {get} /:unidade/estados Listar estados
  38 + * @apiName getEstados
  39 + * @apiGroup Endereco
  40 + * @apiVersion 2.0.0
  41 + *
  42 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  43 + *
  44 + * @apiDescription Consulta estados cadastrados.
  45 + *
  46 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  47 + *
  48 + * @apiExample Exemplo de requisição:
  49 + * curl -i http://<host>/sei-broker/service/cosap/estados
  50 + *
  51 + * @apiSuccess (Sucesso - 200) {List} resultado Lista com os estados.
  52 + * @apiSuccess (Sucesso - 200) {Estado} resultado.estado Objeto representando um estado.
  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.
  55 + * @apiSuccess (Sucesso - 200) {String} resultado.estado.sigla Sigla do estado.
  56 + * @apiSuccess (Sucesso - 200) {String} resultado.estado.nome Nome do estado.
  57 + * @apiSuccess (Sucesso - 200) {String} resultado.estado.codigoIbge Código do IBGE.
  58 + *
  59 + * @apiSuccessExample {json} Success-Response:
  60 + * HTTP/1.1 200 OK
  61 + * {
  62 + * "idEstado": "2",
  63 + * "idPais": "76",
  64 + * "sigla": "AC",
  65 + * "nome": "Acre",
  66 + * "codigoIbge": "12"
  67 + * }
  68 + *
  69 + * @apiErrorExample {json} Error-Response:
  70 + * HTTP/1.1 500 Internal Server Error
  71 + * {
  72 + * "error":"Mensagem de erro."
  73 + * "code":"código do erro"
  74 + * }
  75 + */
  76 +
  77 + /**
  78 + * @api {get} /:unidade/estados Consultar estado
  79 + * @apiName getEstado
  80 + * @apiGroup Endereco
  81 + * @apiVersion 2.0.0
  82 + *
  83 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  84 + *
  85 + * @apiDescription Consulta o estado pela sigla.
  86 + *
  87 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  88 + * @apiParam (Path Parameters) {String} sigla Sigla do estado
  89 + *
  90 + * @apiParam (Query Parameters) {String} [pais="76 (Brasil)"] Identificador do pais que deseja listar os estados.
  91 + *
  92 + * @apiExample Exemplo de requisição:
  93 + * curl -i http://<host>/sei-broker/service/cosap/estados/AC
  94 + *
  95 + * @apiSuccess (Sucesso - 200) {Estado} estado Objeto representando um estado.
  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.
  98 + * @apiSuccess (Sucesso - 200) {String} estado.sigla Sigla do estado.
  99 + * @apiSuccess (Sucesso - 200) {String} estado.nome Nome do estado.
  100 + * @apiSuccess (Sucesso - 200) {String} estado.codigoIbge Código do IBGE.
  101 + *
  102 + * @apiSuccessExample {json} Success-Response:
  103 + * HTTP/1.1 200 OK
  104 + * {
  105 + * "idEstado": "2",
  106 + * "idPais": "76",
  107 + * "sigla": "AC",
  108 + * "nome": "Acre",
  109 + * "codigoIbge": "12"
  110 + * }
  111 + *
  112 + * @apiErrorExample {json} Error-Response:
  113 + * HTTP/1.1 500 Internal Server Error
  114 + * {
  115 + * "error":"Mensagem de erro."
  116 + * "code":"código do erro"
  117 + * }
  118 + */
  119 +
  120 + /**
  121 + * @api {get} /:unidade/estados/:estado/cidades Listar cidades
  122 + * @apiName getCidades
  123 + * @apiGroup Endereco
  124 + * @apiVersion 2.0.0
  125 + *
  126 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  127 + *
  128 + * @apiDescription Consulta as cidades de um determinado estado.
  129 + *
  130 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  131 + * @apiParam (Path Parameters) {String} estado Sigla do estado.
  132 + *
  133 + * @apiParam (Query Parameters) {String} [filtro] String utilizada para filtrar as cidades.
  134 + *
  135 + * @apiExample Exemplo de requisição:
  136 + * curl -i http://<host>/sei-broker/service/cosap/estados/rj/cidades?filtro=paraiba
  137 + *
  138 + * @apiSuccess (Sucesso - 200) {List} resultado Lista com os cidades encontradas.
  139 + * @apiSuccess (Sucesso - 200) {Cidade} resultado.cidade Objeto representando uma cidade.
  140 + * @apiSuccess (Sucesso - 200) {String} resultado.cidade.nome Nome da cidade.
  141 + * @apiSuccess (Sucesso - 200) {String} resultado.cidade.codigoIbge Código do IBGE.
  142 + * @apiSuccess (Sucesso - 200) {Estado} resultado.cidade.estado Objeto representando um estado.
  143 + * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.nome Nome do estado.
  144 + * @apiSuccess (Sucesso - 200) {String} resultado.cidade.estado.sigla Sigla do estado.
  145 + *
  146 + * @apiSuccessExample {json} Success-Response:
  147 + * HTTP/1.1 200 OK
  148 + * {
  149 + * "estado": {
  150 + * "sigla": "RJ",
  151 + * "nome": "Rio de Janeiro"
  152 + * },
  153 + * "nome": "Paraíba do Sul",
  154 + * "codigoIbge": "3303708"
  155 + * }
  156 + *
  157 + * @apiErrorExample {json} Error-Response:
  158 + * HTTP/1.1 500 Internal Server Error
  159 + * {
  160 + * "error":"Mensagem de erro."
  161 + * "code":"código do erro"
  162 + * }
  163 + */
  164 +
  165 + /**
  166 + * @api {get} /:unidade/estados/:estado/cidades/:cidade Consultar cidade
  167 + * @apiName getCidade
  168 + * @apiGroup Endereco
  169 + * @apiVersion 2.0.0
  170 + *
  171 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  172 + *
  173 + * @apiDescription Consulta a cidade pelo código do IBGE.
  174 + *
  175 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  176 + * @apiParam (Path Parameters) {String} estado Sigla do estado.
  177 + * @apiParam (Path Parameters) {String} cidade Código do IBGE.
  178 + *
  179 + * @apiExample Exemplo de requisição:
  180 + * curl -i http://<host>/sei-broker/service/cosap/estados/rj/cidades/3303708
  181 + *
  182 + * @apiSuccess (Sucesso - 200) {Cidade} cidade Objeto representando uma cidade.
  183 + * @apiSuccess (Sucesso - 200) {String} cidade.nome Nome da cidade.
  184 + * @apiSuccess (Sucesso - 200) {String} cidade.codigoIbge Código do IBGE.
  185 + * @apiSuccess (Sucesso - 200) {Estado} cidade.estado Objeto representando um estado.
  186 + * @apiSuccess (Sucesso - 200) {String} cidade.estado.nome Nome do estado.
  187 + * @apiSuccess (Sucesso - 200) {String} cidade.estado.sigla Sigla do estado.
  188 + *
  189 + * @apiSuccessExample {json} Success-Response:
  190 + * HTTP/1.1 200 OK
  191 + * {
  192 + * "estado": {
  193 + * "sigla": "RJ",
  194 + * "nome": "Rio de Janeiro"
  195 + * },
  196 + * "nome": "Paraíba do Sul",
  197 + * "codigoIbge": "3303708"
  198 + * }
  199 + *
  200 + * @apiErrorExample {json} Error-Response:
  201 + * HTTP/1.1 500 Internal Server Error
  202 + * {
  203 + * "error":"Mensagem de erro."
  204 + * "code":"código do erro"
  205 + * }
  206 + */
0 207 \ No newline at end of file
... ...
src/main/resources/apidoc/marcador.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,60 @@
  1 + /**
  2 + * @api {get} /:unidade/marcadores Listar marcadores
  3 + * @apiName listarMarcadores
  4 + * @apiGroup Marcador
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Lista os marcadores de uma unidade.
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  12 + *
  13 + * @apiExample {curl} Exemplo de requisição:
  14 + * curl -i https://<host>/sei-broker/service/cosap/marcadores
  15 + *
  16 + * @apiSuccess (Sucesso - 200) {Marcador[]} marcadores Lista de marcadores
  17 + * @apiSuccess (Sucesso - 200) {String} marcadores.id Identificador do marcador.
  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.
  21 + *
  22 + * @apiErrorExample {json} Error-Response:
  23 + * HTTP/1.1 500 Internal Server Error
  24 + * {
  25 + * "error":"Mensagem de erro."
  26 + * "code":"código do erro"
  27 + * }
  28 + */
  29 +
  30 + /**
  31 + * @api {post} /:unidade/marcadores/:identificador/processos Adicionar Processo
  32 + * @apiName marcarProcesso
  33 + * @apiGroup Marcador
  34 + * @apiVersion 2.0.0
  35 + *
  36 + * @apiPermission RO_SEI_BROKER
  37 + *
  38 + * @apiDescription Adiciona um processo ao marcador.
  39 + *
  40 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  41 + * @apiParam (Path Parameters) {String} identificador Identificador do marcador no SEI.
  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.
  46 + *
  47 + * @apiExample {curl} Exemplo de requisição:
  48 + * curl -i https://<host>/sei-broker/service/cosap/marcadores/3/processos
  49 + *
  50 + * @apiSuccessExample {json} Success-Response:
  51 + * HTTP/1.1 201 Created
  52 + *
  53 + * @apiErrorExample {json} Error-Response:
  54 + * HTTP/1.1 500 Internal Server Error
  55 + * {
  56 + * "error":"Mensagem de erro."
  57 + * "code":"código do erro"
  58 + * }
  59 + */
  60 +
... ...
src/main/resources/apidoc/processo.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,906 @@
  1 + /**
  2 + * @api {get} /:unidade/processos/:processo Consultar processo
  3 + * @apiName consultarProcesso
  4 + * @apiGroup Processo
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Este método realiza uma consulta a processos no SEI e no SIPAR.
  10 + *
  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:
  26 + * curl -i https://<host>/sei-broker/service/COSAP/processos/33910000029201653
  27 + *
  28 + * @apiSuccess (Sucesso - 200) {ResultadoConsultaProcesso} resultadoConsultaProcesso Objeto de retorno da consulta aos processos, pode um conter processo do SEI ou do SIPAR
  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)
  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
  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
  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)
  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
  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
  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
  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
  57 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI
  58 + * @apiSuccess (Sucesso - 200) {Interessado} resultadoConsultaProcesso.sei.interessados Lista de interessados no processo (opcional)
  59 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.nome Nome do interessado
  60 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.interessados.sigla Login do interessado
  61 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.idProcedimento Id interno do processo no SEI
  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
  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
  68 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.observacoes.unidade.sigla Sigla da unidade
  69 + * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosAnexados Lista com os processos anexados
  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
  72 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosAnexados.tipoProcedimento Tipo do processo
  73 + * @apiSuccess (Sucesso - 200) {ProcedimentoResumido} resultadoConsultaProcesso.sei.procedimentosRelacionados Lista com os processos relacionados
  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
  76 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentosRelacionados.tipoProcedimento Tipo do processo
  77 + *
  78 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.procedimentoFormatado Número do processo visível para o usuário
  79 + * @apiSuccess (Sucesso - 200) {TipoProcedimento} resultadoConsultaProcesso.sei.tipoProcedimento Tipo de procedimento
  80 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.idTipoProcedimento Identificador do tipo de procedimento
  81 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.tipoProcedimento.nome Nome do tipo de procedimento
  82 + * @apiSuccess (Sucesso - 200) {Andamento} resultadoConsultaProcesso.sei.ultimoAndamento Ultimo andamento do processo (opcional)
  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
  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
  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
  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
  97 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sei.unidadesProcedimentoAberto.unidade.sigla Sigla da unidade
  98 + *
  99 + * @apiSuccess (Sucesso - 200) {DocumentoSIPAR} resultadoConsultaProcesso.sipar Resultado de processo do SIPAR
  100 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.digito Digito do processo
  101 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.operadora Operadora relacionada ao processo
  102 + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.emissao Data de emissão
  103 + * @apiSuccess (Sucesso - 200) {Data} resultadoConsultaProcesso.sipar.registro Data de registro
  104 + * @apiSuccess (Sucesso - 200) {String} resultadoConsultaProcesso.sipar.tipo Tipo do processo
  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
  110 + *
  111 + * @apiErrorExample {json} Error-Response:
  112 + * HTTP/1.1 500 Internal Server Error
  113 + * {
  114 + * "error":"Mensagem de erro."
  115 + * "code":"código do erro"
  116 + * }
  117 + */
  118 +
  119 + /**
  120 + * @api {post} /:unidade/processos/concluidos Concluir processo
  121 + * @apiName concluirProcesso
  122 + * @apiGroup Processo
  123 + * @apiVersion 2.0.0
  124 + *
  125 + * @apiPermission RO_SEI_BROKER
  126 + *
  127 + * @apiDescription Conclui o processo informado.
  128 + *
  129 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  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
  132 + *
  133 + * @apiParam (Request Body) {String} processo Numero do processo a ser concluído
  134 + *
  135 + * @apiExample Exemplo de requisição:
  136 + * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/concluidos
  137 + *
  138 + * body:
  139 + * 33910000029201653
  140 + *
  141 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  142 + *
  143 + * @apiErrorExample {json} Error-Response:
  144 + * HTTP/1.1 500 Internal Server Error
  145 + * {
  146 + * "error":"Mensagem de erro."
  147 + * "code":"código do erro"
  148 + * }
  149 + */
  150 +
  151 + /**
  152 + * @api {post} /:unidade/processos/enviados Enviar processo
  153 + * @apiName enviarProcesso
  154 + * @apiGroup Processo
  155 + * @apiVersion 2.0.0
  156 + *
  157 + * @apiPermission RO_SEI_BROKER
  158 + *
  159 + * @apiDescription Envia processos a outras unidades.
  160 + *
  161 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI. Representa a unidade de localização atual do processo.
  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
  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.
  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.
  174 + *
  175 + * @apiExample Exemplo de requisição:
  176 + * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/enviados
  177 + *
  178 + * body:
  179 + * {
  180 + * "numeroDoProcesso":"1600000000098",
  181 + * "unidadesDestino":["110000934","110000934"],
  182 + * "manterAbertoOrigem":false,
  183 + * "removerAnotacoes":false,
  184 + * "enviarEmailNotificacao":true,
  185 + * "dataRetornoProgramado":2016-04-14T19:39:22.292+0000,
  186 + * "qtdDiasAteRetorno":5,
  187 + * "somenteDiasUteis":true}
  188 + * }
  189 + *
  190 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  191 + *
  192 + * @apiErrorExample {json} Error-Response:
  193 + * HTTP/1.1 500 Internal Server Error
  194 + * {
  195 + * "error":"Mensagem de erro."
  196 + * "code":"código do erro"
  197 + * }
  198 + */
  199 +
  200 + /**
  201 + * @api {delete} /:unidade/processos/concluidos/:processo Reabrir processo
  202 + * @apiName reabrirProcesso
  203 + * @apiGroup Processo
  204 + * @apiVersion 2.0.0
  205 + *
  206 + * @apiPermission RO_SEI_BROKER
  207 + *
  208 + * @apiDescription Reabre um processo.
  209 + *
  210 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  211 + * @apiParam (Path Parameters) {String} processo Numero do processo a ser reaberto
  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
  214 + *
  215 + * @apiExample Exemplo de requisição:
  216 + * curl -X DELETE https://<host>/sei-broker/service/COSAP/processos/concluidos/33910000029201653
  217 + *
  218 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  219 + *
  220 + * @apiErrorExample {json} Error-Response:
  221 + * HTTP/1.1 500 Internal Server Error
  222 + * {
  223 + * "error":"Mensagem de erro."
  224 + * "code":"código do erro"
  225 + * }
  226 + */
  227 +
  228 + /**
  229 + * @api {get} /:unidade/processos/tipos Tipos de processo
  230 + * @apiName listarTiposProcesso
  231 + * @apiGroup Processo
  232 + * @apiVersion 2.0.0
  233 + *
  234 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  235 + *
  236 + * @apiDescription Consulta os tipos de processo.
  237 + *
  238 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  239 + *
  240 + * @apiParam (Query Parameters) {String} [serie] Tipo do documento cadastrado no serviço
  241 + *
  242 + * @apiExample Exemplo de requisição:
  243 + * curl -i https://<host>/sei-broker/service/COSAP/processos/tipos
  244 + *
  245 + * @apiSuccess (Sucesso - 200) {Boolean} resultado Booleano informando sucesso da requisição
  246 + *
  247 + * @apiErrorExample {json} Error-Response:
  248 + * HTTP/1.1 500 Internal Server Error
  249 + * {
  250 + * "error":"Mensagem de erro."
  251 + * "code":"código do erro"
  252 + * }
  253 + */
  254 +
  255 + /**
  256 + * @api {post} /:unidade/processos Abrir processo
  257 + * @apiName abrirProcesso
  258 + * @apiGroup Processo
  259 + * @apiVersion 2.0.0
  260 + *
  261 + * @apiPermission RO_SEI_BROKER
  262 + *
  263 + * @apiDescription Abre um processo.
  264 + *
  265 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  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
  268 + *
  269 + * @apiParam (Request Body) {NovoProcesso} novoProcesso Objeto de representação de novo processo.
  270 + * @apiParam (Request Body) {Procedimento} novoProcesso.dadosProcesso Dados do processo.
  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.
  279 + * @apiParam (Request Body) {String} novoProcesso.dadosProcesso.interessados.nome Nome do interessado
  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.
  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.
  293 + * @apiParam (Request Body) {String} [novoProcesso.textoMarcador] Texto do marcador.
  294 + *
  295 + * @apiExample Exemplo de requisição:
  296 + * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos
  297 + *
  298 + * body:
  299 + * {
  300 + * "dadosProcesso":{
  301 + * "idTipoProcedimento":"100000375",
  302 + * "especificacao":"Documentação REST",
  303 + * "assuntos":[],
  304 + * "interessados":[{"sigla":"andre.guimaraes","nome":"André Luís Fernandes Guimarães"}],
  305 + * "observacao":"Exemplo de requisição",
  306 + * "nivelAcesso":0
  307 + * },
  308 + * "documentos":[],
  309 + * "processosRelacionados":["186649"],
  310 + * "unidadesDestino":["COTEC","110000935","COSAP"],
  311 + * "manterAbertoOrigem":true,
  312 + * "enviarEmailNotificacao":true,
  313 + * "qtdDiasAteRetorno":null,
  314 + * "somenteDiasUteis":false
  315 + * }
  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
  319 + * @apiSuccess (Sucesso Response Body - 201) {String} linkAcesso Link de acesso ao processo
  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
  323 + * @apiSuccess (Sucesso Response Body - 201) {String} retornoInclusaoDocumentos.linkAcesso Link para acesso ao documento
  324 + *
  325 + * @apiSuccess (Sucesso Response Header - 201) {header} Location URL de acesso ao recurso criado.
  326 + *
  327 + * @apiSuccessExample {json} Success-Response:
  328 + * HTTP/1.1 200 OK
  329 + * {
  330 + * "idProcedimento":"33910000056201626",
  331 + * "procedimentoFormatado":"33910.000056/2016-26",
  332 + * "linkAcesso":"https://sei-hm.ans.gov.br/controlador.php?acao=arvore_visualizar&acao_origem=procedimento_visualizar&id_procedimento=267&infra_sistema=100000100&infra_unidade_atual=110000934&infra_hash=7a6a75f6b8ec6b43aaffc6616159a85e35e444b9b32da54108e467bc9f3bdfab",
  333 + * "retornoInclusaoDocumentos":[]
  334 + * }
  335 + *
  336 + * @apiErrorExample {json} Error-Response:
  337 + * HTTP/1.1 500 Internal Server Error
  338 + * {
  339 + * "error":"Mensagem de erro."
  340 + * "code":"código do erro"
  341 + * }
  342 + */
  343 +
  344 + /**
  345 + * @api {get} /processos Listar processos
  346 + * @apiName consultarProcessos
  347 + * @apiGroup Processo
  348 + * @apiVersion 2.0.0
  349 + *
  350 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  351 + *
  352 + * @apiDescription Lista os processos conforme os filtros informados.
  353 + *
  354 + * @apiParam (Query Parameters) {Boolean} [crescente=false] Ordenar em ordem crescente, processos mais antigos primeiro
  355 + * @apiParam (Query Parameters) {String} [interessado] Identificador do interessado
  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
  359 + * @apiParam (Query Parameters) {String} [tipo] Identificador do tipo de processo que deseja filtrar
  360 + *
  361 + * @apiExample Exemplo de requisição:
  362 + * curl -i https://<host>/sei-broker/service/processos
  363 + *
  364 + * @apiSuccess (Sucesso Response Body - 200) {List} processos Lista com os processos encontrados
  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
  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
  373 + * @apiSuccess (Sucesso Response Body - 200) {String} processos.processoResumido.tipo.nome Nome do tipo
  374 + *
  375 + * @apiSuccess (Sucesso Response Header - 200) {header} total_registros quantidade de registros que existem para essa consulta.
  376 + *
  377 + * @apiSuccessExample {json} Success-Response:
  378 + * HTTP/1.1 200 OK
  379 + * {
  380 + * "numero": "33910007118201710",
  381 + * "numeroFormatado": "33910.007118/2017-10",
  382 + * "descricao": "D:2237021 - SUL AMÉRICA SEGURO SAÚDE S/A",
  383 + * "unidade": "NÚCLEO-RJ",
  384 + * "dataGeracao": "2017-10-09T03:00:00.000+0000",
  385 + * "tipo": {
  386 + * "codigo": "100000882",
  387 + * "nome": "Fiscalização: Sancionador"
  388 + * }
  389 + * }
  390 + *
  391 + * @apiErrorExample {json} Error-Response:
  392 + * HTTP/1.1 500 Internal Server Error
  393 + * {
  394 + * "error":"Mensagem de erro."
  395 + * "code":"código do erro"
  396 + * }
  397 + */
  398 +
  399 + /**
  400 + * @api {get} /:unidade/processos/:processo/andamentos Listar andamentos
  401 + * @apiName listarAndamentos
  402 + * @apiGroup Processo
  403 + * @apiVersion 2.0.0
  404 + *
  405 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  406 + *
  407 + * @apiDescription Lista as andamentos do processo.
  408 + *
  409 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  410 + * @apiParam (Path Parameters) {String} processo Número do processo.
  411 + *
  412 + * @apiParam (Query Parameters) {String = "S (sim), N (não)"} [exibir-atributos="N"] Sinalizador para retorno dos atributos associados.
  413 + * @apiParam (Query Parameters) {String[]} [andamento] Filtra andamentos pelos identificadores informados.
  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.
  416 + *
  417 + * @apiExample {curl} Exemplo de requisição:
  418 + * curl -i https://<host>/sei-broker/service/cosap/processos/33910003114201754/andamentos
  419 + *
  420 + * @apiSuccess (Sucesso - 200) {Andamento[]} andamentos Lista dos andamentos do processo.
  421 + * @apiSuccess (Sucesso - 200) {String} andamentos.idAndamento Identificador do andamento.
  422 + * @apiSuccess (Sucesso - 200) {String} andamentos.idTarefa Identificador da tarefa.
  423 + * @apiSuccess (Sucesso - 200) {String} andamentos.descricao Descrição do andamento.
  424 + * @apiSuccess (Sucesso - 200) {String} andamentos.dataHora Data e hora do andamento.
  425 + * @apiSuccess (Sucesso - 200) {Unidade} andamentos.unidade Unidade onde o andamento ocorreu.
  426 + * @apiSuccess (Sucesso - 200) {String} andamentos.unidade.idUnidade Identificador da unidade.
  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.
  433 + * @apiSuccess (Sucesso - 200) {AtributoAndamento[]} andamentos.atributos Lista com os atributos relacionados ao andamento.
  434 + * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.nome Nome do atributo.
  435 + * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.valor Valor do atributo.
  436 + * @apiSuccess (Sucesso - 200) {String} andamentos.atributos.idOrigem Identificador de origem do atributo.
  437 + *
  438 + * @apiErrorExample {json} Error-Response:
  439 + * HTTP/1.1 500 Internal Server Error
  440 + * {
  441 + * "error":"Mensagem de erro."
  442 + * "code":"código do erro"
  443 + * }
  444 + */
  445 +
  446 + /**
  447 + * @api {post} /:unidade/processos/:processo/andamentos Lançar andamento
  448 + * @apiName lancarAndamento
  449 + * @apiGroup Processo
  450 + * @apiVersion 2.0.0
  451 + *
  452 + * @apiPermission RO_SEI_BROKER
  453 + *
  454 + * @apiDescription Lança um andamento ao processo.
  455 + *
  456 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  457 + * @apiParam (Path Parameters) {String} processo Número do processo.
  458 + *
  459 + * @apiParam (Request Body) {NovoAndamento} novoAndamento Objeto representando o novo andamento.
  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.
  463 + *
  464 + * @apiExample Exemplo de requisição:
  465 + * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/33910003114201754/andamentos
  466 + *
  467 + * body:
  468 + * {
  469 + * "tarefa":"65",
  470 + * "atributos":{"DESCRICAO":"Novo andamento adicionado pelo SEI-Broker"}
  471 + * }
  472 + *
  473 + * @apiSuccess (Sucesso - 201) {Andamento} andamento Andamento criado.
  474 + * @apiSuccess (Sucesso - 201) {String} andamento.idAndamento Identificador do andamento.
  475 + * @apiSuccess (Sucesso - 201) {String} andamento.idTarefa Identificador da tarefa.
  476 + * @apiSuccess (Sucesso - 201) {String} andamento.descricao Descrição do andamento.
  477 + * @apiSuccess (Sucesso - 201) {String} andamento.dataHora Data e hora do andamento.
  478 + * @apiSuccess (Sucesso - 201) {Unidade} andamento.unidade Unidade onde o andamento ocorreu.
  479 + * @apiSuccess (Sucesso - 201) {String} andamento.unidade.idUnidade Identificador da unidade.
  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.
  486 + * @apiSuccess (Sucesso - 201) {AtributoAndamento[]} andamento.atributos Lista com os atributos relacionados ao andamento.
  487 + * @apiSuccess (Sucesso - 201) {String} andamento.atributos.nome Nome do atributo.
  488 + * @apiSuccess (Sucesso - 201) {String} andamento.atributos.valor Valor do atributo.
  489 + * @apiSuccess (Sucesso - 201) {String} andamento.atributos.idOrigem Identificador de origem do atributo.
  490 + *
  491 + * @apiErrorExample {json} Error-Response:
  492 + * HTTP/1.1 500 Internal Server Error
  493 + * {
  494 + * "error":"Mensagem de erro."
  495 + * "code":"código do erro"
  496 + * }
  497 + */
  498 +
  499 + /**
  500 + * @api {post} /:unidade/processos/:processo/anexados Anexar processo
  501 + * @apiName anexarProcesso
  502 + * @apiGroup Processo
  503 + * @apiVersion 2.0.0
  504 + *
  505 + * @apiPermission RO_SEI_BROKER
  506 + *
  507 + * @apiDescription Anexar um processo.
  508 + *
  509 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  510 + * @apiParam (Path Parameters) {String} processo Número do processo.
  511 + *
  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.
  514 + *
  515 + * @apiExample Exemplo de requisição:
  516 + * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/33910003114201754/anexados
  517 + *
  518 + * body:
  519 + * {
  520 + * "numero":"33910003093201777"
  521 + * }
  522 + *
  523 + * @apiSuccessExample {json} Success-Response:
  524 + * HTTP/1.1 200 OK
  525 + *
  526 + * @apiErrorExample {json} Error-Response:
  527 + * HTTP/1.1 500 Internal Server Error
  528 + * {
  529 + * "error":"Mensagem de erro."
  530 + * "code":"código do erro"
  531 + * }
  532 + */
  533 +
  534 + /**
  535 + * @api {delete} /:unidade/processos/:processo/anexados/:processoAnexado Desanexar processo
  536 + * @apiName desanexarProcesso
  537 + * @apiGroup Processo
  538 + * @apiVersion 2.0.0
  539 + *
  540 + * @apiPermission RO_SEI_BROKER
  541 + *
  542 + * @apiDescription Remove um processo anexado.
  543 + *
  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.
  547 + *
  548 + * @apiExample Exemplo de requisição:
  549 + * curl -X DELETE https://<host>/sei-broker/service/COSAP/processos/33910003114201754/anexados/33910003093201777
  550 + *
  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.
  553 + *
  554 + * @apiSuccessExample {json} Success-Response:
  555 + * HTTP/1.1 200 OK
  556 + *
  557 + * @apiErrorExample {json} Error-Response:
  558 + * HTTP/1.1 500 Internal Server Error
  559 + * {
  560 + * "error":"Mensagem de erro."
  561 + * "code":"código do erro"
  562 + * }
  563 + */
  564 +
  565 + /**
  566 + * @api {post} /:unidade/processos/bloqueados Bloquear processo
  567 + * @apiName bloquearProcesso
  568 + * @apiGroup Processo
  569 + * @apiVersion 2.0.0
  570 + *
  571 + * @apiPermission RO_SEI_BROKER
  572 + *
  573 + * @apiDescription Bloquear um processo.
  574 + *
  575 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  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.
  579 + *
  580 + * @apiExample Exemplo de requisição:
  581 + * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/bloqueados
  582 + *
  583 + * body:
  584 + * {
  585 + * "numero":"33910003093201777"
  586 + * }
  587 + *
  588 + * @apiSuccessExample {json} Success-Response:
  589 + * HTTP/1.1 200 OK
  590 + *
  591 + * @apiErrorExample {json} Error-Response:
  592 + * HTTP/1.1 500 Internal Server Error
  593 + * {
  594 + * "error":"Mensagem de erro."
  595 + * "code":"código do erro"
  596 + * }
  597 + */
  598 +
  599 + /**
  600 + * @api {delete} /:unidade/processos/bloqueados/:processo Desbloquear processo
  601 + * @apiName desbloquearProcesso
  602 + * @apiGroup Processo
  603 + * @apiVersion 2.0.0
  604 + *
  605 + * @apiPermission RO_SEI_BROKER
  606 + *
  607 + * @apiDescription Desbloquear um processo.
  608 + *
  609 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  610 + * @apiParam (Path Parameters) {String} processo Número do processo.
  611 + *
  612 + * @apiExample Exemplo de requisição:
  613 + * endpoint: [DELETE] https://<host>/sei-broker/service/COSAP/processos/bloqueados/33910003093201777
  614 + *
  615 + * @apiSuccessExample {json} Success-Response:
  616 + * HTTP/1.1 200 OK
  617 + *
  618 + * @apiErrorExample {json} Error-Response:
  619 + * HTTP/1.1 500 Internal Server Error
  620 + * {
  621 + * "error":"Mensagem de erro."
  622 + * "code":"código do erro"
  623 + * }
  624 + */
  625 +
  626 + /**
  627 + * @api {post} /:unidade/processos/:processo/relacionados Relacionar processo
  628 + * @apiName relacionarProcesso
  629 + * @apiGroup Processo
  630 + * @apiVersion 2.0.0
  631 + *
  632 + * @apiPermission RO_SEI_BROKER
  633 + *
  634 + * @apiDescription Relacionar processos.
  635 + *
  636 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  637 + * @apiParam (Path Parameters) {String} processo Número do processo.
  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.
  641 + *
  642 + * @apiExample Exemplo de requisição:
  643 + * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/33910003093201777/relacionados
  644 + *
  645 + * body:
  646 + * {
  647 + * "numero":"33910000086201632"
  648 + * }
  649 + *
  650 + * @apiSuccessExample {json} Success-Response:
  651 + * HTTP/1.1 200 OK
  652 + *
  653 + * @apiErrorExample {json} Error-Response:
  654 + * HTTP/1.1 500 Internal Server Error
  655 + * {
  656 + * "error":"Mensagem de erro."
  657 + * "code":"código do erro"
  658 + * }
  659 + */
  660 +
  661 + /**
  662 + * @api {delete} /:unidade/processos/:processo/relacionados/:processoRelacionado Desrelacionar processo
  663 + * @apiName desrelacionarProcesso
  664 + * @apiGroup Processo
  665 + * @apiVersion 2.0.0
  666 + *
  667 + * @apiPermission RO_SEI_BROKER
  668 + *
  669 + * @apiDescription Desrelacionar processos.
  670 + *
  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.
  674 + *
  675 + * @apiExample Exemplo de requisição:
  676 + * endpoint: [DELETE] https://<host>/sei-broker/service/COSAP/processos/33910000086201632/relacionados/33910003107201752
  677 + *
  678 + * @apiSuccessExample {json} Success-Response:
  679 + * HTTP/1.1 200 OK
  680 + *
  681 + * @apiErrorExample {json} Error-Response:
  682 + * HTTP/1.1 500 Internal Server Error
  683 + * {
  684 + * "error":"Mensagem de erro."
  685 + * "code":"código do erro"
  686 + * }
  687 + */
  688 +
  689 + /**
  690 + * @api {post} /:unidade/processos/sobrestados Sobrestar processo
  691 + * @apiName sobrestarProcesso
  692 + * @apiGroup Processo
  693 + * @apiVersion 2.0.0
  694 + *
  695 + * @apiPermission RO_SEI_BROKER
  696 + *
  697 + * @apiDescription Sobrestar processo.
  698 + *
  699 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  700 + *
  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.
  703 + * @apiParam (Request Body) {String} sobrestamento.motivo Motivo do sobrestamento.
  704 + * @apiParam (Request Body) {String} [sobrestamento.processoVinculado] Número do processo vinculado.
  705 + *
  706 + * @apiExample Exemplo de requisição:
  707 + * endpoint: [POST] https://<host>/sei-broker/service/COSAP/processos/sobrestados
  708 + *
  709 + * body:
  710 + * {
  711 + * "processo":"33910003093201777",
  712 + * "motivo":"Sobrestando através da camada de serviços."
  713 + * }
  714 + *
  715 + * @apiSuccessExample {json} Success-Response:
  716 + * HTTP/1.1 200 OK
  717 + *
  718 + * @apiErrorExample {json} Error-Response:
  719 + * HTTP/1.1 500 Internal Server Error
  720 + * {
  721 + * "error":"Mensagem de erro."
  722 + * "code":"código do erro"
  723 + * }
  724 + */
  725 +
  726 + /**
  727 + * @api {delete} /:unidade/processos/sobrestados/:processo Remover sobrestamento
  728 + * @apiName removerSobrestamentoProcesso
  729 + * @apiGroup Processo
  730 + * @apiVersion 2.0.0
  731 + *
  732 + * @apiPermission RO_SEI_BROKER
  733 + *
  734 + * @apiDescription Remover sobrestamento de processo.
  735 + *
  736 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  737 + * @apiParam (Path Parameters) {String} processo Número do processo.
  738 + *
  739 + * @apiExample Exemplo de requisição:
  740 + * endpoint: [DELETE] https://<host>/sei-broker/service/COSAP/processos/sobrestados/33910003093201777
  741 + *
  742 + * @apiSuccessExample {json} Success-Response:
  743 + * HTTP/1.1 200 OK
  744 + *
  745 + * @apiErrorExample {json} Error-Response:
  746 + * HTTP/1.1 500 Internal Server Error
  747 + * {
  748 + * "error":"Mensagem de erro."
  749 + * "code":"código do erro"
  750 + * }
  751 + */
  752 +
  753 + /**
  754 + * @api {get} /processos/:processo/documentos Listar documentos
  755 + * @apiName listarDocumentosPorProcesso
  756 + * @apiGroup Processo
  757 + * @apiVersion 2.0.0
  758 + *
  759 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  760 + *
  761 + * @apiDescription Retorna os documentos de um determinado processo.
  762 + *
  763 + * @apiParam (Path Parameters) {String} processo Número do processo.
  764 + *
  765 + * @apiParam (Query Parameters) {String} [tipo=null] Identificador do tipo do documento, caso seja necessário filtrar pelo tipo
  766 + * @apiParam (Query Parameters) {String = "G (gerado/interno), R (recebido/externo)"} [origem=null] Filtra os documentos por gerados ou recebidos
  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
  771 + *
  772 + * @apiExample Exemplo de requisição:
  773 + * curl -i https://<host>/sei-broker/service/processos/33910003149201793/documentos
  774 + *
  775 + * @apiSuccess (Sucesso Response Body - 200) {List} documentos Lista com os documentos encontrados.
  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.
  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.
  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.
  786 + * @apiSuccess (Sucesso Response Body - 200) {boolean} documentos.documentoResumido.assinado Boolean indicando se o documento foi assinado.
  787 + *
  788 + * @apiSuccess (Sucesso Response Header- 200) {header} total_registros Quantidade de registros que existem para essa consulta
  789 + *
  790 + * @apiSuccessExample {json} Success-Response:
  791 + * HTTP/1.1 200 OK
  792 + * {
  793 + * "numero": "0670949",
  794 + * "numeroInformado": "594",
  795 + * "origem": "RECEBIDO",
  796 + * "dataGeracao": "2015-08-10T00:00:00-03:00",
  797 + * "tipo": {
  798 + * "codigo": "629",
  799 + * "nome": "Relatório de Arquivamento-SIF"
  800 + * }
  801 + * "tipoConferencia": "4",
  802 + * "assinado": true
  803 + * }
  804 + *
  805 + * @apiErrorExample {json} Error-Response:
  806 + * HTTP/1.1 500 Internal Server Error
  807 + * {
  808 + * "error":"Mensagem de erro."
  809 + * "code":"código do erro"
  810 + * }
  811 + */
  812 +
  813 + /**
  814 + * @api {get} /processos/:processo/documentos/:documento Consultar documento
  815 + * @apiName consultarDocumentoDoProcesso
  816 + * @apiGroup Processo
  817 + * @apiVersion 2.0.0
  818 + *
  819 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  820 + *
  821 + * @apiDescription Consulta um documento de determinado processo.
  822 + *
  823 + * @apiParam (Path Parameters) {String} processo Número do processo.
  824 + * @apiParam (Path Parameters) {String} documento Número do documento.
  825 + *
  826 + * @apiExample Exemplo de requisição:
  827 + * curl -i https://<host>/sei-broker/service/processos/33910002924201874/documentos/55737058
  828 + *
  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.
  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.
  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.
  838 + * @apiSuccess (Sucesso Response Body - 200) {boolean} documentoResumido.assinado Boolean indicando se o documento foi assinado.
  839 + *
  840 + * @apiSuccessExample {json} Success-Response:
  841 + * HTTP/1.1 200 OK
  842 + * {
  843 + * "numero": "0670949",
  844 + * "numeroInformado": "594",
  845 + * "origem": "RECEBIDO",
  846 + * "dataGeracao": "2015-08-10T00:00:00-03:00",
  847 + * "tipo": {
  848 + * "codigo": "629",
  849 + * "nome": "Relatório de Arquivamento-SIF"
  850 + * }
  851 + * "tipoConferencia": "4",
  852 + * "assinado": true
  853 + * }
  854 + *
  855 + * @apiErrorExample {json} Error-Response:
  856 + * HTTP/1.1 500 Internal Server Error
  857 + * {
  858 + * "error":"Mensagem de erro."
  859 + * "code":"código do erro"
  860 + * }
  861 + */
  862 +
  863 + /**
  864 + * @api {get} /processos/:processo/unidades Consultar unidades
  865 + * @apiName consultarUnidadesProcesso
  866 + * @apiGroup Processo
  867 + * @apiVersion 2.0.0
  868 + *
  869 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  870 + *
  871 + * @apiDescription Consulta as unidades onde o processo está aberto.
  872 + *
  873 + * @apiParam (Path Parameters) {String} processo Número do processo.
  874 + *
  875 + * @apiExample Exemplo de requisição:
  876 + * curl -i https://<host>/sei-broker/service/processos/33910002924201874/unidades
  877 + *
  878 + * @apiSuccess (Sucesso Response Body - 200) {List} unidades Lista da unidades onde o processo está aberto.
  879 + * @apiSuccess (Sucesso Response Body - 200) {Unidade} unidades.unidade Objeto Unidade.
  880 + * @apiSuccess (Sucesso Response Body - 200) {String} unidades.unidade.idUnidade Identificador da unidade.
  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.
  886 + *
  887 + * @apiSuccessExample {json} Success-Response:
  888 + * HTTP/1.1 200 OK
  889 + * [
  890 + * {
  891 + * "idUnidade": "110000934",
  892 + * "sigla": "COSAP",
  893 + * "descricao": "Coordenadoria de Sistemas e Aplicativos",
  894 + * "sinProtocolo": "S",
  895 + * "sinArquivamento": "N",
  896 + * "sinOuvidoria": "N"
  897 + * }
  898 + * ]
  899 + *
  900 + * @apiErrorExample {json} Error-Response:
  901 + * HTTP/1.1 500 Internal Server Error
  902 + * {
  903 + * "error":"Mensagem de erro."
  904 + * "code":"código do erro"
  905 + * }
  906 + */
0 907 \ No newline at end of file
... ...
src/main/resources/apidoc/serie.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,61 @@
  1 + /**
  2 + * @api {get} /:unidade/series Listar séries
  3 + * @apiName listarSeries
  4 + * @apiGroup Serie
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Este método realiza uma consulta às séries.
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  12 + *
  13 + * @apiParam (Query Parameters) {String} [filtro] Para filtrar por series que contenham o trecho no nome.
  14 + * @apiParam (Query Parameters) {String} [tipo-processo=null] Para filtrar por determinado tipo de processo.
  15 + *
  16 + * @apiExample {curl} Exemplo de requisição:
  17 + * curl -i https://<host>/sei-broker/service/COSAP/series
  18 + *
  19 + * @apiSuccess (Sucesso - 200) {Serie[]} series Lista de séries.
  20 + * @apiSuccess (Sucesso - 200) {String} series.idSerie Identificador do tipo de documento
  21 + * @apiSuccess (Sucesso - 200) {String} series.nome Nome do tipo de documento
  22 + * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários
  23 + *
  24 + * @apiErrorExample {json} Error-Response:
  25 + * HTTP/1.1 500 Internal Server Error
  26 + * {
  27 + * "error":"Mensagem de erro."
  28 + * "code":"código do erro"
  29 + * }
  30 + */
  31 +
  32 + /**
  33 + * @api {get} /:unidade/tipos-documentos Listar tipos documentos
  34 + * @apiName listarTiposDocumentos
  35 + * @apiGroup Documento
  36 + * @apiVersion 2.0.0
  37 + *
  38 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  39 + *
  40 + * @apiDescription Lista os tipos de documentos do SEI.
  41 + *
  42 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  43 + *
  44 + * @apiParam (Query Parameters) {String} [filtro] Para filtrar por documentos que contenham o trecho no nome.
  45 + *
  46 + * @apiExample {curl} Exemplo de requisição:
  47 + * curl -i https://<host>/sei-broker/service/COSAP/tipos-documentos
  48 + *
  49 + * @apiSuccess (Sucesso - 200) {List} tipos Lista com os tipos de documentos
  50 + * @apiSuccess (Sucesso - 200) {String} tipos.identificador Identificador do tipo de documento
  51 + * @apiSuccess (Sucesso - 200) {String} tipos.nome Nome do tipo de documento
  52 + * @apiSuccess (Sucesso - 200) {String} series.aplicabilidade T = Documentos internos e externos, I = documentos internos, E = documentos externos e F = formulários
  53 + *
  54 + * @apiErrorExample {json} Error-Response:
  55 + * HTTP/1.1 500 Internal Server Error
  56 + * {
  57 + * "error":"Mensagem de erro."
  58 + * "code":"código do erro"
  59 + * }
  60 + */
  61 +
... ...
src/main/resources/apidoc/sipar.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,83 @@
  1 + /**
  2 + * @api {post} /sipar/importados Importar Processo
  3 + * @apiName importarProcesso
  4 + * @apiGroup SIPAR
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiDescription Marca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
  8 + *
  9 + * @apiParam (Header Parameters) {String} content-type Informar text/plain
  10 + * @apiParam (Request Body) {String} processo Número do processo a ser importado
  11 + *
  12 + * @apiExample Exemplo de requisição:
  13 + * endpoint: [POST] http://<host>/sei-broker/service/sipar/importados
  14 + *
  15 + * body:
  16 + * 33902112492200241
  17 + *
  18 + * @apiSuccessExample {json} Success-Response:
  19 + * HTTP/1.1 201 Created
  20 + *
  21 + * @apiErrorExample {json} Error-Response:
  22 + * HTTP/1.1 500 Internal Server Error
  23 + * {
  24 + * "error":"Mensagem de erro."
  25 + * "code":"código do erro"
  26 + * }
  27 + *
  28 + *
  29 + * @apiErrorExample {json} Error-Response:
  30 + * HTTP/1.1 400 Bad Request
  31 + * {
  32 + * "error":"Mensagem de erro."
  33 + * "code":"código do erro"
  34 + * }
  35 + *
  36 + *
  37 + * @apiErrorExample {json} Error-Response:
  38 + * HTTP/1.1 409 Conflict
  39 + * {
  40 + * "error":"Mensagem de erro."
  41 + * "code":"código do erro"
  42 + * }
  43 + */
  44 +
  45 + /**
  46 + * @api {delete} /sipar/importados/:processo Cancelar Importação Processo
  47 + * @apiName cancelarImportacaoProcesso
  48 + * @apiGroup SIPAR
  49 + * @apiVersion 2.0.0
  50 + *
  51 + * @apiDescription Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
  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
  54 + *
  55 + * @apiExample {curl} Exemplo de requisição:
  56 + * curl -X DELETE http://<host>/sei-broker/service/sipar/importados/33902112492200241
  57 + *
  58 + * @apiSuccessExample {json} Success-Response:
  59 + * HTTP/1.1 204 No Content
  60 + *
  61 + * @apiErrorExample {json} Error-Response:
  62 + * HTTP/1.1 500 Internal Server Error
  63 + * {
  64 + * "error":"Mensagem de erro."
  65 + * "code":"código do erro"
  66 + * }
  67 + *
  68 + *
  69 + * @apiErrorExample {json} Error-Response:
  70 + * HTTP/1.1 400 Bad Request
  71 + * {
  72 + * "error":"Mensagem de erro."
  73 + * "code":"código do erro"
  74 + * }
  75 + *
  76 + *
  77 + * @apiErrorExample {json} Error-Response:
  78 + * HTTP/1.1 404 Not Found
  79 + * {
  80 + * "error":"Mensagem de erro."
  81 + * "code":"código do erro"
  82 + * }
  83 + */
0 84 \ No newline at end of file
... ...
src/main/resources/apidoc/tarefa.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,32 @@
  1 + /**
  2 + * @api {get} /tarefas Listar tarefas
  3 + * @apiName listarTarefas
  4 + * @apiGroup Tarefa
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Lista os tipos de tarefas existentes no SEI.
  10 + *
  11 + * @apiParam (Query Parameters) {String} [nome] Filtro para o nome da tarefa.
  12 + *
  13 + * @apiExample {curl} Exemplo de requisição:
  14 + * curl -i https://<host>/sei-broker/service/tarefas
  15 + *
  16 + * @apiSuccess (Sucesso - 200) {List} tarefas Lista com as tarefas
  17 + * @apiSuccess (Sucesso - 200) {String} tarefas.identificados Identificador da tarefa.
  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.
  21 + * @apiSuccess (Sucesso - 200) {String} tarefas.fecharAndamentosAbertos S/N - Sinalizador indica se a tarefa fecha andamentos abertos.
  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.
  25 + *
  26 + * @apiErrorExample {json} Error-Response:
  27 + * HTTP/1.1 500 Internal Server Error
  28 + * {
  29 + * "error":"Mensagem de erro."
  30 + * "code":"código do erro"
  31 + * }
  32 + */
0 33 \ No newline at end of file
... ...
src/main/resources/apidoc/tipoConferencia.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,26 @@
  1 + /**
  2 + * @api {get} /:unidade/tipos-conferencia Listar tipos de conferência
  3 + * @apiName listarTiposConferencia
  4 + * @apiGroup Tipos Conferência
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Lista os tipos de conferência.
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI
  12 + *
  13 + * @apiExample {curl} Exemplo de requisição:
  14 + * curl -i https://<host>/sei-broker/service/cosap/tipos-conferencia
  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.
  19 + *
  20 + * @apiErrorExample {json} Error-Response:
  21 + * HTTP/1.1 500 Internal Server Error
  22 + * {
  23 + * "error":"Mensagem de erro."
  24 + * "code":"código do erro"
  25 + * }
  26 + */
... ...
src/main/resources/apidoc/unidade.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,50 @@
  1 + /**
  2 + * @api {get} /unidades Listar unidades
  3 + * @apiName listarUnidades
  4 + * @apiGroup Unidade
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Retorna as Unidades cadastradas no SEI.
  10 + *
  11 + * @apiExample {curl} Exemplo de requisição:
  12 + * curl -i https://<host>/sei-broker/service/unidades/
  13 + *
  14 + * @apiSuccess (Sucesso - 200) {Unidade[]} unidades Lista de unidades
  15 + * @apiSuccess (Sucesso - 200) {String} unidades.idUnidade Identificador da unidade
  16 + * @apiSuccess (Sucesso - 200) {String} unidades.sigla Sigla da unidade
  17 + * @apiSuccess (Sucesso - 200) {String} unidades.descricao Descrição da unidade
  18 + *
  19 + * @apiErrorExample {json} Error-Response:
  20 + * HTTP/1.1 500 Internal Server Error
  21 + * {
  22 + * "error":"Mensagem de erro."
  23 + * "code":"código do erro"
  24 + * }
  25 + */
  26 +
  27 + /**
  28 + * @api {get} /unidades/{unidade}/codigo Consultar código
  29 + * @apiName consultarCodigo
  30 + * @apiGroup Unidade
  31 + * @apiVersion 2.0.0
  32 + *
  33 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  34 + *
  35 + * @apiDescription Retorna o código da Unidade pesquisada.
  36 + *
  37 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade que deseja consultar o código
  38 + *
  39 + * @apiExample {curl} Exemplo de requisição:
  40 + * curl -i https://<host>/sei-broker/service/unidades/COSAP/codigo
  41 + *
  42 + * @apiSuccess (Sucesso - 200) {String} codigo Código da unidade.
  43 + *
  44 + * @apiErrorExample {json} Error-Response:
  45 + * HTTP/1.1 500 Internal Server Error
  46 + * {
  47 + * "error":"Mensagem de erro."
  48 + * "code":"código do erro"
  49 + * }
  50 + */
... ...
src/main/resources/apidoc/usuario.apidoc 0 → 100644
  Diff comments   View file @e979172
... ... @@ -0,0 +1,224 @@
  1 + /**
  2 + * @api {get} /:unidade/usuarios Listar usuários
  3 + * @apiName listarUsuarios
  4 + * @apiGroup Usuario
  5 + * @apiVersion 2.0.0
  6 + *
  7 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  8 + *
  9 + * @apiDescription Este método realiza uma consulta aos usuários cadastrados que possuem o perfil "Básico".
  10 + *
  11 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  12 + *
  13 + * @apiParam (Query Parameters) {String} [usuario=null] Id do usuário que deseja recuperar as informações
  14 + *
  15 + * @apiExample {curl} Exemplo de requisição:
  16 + * curl -i http://<host>/sei-broker/service/usuarios/COSAP
  17 + *
  18 + * @apiSuccess {Usuario[]} usuarios Lista de usuários
  19 + *
  20 + * @apiErrorExample {json} Error-Response:
  21 + * HTTP/1.1 500 Internal Server Error
  22 + * {
  23 + * "error":"Mensagem de erro."
  24 + * "code":"código do erro"
  25 + * }
  26 + */
  27 +
  28 + /**
  29 + * @api {get} :unidade/usuarios/:usuario Buscar usuário
  30 + * @apiName buscarUsuario
  31 + * @apiGroup Usuario
  32 + * @apiVersion 2.0.0
  33 + *
  34 + * @apiPermission RO_SEI_BROKER ou RO_SEI_BROKER_CONSULTA
  35 + *
  36 + * @apiDescription Este método realiza a uma busca pelo login do usuário.
  37 + *
  38 + * @apiParam (Path Parameters) {String} unidade Sigla da Unidade cadastrada no SEI.
  39 + * @apiParam (Path Parameters) {String} usuario Login do usuário
  40 + *
  41 + * @apiExample Exemplo de requisição:
  42 + * curl -i http://<host>/sei-broker/service/cosap/usuarios/andre.guimaraes
  43 + *
  44 + * @apiSuccess {Usuario} usuario Informações do usuário encontrado.
  45 + *
  46 + * @apiErrorExample {json} Error-Response:
  47 + * HTTP/1.1 500 Internal Server Error
  48 + * {
  49 + * "error":"Mensagem de erro."
  50 + * "code":"código do erro"
  51 + * }
  52 + */
  53 +
  54 + /**
  55 + * @api {post} /:unidade/:usuario/processos Atribuir processo
  56 + * @apiName atribuirProcesso
  57 + * @apiGroup Usuario
  58 + * @apiVersion 2.0.0
  59 + *
  60 + * @apiPermission RO_SEI_BROKER
  61 + *
  62 + * @apiDescription Este método atribui o processo a um usuário.
  63 + *
  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
  66 + *
  67 + * @apiParam (Request Body) {String} processo Numero do processo a ser atribuído
  68 + * @apiParam (Request Body) {String} [reabrir-processo=N] S ou N para reabrir o processo
  69 + *
  70 + * @apiExample Exemplo de requisição:
  71 + * endpoint: [POST] http://<host>/sei-broker/service/COSAP/usuarios/andre.guimaraes/processos
  72 + *
  73 + * body:
  74 + * {
  75 + * "processo":"33910000029201653",
  76 + * "reabrir":false
  77 + * }
  78 + *
  79 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  80 + *
  81 + * @apiErrorExample {json} Error-Response:
  82 + * HTTP/1.1 500 Internal Server Error
  83 + * {
  84 + * "error":"Mensagem de erro."
  85 + * "code":"código do erro"
  86 + * }
  87 + */
  88 +
  89 + /**
  90 + * @api {post} /usuarios Incluir usuário
  91 + * @apiName incluirUsuario
  92 + * @apiGroup Usuario
  93 + * @apiVersion 2.0.0
  94 + *
  95 + * @apiPermission RO_SEI_BROKER_ADM
  96 + *
  97 + * @apiDescription Este método realiza a inclusão de novos usuários ou alterarações nos usuários existentes.
  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
  102 + *
  103 + * @apiExample Exemplo de requisição:
  104 + * endpoint: http://<host>/sei-broker/service/usuarios
  105 + *
  106 + * body:
  107 + * {
  108 + * "codigo":"1234",
  109 + * "nome":"André Luís Fernandes Guimarães",
  110 + * "login":"andre.guimaraes"
  111 + * }
  112 + *
  113 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  114 + *
  115 + * @apiErrorExample {json} Error-Response:
  116 + * HTTP/1.1 500 Internal Server Error
  117 + * {
  118 + * "error":"Mensagem de erro."
  119 + * "code":"código do erro"
  120 + * }
  121 + */
  122 +
  123 + /**
  124 + * @api {delete} /usuarios/:login Excluir usuário
  125 + * @apiName excluirUsuario
  126 + * @apiGroup Usuario
  127 + * @apiVersion 2.0.0
  128 + *
  129 + * @apiPermission RO_SEI_BROKER_ADM
  130 + *
  131 + * @apiDescription Este método realiza a exclusão de usuários.
  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
  136 + *
  137 + * @apiExample Exemplo de requisição:
  138 + * endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/andre.guimaraes
  139 + *
  140 + * body:
  141 + * {
  142 + * "codigo":"1234",
  143 + * "nome":"André Luís Fernandes Guimarães",
  144 + * "login":"andre.guimaraes"
  145 + * }
  146 + *
  147 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  148 + *
  149 + * @apiErrorExample {json} Error-Response:
  150 + * HTTP/1.1 500 Internal Server Error
  151 + * {
  152 + * "error":"Mensagem de erro."
  153 + * "code":"código do erro"
  154 + * }
  155 + */
  156 +
  157 + /**
  158 + * @api {delete} /usuarios/ativos Desativar usuário
  159 + * @apiName desativarUsuario
  160 + * @apiGroup Usuario
  161 + * @apiVersion 2.0.0
  162 + *
  163 + * @apiPermission RO_SEI_BROKER_ADM
  164 + *
  165 + * @apiDescription Este método desativa usuários.
  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
  170 + *
  171 + * @apiExample Exemplo de requisição:
  172 + * endpoint: [DELETE] http://<host>/sei-broker/service/usuarios/ativos/andre.guimaraes
  173 + *
  174 + * body:
  175 + * {
  176 + * "codigo":"1234",
  177 + * "nome":"André Luís Fernandes Guimarães",
  178 + * "login":"andre.guimaraes"
  179 + * }
  180 + *
  181 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  182 + *
  183 + * @apiErrorExample {json} Error-Response:
  184 + * HTTP/1.1 500 Internal Server Error
  185 + * {
  186 + * "error":"Mensagem de erro."
  187 + * "code":"código do erro"
  188 + * }
  189 + */
  190 +
  191 + /**
  192 + * @api {post} /usuarios/ativos Ativar usuário
  193 + * @apiName ativarUsuario
  194 + * @apiGroup Usuario
  195 + * @apiVersion 2.0.0
  196 + *
  197 + * @apiPermission RO_SEI_BROKER_ADM
  198 + *
  199 + * @apiDescription Este método reativa usuários.
  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
  204 + *
  205 + * @apiExample Exemplo de requisição:
  206 + * endpoint: http://<host>/sei-broker/service/usuarios/ativos
  207 + *
  208 + * body:
  209 + * {
  210 + * "codigo":"1234",
  211 + * "nome":"André Luís Fernandes Guimarães",
  212 + * "login":"andre.guimaraes"
  213 + * }
  214 + *
  215 + * @apiSuccess {Boolean} resultado Booleano informando sucesso da requisição
  216 + *
  217 + * @apiErrorExample {json} Error-Response:
  218 + * HTTP/1.1 500 Internal Server Error
  219 + * {
  220 + * "error":"Mensagem de erro."
  221 + * "code":"código do erro"
  222 + * }
  223 + */
  224 +
... ...