WSQueryAddr40 Web 服務

WSQueryAddr40

按一下這裡以取得完整的作業清單。

QueryAddr

呼叫門牌位置比對服務，需傳入的參數如下
參數名稱參數說明

oAPPId 應用程式識別碼(APPId)，這個值是由使用API的使用者在申請成功後所取得，必須與應用程式介接驗證碼(APIKey)成對使用，這個值是由使用API的使用者在呼叫API時所需傳入

oAPIKey 應用程式介接驗證碼(APIKey)，這個值是由使用API的使用者在申請成功後所取得，必須與應用程式識別碼(APPId)成對使用，這個值是由使用API的使用者在呼叫API時所需傳入

oAddress 所要查詢的門牌地址

oSRS 回傳的坐標系統，允許傳入的坐標系統代碼為：EPSG:4326、EPSG:3825、EPSG:3826、EPSG:3827、EPSG:3828

oFuzzyType
目前有下列三種模糊比對的機制: (一) 最近門牌號機制：先找最近且大於輸入的門牌號，找不到則找最近且小於輸入的門牌號；代碼為 0 (二) 單雙號機制：先找最近且大於輸入的單號或雙號門牌號，找不到則找最近且小於輸入的單號或雙號門牌號；代碼為 1 (三) 單雙號機制 + 最近門牌號機制：當單雙號機制找不到門牌時，就改採用最近門牌號機制；代碼為 2

oResultDataType 回傳的資料格式，允許傳入的代碼為：JSON、XML

oFuzzyBuffer 模糊比對回傳門牌號的許可誤差範圍，輸入格式為正整數，如輸入 0 則代表不限制誤差範圍

oIsOnlyFullMatch 是否只進行完全比對，允許傳入的值為：true、false，如輸入 true ，模糊比對機制將不被使用

oIsSupportPast 是否支援舊門牌的查詢，允許傳入的值為：true、false，如輸入 true ，查詢時範圍包含舊門牌

oIsShowCodeBase 是否顯示地址的統計區相關資訊，允許傳入的值為：true、false

oIsLockCounty 是否鎖定縣市，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [縣市] 要與所輸入的門牌地址中的 [縣市] 完全相同

oIsLockTown 是否鎖定鄉鎮市區，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [鄉鎮市區] 要與所輸入的門牌地址中的 [鄉鎮市區] 完全相同

oIsLockVillage 是否鎖定村里，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [村里] 要與所輸入的門牌地址中的 [村里] 完全相同

oIsLockRoadSection 是否鎖定路段，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [路段] 要與所輸入的門牌地址中的 [路段] 完全相同

oIsLockLane 是否鎖定巷，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [巷] 要與所輸入的門牌地址中的 [巷] 完全相同

oIsLockAlley 是否鎖定弄，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [弄] 要與所輸入的門牌地址中的 [弄] 完全相同

oIsLockArea 是否鎖定地區，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [地區] 要與所輸入的門牌地址中的 [地區] 完全相同

oIsSameNumber_SubNumber 號之、之號是否視為相同，允許傳入的值為：true、false

oCanIgnoreVillage 找不時是否可忽略村里，允許傳入的值為：true、false

oCanIgnoreNeighborhood 找不時是否可忽略鄰，允許傳入的值為：true、false

oReturnMaxCount 如為多筆時，可限制回傳最大筆數（1~9），輸入格式為正整數，如輸入 0 則以本服務上限10筆進行回傳。

