API สำหรับอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลาง
การกำหนดรายละเอียดของ API สำหรับการอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลาง
| API ID | URL | รายละเอียด |
|---|---|---|
| B003.1 | /MediumsizedWaterResourcesInfo | อ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลางตามเงื่อนไข |
| B003.2 | /MediumsizedWaterResourcesInfo/{waterResourcesCode} | อ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลางตามรหัสแหล่งน้ำ |
คุณลักษณะ API สำหรับอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลางตามเงื่อนไข
API ID: B003.1
วัตถุประสงค์: อ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลางตามเงื่อนไข
Status: Required (ตั้งแต่ API version 1.0 Draft 1)
Since: 1.0 Draft 1
Revision: 1.0 Draft 1
ข้อมูลทั่วไปในการติดต่อ API สำหรับอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลางตามเงื่อนไข
| ข้อมูล | รายละเอียด |
|---|---|
| URL | /MediumsizedWaterResourcesInfo |
| HTTP Method | GET |
Query parameter ของ API สำหรับอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลางตามเงื่อนไข
| ลำดับ | Parameter | Type | ความหมาย | หมายเหตุ |
|---|---|---|---|---|
| 1 | agencyCode | string | รหัสสถานีตรวจวัดของหน่วยงาน ดูหัวข้อรหัสสถานีตรวจวัด | optional |
| 2 | waterResourcesCode | string | รหัสแหล่งน้ำ ดูหัวข้อรหัสแหล่งน้ำ | optional |
| 3 | provinceCode | string | รหัสจังหวัด (2 หลัก) ดูหัวข้อการอ้างอิงจังหวัด | optional |
| 4 | amphoeCode | string | รหัสอำเภอ (4 หลัก) ดูหัวข้อการอ้างอิงอำเภอ | optional |
| 5 | tambonCode | string | รหัสตำบล (6 หลัก) ดูหัวข้อการอ้างอิงตำบล | optional |
| 6 | basinCode | string | รหัสลุ่มน้ำหลัก (2 หลัก) ดูหัวข้อการอ้างอิงลุ่มน้ำหลัก/ลุ่มน้ำสาขา | optional |
| 7 | subBasinCode | string | รหัสลุ่มน้ำสาขา (4 หลัก) ดูหัวข้อการอ้างอิงลุ่มน้ำหลัก/ลุ่มน้ำสาขา | optional |
ตัวอย่าง HTTP Request Parameter ระบุรหัสแหล่งน้ำ
waterResourcesCode = G07003-434576
ตัวอย่าง HTTP Request Parameter ระบุรหัสหน่วยงานร่วมกับรหัสจังหวัด
agencyCode= G07003
&provinceCode=60
หมายเหตุ
มีการขึ้นบรรทัดสำหรับ Parameter และไม่ได้ทำ HTTP URL Encode เพื่อให้ง่ายต่อการอ่าน
คุณลักษณะ API สำหรับอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลางตามรหัสแหล่งน้ำ
API ID: B003.2
วัตถุประสงค์: อ่านข้อมูลสารสนเทศแหล่งน้ำขนาดกลาง
Status: Required (ตั้งแต่ API version 1.0 Draft 1)
Since: 1.0 Draft 1
Revision: 1.0 Draft 1
ข้อมูลทั่วไปในการติดต่อ API สําหรับอ่านข้อมูลสารสนเทศแหล่งน้ําขนาดกลางตามรหัสแหล่งน้ํา
| ข้อมูล | รายละเอียด |
|---|---|
| URL | /MediumsizedWaterResourcesInfo/{waterResourcesCode} |
| HTTP Method | GET |
หมายเหตุ
waterResourcesCode – รหัสของแหล่งน้ำอ้างอิงหัวข้อรหัสแหล่งน้ำ
โครงสร้างของ HTTP Response Body ข้อมูลสารสนเทศแหล่งน้ำขนาดกลางที่ได้จาก API
{
"metadata": {
"version": string,
"dataProviderCode": string,
"dataProviderName": string,
"documentGenerateTime": datetime,
"waterDatatype": string
},
"waterResources": [{
"waterResourcesMetadata":
{
"dataOwnerCode": string,
"dataOwnerName": string,
"waterResourcesCode": string,
"waterResourcesName": string,
"waterResourcesSize": string,
"waterResourcesIrrigation": integer,
"capacity": decimal,
"locationCode": string,
"latitude": decimal,
"longitude": decimal,
"surfaceArea": decimal
},
"benefit":
{
"numOfPeople": integer,
"numOfHouseholds": integer,
"agriculturalArea": decimal
}
"lastUpdateTime": datetime,
}
]
}
หมายเหตุ
ในกรณีที่ ข้อมูลตามโครงสร้างมาตรฐานไม่ได้กำหนดเป็น Mandatory (ดูหัวข้อโครงสร้างข้อมูลสารสนเทศแหล่งน้ำขนาดกลาง (Medium-sized Water Resources Information)) ถ้ามีข้อมูลสามารถส่งข้อมูลนั้นๆได้ตามโครงสร้าง แต่ในกรณีที่ไม่มีข้อมูล API จะไม่ส่งข้อมูลกลับออกมา
ตัวอย่าง ของ HTTP Response Body ข้อมูลสารสนเทศแหล่งน้ำขนาดกลางที่ได้จาก API
{
"metadata": {
"version": "1.0",
"dataProviderCode": "G07003",
"dataProviderName": "Royal Irrigation Department",
"documentGenerateTime": "2023-09-01T10:00:00",
"waterDatatype": "B003"
},
"waterResources": [{
"waterResourcesMetadata":
{
"dataOwnerCode": "G07003",
"dataOwnerName": "Royal Irrigation Department",
"waterResourcesCode": "G07003-434576",
"waterResourcesName": "อ่างเก็บน้ำน้ำเลย",
"waterResourcesSize": "ML",
"waterResourcesIrrigation": 1,
"capacity": 35.087,
"locationCode": 421106,
"latitude": 17.03986488,
"longitude": 101.64073975,
"surfaceArea": 3.7023
},
"benefit":
{
"numOfPeople": 1000,
"numOfHouseholds": 100,
"agriculturalArea": 1000
}
"lastUpdateTime": "2022-05-02T9:00:00"
}
]
}