TDX API 網址參數介紹

TDX API 服務

TDX API 網址參數支援介紹

TDX 中的每個 API 都有提供網址參數方便取得資料,下方以景點為例。

Parameters 參數

Parameters 參數 ▲

  • $select 挑選 :從資料庫中挑選要顯示的屬性。

  • $filter 過濾 :可針對資料庫中某屬性的關鍵字去做過濾。例如過濾景點名稱中有公園的關鍵字為例 :

    • 語法 contains(屬性,'關鍵字') ,如 contains(ScenicSpotName,'公園')
    • 其他操作方式可參考 PTX API 官方操作教學 p19 ~ p32。
  • $orderby 排序 : 針對英文或數字做資料庫排序

  • $top 取資料庫前幾筆:預設 30 。

  • $skip 跳過資料庫前幾筆:較少用。

  • $spatialFilter 空間過濾:可丟目前座標,搜尋目前座標附近多少範圍有哪些景點。

    1
    2
    3
    4
    // 語法
    nearby({Lat},{Lon},{DistanceInMeters})
    // 翻譯
    nearby(經度,緯度,要抓距離經緯度多少範圍以公尺為單位)
    • 例如 nearby(25.047675, 121.517055, 100) ( 經度 25.047675, 緯度 121.517055, 抓取距離此經緯度一公尺距離的資料 ),如果要抓一公里為 1000。。

實作|Parameters

以景點為例讓資料庫只顯示景點名稱與地址

  1. 景點資訊 API 選擇 「 GET 取得所有觀光景點資料」

    GET 取得所有觀光景點資料 API ▲

  2. Parameters 中使用 $select 參數,挑選出景點名稱與地址 ScenicSpotName, Address,並點擊下方 Execute 按鈕,Responses 的 Request URL 顯示剛剛 select 後的網址參數,開啟網址可見資料庫中的景點資料就只有景點名稱與地址囉 !

    Parameters 中使用 $select 參數 ▲

    Responses 的 Request URL ▲

    Request URL貼入網頁 示意圖 ▲

參考資訊