呼叫門牌位置比對服務，需傳入的參數如下
參數名稱	參數說明
oAPPId	應用程式識別碼(APPId)，這個值是由使用API的使用者在申請成功後所取得，必須與應用程式介接驗證碼(APIKey)成對使用，這個值是由使用API的使用者在呼叫API時所需傳入
oAPIKey	應用程式介接驗證碼(APIKey)，這個值是由使用API的使用者在申請成功後所取得，必須與應用程式識別碼(APPId)成對使用，這個值是由使用API的使用者在呼叫API時所需傳入
oAddress	所要查詢的門牌地址
oSRS	回傳的坐標系統，允許傳入的坐標系統代碼為：EPSG:4326、EPSG:3825、EPSG:3826、EPSG:3827、EPSG:3828
oFuzzyType	目前有下列三種模糊比對的機制: (一) 最近門牌號機制：先找最近且大於輸入的門牌號，找不到則找最近且小於輸入的門牌號；代碼為 0 (二) 單雙號機制：先找最近且大於輸入的單號或雙號門牌號，找不到則找最近且小於輸入的單號或雙號門牌號；代碼為 1 (三) 單雙號機制 + 最近門牌號機制：當單雙號機制找不到門牌時，就改採用最近門牌號機制；代碼為 2
oResultDataType	回傳的資料格式，允許傳入的代碼為：JSON、XML
oFuzzyBuffer	模糊比對回傳門牌號的許可誤差範圍，輸入格式為正整數，如輸入 0 則代表不限制誤差範圍
oIsOnlyFullMatch	是否只進行完全比對，允許傳入的值為：true、false，如輸入 true ，模糊比對機制將不被使用
oIsSupportPast	是否支援舊門牌的查詢，允許傳入的值為：true、false，如輸入 true ，查詢時範圍包含舊門牌
oIsShowCodeBase	是否顯示地址的統計區相關資訊，允許傳入的值為：true、false
oIsLockCounty	是否鎖定縣市，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [縣市] 要與所輸入的門牌地址中的 [縣市] 完全相同
oIsLockTown	是否鎖定鄉鎮市區，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [鄉鎮市區] 要與所輸入的門牌地址中的 [鄉鎮市區] 完全相同
oIsLockVillage	是否鎖定村里，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [村里] 要與所輸入的門牌地址中的 [村里] 完全相同
oIsLockRoadSection	是否鎖定路段，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [路段] 要與所輸入的門牌地址中的 [路段] 完全相同
oIsLockLane	是否鎖定巷，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [巷] 要與所輸入的門牌地址中的 [巷] 完全相同
oIsLockAlley	是否鎖定弄，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [弄] 要與所輸入的門牌地址中的 [弄] 完全相同
oIsLockArea	是否鎖定地區，允許傳入的值為：true、false，如輸入 true ，則代表查詢結果中的 [地區] 要與所輸入的門牌地址中的 [地區] 完全相同
oIsSameNumber_SubNumber	號之、之號是否視為相同，允許傳入的值為：true、false
oCanIgnoreVillage	找不時是否可忽略村里，允許傳入的值為：true、false
oCanIgnoreNeighborhood	找不時是否可忽略鄰，允許傳入的值為：true、false
oReturnMaxCount	如為多筆時，可限制回傳最大筆數（1~9），輸入格式為正整數，如輸入 0 則以本服務上限10筆進行回傳。

回傳資訊格式為SOAP:XML或JSON

JSON格式

{
    Info: [
            {
              InAddress: "臺北市中山區行政里1鄰松江路469巷4號",
              InSRS: "EPSG:3826",
              InFuzzyType: "最近門牌號機制",
              InFuzzyBuffer: "0",
              InIsOnlyFullMatch: "False",
              InIsSupportPast: "True",
              InIsShowCodeBase: "True",
              InIsLockCounty: "False",
              InIsLockTown: "False",
              InIsLockVillage: "False",
              InIsLockRoadSection: "False",
              InIsLockLane: "False",
              InIsLockAlley: "False",
              InIsLockArea "False",
              InIsSameNumber_SubNumber: "True",
              InCanIgnoreVillage: "True",
              InCanIgnoreNeighborhood: "True",
              InReturnMaxCount: "0",
              OutTotal: "1",
              OutMatchType: "完全比對",
              OutMatchCode: "111110100001(+0)",
              OutTraceInfo: "[臺北市]\t完全比對找到符合的門牌地址"

            }
    ],
    AddressList: [
            {
                PERIOD: "",
                FULL_ADDR: "臺北市中山區行政里1鄰松江路469巷4號",
                COUNTY: "臺北市",
                TOWN: "中山區",
                VILLAGE: "行政里",
                NEIGHBORHOOD: "1鄰",
                ROAD: "松江路",
                SECTION: "",
                LANE: "469巷",
                ALLEY: "",
                SUB_ALLEY: "",
                TONG: "",
                NUMBER: "4號",
                X: 303891.5427,
                Y: 2773226.674,
                CODEBASE: "A6304-0331-00",
                CODE1: "A6304-25-002",
                CODE2: "A6304-25"
            }
    ]
}

