API สำหรับอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดเล็ก
การกำหนดรายละเอียดของ API สำหรับการอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดเล็ก
| API ID | URL | รายละเอียด |
|---|---|---|
| B004.1 | /SmallsizedWaterResourcesInfo | อ่านข้อมูลสารสนเทศแหล่งน้ำขนาดเล็กตามเงื่อนไข |
| B004.2 | /SmallsizedWaterResourcesInfo/{waterResourcesCode} | อ่านข้อมูลสารสนเทศแหล่งน้ำขนาดเล็กตามรหัสแหล่งน้ำ |
คุณลักษณะ API สำหรับอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดเล็กตามเงื่อนไข
API ID: B004.1
วัตถุประสงค์: อ่านข้อมูลสารสนเทศแหล่งน้ำขนาดเล็กตามเงื่อนไข
Status: Required (ตั้งแต่ API version 1.0 Draft 1)
Since: 1.0 Draft 1
Revision: 1.0 Draft 1
ข้อมูลทั่วไปในการติดต่อ API สำหรับอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดเล็กตามเงื่อนไข
| ข้อมูล | รายละเอียด |
|---|---|
| URL | /SmallsizedWaterResourcesInfo |
| 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= G09006-672
ตัวอย่าง HTTP Request Parameter ระบุรหัสหน่วยงานร่วมกับรหัสจังหวัด
agencyCode= G09006
&provinceCode=60
หมายเหตุ
มีการขึ้นบรรทัดสำหรับ Parameter และไม่ได้ทำ HTTP URL Encode เพื่อให้ง่ายต่อการอ่าน
คุณลักษณะ API สำหรับอ่านข้อมูลสารสนเทศแหล่งน้ำขนาดเล็กตามรหัสแหล่งน้ำ
API ID: B004.2
วัตถุประสงค์: อ่านข้อมูลสารสนเทศแหล่งน้ำขนาดเล็ก
Status: Required (ตั้งแต่ API version 1.0 Draft 1)
Since: 1.0 Draft 1
Revision: 1.0 Draft 1
ข้อมูลทั่วไปในการติดต่อ API สําหรับอ่านข้อมูลสารสนเทศแหล่งน้ําขนาดเล็กตามรหัสแหล่งน้ํา
| ข้อมูล | รายละเอียด |
|---|---|
| URL | /SmallsizedWaterResourcesInfo/{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,
"waterResourcesType": string,
"waterResourcesIrrigation": integer,
"capacity": decimal,
"locationCode": string,
"latitude": decimal,
"longitude": decimal,
"surfaceArea": decimal
},
"benefit":
{
"numOfPeople": integer,
"numOfHouseholds": integer,
"agriculturalArea": decimal
},
"administration":
{
"developAgencyName": string,
"improveAgencyName": string,
"developDate": date,
"lastImproveDate": date
},
"lastUpdateTime": datetime
}
]
}
หมายเหตุ
ในกรณีที่ ข้อมูลตามโครงสร้างมาตรฐานไม่ได้กำหนดเป็น Mandatory (ดูหัวข้อโครงสร้างข้อมูลสารสนเทศแหล่งน้ำขนาดเล็ก (Small-sized Water Resources Information)) ถ้ามีข้อมูลสามารถส่งข้อมูลนั้นๆได้ตามโครงสร้าง แต่ในกรณีที่ไม่มีข้อมูล API จะไม่ส่งข้อมูลกลับออกมา
ตัวอย่าง ของ HTTP Response Body ข้อมูลสารสนเทศแหล่งน้ำขนาดเล็กที่ได้จาก API
{
"metadata": {
"version": "1.0",
"dataProviderCode": "G09006",
"dataProviderName": "Department of Water Resource",
"documentGenerateTime": "2023-05-02T22:01:00",
"waterDatatype": "B004"
},
"waterResources": [
{
"waterResourcesMetadata": {
"dataOwnerCode": "G09006",
"dataOwnerName": "Department of Water Resource",
"waterResourcesCode": "G09006-672",
"waterResourcesName": "หนองขลา",
"waterResourcesSize": "S",
"waterResourcesType": "0201",
"waterResourcesIrrigation": 0,
"capacity": 140000,
"locationCode": 660011,
"latitude": 16.38299234,
"longitude": 100.36135700,
"surfaceArea": 0.3
},
"benefit": {
"numOfPeople": 100,
"numOfHouseholds": 50,
"agriculturalArea": 100
},
"administration": {
"developAgencyName": "Department of Water Resource",
"improveAgencyName": "Department of Water Resource",
"developDate": "2000-01-01",
"lastImproveDate": "2022-01-01"
},
"lastUpdateTime": "2022-05-02T09:00:00"
}
]
}