forked from bundesAPI/eco-visio-api
-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi_Eco-Counter_v1.1.yaml
135 lines (135 loc) · 3.54 KB
/
openapi_Eco-Counter_v1.1.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
openapi: 3.0.1
info:
title: API
description: Eco-Counter API
version: "1.1"
servers:
- url: https://apieco.eco-counter-tools.com/api/1.0
- url: http://apieco.eco-counter-tools.com/api/1.0
paths:
/data/site/{id}:
get:
summary: Get Site Data
parameters:
- name: id
in: path
description: Site ID
required: true
schema:
type: integer
- name: begin
in: query
description: 'Beginning of the period (ISO-8601 format: yyyy-mm-ddThh:mm:ss)
included'
schema:
type: string
- name: end
in: query
description: 'End of the period (ISO-8601 format: yyyy-mm-ddThh:mm:ss) excluded'
schema:
type: string
- name: step
in: query
description: 'Data step (allowed values: 15m/hour/day/week/month/year; default:hour)'
schema:
type: string
- name: complete
in: query
description: 'Complete data holes with null values (default: true)'
schema:
type: string
responses:
200:
description: "200"
content: {}
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
/tag:
get:
summary: Get a list of your Tags
parameters:
- name: domain_id
in: query
description: Restrict results to one domain (optional)
schema:
type: integer
responses:
200:
description: "200"
content: {}
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
/site/{id}:
get:
summary: Get a Site with a given ID
parameters:
- name: id
in: path
description: Site ID
required: true
schema:
type: string
- name: attributes
in: query
description: Add custom attributes to response
schema:
type: string
responses:
200:
description: "200"
content: {}
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
/counter:
get:
summary: Get a list of your Counters
responses:
200:
description: "200"
content: {}
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
/site:
get:
summary: Get a list of your Sites
parameters:
- name: domain_id
in: query
description: Restrict results to one domain (optional)
schema:
type: integer
- name: attributes
in: query
description: Add custom attributes to response
schema:
type: string
responses:
200:
description: "200"
content: {}
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
/counter/{serial}:
get:
summary: Get a Counter with a given Serial Number
parameters:
- name: serial
in: path
description: Counter Serial Number
required: true
schema:
type: integer
responses:
200:
description: "200"
content: {}
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
components:
securitySchemes:
default:
type: oauth2
flows:
implicit:
authorizationUrl: https://apieco.eco-counter-tools.com/authorize
scopes: {}