-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi_data.js
More file actions
5360 lines (5360 loc) · 178 KB
/
api_data.js
File metadata and controls
5360 lines (5360 loc) · 178 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
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
define({ "api": [
{
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"optional": false,
"field": "varname1",
"description": "<p>No type.</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "varname2",
"description": "<p>With type.</p>"
}
]
}
},
"type": "",
"url": "",
"version": "0.0.0",
"filename": "doc/version_1_0_0/archives/main.js",
"group": "/home/matheus/Área de Trabalho/geopark/backend/doc/version_1_0_0/archives/main.js",
"groupTitle": "/home/matheus/Área de Trabalho/geopark/backend/doc/version_1_0_0/archives/main.js",
"name": ""
},
{
"type": "get",
"url": "/",
"title": "01.Home",
"version": "1.0.0",
"group": "General",
"description": "<p>Informações da básicas da API.</p>",
"success": {
"fields": {
"200": [
{
"group": "200",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>Nome da API</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "version",
"description": "<p>Versão da API</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK \n{\n \"name\": \"Backend Geopark\",\n \"version\": \"1.0.0\"\n}",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/general.js",
"groupTitle": "General",
"name": "Get"
},
{
"type": "get",
"url": "/users/profile",
"title": "04.Visualizar dados",
"version": "1.0.0",
"group": "General",
"description": "<p>Permite ao usuário logado visualize suas informações.</p>",
"success": {
"fields": {
"200": [
{
"group": "200",
"type": "String",
"optional": false,
"field": "avatar_url",
"description": "<p>Endereço da imagem do usuário</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>Nome do usuário</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>Email do usuário</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "avatar",
"description": "<p>Nome único do arquivo do profile do usuário</p>"
},
{
"group": "200",
"type": "Object",
"optional": false,
"field": "user_type",
"description": "<p>Objeto com o informações do tipo de usuário</p>"
},
{
"group": "200",
"type": "Integer",
"optional": false,
"field": "user_type.id",
"description": "<p>Id do tipo do usuário</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "user_type.type",
"description": "<p>Descrição do tipo</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK \n{\n \"avatar_url\": \"http://localhost:3333/files/user_profile/anonymous.png\",\n \"name\": \"Rodrigo Cardoso\",\n \"genre\": \"M\",\n \"email\": \"rodrigocardoso@geopark.com.br\",\n \"avatar\": null,\n \"user_type\": {\n \"id\": 1,\n \"type\": \"administrator\"\n }\n}",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/general.js",
"groupTitle": "General",
"name": "GetUsersProfile",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>Token necessário para a realização de autenticação</p>"
}
]
},
"examples": [
{
"title": "Header:",
"content": "{\n \"authorization\": \"Bearer [token]\"\n}",
"type": "json"
}
]
}
},
{
"type": "post",
"url": "/recovery_password",
"title": "02.Email de Recuperação",
"version": "1.0.0",
"group": "General",
"description": "<p>Rota para gerar o token de recuperação de senha e envio do email com o token.</p>",
"parameter": {
"fields": {
"Body": [
{
"group": "Body",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>Email do usuário</p>"
}
]
}
},
"examples": [
{
"title": "Exemplo de requisição:",
"content": "{\n \"email\": \"jonhdoe@email.com\"\n}",
"type": "json"
}
],
"success": {
"fields": {
"204": [
{
"group": "204",
"type": "<ul> <li></li> </ul>",
"optional": false,
"field": "-",
"description": "<p>Confirmação do envio de email de recuperação com token de acesso</p>"
}
]
}
},
"error": {
"examples": [
{
"title": "Campos inválidos - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Invalid fields.\"\n}",
"type": "json"
},
{
"title": "Usuário inexistente - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"User not exists.\"\n}",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/general.js",
"groupTitle": "General",
"name": "PostRecovery_password"
},
{
"type": "put",
"url": "/reset_password",
"title": "03.Atualização da Senha",
"version": "1.0.0",
"group": "General",
"description": "<p>Rota para receber o token de atualização com a nova senha.</p>",
"parameter": {
"fields": {
"Body": [
{
"group": "Body",
"type": "String",
"optional": false,
"field": "token",
"description": "<p>Token para validação de recuperação</p>"
},
{
"group": "Body",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>Nova senha do usuário</p>"
},
{
"group": "Body",
"type": "String",
"optional": false,
"field": "confirmPassword",
"description": "<p>Confimação da nova senha cadastrada</p>"
}
]
}
},
"examples": [
{
"title": "Exemplo de requisição:",
"content": "{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\"\n \"password\": \"newPassword\",\n \"confirmPassword\": \"newPassword\"\n}",
"type": "json"
}
],
"success": {
"fields": {
"204": [
{
"group": "204",
"type": "<ul> <li></li> </ul>",
"optional": false,
"field": "-",
"description": "<p>Confirmação que a senha foi atualizada com sucesso.</p>"
}
]
}
},
"error": {
"examples": [
{
"title": "Campos inválidos - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Invalid fields.\"\n}",
"type": "json"
},
{
"title": "Usuário inexistente - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"User not exists.\"\n}",
"type": "json"
},
{
"title": "Expiração do Token - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Time expires.\"\n}",
"type": "json"
},
{
"title": "Token Inválido - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Token Inválid.\"\n}",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/general.js",
"groupTitle": "General",
"name": "PutReset_password"
},
{
"type": "get",
"url": "/solicitations/geosites/researcher",
"title": "03.Listar Solicitações",
"version": "1.0.0",
"group": "Mobile",
"description": "<p>Rota onde o pesquisador poderá listar todos as solicitações de pesquisas que ele precisa fazer.</p>",
"success": {
"fields": {
"200": [
{
"group": "200",
"type": "Integer",
"optional": false,
"field": "id",
"description": "<p>Id da solicitação</p>"
},
{
"group": "200",
"type": "Integer",
"optional": false,
"field": "id_adm",
"description": "<p>Id do administrador que indicou a pesquisa</p>"
},
{
"group": "200",
"type": "Integer",
"optional": false,
"field": "id_geosite_report",
"description": "<p>Id que representa qual relatório do geoparque essa pesquisa será atribuída</p>"
},
{
"group": "200",
"type": "Object",
"optional": false,
"field": "geosite",
"description": "<p>Informações do geossítio para a construção do arquivo de pesquisa</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "geosite.image_url",
"description": "<p>Imagem correspondente ao geossítio</p>"
},
{
"group": "200",
"type": "Integer",
"optional": false,
"field": "geosite.id",
"description": "<p>Id do geossítio</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "geosite.name",
"description": "<p>Nome do geossítio</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "geosite.address",
"description": "<p>Endereço do geossítio</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "geosite.image",
"description": "<p>Nome do arquivo da imagem</p>"
},
{
"group": "200",
"type": "Array",
"optional": false,
"field": "geosite.attractions",
"description": "<p>Array Contendo informações de cada atração do geossítio para a devida pesquisa</p>"
},
{
"group": "200",
"type": "Integer",
"optional": false,
"field": "geosite.attractions.id",
"description": "<p>Id da atração</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "geosite.attractions.name",
"description": "<p>Nome da atração</p>"
},
{
"group": "200",
"type": "Date",
"optional": false,
"field": "createdAt",
"description": "<p>Data da criação do elemento</p>"
},
{
"group": "200",
"type": "Date",
"optional": false,
"field": "updatedAt",
"description": "<p>Data da ultima atualização nesse objeto</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n[\n {\n \"id\": 1,\n \"id_adm\": 1,\n \"id_geosite_report\": 1,\n \"geosite\": {\n \"image_url\": \"http://localhost:3333/files/user_profile/anonymous.png\",\n \"id\": 3,\n \"name\": \"Floresta Petrificada do Cariri\",\n \"address\": \"Cidade - Ceará\",\n \"image\": null,\n \"attractions\": [\n {\n \"id\": 15,\n \"name\": \"Rocky Wall\"\n },\n {\n \"id\": 16,\n \"name\": \"Fossil Trunks\"\n }\n ]\n }\n }\n]",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/mobile.js",
"groupTitle": "Mobile",
"name": "GetSolicitationsGeositesResearcher",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>Token necessário para a realização de autenticação</p>"
}
]
},
"examples": [
{
"title": "Header:",
"content": "{\n \"authorization\": \"Bearer [token]\"\n}",
"type": "json"
}
]
}
},
{
"type": "post",
"url": "/reports/attractions/:id_solicitation",
"title": "04.Enviar a Pesquisa",
"version": "1.0.0",
"group": "Mobile",
"description": "<p>Permite que o usuário pesquisador envie os dados da pesquisa de um geossítio. Ao longo do preenchimento das informações da pesquisa, o aplicativo deve ser responsável por criar um arquivo json com todos esse dados para o envio, ressaltando que no arquivo é necessário um atributo image com o nome da foto que será enviada no array do multipart form data para que haja um link entre o ponto e seus dados respectivos dados e o próprio arquivo de imagem.</p>",
"parameter": {
"fields": {
"Param": [
{
"group": "Param",
"type": "Integer",
"optional": false,
"field": "id_solicitation",
"description": "<p>Id da solicitação da pesquisa que o usuário recebeu</p>"
}
],
"Body - Multipart Form Data": [
{
"group": "Body - Multipart Form Data",
"type": "Integer",
"optional": false,
"field": "id_geosite_report",
"description": "<p>ID que representa a pesquisa do geossítio para controle de versão</p>"
},
{
"group": "Body - Multipart Form Data",
"type": "File",
"optional": false,
"field": "attractions",
"description": "<p>Arquivo JSON contendo informações da pesquisa que serão coletadas pelo app</p>"
},
{
"group": "Body - Multipart Form Data",
"type": "File",
"optional": false,
"field": "images",
"description": "<p>Campo de imagem onde serão passadas todas as imagens de cada atributo da pesquisa. (Lembrando que ele será um array de arquivos de imagem tendo em vista a quantidades de pontos das pesquisas) [*.jpg, *.jpeg, *.png]</p>"
}
]
}
},
"examples": [
{
"title": "Exemplo de requisição:",
"content": "id_geosite_report = 1\nattractions = JSON\nimages = [imagem1.jpg, imagem2.jpg, ..., imagem34.jpg]",
"type": "multpart/form"
},
{
"title": "Exemplo do Arquivo JSON com as informações da pesquisa:",
"content": "\"Esse arquivo ele é um array onde contém os dados de cada a atração para isso o campo id de cada objeto \nrepresenta o id da atração, sendo que cada atração possui os tópicos de demand, zone, management e impacts. \nO impacts ele subdivide em outros, como também, cada requisito possui seu próprio id de atributo, desde o demand, \nzone, management e impact com suas subdivisões, cada id de atributo deve ser passado no arquivo para que cada \ninformação seja persistida corretamente no banco, o grade representa a nota que pode ser dada pelo \nvalor null ou 0, 1, 2 e 3. Por fim, as informações das imagens\"\n\n\"id_attribute - Atributo\"\n\"1 - demand\"\t\t\t\n\"2 - zone\"\t\t\n\"3 - management\"\t\t\t\n\"4 - Improper disposal of waste, residues and spinoffs\"\t\t\t\n\"5 - Damage to signaling boards and others\"\t\t\t\n\"6 - Damage to buildings, sculptures and others\"\t\t\t\n\"7 - Graffiti and depredation in geological heritage\"\t\t\t\n\"8 - Erosive grooves and changes in soil properties\"\t\t\t\n\"9 - Geological and geomorphological risks\"\t\t\t\n\"10 - Noise and visual pollution\"\t\t\t\n\"11 - Trampling, hunting, seizure and risk of extinction of species\"\t\t\t\n\"12 - Production of refuse, waste and spin-offs\"\t\t\t\n\"13 - Forest damage and uncontrolled native vegetation\"\t\t\t\n\"14 - Pollution and evident discharge in water sources\"\t\t\t\n\"15 - Mining, excavation and drilling\"\t\t\t\n\"16 - Reports of illegal trade in fossils, historical artifacts and others\"\t\t\t\n\"17 - Uncontrolled redirecting of water sources\"\n\n\"Exemplo do Arquivo\"\n\n[\n {\n \"id\": 15,\n \"demand\": {\n \"id_attribute\": 1,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem1.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n \"zone\": {\n \"id_attribute\": 2,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem2.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n \"management\": {\n \"id_attribute\": 3,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem3.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n \"impacts\": [\n {\n \"id_attribute\": 4,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem4.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 5,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem5.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 6,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem6.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 7,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem7.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 8,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem8.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 9,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem9.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 10,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem10.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 11,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem11.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 12,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem12.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 13,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem13.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 14,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem14.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 15,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem15.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 16,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem16.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 17,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem17.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n }\n ]\n },\n {\n \"id\": 16,\n \"demand\": {\n \"id_attribute\": 1,\n \"grade\": 1,\n \"image\": {\n \"name\": \"imagem18.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n \"zone\": {\n \"id_attribute\": 2,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem19.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n \"management\": {\n \"id_attribute\": 3,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem20.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n \"impacts\": [\n {\n \"id_attribute\": 4,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem21.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 5,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem22.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 6,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem23.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 7,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem24.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 8,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem25.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 9,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem26.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 10,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem27.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 11,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem28.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 12,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem29.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 13,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem30.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 14,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem31.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 15,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem32.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 16,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem33.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n },\n {\n \"id_attribute\": 17,\n \"grade\": 2,\n \"image\": {\n \"name\": \"imagem34.jpg\",\n \"latitude\": 0.45484,\n \"longitude\": 0.45484\n }\n }\n ]\n }\n]",
"type": "multpart/form"
}
],
"success": {
"fields": {
"204": [
{
"group": "204",
"type": "<ul> <li></li> </ul>",
"optional": false,
"field": "-",
"description": "<p>Confirmação do envio com sucesso</p>"
}
]
}
},
"error": {
"examples": [
{
"title": "Quando um usuário tenta enviar a pesquisa que não foi direcionada a ele - Error-Response:",
"content": "HTTP/1.1 403 Error\n{\n \"error\": \"Do you not have permission.\"\n}",
"type": "json"
},
{
"title": "Quando o usuário tenta reenviar uma pesquisa já fechada - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"The solicitation is no longer open.\"\n}",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/mobile.js",
"groupTitle": "Mobile",
"name": "PostReportsAttractionsId_solicitation",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>Token necessário para a realização de autenticação</p>"
}
]
},
"examples": [
{
"title": "Header:",
"content": "{\n \"authorization\": \"Bearer [token]\"\n}",
"type": "json"
}
]
}
},
{
"type": "post",
"url": "/sessions",
"title": "01.Login/Mobile",
"version": "1.0.0",
"group": "Mobile",
"description": "<p>Rota de autenticação para aplicação mobile.</p>",
"parameter": {
"fields": {
"Body": [
{
"group": "Body",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>Email do usuário</p>"
},
{
"group": "Body",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>Senha do usuário</p>"
}
]
}
},
"success": {
"fields": {
"200": [
{
"group": "200",
"type": "Object",
"optional": false,
"field": "user",
"description": "<p>Objeto contendo informações do usuário</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "user.email",
"description": "<p>Email do usuário autenticado</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "user.name",
"description": "<p>Nome do usuário autenticado</p>"
},
{
"group": "200",
"type": "Object",
"optional": false,
"field": "user.user_type",
"description": "<p>Objeto contendo informações sobre o nível de permissão</p>"
},
{
"group": "200",
"type": "Integer",
"optional": false,
"field": "user.user_type.id",
"description": "<p>Indentificador do tipo de permissão</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "user.user_type.type",
"description": "<p>Tipo do nível de permissão</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "token",
"description": "<p>Token de autenticação</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"user\": {\n \"email\": \"jonh@email.com\",\n \"name\": \"Jonh Doe\",\n \"user_type\": {\n \"id\": 2,\n \"type\": \"researcher\"\n }\n }\n \"token\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Campos inválidos - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Invalid fields.\"\n}",
"type": "json"
},
{
"title": "Email ou senha inválidos - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Email or password invalid.\"\n}",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/mobile.js",
"groupTitle": "Mobile",
"name": "PostSessions"
},
{
"type": "put",
"url": "/users/researcher",
"title": "02.Atualizar os dados",
"version": "1.0.0",
"group": "Mobile",
"description": "<p>Permite ao usuário dentro da aplicação mobile atualizar seus dados.</p>",
"parameter": {
"fields": {
"Body - Multipart Form Data": [
{
"group": "Body - Multipart Form Data",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>Nome do usuário</p>"
},
{
"group": "Body - Multipart Form Data",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>Nova Senha do usuário</p>"
},
{
"group": "Body - Multipart Form Data",
"type": "File",
"optional": false,
"field": "avatar",
"description": "<p>Campo da imagem do usuário [*.jpg, *.jpeg, *.png]</p>"
}
]
}
},
"success": {
"fields": {
"200": [
{
"group": "200",
"type": "String",
"optional": false,
"field": "avatar_url",
"description": "<p>Endereço da imagem do usuário</p>"
},
{
"group": "200",
"type": "Integer",
"optional": false,
"field": "id",
"description": "<p>Id do usuário</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>Nome do usuário</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>Email do usuário</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "avatar",
"description": "<p>Nome único do arquivo do profile do usuário</p>"
},
{
"group": "200",
"type": "Date",
"optional": false,
"field": "updated_at",
"description": "<p>Data da última atualização do usuário</p>"
},
{
"group": "200",
"type": "Object",
"optional": false,
"field": "user_type",
"description": "<p>Objeto com o informações do tipo de usuário</p>"
},
{
"group": "200",
"type": "Integer",
"optional": false,
"field": "user_type.id",
"description": "<p>Id do tipo do usuário</p>"
},
{
"group": "200",
"type": "String",
"optional": false,
"field": "user_type.type",
"description": "<p>Descrição do tipo</p>"
}
]
},
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"avatar_url\": \"http://localhost:3333/files/user_profile/4c5a37ed8ede1b9efa0e993c2daac0fb.jpeg\",\n \"id\": 15,\n \"name\": \"Matheus Maximiano\",\n \"genre\": \"M\",\n \"email\": \"matheus@email.com\",\n \"avatar\": \"4c5a37ed8ede1b9efa0e993c2daac0fb.jpeg\",\n \"user_type\": {\n \"id\": 2,\n \"type\": \"researcher\"\n },\n \"updatedAt\": \"2020-05-08T20:56:07.094Z\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Campos inválidos - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Invalid fields.\"\n}",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/mobile.js",
"groupTitle": "Mobile",
"name": "PutUsersResearcher",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>Token necessário para a realização de autenticação</p>"
}
]
},
"examples": [
{
"title": "Header:",
"content": "{\n \"authorization\": \"Bearer [token]\"\n}",
"type": "json"
}
]
}
},
{
"type": "delete",
"url": "/geoparks/geosites/attractions/:id",
"title": "19.Deletar Atrações",
"version": "1.0.0",
"group": "Web",
"description": "<p>Permite que o usuário administrador delete os dados das atrações, a partir do id referente do mesmo. Essa exclusão não destroi o registro apenas ativa uma flag de exclusão permitindo a recuperação das informações e também não comprometendo os dados das pesquisas.</p>",
"parameter": {
"fields": {
"Params": [
{
"group": "Params",
"optional": false,
"field": "id",
"description": "<p>ID da atração no qual se deseja excluir os dados</p>"
}
],
"Nível de Acesso": [
{
"group": "Nível de Acesso",
"type": "Object",
"optional": false,
"field": "user_type",
"description": "<p>O nível de permissão que o usuário precisa para ter acesso as informações dessa rota</p>"
},
{
"group": "Nível de Acesso",
"type": "Integer",
"optional": false,
"field": "user_type.id",
"description": "<p>1</p>"
},
{
"group": "Nível de Acesso",
"type": "String",
"optional": false,
"field": "user_type.type",
"description": "<p>"Administrator"</p>"
}
]
}
},
"success": {
"fields": {
"204": [
{
"group": "204",
"type": "<ul> <li></li> </ul>",
"optional": false,
"field": "-",
"description": "<p>Resultado da requisição positiva sem conteúdo na resposta</p>"
}
]
}
},
"error": {
"examples": [
{
"title": "Parâmentro Inválido - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"URL params validation fail.\"\n}",
"type": "json"
},
{
"title": "Atração Inválida - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Invalid Attraction.\"\n}",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/web.js",
"groupTitle": "Web",
"name": "DeleteGeoparksGeositesAttractionsId",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>Token necessário para a realização de autenticação</p>"
}
]
},
"examples": [
{
"title": "Header:",
"content": "{\n \"authorization\": \"Bearer [token]\"\n}",
"type": "json"
}
]
}
},
{
"type": "delete",
"url": "/geoparks/geosites/:id",
"title": "15.Deletar geossítios",
"version": "1.0.0",
"group": "Web",
"description": "<p>Permite que o usuário administrador delete os dados dos geossítios, a partir do id referente do mesmo. Essa exclusão não destroi o registro apenas ativa uma flag de exclusão permitindo a recuperação das informações e também não comprometendo os dados das pesquisas.</p>",
"parameter": {
"fields": {
"Params": [
{
"group": "Params",
"optional": false,
"field": "id",
"description": "<p>ID do geossítio no qual se deseja excluir os dados</p>"
}
],
"Nível de Acesso": [
{
"group": "Nível de Acesso",
"type": "Object",
"optional": false,
"field": "user_type",
"description": "<p>O nível de permissão que o usuário precisa para ter acesso as informações dessa rota</p>"
},
{
"group": "Nível de Acesso",
"type": "Integer",
"optional": false,
"field": "user_type.id",
"description": "<p>1</p>"
},
{
"group": "Nível de Acesso",
"type": "String",
"optional": false,
"field": "user_type.type",
"description": "<p>"Administrator"</p>"
}
]
}
},
"success": {
"fields": {
"204": [
{
"group": "204",
"type": "<ul> <li></li> </ul>",
"optional": false,
"field": "-",
"description": "<p>Resultado da requisição positiva sem conteúdo na resposta</p>"
}
]
}
},
"error": {
"examples": [
{
"title": "Parâmentro Inválido - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Invalid Params.\"\n}",
"type": "json"
},
{
"title": "Geossítio Inválido - Error-Response:",
"content": "HTTP/1.1 400 Error\n{\n \"error\": \"Invalid Geosite.\"\n}",
"type": "json"
}
]
},
"filename": "doc/version_1_0_0/web.js",
"groupTitle": "Web",
"name": "DeleteGeoparksGeositesId",
"header": {
"fields": {
"Header": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>Token necessário para a realização de autenticação</p>"
}
]
},
"examples": [
{
"title": "Header:",
"content": "{\n \"authorization\": \"Bearer [token]\"\n}",
"type": "json"
}
]
}
},
{
"type": "delete",
"url": "/geoparks/:id",
"title": "10.Deletar geoparques",
"version": "1.0.0",
"group": "Web",
"description": "<p>Permite que o usuário administrador delete os dados dos geoparques, a partir do id referente do mesmo. Essa exclusão não destroi o registro apenas ativa uma flag de exclusão permitindo a recuperação das informações e também não comprometendo os dados das pesquisas.</p>",
"parameter": {
"fields": {
"Params": [
{
"group": "Params",
"optional": false,
"field": "id",
"description": "<p>ID do geoparque no qual se deseja deletar seus dados</p>"
}