-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathdivulgacandcontas-swagger.yaml
1085 lines (1082 loc) · 31.3 KB
/
divulgacandcontas-swagger.yaml
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: DivulgaCandContas
description: Documentação não oficial da API do sistema de divulgação de candidaturas
e contas ([DivulgaCandContas](http://divulgacandcontas.tse.jus.br/divulga/)) do
Tribunal Superior Eleitoral.
termsOfService: http://www.tse.jus.br/transparencia/politica-de-privacidade-e-termos-de-uso
contact:
url: http://divulgacandcontas.tse.jus.br/divulga/
version: 1.0.0
externalDocs:
description: Repositório de dados eleitorais
url: https://www.tse.jus.br/eleicoes/estatisticas/repositorio-de-dados-eleitorais-1/repositorio-de-dados-eleitorais
servers:
- url: https://divulgacandcontas.tse.jus.br/divulga/rest/v1
tags:
- name: candidaturas
description: Candidaturas
- name: contas
description: Informações sobre a prestação de contas
- name: eleicoes
description: Eleições
- name: eleicoes-suplementares
description: Eleições suplementares
paths:
/candidatura/listar/{ano}/{municipio}/{eleicao}/{cargo}/candidatos:
get:
tags:
- candidaturas
summary: Candidatos no município
description: Lista de todos os candidatos nas eleições de 2020 no município
especificado
operationId: listaCandidatosPorMunicipio
parameters:
- name: eleicao
in: path
description: >
Id da eleição
(ex.: 2030402020 para as eleições municipais de 2020)
required: true
schema:
type: integer
example: 2030402020
- name: ano
in: path
description: Ano
required: true
schema:
type: integer
example: 2020
- name: municipio
in: path
description: Código do município
required: true
schema:
type: integer
example: 35157
- name: cargo
in: path
description: Código do cargo
required: true
schema:
type: integer
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
unidadeEleitoral:
type: object
properties: {}
cargo:
type: object
properties: {}
candidatos:
type: array
items:
$ref: '#/components/schemas/Candidato'
404:
description: não encontrado
content: {}
/candidatura/buscar/{ano}/{municipio}/{eleicao}/candidato/{candidato}:
get:
tags:
- candidaturas
summary: Candidato
description: Informações sobre o candidato
operationId: consultaCandidato
parameters:
- name: eleicao
in: path
description: >
Id da eleição
(ex.: 2030402020 para as eleições municipais de 2020)
required: true
schema:
type: integer
example: 2030402020
- name: ano
in: path
description: Ano
required: true
schema:
type: integer
example: 2020
- name: municipio
in: path
description: Código do município
required: true
schema:
type: integer
example: 35157
- name: candidato
in: path
description: Código do candidato
required: true
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Candidato'
/eleicao/anos-eleitorais:
get:
tags:
- eleicoes
summary: Anos eleitorais
description: Lista de anos eleitorais
operationId: anosEleitorais
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
type: integer
/eleicao/estados/{ano}/ano:
get:
tags:
- eleicoes-suplementares
summary: Estados com eleições suplementares
description: Lista de estados com eleições suplementares naquele ano
operationId: eleicoes_suplementares_estados
parameters:
- name: ano
in: path
description: Ano
required: true
schema:
type: integer
example: 2020
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
uf:
type: string
404:
description: não encontrado
content: {}
/eleicao/listar/municipios/{eleicao}/{municipio}/cargos:
get:
tags:
- eleicoes
summary: Cargos no município
description: Lista de cargos em disputa no município
operationId: listaCargosMunicipio
parameters:
- name: eleicao
in: path
description: Id da eleição
required: true
schema:
type: integer
- name: municipio
in: path
description: Código do município
required: true
schema:
type: integer
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
unidadeEleitoralDTO:
type: object
properties:
id:
type: string
format: nullable
sigla:
type: string
nome:
type: string
regiao:
type: string
format: nullable
cargos:
type: string
format: nullable
diretorios:
type: string
format: nullable
codigo:
type: string
capital:
type: boolean
estado:
type: string
cargos:
type: array
items:
$ref: '#/components/schemas/Cargo'
404:
description: não encontrado
content: {}
/eleicao/ordinarias:
get:
tags:
- eleicoes
summary: Eleições
description: Lista eleições, por ano, disponível para consulta
operationId: eleicoesOrdinarias
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Eleição"
404:
description: não encontrado
content: {}
/eleicao/suplementares/{ano}/{uf}:
get:
tags:
- eleicoes-suplementares
summary: Eleições suplementares
description: Lista de eleições suplementares no estado naquele ano
operationId: eleicoes_suplementares_estados
parameters:
- name: ano
in: path
description: Ano
required: true
schema:
type: integer
example: 2020
- name: uf
in: path
description: Sigla da unidade federativa
required: true
schema:
type: string
example: AL
responses:
200:
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Eleição"
404:
description: não encontrado
content: {}
/prestador/consulta/{eleicao}/{ano}/{municipio}/{cargo}/90/90/{candidato}:
get:
tags:
- contas
summary: Prestador
description: Informações sobre o prestador de contas
operationId: consultaPrestador
parameters:
- name: eleicao
in: path
description: >
Id da eleição
(ex.: 2030402020 para as eleições municipais de 2020)
required: true
schema:
type: integer
example: 2030402020
- name: ano
in: path
description: Ano
required: true
schema:
type: integer
example: 2020
- name: municipio
in: path
description: Código do município
required: true
schema:
type: integer
example: 35157
- name: cargo
in: path
description: Código do cargo
required: true
schema:
type: integer
- name: candidato
in: path
description: Código do candidato
required: true
schema:
type: integer
format: int64
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
idEleicao:
type: integer
format: int32
ano:
type: integer
format: int32
sgUe:
type: string
sgUeSuperior:
type: string
nmUe:
type: string
nrPartido:
type: integer
format: int32
nomePartido:
type: string
siglaPartido:
type: string
siglaPartidoSemEspaco:
type: string
nrCandidato:
type: integer
format: int32
idCandidato:
type: string
nrProcessoPje:
type: string
cnpj:
type: string
idOrgao:
type: string
format: nullable
idPrestador:
type: string
idPrestadorVice:
type: string
idUltimaEntrega:
type: string
numeroDeControleEntrega:
type: string
dataUltimaAtualizacaoContas:
type: string
entregaAtual:
type: string
format: nullable
dadosConsolidados:
type: object
properties:
totalRecebido:
type: integer
format: int32
qtdRecebido:
type: integer
format: int32
percentualRecebido:
type: string
format: nullable
totalFinanceiro:
type: integer
format: int32
qtdFinanceiro:
type: integer
format: int32
percentualFinanceiro:
type: integer
format: int32
totalEstimados:
type: integer
format: int32
qtdEstimados:
type: integer
format: int32
percentualEstimados:
type: integer
format: int32
totalReceitaPF:
type: integer
format: int32
qtdReceitaPF:
type: integer
format: int32
percentualReceitaPF:
type: integer
format: int32
totalReceitaPJ:
type: integer
format: int32
qtdReceitaPJ:
type: integer
format: int32
percentualReceitaPJ:
type: integer
format: int32
totalPartidos:
type: integer
format: int32
qtdPartidos:
type: integer
format: int32
percentualPartidos:
type: integer
format: int32
totalInternet:
type: integer
format: int32
qtdInternet:
type: integer
format: int32
percentualInternet:
type: integer
format: int32
totalRoni:
type: integer
format: int32
qtdRoni:
type: integer
format: int32
percentualRoni:
type: integer
format: int32
totalProprios:
type: integer
format: int32
qtdProprios:
type: integer
format: int32
percentualProprios:
type: integer
format: int32
totalReceitaOutCand:
type: integer
format: int32
qtdReceitaOutCand:
type: integer
format: int32
percentualReceitaOutCand:
type: integer
format: int32
totalDoacaoFcc:
type: integer
format: int32
qtdDoacaoFcc:
type: integer
format: int32
percentualDoacaoFcc:
type: integer
format: int32
sqPrestadorConta:
type: string
format: nullable
sqEntregaPrestacao:
type: string
format: nullable
graphQtdReceitaFin:
type: integer
format: int32
graphVrReceitaFin:
type: integer
format: int32
graphQtdReceitaFinFundo:
type: integer
format: int32
graphVrReceitaFinFundo:
type: integer
format: int32
graphPercentReceitaFinFundo:
type: integer
format: int32
graphQtdReceitaFinOutros:
type: integer
format: int32
graphVrReceitaFinOutros:
type: integer
format: int32
graphPercentFinOutros:
type: integer
format: int32
graphQtdReceitaFinFefc:
type: integer
format: int32
graphVrReceitaFinFefc:
type: integer
format: int32
graphPercentFinFefc:
type: integer
format: int32
historicoEntregas:
type: array
items:
type: object
properties:
dataEntrega:
type: string
tipo:
type: string
retificadora:
type: string
numeroControle:
type: string
idEntrega:
type: string
isCompare:
type: boolean
despesas:
type: object
properties:
limiteDeGasto1T:
type: number
limiteDeGasto2T:
type: integer
format: int32
valorLimiteDeGastos:
type: number
totalDespesasContratadas:
type: integer
format: int32
totalDespesasPagas:
type: integer
format: int32
doacoesOutrosCandidatosPartigos:
type: integer
format: int32
fundosPartidarios:
type: integer
format: int32
fundoEspecial:
type: integer
format: int32
outrosRecursos:
type: integer
format: int32
financeiras:
type: integer
format: int32
estimaveis:
type: integer
format: int32
haveExtratos:
type: boolean
haveNfes:
type: boolean
concentracaoDespesas:
type: array
items:
type: object
properties:
dsDRD:
type: string
qtdeDespesas:
type: string
valor:
type: integer
format: int32
rankingDoadores:
type: array
items:
type: object
properties:
cpfCnpj:
type: string
nome:
type: string
qntd:
type: string
valor:
type: integer
format: int32
stFinanciamentoColetivo:
type: boolean
rankingFornecedores:
type: array
items:
type: object
properties:
cpfCnpj:
type: string
nome:
type: string
qntd:
type: string
valor:
type: integer
format: int32
stFinanciamentoColetivo:
type: string
format: nullable
contasBancarias:
type: array
items:
type: object
properties: {}
receitaIndividual:
type: string
format: nullable
qualificacoes:
type: array
items:
type: object
properties:
membro:
type: string
codigoFuncao:
type: integer
format: int32
funcao:
type: string
nrRegistroConselho:
type: string
format: nullable
dtGestaoInicio:
type: integer
format: int64
dtGestaoFim:
type: integer
format: int64
dividaCampanha:
type: string
format: nullable
sobraFinanceira:
type: string
format: nullable
sobraFinanceiraFP:
type: string
format: nullable
sobraFinanceiraOR:
type: string
format: nullable
sobraFinanceiraFEFC:
type: string
format: nullable
sobraEstimavel:
type: string
format: nullable
404:
description: não encontrado
content: {}
components:
schemas:
Candidato:
type: object
properties:
id:
type: integer
format: int64
nomeUrna:
type: string
numero:
type: integer
format: int32
idCandidatoSuperior:
type: integer
format: int32
nomeCompleto:
type: string
descricaoSexo:
type: string
format: nullable
dataDeNascimento:
type: integer
format: int64
tituloEleitor:
type: string
format: nullable
cpf:
type: string
format: nullable
descricaoEstadoCivil:
type: string
format: nullable
descricaoCorRaca:
type: string
format: nullable
descricaoSituacao:
type: string
nacionalidade:
type: string
format: nullable
grauInstrucao:
type: string
format: nullable
ocupacao:
type: string
format: nullable
gastoCampanha1T:
type: number
format: nullable
gastoCampanha2T:
type: number
format: nullable
sgUfNascimento:
type: string
format: nullable
nomeMunicipioNascimento:
type: string
format: nullable
localCandidatura:
type: string
format: nullable
ufCandidatura:
type: string
format: nullable
ufSuperiorCandidatura:
type: string
format: nullable
dataUltimaAtualizacao:
type: integer
format: int64
fotoUrl:
type: string
format: nullable
fotoDataUltimaAtualizacao:
type: string
format: nullable
descricaoTotalizacao:
type: string
nomeColigacao:
type: string
composicaoColigacao:
type: string
format: nullable
numeroProcessoDrap:
type: string
format: nullable
numeroProcessoDrapEncrypt:
type: string
format: nullable
numeroProcesso:
type: string
format: nullable
numeroProcessoEncrypt:
type: string
format: nullable
numeroProcessoPrestContas:
type: string
format: nullable
numeroProcessoPrestContasEncrypt:
type: string
format: nullable
numeroProtocolo:
type: string
format: nullable
cargo:
$ref: '#/components/schemas/Cargo'
bens:
type: array
items:
type: object
properties:
ordem:
type: integer
format: int32
descricao:
type: string
descricaoDeTipoDeBem:
type: string
valor:
type: number
dataUltimaAtualizacao:
type: integer
format: int64
totalDeBens:
type: number
format: nullable
vices:
type: array
items:
type: object
properties:
nomeColigacao:
type: string
format: nullable
composicaoColigacao:
type: string
format: nullable
stRegistro:
type: string
format: nullable
situacaoCandidato:
type: string
format: nullable
urlFoto:
type: string
sq_CANDIDATO:
type: integer
format: int64
sq_CANDIDATO_SUPERIOR:
type: string
format: nullable
sq_ELEICAO:
type: integer
format: int32
sg_UE:
type: string
nr_CANDIDATO:
type: string
nm_URNA:
type: string
nm_CANDIDATO:
type: string
dt_ULTIMA_ATUALIZACAO:
type: integer
format: int64
ds_CARGO:
type: string
format: nullable
nm_PARTIDO:
type: string
sg_PARTIDO:
type: string
partido:
type: object
properties:
numero:
type: integer
format: int32
sigla:
type: string
nome:
type: string
format: nullable
eleicao:
type: object
properties:
id:
type: integer
format: int32
siglaUF:
type: string
format: nullable
localidadeSgUe:
type: string
format: nullable
ano:
type: integer
format: int32
codigo:
type: string
format: nullable
nomeEleicao:
type: string
format: nullable
tipoEleicao:
type: string
format: nullable
turno:
type: string
format: nullable
tipoAbrangencia:
type: string
format: nullable
dataEleicao:
type: string
format: nullable
codSituacaoEleicao:
type: string
format: nullable
descricaoSituacaoEleicao:
type: string
format: nullable
descricaoEleicao:
type: string
emails:
type: array
items:
type: string
sites:
type: array
items:
type: string
arquivos:
type: array
items:
type: object
properties:
idArquivo:
type: integer
format: int64
nome:
type: string
url:
type: string
tipo:
type: string
codTipo:
type: string
fullFilePath:
type: string
format: nullable
fileInputStream:
type: string
format: nullable
fileByteArray:
type: string
format: nullable
eleicoesAnteriores:
type: array
items:
type: object
properties:
nrAno:
type: integer
format: int32
id:
type: string
nomeUrna:
type: string
nomeCandidato:
type: string
idEleicao:
type: string
sgUe:
type: string
local:
type: string
cargo:
type: string
partido:
type: string
situacaoTotalizacao:
type: string
txLink:
type: string
substituto:
type: string
format: nullable
motivos:
type: string
format: nullable
codigoSituacaoCandidato:
type: integer
format: int32
descricaoSituacaoCandidato:
type: string
format: nullable
isCandidatoInapto:
type: boolean
format: nullable
codigoSituacaoPartido:
type: string
format: nullable
descricaoSituacaoPartido:
type: string
format: nullable
cnpjcampanha:
type: string
format: nullable
descricaoNaturalidade:
type: string
gastoCampanha:
type: integer
format: int32
st_SUBSTITUIDO:
type: boolean
format: nullable
st_MOTIVO_FICHA_LIMPA:
type: boolean
format: nullable
st_MOTIVO_ABUSO_PODER: