33 componentReq:
34 name: component
35 description: Id of component
36 in: query
37 required: true
38 schema:
59 dateToAq:
60 name: date_to
61 description: A date (required only for use = airquality)
62 in: query
63 required: false
64 schema:
68 dateFromReq:
69 name: date_from
70 description: A date
71 in: query
72 required: true
73 schema:
77 dateToReq:
78 name: date_to
79 description: A date
80 in: query
81 required: true
82 schema:
123 stationReq:
124 name: station
125 description: Id of station
126 in: query
127 required: true
128 schema:
140 timeFromAq:
141 name: time_from
142 description: An hour.
143 in: query
144 schema:
145 type: integer
149 timeToAq:
150 name: time_to
151 description: An hour.
152 in: query
153 schema:
154 type: integer
158 timeFromReq:
159 name: time_from
160 description: An hour.
161 in: query
162 required: true
163 schema:
168 timeToReq:
169 name: time_to
170 description: An hour.
171 in: query
172 required: true
173 schema:
215 yearReq:
216 name: year
217 description: A 4-digit Year
218 in: query
219 required: true
220 schema:
236 properties:
237 co:
238 description: Id of component
239 sc:
240 description: Id of scope
241 st:
238 description: Id of component
239 sc:
240 description: Id of scope
241 st:
242 description: Id of station
243 schemas:
240 description: Id of scope
241 st:
242 description: Id of station
243 schemas:
244 airquality:
245 type: object
276 properties:
277 '0':
278 description: Id of component
279 type: integer
280 example: 1
281 '1':
319 properties:
320 '0':
321 description: Id of station
322 example: 6
323 format: integer
324 type: integer
324 type: integer
325 '1':
326 description: Id of component
327 example: 3
328 type: integer
329 '2':
344 properties:
345 '0':
346 description: Id of component
347 example: 5
348 format: integer
349 type: integer
384 properties:
385 '0':
386 description: Id of scope
387 example: 2
388 format: integer
389 type: integer
417 properties:
418 '0':
419 description: Id of station
420 example: "769"
421 type: string
422 format: interger
459 format: float
460 '9':
461 description: Id of network
462 example: "6"
463 type: string
464 format: integer
509 properties:
510 '0':
511 description: Id of station setting
512 example: 2
513 format: integer
514 type: integer
514 type: integer
515 '1':
516 description: Name of station setting in specified language
517 example: "suburban area"
518 type: string
519 '2':
518 type: string
519 '2':
520 description: Short name of station setting in specified language
521 example: "suburban"
522 type: string
523 stationtype:
525 properties:
526 '0':
527 description: Id of station type
528 example: 2
529 format: integer
530 type: integer
530 type: integer
531 '1':
532 description: Name of station type in specified language
533 example: "industry"
534 type: string
535 threshold:
542 type: integer
543 '1':
544 description: Id of component
545 example: 5
546 type: integer
547 '2':
546 type: integer
547 '2':
548 description: Id of scope
549 example: 1
550 type: integer
551 '3':
565 properties:
566 '0':
567 description: Id of station
568 example: 2
569 format: integer
570 type: integer
570 type: integer
571 '1':
572 description: Date of first activity
573 example: '2019-01-01'
574 format: YYYY-MM-DD
575 type: string
660 properties:
661 '0':
662 description: Id of component
663 example: 2
664 type: integer
665 '1':
664 type: integer
665 '1':
666 description: Id of scope
667 example: 2
668 type: integer
669 '2':
687 properties:
688 '0':
689 description: Id of scope
690 example: 2
691 format: integer
692 type: integer
692 type: integer
693 '1':
694 description: Id of component
695 example: 2
696 format: integer
697 type: integer
697 type: integer
698 '2':
699 description: Id of station
700 example: 2
701 format: integer
702 type: integer
713 limit:
714 type: object
715 description: 'The index is a concatination of scope id, component id and station id.'
716 properties:
717 '0':
718 description: Id of scope
716 properties:
717 '0':
718 description: Id of scope
719 example: "1"
720 format: integer
721 type: string
721 type: string
722 '1':
723 description: Id of component
724 example: "1"
725 format: integer
726 type: string
726 type: string
727 '2':
728 description: Id of station
729 example: "120"
730 format: integer
731 type: string
736 type: string
737 '4':
738 description: Maximum datetime of start (CET)
739 example: "2019-09-02T11:00:00.000Z"
740 format: 'YYYY-MM-DD HH:mm:ss'
741 type: string
788 responses:
789 '200':
790 description: successful operation
791 content:
792 application/json:
793 schema:
795 properties:
796 indices:
797 description: Description of indices
798 example:
799 station_id:
800 '0': limit date start min (CET)
820 responses:
821 '200':
822 description: successful operation
823 content:
824 application/json:
825 schema:
829 items:
830 type: object
831 description: Description of indices
832 example:
833 - '0': station id
834 - '1': component id
842 type: object
843 '422':
844 description: required parameter is missing.
845 summary: Get annualtabulation
846 tags:
847 - annualtabulation
854 responses:
855 '200':
856 description: successful operation
857 content:
858 application/json:
859 schema:
891 responses:
892 '200':
893 description: successful operation
894 content:
895 application/json:
896 schema:
903 items:
904 type: object
905 description: Description of indices
906 example:
907 - station id:
908 date start:
937 '4': null
938 '422':
939 description: required parameter is missing.
940 summary: Get all measurements
941 tags:
942 - measurements
946 responses:
947 '200':
948 description: successful operation
949 content:
950 application/json:
951 schema:
954 indices:
955 type: object
956 description: Description of indices
957 example:
958 'combination of scope id, component id, station id':
959 '0': scope id
987 responses:
988 '200':
989 description: successful operation
990 content:
991 application/json:
992 schema:
998 items:
999 type: string
1000 description: Description of indices
1001 example:
1002 - network id
1003 - network code
1029 responses:
1030 '200':
1031 description: successful operation
1032 content:
1033 application/json:
1034 schema:
1062 responses:
1063 '200':
1064 description: successful operation
1065 content:
1066 application/json:
1067 schema:
1079 responses:
1080 '200':
1081 description: successful operation
1082 content:
1083 application/json:
1084 schema:
1099 responses:
1100 '200':
1101 description: successful operation
1102 content:
1103 application/json:
1104 schema:
1107 type: array
1108 '422':
1109 description: required parameter is missing.
1110 summary: Get all thresholds
1111 tags:
1112 - metadata
1121 responses:
1122 '200':
1123 description: successful operation
1124 content:
1125 application/json:
1126 schema:
1128 indices:
1129 type: object
1130 description: Description of indices
1131 example:
1132 '0': station id,
1133 '1': day_frist,
1140 type: array
1141 '422':
1142 description: required parameter is missing.
1143 summary: Get exceedances data
1144 tags:
1145 - exceedances
1151 responses:
1152 '200':
1153 description: successful operation
1154 content:
1155 application/json:
1156 schema:
1178 responses:
1179 '200':
1180 description: successful operation
1181 content:
1182 application/json:
1183 schema:
1283 properties:
1284 '0':
1285 description: Year
1286 example: 2004
1287 type: integer
1288 minLength: 4
1289 maxLength: 4
1290 '1':
1291 description: Id of component
1292 example: 1
1293 type: integer
1294 xref:
1301 properties:
1302 '0':
1303 description: Id of component
1304 example: 2
1305 type: integer
1306 '1':
1305 type: integer
1306 '1':
1307 description: Id of scope
1308 example: 4
1309 type: integer
1310 '2':
1333 maximum: 1
1334 '422':
1335 description: required parameter is missing.
39 type: integer
40 example: 1
41 date:
42 name: date
43 description: A date
44 in: query
121 type: integer
122 example: 769
123 stationReq:
124 name: station
125 description: Id of station
126 in: query
129 type: integer
130 example: 769
131 time:
132 name: time
133 description: An hour.
134 in: query
201 type: string
202 example: airquality
203 year:
204 name: year
205 description: A 4-digit Year
206 in: query
225 type: string
226 example: "2019"
227 dataArray:
228 name: dataArray
229 description: An array of datas.
230 in: query
230 in: query
231 required: true
232 schema:
233 type: array
234 items:
235 type: object
245 type: object
246 properties:
247 station id:
248 type: array
249 items:
250 type: object
302 type: object
303 properties:
304 station id:
305 properties:
306 '0':
307 description: Minimum date start (CET)
406 - 0
407 - 1
408 example: 0
409 format: integer
410 type: integer
411 '5':
755 content:
756 application/json:
757 schema:
758 type: object
759 properties:
760 indices:
791 content:
792 application/json:
793 schema:
794 type: object
795 properties:
796 indices:
823 content:
824 application/json:
825 schema:
826 properties:
827 indices:
828 type: array
857 content:
858 application/json:
859 schema:
860 type: object
861 example:
862 '5':
894 content:
895 application/json:
896 schema:
897 items:
898 $ref: '#/components/schemas/measure'
899 type: object
949 content:
950 application/json:
951 schema:
952 type: object
953 properties:
954 indices:
990 content:
991 application/json:
992 schema:
993 items:
994 $ref: '#/components/schemas/network'
995 properties:
1032 content:
1033 application/json:
1034 schema:
1035 example:
1036 '2':
1037 '0': 2
1065 content:
1066 application/json:
1067 schema:
1068 items:
1069 $ref: '#/components/schemas/stationsetting'
1070 type: array
1082 content:
1083 application/json:
1084 schema:
1085 items:
1086 $ref: '#/components/schemas/stationtype'
1087 type: array
1102 content:
1103 application/json:
1104 schema:
1105 items:
1106 $ref: '#/components/schemas/threshold'
1107 type: array
1154 content:
1155 application/json:
1156 schema:
1157 type: array
1158 items:
1159 $ref: '#/components/schemas/transgressiontype'
1181 content:
1182 application/json:
1183 schema:
1184 type: object
1185 properties:
1186 components:
743 /airquality/json:
744 get:
745 description: This entry point returns airquality data for the provided parameters.
746 parameters:
747 - $ref: '#/components/parameters/dateFromReq'
748 - $ref: '#/components/parameters/timeFromReq'
785 /airquality/limits:
786 get:
787 description: This entry point returns the date limits of airquality stations.
788 responses:
789 '200':
790 description: successful operation
813 /annualbalances/json:
814 get:
815 description: This entry point returns the data of annual tabulations
816 parameters:
817 - $ref: '#/components/parameters/componentReq'
818 - $ref: '#/components/parameters/yearReq'
848 /components/json:
849 get:
850 description: This entry point returns a list of all components.
851 parameters:
852 - $ref: '#/components/parameters/lang'
853 - $ref: '#/components/parameters/index'
880 /measures/json:
881 get:
882 description: This entry point returns measures for the provided parameters.
883 parameters:
884 - $ref: '#/components/parameters/dateFromReq'
885 - $ref: '#/components/parameters/timeFromReq'
943 /measures/limits:
944 get:
945 description: This entry point returns all limits of measurements
946 responses:
947 '200':
948 description: successful operation
981 /networks/json:
982 get:
983 description: This entry point returns a list of all networks.
984 parameters:
985 - $ref: '#/components/parameters/lang'
986 - $ref: '#/components/parameters/index'
1023 /scopes/json:
1024 get:
1025 description: The entry point returns a list of all scopes.
1026 parameters:
1027 - $ref: '#/components/parameters/lang'
1028 - $ref: '#/components/parameters/index'
1057 /stationsettings/json:
1058 get:
1059 description: This entry point returns a list of all station settings.
1060 parameters:
1061 - $ref: '#/components/parameters/lang'
1062 responses:
1074 /stationtypes/json:
1075 get:
1076 description: This entry point returns a list of all station types.
1077 parameters:
1078 - $ref: '#/components/parameters/lang'
1079 responses:
1091 /thresholds/json:
1092 get:
1093 description: This entry point returns a list of all thresholds
1094 parameters:
1095 - $ref: '#/components/parameters/usethreshold'
1096 - $ref: '#/components/parameters/lang'
1113 /transgressions/json:
1114 get:
1115 description: Returns exceedances data
1116 parameters:
1117 - $ref: '#/components/parameters/componentReq'
1118 - $ref: '#/components/parameters/yearReq'
1146 /transgressiontypes/json:
1147 get:
1148 description: Returns all exceedances types
1149 parameters:
1150 - $ref: '#/components/parameters/lang'
1151 responses:
1163 /meta/json:
1164 get:
1165 parameters:
1166 - $ref: '#/components/parameters/use'
1167 - $ref: '#/components/parameters/lang'
1168 - $ref: '#/components/parameters/dateFromAq'
743 /airquality/json:
744 get:
745 description: This entry point returns airquality data for the provided parameters.
746 parameters:
747 - $ref: '#/components/parameters/dateFromReq'
748 - $ref: '#/components/parameters/timeFromReq'
785 /airquality/limits:
786 get:
787 description: This entry point returns the date limits of airquality stations.
788 responses:
789 '200':
790 description: successful operation
813 /annualbalances/json:
814 get:
815 description: This entry point returns the data of annual tabulations
816 parameters:
817 - $ref: '#/components/parameters/componentReq'
818 - $ref: '#/components/parameters/yearReq'
848 /components/json:
849 get:
850 description: This entry point returns a list of all components.
851 parameters:
852 - $ref: '#/components/parameters/lang'
853 - $ref: '#/components/parameters/index'
880 /measures/json:
881 get:
882 description: This entry point returns measures for the provided parameters.
883 parameters:
884 - $ref: '#/components/parameters/dateFromReq'
885 - $ref: '#/components/parameters/timeFromReq'
943 /measures/limits:
944 get:
945 description: This entry point returns all limits of measurements
946 responses:
947 '200':
948 description: successful operation
981 /networks/json:
982 get:
983 description: This entry point returns a list of all networks.
984 parameters:
985 - $ref: '#/components/parameters/lang'
986 - $ref: '#/components/parameters/index'
1023 /scopes/json:
1024 get:
1025 description: The entry point returns a list of all scopes.
1026 parameters:
1027 - $ref: '#/components/parameters/lang'
1028 - $ref: '#/components/parameters/index'
1057 /stationsettings/json:
1058 get:
1059 description: This entry point returns a list of all station settings.
1060 parameters:
1061 - $ref: '#/components/parameters/lang'
1062 responses:
1074 /stationtypes/json:
1075 get:
1076 description: This entry point returns a list of all station types.
1077 parameters:
1078 - $ref: '#/components/parameters/lang'
1079 responses:
1091 /thresholds/json:
1092 get:
1093 description: This entry point returns a list of all thresholds
1094 parameters:
1095 - $ref: '#/components/parameters/usethreshold'
1096 - $ref: '#/components/parameters/lang'
1113 /transgressions/json:
1114 get:
1115 description: Returns exceedances data
1116 parameters:
1117 - $ref: '#/components/parameters/componentReq'
1118 - $ref: '#/components/parameters/yearReq'
1146 /transgressiontypes/json:
1147 get:
1148 description: Returns all exceedances types
1149 parameters:
1150 - $ref: '#/components/parameters/lang'
1151 responses:
1163 /meta/json:
1164 get:
1165 parameters:
1166 - $ref: '#/components/parameters/use'
1167 - $ref: '#/components/parameters/lang'
1168 - $ref: '#/components/parameters/dateFromAq'
39 type: integer
40 example: 1
41 date:
42 name: date
43 description: A date
44 in: query
121 type: integer
122 example: 769
123 stationReq:
124 name: station
125 description: Id of station
126 in: query
129 type: integer
130 example: 769
131 time:
132 name: time
133 description: An hour.
134 in: query
201 type: string
202 example: airquality
203 year:
204 name: year
205 description: A 4-digit Year
206 in: query
225 type: string
226 example: "2019"
227 dataArray:
228 name: dataArray
229 description: An array of datas.
230 in: query
33 componentReq:
34 name: component
35 description: Id of component
36 in: query
37 required: true
38 schema:
59 dateToAq:
60 name: date_to
61 description: A date (required only for use = airquality)
62 in: query
63 required: false
64 schema:
68 dateFromReq:
69 name: date_from
70 description: A date
71 in: query
72 required: true
73 schema:
77 dateToReq:
78 name: date_to
79 description: A date
80 in: query
81 required: true
82 schema:
123 stationReq:
124 name: station
125 description: Id of station
126 in: query
127 required: true
128 schema:
140 timeFromAq:
141 name: time_from
142 description: An hour.
143 in: query
144 schema:
145 type: integer
149 timeToAq:
150 name: time_to
151 description: An hour.
152 in: query
153 schema:
154 type: integer
158 timeFromReq:
159 name: time_from
160 description: An hour.
161 in: query
162 required: true
163 schema:
168 timeToReq:
169 name: time_to
170 description: An hour.
171 in: query
172 required: true
173 schema:
215 yearReq:
216 name: year
217 description: A 4-digit Year
218 in: query
219 required: true
220 schema:
236 properties:
237 co:
238 description: Id of component
239 sc:
240 description: Id of scope
241 st:
238 description: Id of component
239 sc:
240 description: Id of scope
241 st:
242 description: Id of station
243 schemas:
240 description: Id of scope
241 st:
242 description: Id of station
243 schemas:
244 airquality:
245 type: object
276 properties:
277 '0':
278 description: Id of component
279 type: integer
280 example: 1
281 '1':
319 properties:
320 '0':
321 description: Id of station
322 example: 6
323 format: integer
324 type: integer
324 type: integer
325 '1':
326 description: Id of component
327 example: 3
328 type: integer
329 '2':
344 properties:
345 '0':
346 description: Id of component
347 example: 5
348 format: integer
349 type: integer
384 properties:
385 '0':
386 description: Id of scope
387 example: 2
388 format: integer
389 type: integer
417 properties:
418 '0':
419 description: Id of station
420 example: "769"
421 type: string
422 format: interger
459 format: float
460 '9':
461 description: Id of network
462 example: "6"
463 type: string
464 format: integer
509 properties:
510 '0':
511 description: Id of station setting
512 example: 2
513 format: integer
514 type: integer
514 type: integer
515 '1':
516 description: Name of station setting in specified language
517 example: "suburban area"
518 type: string
519 '2':
518 type: string
519 '2':
520 description: Short name of station setting in specified language
521 example: "suburban"
522 type: string
523 stationtype:
525 properties:
526 '0':
527 description: Id of station type
528 example: 2
529 format: integer
530 type: integer
530 type: integer
531 '1':
532 description: Name of station type in specified language
533 example: "industry"
534 type: string
535 threshold:
542 type: integer
543 '1':
544 description: Id of component
545 example: 5
546 type: integer
547 '2':
546 type: integer
547 '2':
548 description: Id of scope
549 example: 1
550 type: integer
551 '3':
565 properties:
566 '0':
567 description: Id of station
568 example: 2
569 format: integer
570 type: integer
570 type: integer
571 '1':
572 description: Date of first activity
573 example: '2019-01-01'
574 format: YYYY-MM-DD
575 type: string
660 properties:
661 '0':
662 description: Id of component
663 example: 2
664 type: integer
665 '1':
664 type: integer
665 '1':
666 description: Id of scope
667 example: 2
668 type: integer
669 '2':
687 properties:
688 '0':
689 description: Id of scope
690 example: 2
691 format: integer
692 type: integer
692 type: integer
693 '1':
694 description: Id of component
695 example: 2
696 format: integer
697 type: integer
697 type: integer
698 '2':
699 description: Id of station
700 example: 2
701 format: integer
702 type: integer
713 limit:
714 type: object
715 description: 'The index is a concatination of scope id, component id and station id.'
716 properties:
717 '0':
718 description: Id of scope
716 properties:
717 '0':
718 description: Id of scope
719 example: "1"
720 format: integer
721 type: string
721 type: string
722 '1':
723 description: Id of component
724 example: "1"
725 format: integer
726 type: string
726 type: string
727 '2':
728 description: Id of station
729 example: "120"
730 format: integer
731 type: string
736 type: string
737 '4':
738 description: Maximum datetime of start (CET)
739 example: "2019-09-02T11:00:00.000Z"
740 format: 'YYYY-MM-DD HH:mm:ss'
741 type: string
788 responses:
789 '200':
790 description: successful operation
791 content:
792 application/json:
793 schema:
795 properties:
796 indices:
797 description: Description of indices
798 example:
799 station_id:
800 '0': limit date start min (CET)
820 responses:
821 '200':
822 description: successful operation
823 content:
824 application/json:
825 schema:
829 items:
830 type: object
831 description: Description of indices
832 example:
833 - '0': station id
834 - '1': component id
842 type: object
843 '422':
844 description: required parameter is missing.
845 summary: Get annualtabulation
846 tags:
847 - annualtabulation
854 responses:
855 '200':
856 description: successful operation
857 content:
858 application/json:
859 schema:
891 responses:
892 '200':
893 description: successful operation
894 content:
895 application/json:
896 schema:
903 items:
904 type: object
905 description: Description of indices
906 example:
907 - station id:
908 date start:
937 '4': null
938 '422':
939 description: required parameter is missing.
940 summary: Get all measurements
941 tags:
942 - measurements
946 responses:
947 '200':
948 description: successful operation
949 content:
950 application/json:
951 schema:
954 indices:
955 type: object
956 description: Description of indices
957 example:
958 'combination of scope id, component id, station id':
959 '0': scope id
987 responses:
988 '200':
989 description: successful operation
990 content:
991 application/json:
992 schema:
998 items:
999 type: string
1000 description: Description of indices
1001 example:
1002 - network id
1003 - network code
1029 responses:
1030 '200':
1031 description: successful operation
1032 content:
1033 application/json:
1034 schema:
1062 responses:
1063 '200':
1064 description: successful operation
1065 content:
1066 application/json:
1067 schema:
1079 responses:
1080 '200':
1081 description: successful operation
1082 content:
1083 application/json:
1084 schema:
1099 responses:
1100 '200':
1101 description: successful operation
1102 content:
1103 application/json:
1104 schema:
1107 type: array
1108 '422':
1109 description: required parameter is missing.
1110 summary: Get all thresholds
1111 tags:
1112 - metadata
1121 responses:
1122 '200':
1123 description: successful operation
1124 content:
1125 application/json:
1126 schema:
1128 indices:
1129 type: object
1130 description: Description of indices
1131 example:
1132 '0': station id,
1133 '1': day_frist,
1140 type: array
1141 '422':
1142 description: required parameter is missing.
1143 summary: Get exceedances data
1144 tags:
1145 - exceedances
1151 responses:
1152 '200':
1153 description: successful operation
1154 content:
1155 application/json:
1156 schema:
1178 responses:
1179 '200':
1180 description: successful operation
1181 content:
1182 application/json:
1183 schema:
1283 properties:
1284 '0':
1285 description: Year
1286 example: 2004
1287 type: integer
1288 minLength: 4
1289 maxLength: 4
1290 '1':
1291 description: Id of component
1292 example: 1
1293 type: integer
1294 xref:
1301 properties:
1302 '0':
1303 description: Id of component
1304 example: 2
1305 type: integer
1306 '1':
1305 type: integer
1306 '1':
1307 description: Id of scope
1308 example: 4
1309 type: integer
1310 '2':
1333 maximum: 1
1334 '422':
1335 description: required parameter is missing.
230 in: query
231 required: true
232 schema:
233 type: array
234 items:
235 type: object
245 type: object
246 properties:
247 station id:
248 type: array
249 items:
250 type: object
302 type: object
303 properties:
304 station id:
305 properties:
306 '0':
307 description: Minimum date start (CET)
406 - 0
407 - 1
408 example: 0
409 format: integer
410 type: integer
411 '5':
755 content:
756 application/json:
757 schema:
758 type: object
759 properties:
760 indices:
791 content:
792 application/json:
793 schema:
794 type: object
795 properties:
796 indices:
823 content:
824 application/json:
825 schema:
826 properties:
827 indices:
828 type: array
857 content:
858 application/json:
859 schema:
860 type: object
861 example:
862 '5':
894 content:
895 application/json:
896 schema:
897 items:
898 $ref: '#/components/schemas/measure'
899 type: object
949 content:
950 application/json:
951 schema:
952 type: object
953 properties:
954 indices:
990 content:
991 application/json:
992 schema:
993 items:
994 $ref: '#/components/schemas/network'
995 properties:
1032 content:
1033 application/json:
1034 schema:
1035 example:
1036 '2':
1037 '0': 2
1065 content:
1066 application/json:
1067 schema:
1068 items:
1069 $ref: '#/components/schemas/stationsetting'
1070 type: array
1082 content:
1083 application/json:
1084 schema:
1085 items:
1086 $ref: '#/components/schemas/stationtype'
1087 type: array
1102 content:
1103 application/json:
1104 schema:
1105 items:
1106 $ref: '#/components/schemas/threshold'
1107 type: array
1154 content:
1155 application/json:
1156 schema:
1157 type: array
1158 items:
1159 $ref: '#/components/schemas/transgressiontype'
1181 content:
1182 application/json:
1183 schema:
1184 type: object
1185 properties:
1186 components: