نمای عمومی

GET /api/v1/channel_data

فهرستی از قرائت‌های گره اندازه‌گیری (metering unit) را به تفکیک نوع آرشیو و بازهٔ زمانی تأمین‌کنندهٔ منابع بازمی‌گرداند.

پارامترهای پرس‌وجو

archive_type string

نوع آرشیوی که داده‌های آن دریافت می‌شود. فهرست انواع آرشیو در جدول «مرجع انواع آرشیو» آمده است.

equipment_id integer

شناسهٔ دستگاه اندازه‌گیری‌ای که داده‌های آن دریافت می‌شود.

fp_start string

بازهٔ زمانی (آغاز بازه) با قالب yyyy-mm-dd که داده‌های آن دریافت می‌شود.

fp_end string

بازهٔ زمانی (پایان بازه) با قالب yyyy-mm-dd که داده‌های آن دریافت می‌شود.

page integer

شمارهٔ صفحه.

فیلدهای پاسخ

ویژگی	توضیح
`event_time`	تاریخ و زمان قرائت‌های کنتور با قالب UTC
`channel_data`	داده‌های آرشیو. این داده‌ها به پارامترهای نوع آرشیو و نوع تصحیح‌گر دستگاه اندازه‌گیری بستگی دارد. توضیح کانال‌های پارامترها در جدول «مرجع پارامترهای کانال‌های گره اندازه‌گیری» آمده است
`data`	آرایه‌ای از داده‌های بازگردانده‌شده
`total_pages`	تعداد کل صفحه‌ها در مجموعهٔ بازگردانده‌شده
`current_page`	صفحهٔ جاری
`next_page`	صفحهٔ بعدی که برای بارگیری در دسترس است؛ اگر صفحهٔ جاری آخرین صفحه باشد، `null`

درخواست

bash

curl -i \
  --header "access-token: *********************" \
  --header "token-type: Bearer" \
  --header "client: **********************" \
  --header "uid: api-user@example.com" \
  --header "Content-Type: application/json" \
  --request GET \
  "https://api.vadsro.eu/api/v1/channel_data?archive_type=hourly&equipment_id=25&fp_end=2021-02-20&fp_start=2021-02-01&page=2"

const res = await fetch(
  'https://api.vadsro.eu/api/v1/channel_data?archive_type=hourly&equipment_id=25&fp_end=2021-02-20&fp_start=2021-02-01&page=2',
  {
    headers: {
      'access-token': '*********************',
      'token-type': 'Bearer',
      client: '**********************',
      uid: 'api-user@example.com',
      'Content-Type': 'application/json',
    },
  },
);
const data = await res.json();

python

import requests

res = requests.get(
    "https://api.vadsro.eu/api/v1/channel_data",
    params={
        "archive_type": "hourly",
        "equipment_id": 25,
        "fp_end": "2021-02-20",
        "fp_start": "2021-02-01",
        "page": 2,
    },
    headers={
        "access-token": "*********************",
        "token-type": "Bearer",
        "client": "**********************",
        "uid": "api-user@example.com",
        "Content-Type": "application/json",
    },
)
data = res.json()

req, _ := http.NewRequest("GET", "https://api.vadsro.eu/api/v1/channel_data?archive_type=hourly&equipment_id=25&fp_end=2021-02-20&fp_start=2021-02-01&page=2", nil)
req.Header.Set("access-token", "*********************")
req.Header.Set("token-type", "Bearer")
req.Header.Set("client", "**********************")
req.Header.Set("uid", "api-user@example.com")
req.Header.Set("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

php

$ch = curl_init("https://api.vadsro.eu/api/v1/channel_data?archive_type=hourly&equipment_id=25&fp_end=2021-02-20&fp_start=2021-02-01&page=2");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "access-token: *********************",
    "token-type: Bearer",
    "client: **********************",
    "uid: api-user@example.com",
    "Content-Type: application/json",
]);
$data = json_decode(curl_exec($ch), true);

پاسخ

json

{
"data": [
   {
     "event_time": 1612292400,
     "channel_data": [
       { "T": 25.193481 },
       { "VNakpriv": 89519.01 },
       { "VNakwork": 292537.06 },
       { "P": 0.9954071 }
] },
...,
   {
     "event_time": 1612288800,
     "channel_data": [
       { "P": 0.995224 },
       { "VNakpriv": 89519.01 },
       { "VNakwork": 292537.06 },
       { "T": 25.103271 }
] }
],
 "total_pages": 2,
 "current_page": 1,
 "next_page": 2
}

آخرین به‌روزرسانی در ۱۷ مرداد ۱۴۰۵

آیا این صفحه مفید بود؟