sipar.apidoc
2.44 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/**
* @api {post} /sipar/importados Importar Processo
* @apiName importarProcesso
* @apiGroup SIPAR
* @apiVersion 2.0.0
*
* @apiDescription Marca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
*
* @apiParam (Header Parameters) {String} content-type Informar text/plain
* @apiParam (Request Body) {String} processo Número do processo a ser importado
*
* @apiExample Exemplo de requisição:
* endpoint: [POST] http://<host>/sei-broker/service/sipar/importados
*
* body:
* 33902112492200241
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 201 Created
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 500 Internal Server Error
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 400 Bad Request
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 409 Conflict
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*/
/**
* @api {delete} /sipar/importados/:processo Cancelar Importação Processo
* @apiName cancelarImportacaoProcesso
* @apiGroup SIPAR
* @apiVersion 2.0.0
*
* @apiDescription Desmarca um processo físico (SIPAR) como importado para um processo eletrônico (SEI).
*
* @apiParam (Path Parameter) {String} processo Número do processo físico existente no SIPAR contendo 17 dígitos e iniciado com 33902. Ex. 33902111111111111
*
* @apiExample {curl} Exemplo de requisição:
* curl -X DELETE http://<host>/sei-broker/service/sipar/importados/33902112492200241
*
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 204 No Content
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 500 Internal Server Error
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 400 Bad Request
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*
*
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 404 Not Found
* {
* "error":"Mensagem de erro."
* "code":"código do erro"
* }
*/