API สำหรับอ่านข้อมูลน้ำท่า

การกำหนดรายละเอียดของ API สำหรับอ่านข้อมูลน้ำท่า

API ID	URL	รายละเอียด
A002.1	/Runoff	อ่านข้อมูลน้ำท่าตามเงื่อนไขที่ระบุ

คุณลักษณะ API สำหรับอ่านข้อมูลน้ำท่า

API ID: A002.1
วัตถุประสงค์: อ่านข้อมูลน้ำท่า
Status: Required (ตั้งแต่ API version 1.0 Draft 1)
Since: 1.0 Draft 1
Revision: 1.0 Draft 1

ข้อมูลทั่วไป ในการติดต่อ API สำหรับอ่านข้อมูลน้ำท่า

ข้อมูล	รายละเอียด
URL	/Runoff
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
11	stationCode	string	รหัสสถานีตรวจวัดของหน่วยงาน ดูหัวข้อรหัสสถานีตรวจวัด	optional

หมายเหตุ

1) การดึงข้อมูลที่มีความถี่แตกต่างกัน ให้ทำการ call API แยกกัน
2) ข้อมูล parameter 5-11 ใช้ในการบ่งบอก filter ว่าต้องการดึงข้อมูลของสถานีตรวจวัดครอบคลุมพื้นที่ใดบ้าง

ตัวอย่าง HTTP Request Parameter ในการอ่านค่าแบบช่วงเวลารายชั่วโมง

latest=false
&amp;startDatetime=2022-05-02T22:00:00
&amp;endDatetime=2022-05-02T23:59:59
&amp;interval=C-60
&amp;provinceCode=10

หมายเหตุ

มีการขึ้นบรรทัดสำหรับ Parameter และไม่ได้ทำ HTTP URL Encode เพื่อให้ง่ายต่อการอ่าน

โครงสร้างของ 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": "WaterLevel",  
				"value": decimal, 
				"uom": string, 
				"qualityFlag": string, 
				"comment": string, 
				"qualityControlLevel": string 
				}, 
				{ 
				"instrumentPosition": 
					{  
					"position": string, 
					"number": integer 
					} 
				"measureTime": datetime, 
				"createTime": datetime, 
				"updateTime": datetime, 
				"variable": "Discharge", 
				"value": decimal, 
				"uom": string, 
				"qualityFlag": string, 
				"comment": string, 
				"qualityControlLevel": string 
				} 
			] 
		} 
	] 
}

หมายเหตุ

ในกรณีที่ ข้อมูลตามโครงสร้างมาตรฐานไม่ได้กำหนดเป็น Mandatory (ดูหัวข้อโครงสร้างข้อมูลตามลำดับเวลา (Time Series)) ถ้ามีข้อมูลสามารถส่งข้อมูลนั้นๆได้ตามโครงสร้าง แต่ในกรณีที่ไม่มีข้อมูล API อาจจะไม่ส่งข้อมูลกลับออกมา

ตัวอย่าง HTTP Response Body ของข้อมูลน้ำท่ารายชั่วโมง (60นาที)

{ 
    "metadata": { 
        "version": "1.0", 
        "dataProviderCode": "G07003", 
        "dataProviderName": "Royal Irrigation Department", 
        "documentGenerateTime": "2022-05-02T22:00:00", 
        "waterDatatype": "A002", 
        "interval": "C-60"
    },  
    "timeSeriesObservation": [{ 
        "observationMetadata": { 
            "observeAgencyCode": "G07003", 
            "observeAgencyName": "Royal Irrigation Department", 
            "originality": 1
        }, 
        "resultTime": "2022-05-02T22:01:00", 
        "station": { 
            "stationCode": "G07003-C.2", 
            "stationReference": "https://api.my.org/twsapi/v1.0/StationInfo/G07003-C.2"
        },
        "measurementResults": [ 
            { 
                "measureTime": "2022-05-02T22:00:00", 
                "createTime": "2022-05-02T22:01:00", 
                "updateTime": "2022-05-02T22:01:00", 
                "variable": "WaterLevel", 
                "value": 2.149, 
                "uom": "M(MSL)", 
                "qualityFlag": "U", 
                "comment": "No Quality Control", 
                "qualityControlLevel": "1"
            }, 
            { 
                "measureTime": "2022-05-02T22:00:00", 
                "createTime": "2022-05-02T22:01:00", 
                "updateTime": "2022-05-02T22:01:00", 
                "variable": "Discharge", 
                "value": 100, 
                "uom": "CMS", 
                "qualityFlag": "U", 
                "comment": "No Quality Control", 
                "qualityControlLevel": "1"
            } 
        ]    
    }] 
}

Was this article helpful to you?