跳到主要內容區塊
:::

API說明

Application Programming Interface
技術指南
臺南市政府資料開放系統技術指南

  臺南市政府資料開放系統提供派工通報資料,民眾或機關可在網站或以Open API介接方式取得通報資料,每個通報服務查詢資料均有列出格式及欄位定義,協助開發人員充分了解資料內容或應使用的介接技術,針對較複雜的API,並於系統點擊”使用說明”時即提供相關說明。

  本文件針對API的使用方式進行說明。

一、服務案件批次查詢(GET Service Requests):

   提供查詢派工通報資料內容。

   服務名稱:ServiceRequestsQuery

   URL:http://open1999.tainan.gov.tw:82/ServiceRequestsQuery.aspx

   編碼:UTF-8

   傳遞參數格式:XML

   參數說明:

    city_id:城市識別碼

    service_request_id:案件編號【多筆以逗號(,)分隔】

    service_name:案件類型【多筆以逗號(,)分隔】,可使用API服務ServiceList來查詢可使用條件。

    start_date:反映開始時間

    end_date:反映結束時間

    status:案件狀態

   參數內容及限制:

    1.service_request_id、service_name、start_date、end_date及status擇一查詢。

    2.service_request_id:條件最多1000筆。

    3.service_name:條件最多1000筆,可使用API服務ServiceList來查詢可使用條件。

    4.status:可查詢條件【處理中、已完成】。

   返回參數:

    returncode:0表示成功,其它表示不成功

    description:錯誤說明【操作失敗才會顯示】

    stacktrace:錯誤Log【操作失敗才會顯示】

    count:結果筆數

    records:多筆查詢結果

    record:每筆資料

    service_request_id:案件編號

    requested_datetime:反映日期

    status:案件狀態

    keyword:案件描述

    area:行政區

    service_name:案件類型

    agency:業管單位

    subproject:案件事項

    description:案件內容

    address_string:地點

    lat:緯度

    long:經度

    service_notice:服務案件說明

    updated_datetime:結案日期

    expected_datetime:預計完成日期

    pictures:多筆處理前照片

    picture:每筆處理前照片

    description:照片描述

    fileName:檔案名稱

    file:檔案資料

   返回參數內容及限制:

    1.回傳結果最多5000筆。

    2.file:byte格式。
 

二、服務請求新增(POST Service Request):
您如需新增大量案件(如開發APP協力通報),請先與我們聯繫 weiwuwu @mail.tainan.gov.tw

我們將提供相關測試網站

   提供新增派工通報資料。

   URL:http://open1999.tainan.gov.tw:82/ServiceRequestAdd.aspx

   服務名稱:ServiceRequestAdd

   編碼:UTF-8

   傳遞參數格式:XML

   參數說明:

    city_id:城市識別碼

    area:行政區

    address_string:地點

    lat:緯度(WGS84)

    long:經度(WGS84)

    email:E-MAIL

    device_id:僅用於行動裝置

    name:姓名

    phone:電話

    service_name:案件類型

    subproject:案件事項

    description:案件內容

    pictures:上傳照片

    description:照片描述

    fileName:檔案名稱

    file:檔案資料

   參數內容及限制:

    1.必填欄位:city_id、area、address_string、name、phone、service_name、subproject、description。

    2.service_name:可使用API服務ServiceList來查詢可新增條件。

    3.subproject:參考案件事項對應案件內容表。下載案件事項對應案件內容表

    4.pictures:最多三筆,檔案大小總和限制3MB以下。

    5.fileName:需含副檔名且檔案類型限制JPG。

    6.file:byte格式。

   返回參數:

    returncode:0表示成功,其它表示不成功

    description:錯誤說明【操作失敗才會顯示】

    stacktrace:錯誤Log【操作失敗才會顯示】

    service_request_id:案件編號

    token:token

    service_notice:服務說明

    count:結果筆數

   返回參數內容及限制:

    無
 

三、服務案件查詢(GET Service Request):

   提供查詢派工通報資料內容。

   服務名稱:ServiceRequestQuery

   URL:http://open1999.tainan.gov.tw:82/ServiceRequestQuery.aspx

   編碼:UTF-8

   傳遞參數格式:XML

   參數說明:

    city_id:城市識別碼

    service_request_id:案件編號

   參數內容及限制:

    1.service_request_id必需輸入。

    2.service_name:案件類型名稱可使用API服務ServiceList來進行查詢。

   返回參數:

    returncode:0表示成功,其它表示不成功

    description:錯誤說明【操作失敗才會顯示】

    stacktrace:錯誤Log【操作失敗才會顯示】

    count:結果筆數

    records:多筆查詢結果

    record:每筆資料

    service_request_id:案件編號

    requested_datetime:反映日期

    status:案件狀態

    keyword:案件描述

    area:行政區

    service_name:案件類型

    agency:業管單位

    subproject:案件事項

    description:案件內容

    address_string:地點

    lat:緯度

    long:經度

    service_notice:服務案件說明

    updated_datetime:結案日期

    expected_datetime:預計完成日期

    pictures:多筆處理前照片

    picture:每筆處理前照片

    description:照片描述

    fileName:檔案名稱

    file:檔案資料

   返回參數內容及限制:

    1.回傳結果最多5000筆。

    2.file:byte格式。
 

四、服務列表查詢(GET Service List):

   查詢服務列表(查詢所提供的案件服務類型及其代碼)。

   服務名稱:ServiceRequestQuery

   URL:http://open1999.tainan.gov.tw:82/ServiceList.aspx

   編碼:UTF-8

   傳遞參數格式:XML

   參數說明:

    city_id:城市識別碼

   參數內容及限制:

    無

   返回參數:

    returncode:0表示成功,其它表示不成功

    description:錯誤說明【操作失敗才會顯示】

    stacktrace:錯誤Log【操作失敗才會顯示】

    count:結果筆數

    records:多筆查詢結果

    record:每筆資料

    service_code:服務類別代碼

    service_name:服務名稱

    description:服務說明

    metadata:是否有定義擴充資料(是/否)

    type:產生方式(realtime/batch/black)

    keywords:服務相關關鍵字【多筆以逗號(,)分隔】

    subproject:服務包含哪些次類別【多筆以逗號(,)分隔】

   返回參數內容及限制:

    1.回傳結果最多30筆。

 

:::
Download Android App
Download IOS App
gotop