JSON格式說明

{
    回傳資訊: [
            {
              輸入資料: "臺北市中山區行政里1鄰松江路469巷4號",
              回傳坐標系統: "EPSG:3826",
              比對機制: "最近門牌號機制",
              模糊比對的容許誤差範圍(N號): "0",
              是否只進行完全比對: "False",
              是否支援舊門牌: "True",
              是否顯示統計區資訊: "True",
              是否鎖定縣市: "False",
              是否鎖定鄉鎮市區: "False",
              是否鎖定村里: "False",
              是否鎖定路名: "False",
              是否鎖定巷: "False",
              是否鎖定弄: "False",
              是否鎖定地區 "False",
              號之、之號是否視為相同: "True",
              找不時是否可忽略村里: "True",
              找不時是否可忽略鄰: "True",
              如為多筆時，限制回傳最大筆數: "0",
              本次回傳筆數: "1",
              比對結果類型: "完全比對",
              比對結果代碼: "111110100001(+0)",
              比對追蹤訊息: "[臺北市]\t完全比對找到符合的門牌地址"
            }
    ],
    門牌清單: [
            {
              "期別": "",
              "完整地址": "臺北市中山區行政里1鄰松江路469巷4號",
              "縣市": "臺北市",
              "鄉鎮市區": "中山區",
              "村里": "行政里",
              "鄰": "1鄰",
              "大道路街": "松江路",
              "段": "",
              "巷": "469巷",
              "弄": "",
              "衖": "",
              "衕": "",
              "門牌號碼": "4號",
              "X坐標": 303891.5427000000,
              "Y坐標": 2773226.6740000000,
              "最小統計區": "A6304-0331-00",
              "一級統計區": "A6304-25-002",
              "二級統計區": "A6304-25"
            }
    ]
}

XML格式

<AddressList InAddress="臺北市中山區行政里1鄰松江路469巷4號" InSRS="EPSG:3826" InFuzzyType="最近門牌號機制" InFuzzyBuffer="0" InIsOnlyFullMatch="False" InIsSupportPast="True" InIsShowCodeBase="True" InIsLockCounty="False" InIsLockTown="False" InIsLockVillage="False" InIsLockRoadSection="False" InIsLockLane="False" InIsLockAlley="False" InIsLockArea="False" InIsSameNumber_SubNumber="True" InCanIgnoreVillage="True" InCanIgnoreNeighborhood="True" InReturnMaxCount="0" OutTotal="1" OutMatchType="完全比對" OutMatchCode="111110100001(+0)" OutTraceInfo="[臺北市]	完全比對找到符合的門牌地址" >
  <Address>
    <PERIOD></PERIOD>
    <FULL_ADDR>臺北市中山區行政里1鄰松江路469巷4號</FULL_ADDR>
    <COUNTY>臺北市</COUNTY>
    <TOWN>中山區</TOWN>
    <VILLAGE>行政里</VILLAGE>
    <NEIGHBORHOOD>1鄰</NEIGHBORHOOD>
    <ROAD>松江路</ROAD>
    <SECTION/>
    <LANE>469巷</LANE>
    <ALLEY/>
    <SUB_ALLEY/>
    <TONG/>
    <NUMBER>4號</NUMBER>
    <X>303891.5427000000</X>
    <Y>2773226.6740000000</Y>
    <CODEBASE>A6304-0331-00</CODEBASE>
    <CODE1>A6304-25-002</CODE1>
    <CODE2>A6304-25</CODE2>
  </Address>
