API สำหรับอ่านข้อมูลแหล่งน้ำขนาดเล็ก
การกำหนดรายละเอียดของ API สำหรับอ่านข้อมูลแหล่งน้ำขนาดเล็ก
API ID | URL | รายละเอียด |
---|---|---|
A005.1 | /SmallsizedWaterResources | อ่านข้อมูลแหล่งน้ำขนาดเล็ก ตามเงื่อนไขที่ระบุ |
คุณลักษณะ API สำหรับอ่านข้อมูลแหล่งน้ำขนาดเล็ก
API ID: A005.1
วัตถุประสงค์: อ่านข้อมูลแหล่งน้ำขนาดเล็ก
Status: Required (ตั้งแต่ API version 1.0 Draft 1)
Since: 1.0 Draft 1
Revision: 1.0 Draft 1
ข้อมูลทั่วไป ในการติดต่อ API สำหรับอ่านข้อมูลแหล่งน้ำขนาดเล็ก
ข้อมูล | รายละเอียด |
---|---|
URL | /SmallsizedWaterResources |
HTTP Method | GET |
Query parameter ของ API สำหรับอ่านข้อมูลแหล่งน้ำขนาดเล็ก
ลำดับ | Parameter | Type | ความหมาย | หมายเหตุ |
---|---|---|---|---|
1 | interval | string | ประเภทความถี่ของการตรวจวัด (อ้างอิงค่าตามหัวข้อ การใช้ค่า interval ในการระบุความถี่ของข้อมูลด้านน้ำจากการตรวจวัด) | required |
2 | latest | boolean | true – ดึงข้อมูลเฉพาะค่าของการตรวจวัดล่าสุด false – ดึงข้อมูลตาม startDateTime และ endDateTime |
required |
3 | startDatetime | datetime | วัน-เวลาที่ตรวจวัด (เริ่มต้น) – Inclusive | required เมื่อค่าพารามิเตอร์ latest = false |
4 | endDatetime | datetime | วัน-เวลาที่ตรวจวัด (สิ้นสุด) – Inclusive | required เมื่อค่าพารามิเตอร์ latest = false |
5 | provinceCode | string | รหัสจังหวัด (2 หลัก) ดูหัวข้อการอ้างอิงจังหวัด | optional |
6 | amphoeCode | string | รหัสอำเภอ (4 หลัก) ดูหัวข้อการอ้างอิงอำเภอ | optional |
7 | tambonCode | string | รหัสตำบล (6 หลัก) ดูหัวข้อการอ้างอิงตำบล | optional |
8 | basinCode | string | รหัสลุ่มน้ำหลัก (2 หลัก) ดูหัวข้อการอ้างอิงลุ่มน้ำหลัก/ลุ่มน้ำสาขา | optional |
9 | subBasinCode | string | รหัสลุ่มน้ำสาขา (4 หลัก) ดูหัวข้อการอ้างอิงลุ่มน้ำหลัก/ลุ่มน้ำสาขา | optional |
10 | agencyCode | string | รหัสหน่วยงาน ดูหัวข้อรหัสหน่วยงาน | optional |
หมายเหตุ
การดึงข้อมูลที่มีความถี่แตกต่างกัน ให้ทำการ call API แยกกัน
2) ข้อมูล parameter 5-10 ใช้ในการบ่งบอก filter ว่าต้องการดึงข้อมูลของแหล่งน้ำขนาดเล็กครอบคลุมพื้นที่ใดบ้าง
ตัวอย่าง HTTP Request Parameter ในการอ่านค่าแบบช่วงรายเดือน
latest=false
&startDatetime=2022-05-01T00:00:00
&endDatetime=2022-06-01T00:00:00
&interval= P- Montly
&provinceCode=10
โครงสร้างของ Response body ข้อมูลแหล่งน้ำขนาดเล็ก
{ "metadata": { "version": string, "dataProviderCode": string, "dataProviderName": string, "documentGenerateTime": datetime, "waterDatatype": string, "interval": string }, "timeSeriesObservation": [{ "observationMetadata": { "observeAgencyCode": string, "observeAgencyName": string, "originality": integer, "editAgencyCode": string, "editAgencyName": string }, "resultTime": datetime, "station": { "stationCode": string, "stationReference": url }, "waterResources": { "waterResourcesCode": string, "waterResourcesReference": url }, "measurementResults": [ { "instrumentPosition": { "position": string, "number": integer } "measureTime": datetime, "createTime": datetime, "updateTime": datetime, "variable": "Storage", "value": decimal, "uom": string, "qualityFlag": string, "comment": string, "qualityControlLevel": string } ] } ] }
หมายเหตุ
ในกรณีที่ ข้อมูลตามโครงสร้างมาตรฐานไม่ได้กําหนดเป็น Mandatory (ดูหัวข้อโครงสร้างข้อมูลตามลำดับเวลา (Time Series)) ถ้ามีข้อมูล สามารถส่งข้อมูลนั้นๆได้ตามโครงสร้าง แต่ในกรณีที่ไม่มีข้อมูล API จะไม่ส่งข้อมูลกลับออกมา
ตัวอย่าง HTTP Response Body ของข้อมูลแหล่งน้ําขนาดเล็กรายเดือน
{ "metadata": { "version": "1.0", "dataProviderCode": "G09006", "dataProviderName": "Department of Water Resources", "documentGenerateTime": "2023-09-15T10:00:00", "waterDatatype": "A005", "interval": "P-Montly" }, "timeSeriesObservation": [{ "observationMetadata": { "observeAgencyCode": "G09006", "observeAgencyName": "Department of Water Resources", "originality": 1 }, "resultTime": "2023-09-15T07:00:00", "waterResources": { "waterResourcesCode": "G09006-672", "waterResourcesReference": "https://api.my.org/twsapi/v1.0/SmallsizedWaterResourcesInfo/G09006-672" }, "measurementResults": [{ "measureTime": "2023-09-15T07:00:00", "createTime": "2023-09-15T07:00:00", "updateTime": "2023-09-15T07:00:00", "variable": "Storage", "value": 20000, "uom": "CM", "qualityFlag": "U", "comment": "No Quality Control", "qualityControlLevel": "1" }] }] }
หมายเหตุ
ข้อมูลที่ใส่ในตัวอย่างเป็นข้อมูลจําลองเพื่อประกอบความเข้าใจในการทํางานของ API เท่านั้น อาจจะไม่ตรงกับการใช้งานจริง