</AddressList>

XML格式說明

<門牌清單 輸入資料="臺北市中山區行政里1鄰松江路469巷4號" 回傳坐標系統="EPSG:3826" 比對機制="最近門牌號機制" 模糊比對的容許誤差範圍(N號)="0" 是否只進行完全比對="False" 是否支援舊門牌="True" 是否顯示統計區資訊: "True" 是否鎖定縣市="False" 是否鎖定鄉鎮市區="False" 是否鎖定村里="False" 是否鎖定路名="False" 是否鎖定巷="False" 是否鎖定弄="False" 是否鎖定地區="False" 號之、之號是否視為相同="True" 找不時是否可忽略村里="True" 找不時是否可忽略鄰="True" 如為多筆時，限制回傳最大筆數="0" 本次回傳筆數="1" 比對結果類型="完全比對" 比對結果代碼="111110100001(+0)" 比對追蹤訊息="[臺北市]	完全比對找到符合的門牌地址" >
  <門牌>
    <期別></期別>
    <完整地址>臺北市中山區行政里1鄰松江路469巷4號</完整地址>
    <縣市>臺北市</縣市>
    <鄉鎮市區>中山區</鄉鎮市區>
    <村里>行政里</村里>
    <鄰>1鄰</鄰>
    <大道路街>松江路</大道路街>
    <段/>
    <巷>469巷</巷>
    <弄/>
    <衖/>
    <衕/>
    <門牌號碼>4號</門牌號碼>
    <X坐標>303891.5427000000</X坐標>
    <Y坐標>2773226.6740000000</Y坐標>
    <最小統計區>A6304-0331-00</最小統計區>
    <一級統計區>A6304-25-002</一級統計區>
    <二級統計區>A6304-25</二級統計區>
  </門牌>
</門牌清單>

測試

若要以 HTTP POST 通訊協定測試作業，請按一下 [叫用] 按鈕。

參數	值
oAPPId:
oAPIKey:
oAddress:
oSRS:
oFuzzyType:
oResultDataType:
oFuzzyBuffer:
oIsOnlyFullMatch:
oIsSupportPast:
oIsShowCodeBase:
oIsLockCounty:
oIsLockTown:
oIsLockVillage:
oIsLockRoadSection:
oIsLockLane:
oIsLockAlley:
oIsLockArea:
oIsSameNumber_SubNumber:
oCanIgnoreVillage:
oCanIgnoreNeighborhood:
oReturnMaxCount:

SOAP 1.1

下列是 SOAP 1.1 要求與回應的範例。預留位置顯示之處必須代入實際的值。

POST /AddrWS/v40/QueryAddr.asmx HTTP/1.1
Host: addr.tgos.tw
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/QueryAddr"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryAddr xmlns="http://tempuri.org/">
      <oAPPId>string</oAPPId>
      <oAPIKey>string</oAPIKey>
      <oAddress>string</oAddress>
      <oSRS>string</oSRS>
      <oFuzzyType>int</oFuzzyType>
      <oResultDataType>string</oResultDataType>
      <oFuzzyBuffer>int</oFuzzyBuffer>
      <oIsOnlyFullMatch>boolean</oIsOnlyFullMatch>
      <oIsSupportPast>boolean</oIsSupportPast>
      <oIsShowCodeBase>boolean</oIsShowCodeBase>
      <oIsLockCounty>boolean</oIsLockCounty>
      <oIsLockTown>boolean</oIsLockTown>
      <oIsLockVillage>boolean</oIsLockVillage>
      <oIsLockRoadSection>boolean</oIsLockRoadSection>
      <oIsLockLane>boolean</oIsLockLane>
      <oIsLockAlley>boolean</oIsLockAlley>
      <oIsLockArea>boolean</oIsLockArea>
      <oIsSameNumber_SubNumber>boolean</oIsSameNumber_SubNumber>
      <oCanIgnoreVillage>boolean</oCanIgnoreVillage>
      <oCanIgnoreNeighborhood>boolean</oCanIgnoreNeighborhood>
      <oReturnMaxCount>int</oReturnMaxCount>
    </QueryAddr>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryAddrResponse xmlns="http://tempuri.org/">
      <QueryAddrResult>string</QueryAddrResult>
    </QueryAddrResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

下列是 SOAP 1.2 要求與回應的範例。預留位置顯示之處必須代入實際的值。

POST /AddrWS/v40/QueryAddr.asmx HTTP/1.1
Host: addr.tgos.tw
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryAddr xmlns="http://tempuri.org/">
      <oAPPId>string</oAPPId>
      <oAPIKey>string</oAPIKey>
      <oAddress>string</oAddress>
      <oSRS>string</oSRS>
      <oFuzzyType>int</oFuzzyType>
      <oResultDataType>string</oResultDataType>
      <oFuzzyBuffer>int</oFuzzyBuffer>
      <oIsOnlyFullMatch>boolean</oIsOnlyFullMatch>
      <oIsSupportPast>boolean</oIsSupportPast>
      <oIsShowCodeBase>boolean</oIsShowCodeBase>
      <oIsLockCounty>boolean</oIsLockCounty>
      <oIsLockTown>boolean</oIsLockTown>
      <oIsLockVillage>boolean</oIsLockVillage>
      <oIsLockRoadSection>boolean</oIsLockRoadSection>
      <oIsLockLane>boolean</oIsLockLane>
      <oIsLockAlley>boolean</oIsLockAlley>
      <oIsLockArea>boolean</oIsLockArea>
      <oIsSameNumber_SubNumber>boolean</oIsSameNumber_SubNumber>
      <oCanIgnoreVillage>boolean</oCanIgnoreVillage>
      <oCanIgnoreNeighborhood>boolean</oCanIgnoreNeighborhood>
      <oReturnMaxCount>int</oReturnMaxCount>
    </QueryAddr>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryAddrResponse xmlns="http://tempuri.org/">
      <QueryAddrResult>string</QueryAddrResult>
    </QueryAddrResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

下列是 HTTP GET 要求與回應的範例。預留位置顯示之處必須代入實際的值。

GET /AddrWS/v40/QueryAddr.asmx/QueryAddr?oAPPId=string&oAPIKey=string&oAddress=string&oSRS=string&oFuzzyType=string&oResultDataType=string&oFuzzyBuffer=string&oIsOnlyFullMatch=string&oIsSupportPast=string&oIsShowCodeBase=string&oIsLockCounty=string&oIsLockTown=string&oIsLockVillage=string&oIsLockRoadSection=string&oIsLockLane=string&oIsLockAlley=string&oIsLockArea=string&oIsSameNumber_SubNumber=string&oCanIgnoreVillage=string&oCanIgnoreNeighborhood=string&oReturnMaxCount=string HTTP/1.1
Host: addr.tgos.tw

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/">string</string>

HTTP POST

下列是 HTTP POST 要求與回應的範例。預留位置顯示之處必須代入實際的值。

POST /AddrWS/v40/QueryAddr.asmx/QueryAddr HTTP/1.1
Host: addr.tgos.tw
Content-Type: application/x-www-form-urlencoded
Content-Length: length

oAPPId=string&oAPIKey=string&oAddress=string&oSRS=string&oFuzzyType=string&oResultDataType=string&oFuzzyBuffer=string&oIsOnlyFullMatch=string&oIsSupportPast=string&oIsShowCodeBase=string&oIsLockCounty=string&oIsLockTown=string&oIsLockVillage=string&oIsLockRoadSection=string&oIsLockLane=string&oIsLockAlley=string&oIsLockArea=string&oIsSameNumber_SubNumber=string&oCanIgnoreVillage=string&oCanIgnoreNeighborhood=string&oReturnMaxCount=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/">string</string>